org.jminor.swing.common.model.table

Class SwingFilteredTableColumnModel<C>

java.lang.Object

javax.swing.table.DefaultTableColumnModel

org.jminor.swing.common.model.table.SwingFilteredTableColumnModel<C>

Type Parameters:

C - the type of column identifier

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.swing.event.ListSelectionListener, javax.swing.table.TableColumnModel, FilteredTableColumnModel<C,javax.swing.table.TableColumn>

public class SwingFilteredTableColumnModel<C>
extends javax.swing.table.DefaultTableColumnModel
implements FilteredTableColumnModel<C,javax.swing.table.TableColumn>

A TableColumnModel handling hidden columns

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.table.DefaultTableColumnModel

changeEvent, columnMargin, columnSelectionAllowed, listenerList, selectionModel, tableColumns, totalColumnWidth

Constructor Summary

Constructors

Constructor and Description
SwingFilteredTableColumnModel(java.util.List<javax.swing.table.TableColumn> columns, java.util.Collection<? extends ColumnConditionModel<C>> columnFilterModels) Instantiates a new SwingFilteredTableColumnModel, note that the TableColumnModel this model is to be based on must contain all the columns when this constructor is called

Method Summary

Modifier and Type	Method and Description
void	addColumnHiddenListener(EventDataListener<C> listener)
void	addColumnShownListener(EventDataListener<C> listener)
boolean	containsColumn(C identifier)
protected int	convertColumnIndexToView(int modelColumnIndex) Converts the index of the column in the table model at modelColumnIndex to the index of the column in the view.
java.util.List<javax.swing.table.TableColumn>	getAllColumns()
ColumnConditionModel<C>	getColumnFilterModel(C columnIdentifier)
java.util.Collection<ColumnConditionModel<C>>	getColumnFilterModels()
C	getColumnIdentifier(int columnModelIndex)
java.util.List<javax.swing.table.TableColumn>	getHiddenColumns()
javax.swing.table.TableColumn	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.

Methods inherited from class javax.swing.table.DefaultTableColumnModel

addColumn, addColumnModelListener, createSelectionModel, fireColumnAdded, fireColumnMarginChanged, fireColumnMoved, fireColumnRemoved, fireColumnSelectionChanged, getColumn, getColumnCount, getColumnIndex, getColumnIndexAtX, getColumnMargin, getColumnModelListeners, getColumns, getColumnSelectionAllowed, getListeners, getSelectedColumnCount, getSelectedColumns, getSelectionModel, getTotalColumnWidth, moveColumn, propertyChange, recalcWidthCache, removeColumn, removeColumnModelListener, setColumnMargin, setColumnSelectionAllowed, setSelectionModel, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwingFilteredTableColumnModel

public SwingFilteredTableColumnModel(java.util.List<javax.swing.table.TableColumn> columns,
                                     java.util.Collection<? extends ColumnConditionModel<C>> columnFilterModels)

Instantiates a new SwingFilteredTableColumnModel, note that the TableColumnModel this model is to be based on must contain all the columns when this constructor is called

Parameters:

columns - the columns to base this model on

columnFilterModels - the filter models if any

Method Detail

getAllColumns

public final java.util.List<javax.swing.table.TableColumn> getAllColumns()

Specified by:

getAllColumns in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Returns:

all columns in this model, both hidden and visible

setColumnVisible

public final void setColumnVisible(C columnIdentifier,
                                   boolean visible)

Toggles the visibility of the column representing the given columnIdentifier.

Specified by:

setColumnVisible in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the column identifier

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

isColumnVisible

public final boolean isColumnVisible(C columnIdentifier)

Specified by:

isColumnVisible in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

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

setColumns

public final void setColumns(C... columnIdentifiers)

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

Specified by:

setColumns in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

columnIdentifiers - the column identifiers

getHiddenColumns

public final java.util.List<javax.swing.table.TableColumn> getHiddenColumns()

Specified by:

getHiddenColumns in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Returns:

an unmodifiable view of hidden table columns

getTableColumn

public final javax.swing.table.TableColumn getTableColumn(C identifier)

Returns the TableColumn with the given identifier

Specified by:

getTableColumn in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

identifier - the column identifier

Returns:

the TableColumn with the given identifier

containsColumn

public final boolean containsColumn(C identifier)

Specified by:

containsColumn in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

identifier - the column identifier

Returns:

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

getColumnFilterModel

public final ColumnConditionModel<C> getColumnFilterModel(C columnIdentifier)

Specified by:

getColumnFilterModel in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the column identifier

Returns:

the ColumnConditionModel at the given column index

getColumnFilterModels

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

Specified by:

getColumnFilterModels in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Returns:

the ColumnFilterModel instances

getColumnIdentifier

public final C getColumnIdentifier(int columnModelIndex)

Specified by:

getColumnIdentifier in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

columnModelIndex - the column model index

Returns:

the column identifier

addColumnHiddenListener

public final void addColumnHiddenListener(EventDataListener<C> listener)

Specified by:

addColumnHiddenListener in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

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

removeColumnHiddenListener

public final void removeColumnHiddenListener(EventDataListener<C> listener)

Specified by:

removeColumnHiddenListener in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

addColumnShownListener

public final void addColumnShownListener(EventDataListener<C> listener)

Specified by:

addColumnShownListener in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

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

removeColumnShownListener

public final void removeColumnShownListener(EventDataListener<C> listener)

Specified by:

removeColumnShownListener in interface FilteredTableColumnModel<C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

convertColumnIndexToView

protected final int convertColumnIndexToView(int modelColumnIndex)

Converts the index of the column in the table model at modelColumnIndex to the index of the column in the view. Returns the index of the corresponding column in the view; returns -1 if this column is not being displayed. If modelColumnIndex is less than zero, this returns modelColumnIndex.

Parameters:

modelColumnIndex - the index of the column in the model

Returns:

the index of the corresponding column in the view