org.jminor.common.model.table

Interface FilteredTableColumnModel<C,T>

Type Parameters:

C - the type of column identifier

T - the type representing table columns

All Known Implementing Classes:

SwingFilteredTableColumnModel

public interface FilteredTableColumnModel<C,T>

A TableColumnModel handling hidden columns

Method Summary

Modifier and Type	Method and Description
void	addColumnHiddenListener(EventDataListener<C> listener)
void	addColumnShownListener(EventDataListener<C> listener)
boolean	containsColumn(C identifier)
java.util.List<T>	getAllColumns()
ColumnConditionModel<C>	getColumnFilterModel(C columnIdentifier)
java.util.Collection<ColumnConditionModel<C>>	getColumnFilterModels()
C	getColumnIdentifier(int modelColumnIndex)
java.util.Collection<T>	getHiddenColumns()
T	getTableColumn(C identifier) Returns the TableColumn with the given identifier
boolean	isColumnVisible(C columnIdentifier)
void	removeColumnHiddenListener(EventDataListener<C> listener)
void	removeColumnShownListener(EventDataListener<C> listener)
void	setColumns(C... columnIdentifiers) Arranges the columns so that only the given columns are visible and in the given order
void	setColumnVisible(C columnIdentifier, boolean visible) Toggles the visibility of the column representing the given columnIdentifier.

Method Detail

getAllColumns

java.util.List<T> getAllColumns()

Returns:

all columns in this model, both hidden and visible

getHiddenColumns

java.util.Collection<T> getHiddenColumns()

Returns:

an unmodifiable view of hidden table columns

isColumnVisible

boolean isColumnVisible(C columnIdentifier)

Parameters:

columnIdentifier - the key for which to query if its column is visible

Returns:

true if the column is visible, false if it is hidden

setColumnVisible

void setColumnVisible(C columnIdentifier,
                      boolean visible)

Toggles the visibility of the column representing the given columnIdentifier.

Parameters:

columnIdentifier - the column identifier

visible - if true the column is shown, otherwise it is hidden

setColumns

void setColumns(C... columnIdentifiers)

Arranges the columns so that only the given columns are visible and in the given order

Parameters:

columnIdentifiers - the column identifiers

getTableColumn

T getTableColumn(C identifier)

Returns the TableColumn with the given identifier

Parameters:

identifier - the column identifier

Returns:

the TableColumn with the given identifier

Throws:

java.lang.IllegalArgumentException - in case this table model does not contain a column with the given identifier

containsColumn

boolean containsColumn(C identifier)

Parameters:

identifier - the column identifier

Returns:

true if this column model contains a column with the given identifier

getColumnIdentifier

C getColumnIdentifier(int modelColumnIndex)

Parameters:

modelColumnIndex - the column model index

Returns:

the column identifier

getColumnFilterModel

ColumnConditionModel<C> getColumnFilterModel(C columnIdentifier)

Parameters:

columnIdentifier - the column identifier

Returns:

the ColumnConditionModel at the given column index

getColumnFilterModels

java.util.Collection<ColumnConditionModel<C>> getColumnFilterModels()

Returns:

the ColumnFilterModel instances

addColumnHiddenListener

void addColumnHiddenListener(EventDataListener<C> listener)

Parameters:

listener - a listener to be notified each time a column is hidden

removeColumnHiddenListener

void removeColumnHiddenListener(EventDataListener<C> listener)

Parameters:

listener - the listener to remove

addColumnShownListener

void addColumnShownListener(EventDataListener<C> listener)

Parameters:

listener - a listener to be notified each time a column is shown

removeColumnShownListener

void removeColumnShownListener(EventDataListener<C> listener)

Parameters:

listener - the listener to remove