Class DefaultTableColumnModel

protected ChangeEvent changeEvent

A change event used when notifying listeners of a change to the columnMargin field. This single event is reused for all notifications (it is lazily instantiated within the fireColumnMarginChanged() method).

protected int columnMargin

The space between the columns (the default value is 1).

protected boolean columnSelectionAllowed

A flag that indicates whether or not columns can be selected.

protected EventListenerList listenerList

Storage for the listeners registered with the model.

protected ListSelectionModel selectionModel

A selection model that keeps track of column selections.

protected Vector tableColumns

Storage for the table columns.

protected int totalColumnWidth

The total width of all the columns in this model.

public DefaultTableColumnModel()

Creates a new table column model with zero columns. A default column selection model is created by calling createSelectionModel(). The default value for columnMargin is 1 and the default value for columnSelectionAllowed is false.

public void addColumn(TableColumn column)

Adds a column to the model then calls fireColumnAdded(TableColumnModelEvent) to notify the registered listeners. The model registers itself with the column as a PropertyChangeListener so that changes to the column width will invalidate the cached totalColumnWidth value.

Specified by:

addColumn in interface TableColumnModel

Parameters:

column - the column (null not permitted).

Throws:

IllegalArgumentException - if column is null.

See Also:

removeColumn(TableColumn)

public void addColumnModelListener(TableColumnModelListener listener)

Registers a listener with the model, so that it will receive TableColumnModelEvent notifications.

Specified by:

addColumnModelListener in interface TableColumnModel

Parameters:

listener - the listener (null ignored).

protected ListSelectionModel createSelectionModel()

Creates a default selection model to track the currently selected column(s). This method is called by the constructor and returns a new instance of DefaultListSelectionModel.

Returns:

A new default column selection model.

public extends EventListener> T[] getListeners(Class listenerType)

Returns an array containing the listeners (of the specified type) that are registered with this model.

Parameters:

listenerType - the listener type (must indicate a subclass of EventListener, null not permitted).

Returns:

An array containing the listeners (of the specified type) that are registered with this model.

protected void fireColumnAdded(TableColumnModelEvent e)

Sends the specified TableColumnModelEvent to all registered listeners, to indicate that a column has been added to the model. The event's toIndex attribute should contain the index of the added column.

Parameters:

e - the event.

See Also:

addColumn(TableColumn)

protected void fireColumnMarginChanged()

Sends a ChangeEvent to the model's registered listeners to indicate that the column margin was changed.

See Also:

setColumnMargin(int)

protected void fireColumnMoved(TableColumnModelEvent e)

Sends the specified TableColumnModelEvent to all registered listeners, to indicate that a column in the model has been moved. The event's fromIndex attribute should contain the old column index, and the toIndex attribute should contain the new column index.

Parameters:

e - the event.

See Also:

moveColumn(int,int)

protected void fireColumnRemoved(TableColumnModelEvent e)

Sends the specified TableColumnModelEvent to all registered listeners, to indicate that a column has been removed from the model. The event's fromIndex attribute should contain the index of the removed column.

Parameters:

e - the event.

See Also:

removeColumn(TableColumn)

protected void fireColumnSelectionChanged(ListSelectionEvent e)

Sends the specified ListSelectionEvent to all registered listeners, to indicate that the column selections have changed.

Parameters:

e - the event.

See Also:

valueChanged(ListSelectionEvent)

public TableColumn getColumn(int columnIndex)

Returns the column at the specified index.

Specified by:

getColumn in interface TableColumnModel

Parameters:

columnIndex - the column index (in the range from 0 to N-1, where N is the number of columns in the model).

Returns:

The column at the specified index.

Throws:

ArrayIndexOutOfBoundsException - if i is not within the specified range.

public int getColumnCount()

Returns the number of columns in the model.

Specified by:

getColumnCount in interface TableColumnModel

Returns:

The column count.

public int getColumnIndex(Object identifier)

Returns the index of the TableColumn with the given identifier.

Specified by:

getColumnIndex in interface TableColumnModel

Parameters:

identifier - the identifier (null not permitted).

Returns:

The index of the TableColumn with the given identifier.

Throws:

IllegalArgumentException - if identifier is null or there is no column with that identifier.

public int getColumnIndexAtX(int x)

Returns the index of the column that contains the specified x-coordinate. This method assumes that:

• column zero begins at position zero;
• all columns appear in order;
• individual column widths are taken into account, but the column margin is ignored.

