net.sf.cuf.ui.table

Class ColumnVisibilitySupport

java.lang.Object

net.sf.cuf.ui.table.ColumnVisibilitySupport

All Implemented Interfaces:

PropertyChangeListener, EventListener

public class ColumnVisibilitySupport
extends Object
implements PropertyChangeListener

Support showing/hiding columns in a JTable. It has to be bound to a table instance upon creation.
It assumes that there is a 1:1 mapping from model columns to view columns (each model column must be displayed in exactly one view column).
Be careful when manipulating the column model of the table from the application. There might be conflicts with the column showing/hiding. Especially two points have to be observed: do not try to remove any hidden columns from the column model and do not break the 1:1 mapping between model and view columns.

This class notifies listeners about each showing/hiding of columns.

This class listens for changes of the column model of the table. Whenever the column model is replaced by another instance all the invisible columns are forgotten. Unfortunately we are not able to notice all changes. So the application may have to explicitly call clearInvisibleColumns(). See SortingTable.createDefaultColumnsFromModel() for a possible solution of this problem.

Author:

Hendrik Wördehoff, sd&m AG

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TableColumn>	mInvisibleColumns List of currently invisible table columns.
protected EventListenerList	mListenerList List of ColumnVisibilityChangeListeners.
protected JTable	mTable Table to operate on.

Constructor Summary

Constructors

Constructor and Description
ColumnVisibilitySupport(JTable pTable) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumnVisibilityChangeListener(ColumnVisibilityChangeListener pListener) Add a listener for showing/hiding of columns.
void	clearInvisibleColumns() Clear the list of invisible columns.
protected void	fireColumnVisibilityEventHidden(TableColumn pColumn) Notify our listeners that a table column was hidden.
protected void	fireColumnVisibilityEventShown(TableColumn pColumn) Notify our listeners that a table column was shown.
boolean[]	getColumnsVisible() Get the visibility of all table columns at once.
TableColumn	getInvisibleColumn(int pModelIndex) Fetch the hidden table column for a model index.
JTable	getTable() Access the table we work on.
protected void	hideColumn(int pModelIndex) Hide a column of our table.
boolean	isAllColumnsVisible() Test if all columns are visible.
boolean	isColumnVisible(int pModelIndex) Test whether a table column is currently visible.
void	propertyChange(PropertyChangeEvent pEvent) Forget all invisible columns if the column model of the table is changed.
void	removeColumnVisibilityChangeListener(ColumnVisibilityChangeListener pListener) Remove a listener for showing/hiding of columns.
void	setAllColumnsVisible() Make all table columns visible.
void	setColumnsVisible(boolean[] pVisible) Set the visibility of all table columns at once.
void	setColumnVisible(int pModelIndex, boolean pVisible) Show or hide a table column.
protected void	showColumn(int pModelIndex) Show a column of this table.

Methods inherited from class java.lang.Object

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

Field Detail

mTable

protected JTable mTable

Table to operate on.

mInvisibleColumns

protected List<TableColumn> mInvisibleColumns

List of currently invisible table columns. The removed TableColumn objects are stored in this list.

mListenerList

protected EventListenerList mListenerList

List of ColumnVisibilityChangeListeners.

Constructor Detail

ColumnVisibilitySupport

public ColumnVisibilitySupport(JTable pTable)

Constructor. We install ourselves as property change listener on the table.

Parameters:

pTable - table to operate on (must not be null)

Method Detail

getTable

public JTable getTable()

Access the table we work on.

Returns:

table this instance operates on

hideColumn

protected void hideColumn(int pModelIndex)

Hide a column of our table. Listeners are notified after the column is hidden.

Parameters:

pModelIndex - column index in the table model

showColumn

protected void showColumn(int pModelIndex)

Show a column of this table. Listeners are notified after the column is shown.

Parameters:

pModelIndex - column index in the table model

isColumnVisible

public boolean isColumnVisible(int pModelIndex)

Test whether a table column is currently visible.

Parameters:

pModelIndex - column index in the table model

Returns:

true if table column is visible

setColumnVisible

public void setColumnVisible(int pModelIndex,
                    boolean pVisible)

Show or hide a table column.

Parameters:

pModelIndex - column index in the table model

pVisible - true to make the column visible

getColumnsVisible

public boolean[] getColumnsVisible()

Get the visibility of all table columns at once. The visibility is modeled as a boolean[]. There is an entry in this array for each table model column. true means the respective column is visible. false makes the column hidden.

Returns:

visiblity information for each column in the table model

setColumnsVisible

public void setColumnsVisible(boolean[] pVisible)

Set the visibility of all table columns at once. The visibility is modeled as a boolean[]. There must be an entry in this array for each table model column. true means the respective column is visible. false makes the column hidden.

Parameters:

pVisible - visiblity information for each column in the table model

Throws:

IllegalArgumentException - if visible is null or has a different number of entries than the table model

setAllColumnsVisible

public void setAllColumnsVisible()

Make all table columns visible.

isAllColumnsVisible

public boolean isAllColumnsVisible()

Test if all columns are visible.

Returns:

true if there are currently no invisible columns

getInvisibleColumn

public TableColumn getInvisibleColumn(int pModelIndex)

Fetch the hidden table column for a model index. If the table column with the index is not hidden this method will return null.

Parameters:

pModelIndex - the model index

Returns:

table column object with the fitting model index or null

clearInvisibleColumns

public void clearInvisibleColumns()

Clear the list of invisible columns.

This method must be called whenever the table column model is changed completely. We do our best to catch this in propertyChange(java.beans.PropertyChangeEvent). But we cannot notice all changes. So you have to call this e.g. whenever JTable.createDefaultColumnsFromModel() is called explicitely.

propertyChange

public void propertyChange(PropertyChangeEvent pEvent)

Forget all invisible columns if the column model of the table is changed. This may happen either by an explicitly JTable.setColumnModel(TableColumnModel) or implicitly by any action that calls JTable.createDefaultColumnsFromModel().

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

pEvent - information about the changed property

addColumnVisibilityChangeListener

public void addColumnVisibilityChangeListener(ColumnVisibilityChangeListener pListener)

Add a listener for showing/hiding of columns.

Parameters:

pListener - listener to add

removeColumnVisibilityChangeListener

public void removeColumnVisibilityChangeListener(ColumnVisibilityChangeListener pListener)

Remove a listener for showing/hiding of columns.

Parameters:

pListener - listener to remove

fireColumnVisibilityEventShown

protected void fireColumnVisibilityEventShown(TableColumn pColumn)

Notify our listeners that a table column was shown.

Parameters:

pColumn - column that was shown

fireColumnVisibilityEventHidden

protected void fireColumnVisibilityEventHidden(TableColumn pColumn)

Notify our listeners that a table column was hidden.

Parameters:

pColumn - column that was hidden