ucar.nc2.ui.table

Class HidableTableColumnModel

java.lang.Object

javax.swing.table.DefaultTableColumnModel

ucar.nc2.ui.table.HidableTableColumnModel

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.swing.event.ListSelectionListener, javax.swing.event.TableModelListener, javax.swing.table.TableColumnModel

public class HidableTableColumnModel
extends javax.swing.table.DefaultTableColumnModel
implements javax.swing.event.TableModelListener

HidableTableColumnModel extends the DefaultTableColumnModel . It provides a comfortable way to hide/show columns. Columns keep their positions when hidden and shown again.

In order to work with JTable it cannot add any events to TableColumnModelListener. Therefore hiding a column will result in columnRemoved event and showing it again will notify listeners of a columnAdded, and possibly a columnMoved event. For the same reason the following methods still deal with visible columns only: getColumnCount(), getColumns(), getColumnIndex(), getColumn() There are overloaded versions of these methods that take a parameter onlyVisible which let's you specify whether you want invisible columns taken into account.

See Also:

DefaultTableColumnModel, original documentation, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<javax.swing.table.TableColumn>	allTableColumns Array of TableColumn objects in this model.

Fields inherited from class javax.swing.table.DefaultTableColumnModel

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

Constructor Summary

Constructors

Constructor and Description
HidableTableColumnModel(javax.swing.table.TableModel model)

Method Summary

Modifier and Type	Method and Description
void	addColumn(javax.swing.table.TableColumn column) Append column to the right of exisiting columns.
void	createColumnsFromModel(javax.swing.table.TableModel newModel)
javax.swing.table.TableColumn	getColumn(int columnIndex, boolean onlyVisible) Returns the TableColumn object for the column at columnIndex.
int	getColumnCount(boolean onlyVisible) Returns the total number of columns in this model.
java.util.Enumeration<javax.swing.table.TableColumn>	getColumns(boolean onlyVisible) Returns an Enumeration of all the columns in the model.
boolean	isColumnVisible(javax.swing.table.TableColumn aColumn) Checks whether the specified column is currently visible.
void	moveColumn(int oldIndex, int newIndex) Moves the column from oldIndex to newIndex.
void	removeColumn(javax.swing.table.TableColumn column) Removes column from this column model.
void	setColumnVisible(javax.swing.table.TableColumn column, boolean visible) Sets the visibility of the specified TableColumn.
void	tableChanged(javax.swing.event.TableModelEvent e)

Methods inherited from class javax.swing.table.DefaultTableColumnModel

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

Methods inherited from class java.lang.Object

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

Field Detail

allTableColumns

protected java.util.Vector<javax.swing.table.TableColumn> allTableColumns

Array of TableColumn objects in this model. Holds all column objects, regardless of their visibility.

Constructor Detail

HidableTableColumnModel

public HidableTableColumnModel(javax.swing.table.TableModel model)

Method Detail

setColumnVisible

public void setColumnVisible(javax.swing.table.TableColumn column,
                             boolean visible)

Sets the visibility of the specified TableColumn. The call is ignored if the TableColumn is not found in this column model or its visibility status did not change.

Parameters:

column - the column to show/hide

visible - its new visibility status

isColumnVisible

public boolean isColumnVisible(javax.swing.table.TableColumn aColumn)

Checks whether the specified column is currently visible.

Parameters:

aColumn - column to check

Returns:

visibility of specified column (false if there is no such column at all. [It's not visible, right?])

addColumn

public void addColumn(javax.swing.table.TableColumn column)

Append column to the right of exisiting columns. Posts columnAdded event.

Specified by:

addColumn in interface javax.swing.table.TableColumnModel

Overrides:

addColumn in class javax.swing.table.DefaultTableColumnModel

Parameters:

column - The column to be added

Throws:

java.lang.IllegalArgumentException - if column is null

See Also:

removeColumn(javax.swing.table.TableColumn)

removeColumn

public void removeColumn(javax.swing.table.TableColumn column)

Removes column from this column model. Posts columnRemoved event. Will do nothing if the column is not in this model.

Specified by:

removeColumn in interface javax.swing.table.TableColumnModel

Overrides:

removeColumn in class javax.swing.table.DefaultTableColumnModel

Parameters:

column - the column to be added

See Also:

addColumn(javax.swing.table.TableColumn)

moveColumn

public void moveColumn(int oldIndex,
                       int newIndex)

Moves the column from oldIndex to newIndex. Posts columnMoved event. Will not move any columns if oldIndex equals newIndex.

Specified by:

moveColumn in interface javax.swing.table.TableColumnModel

Overrides:

moveColumn in class javax.swing.table.DefaultTableColumnModel

Parameters:

oldIndex - index of column to be moved

newIndex - new index of the column

Throws:

java.lang.IllegalArgumentException - if either oldIndex or newIndex are not in [0, getColumnCount() - 1]

getColumnCount

public int getColumnCount(boolean onlyVisible)

Returns the total number of columns in this model.

Parameters:

onlyVisible - if set only visible columns will be counted

Returns:

the number of columns in the tableColumns array

See Also:

getColumns(boolean)

getColumns

public java.util.Enumeration<javax.swing.table.TableColumn> getColumns(boolean onlyVisible)

Returns an Enumeration of all the columns in the model.

Parameters:

onlyVisible - if set all invisible columns will be missing from the enumeration.

Returns:

an Enumeration of the columns in the model

getColumn

public javax.swing.table.TableColumn getColumn(int columnIndex,
                                               boolean onlyVisible)

Returns the TableColumn object for the column at columnIndex.

Parameters:

columnIndex - the index of the column desired

onlyVisible - if set columnIndex is meant to be relative to all visible columns only else it is the index in all columns

Returns:

the TableColumn object for the column at columnIndex

tableChanged

public void tableChanged(javax.swing.event.TableModelEvent e)

Specified by:

tableChanged in interface javax.swing.event.TableModelListener

createColumnsFromModel

public void createColumnsFromModel(javax.swing.table.TableModel newModel)