If no column contains the specified position, this method returns -1.

Specified by:

getColumnIndexAtX in interface TableColumnModel

Parameters:

x - the x-position.

Returns:

The column index, or -1.

public int getColumnMargin()

Returns the column margin.

Specified by:

getColumnMargin in interface TableColumnModel

Returns:

The column margin.

See Also:

setColumnMargin(int)

public TableColumnModelListener[] getColumnModelListeners()

Returns an array containing the listeners that are registered with the model. If there are no listeners, an empty array is returned.

Returns:

An array containing the listeners that are registered with the model.

Since:

1.4

See Also:

addColumnModelListener(TableColumnModelListener)

public boolean getColumnSelectionAllowed()

Returns true if column selection is allowed, and false if column selection is not allowed.

Specified by:

getColumnSelectionAllowed in interface TableColumnModel

Returns:

A boolean.

See Also:

setColumnSelectionAllowed(boolean)

public Enumeration getColumns()

Returns an enumeration of the columns in the model.

Specified by:

getColumns in interface TableColumnModel

Returns:

An enumeration of the columns in the model.

public int getSelectedColumnCount()

Returns the number of selected columns in the model.

Specified by:

getSelectedColumnCount in interface TableColumnModel

Returns:

The selected column count.

See Also:

getSelectionModel()

public int[] getSelectedColumns()

Returns an array containing the indices of the selected columns.

Specified by:

getSelectedColumns in interface TableColumnModel

Returns:

An array containing the indices of the selected columns.

public ListSelectionModel getSelectionModel()

Returns the selection model used to track table column selections.

Specified by:

getSelectionModel in interface TableColumnModel

Returns:

The selection model.

See Also:

setSelectionModel(ListSelectionModel)

public int getTotalColumnWidth()

Returns total width of all the columns in the model, ignoring the columnMargin.

Specified by:

getTotalColumnWidth in interface TableColumnModel

Returns:

The total width of all the columns.

public void moveColumn(int i,
                       int j)

Moves the column at index i to the position specified by index j, then calls fireColumnMoved(TableColumnModelEvent) to notify registered listeners.

Specified by:

moveColumn in interface TableColumnModel

Parameters:

i - index of the column that will be moved.

j - index of the column's new location.

Throws:

IllegalArgumentException - if i or j are outside the range 0 to N-1, where N is the column count.

public void propertyChange(PropertyChangeEvent event)

Receives notification of property changes for the columns in the model. If the width property for any column changes, we invalidate the totalColumnWidth value here.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

event - the event.

protected void recalcWidthCache()

Recalculates the total width of the columns, if the cached value is -1. Otherwise this method does nothing.

See Also:

getTotalColumnWidth()

public void removeColumn(TableColumn column)

Removes a column from the model then calls fireColumnRemoved(TableColumnModelEvent) to notify the registered listeners. If the specified column does not belong to the model, or is null, this method does nothing.

Specified by:

removeColumn in interface TableColumnModel

Parameters:

column - the column to be removed (null permitted).

See Also:

addColumn(TableColumn)

public void removeColumnModelListener(TableColumnModelListener listener)

Deregisters a listener so that it no longer receives notification of changes to this model.

Specified by:

removeColumnModelListener in interface TableColumnModel

Parameters:

listener - the listener to remove

public void setColumnMargin(int margin)

Sets the column margin then calls fireColumnMarginChanged() to notify the registered listeners.

Specified by:

setColumnMargin in interface TableColumnModel

Parameters:

margin - the column margin.

See Also:

getColumnMargin()

public void setColumnSelectionAllowed(boolean flag)

Sets the flag that indicates whether or not column selection is allowed.

Specified by:

setColumnSelectionAllowed in interface TableColumnModel

Parameters:

flag - the new flag value.

See Also:

getColumnSelectionAllowed()

public void setSelectionModel(ListSelectionModel model)

Sets the selection model that will be used to keep track of the selected columns.

Specified by:

setSelectionModel in interface TableColumnModel

Parameters:

model - the selection model (null not permitted).

Throws:

IllegalArgumentException - if model is null.

See Also:

getSelectionModel()

public void valueChanged(ListSelectionEvent e)

Receives notification of the change to the list selection model, and responds by calling fireColumnSelectionChanged(ListSelectionEvent).

Specified by:

valueChanged in interface ListSelectionListener

Parameters:

e - the list selection event.

See Also:

getSelectionModel()