is.codion.swing.common.model.component.table

Interface FilteredTableColumnModel<C>

Type Parameters:

C - the type of column identifier

All Superinterfaces:

TableColumnModel

public interface FilteredTableColumnModel<C>
extends TableColumnModel

A TableColumnModel handling hidden columns. Note that this column model does not support dynamically adding or removing columns, TableColumnModel.addColumn(TableColumn) and TableColumnModel.removeColumn(TableColumn) both throw UnsupportedOperationException.

Method Summary

Modifier and Type	Method and Description
void	addColumnHiddenListener(EventDataListener<C> listener)
void	addColumnShownListener(EventDataListener<C> listener)
C	columnIdentifier(int modelColumnIndex)
Collection<FilteredTableColumn<C>>	columns()
boolean	containsColumn(C identifier)
FilteredTableColumn<C>	getColumn(int columnIndex)
Collection<FilteredTableColumn<C>>	hiddenColumns()
boolean	isColumnVisible(C columnIdentifier)
State	lockedState() Returns a State instance controlling whether this model is locked or not.
void	removeColumnHiddenListener(EventDataListener<C> listener)
void	removeColumnShownListener(EventDataListener<C> listener)
void	resetColumns() Resets the columns to their original location and visibility
boolean	setColumnVisible(C columnIdentifier, boolean visible)
void	setVisibleColumns(C... columnIdentifiers) Arranges the columns so that only the given columns are visible and in the given order
void	setVisibleColumns(List<C> columnIdentifiers) Arranges the columns so that only the given columns are visible and in the given order
FilteredTableColumn<C>	tableColumn(C identifier) Returns the TableColumn with the given identifier
List<FilteredTableColumn<C>>	visibleColumns()

Methods inherited from interface javax.swing.table.TableColumnModel

addColumn, addColumnModelListener, getColumnCount, getColumnIndex, getColumnIndexAtX, getColumnMargin, getColumns, getColumnSelectionAllowed, getSelectedColumnCount, getSelectedColumns, getSelectionModel, getTotalColumnWidth, moveColumn, removeColumn, removeColumnModelListener, setColumnMargin, setColumnSelectionAllowed, setSelectionModel

Method Detail

columns

Collection<FilteredTableColumn<C>> columns()

Returns:

an unmodifiable view of all columns in this model, both hidden and visible, in no particular order

visibleColumns

List<FilteredTableColumn<C>> visibleColumns()

Returns:

an unmodifiable view of the currently visible columns

hiddenColumns

Collection<FilteredTableColumn<C>> hiddenColumns()

Returns:

an unmodifiable view of currently hidden columns, in no particular order

lockedState

State lockedState()

Returns a State instance controlling whether this model is locked or not. A locked column model does not allow adding or removing of columns, but columns can be reordered.

Returns:

a State controlling whether this model is locked or not

setColumnVisible

boolean setColumnVisible(C columnIdentifier,
                         boolean visible)

Parameters:

columnIdentifier - the columnd identifier

visible - true if the column should be visible, false if it should be hidden

Returns:

true if the column visibility changed

Throws:

IllegalStateException - in case this model is locked

See Also:

lockedState()

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

setVisibleColumns

void setVisibleColumns(C... columnIdentifiers)

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

Parameters:

columnIdentifiers - the column identifiers

setVisibleColumns

void setVisibleColumns(List<C> columnIdentifiers)

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

Parameters:

columnIdentifiers - the column identifiers

tableColumn

FilteredTableColumn<C> tableColumn(C identifier)

Returns the TableColumn with the given identifier

Parameters:

identifier - the column identifier

Returns:

the TableColumn with the given identifier

Throws:

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

getColumn

FilteredTableColumn<C> getColumn(int columnIndex)

Specified by:

getColumn in interface TableColumnModel

containsColumn

boolean containsColumn(C identifier)

Parameters:

identifier - the column identifier

Returns:

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

columnIdentifier

C columnIdentifier(int modelColumnIndex)

Parameters:

modelColumnIndex - the column model index

Returns:

the column identifier

resetColumns

void resetColumns()

Resets the columns to their original location and visibility

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