javax.swing.table
class DefaultTableColumnModel

java.lang.Object javax.swing.table.DefaultTableColumnModel

All Implemented Interfaces:

PropertyChangeListener, Serializable, ListSelectionListener, TableColumnModel

Most common way to construct:

JTable table = …;

DefaultTableColumnModel colModel = (DefaultTableColumnModel)table.getColumnModel();

Based on 14 examples

public class DefaultTableColumnModel
extends Object
implements TableColumnModel, PropertyChangeListener, ListSelectionListener, Serializable

The standard column-handler for a JTable.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

changeEvent

protected transient ChangeEvent changeEvent

Change event (only one needed)

columnMargin

protected int columnMargin

Width margin between each column

columnSelectionAllowed

protected boolean columnSelectionAllowed

Column selection allowed in this column model

listenerList

protected EventListenerList listenerList

List of TableColumnModelListener

selectionModel

protected ListSelectionModel selectionModel

Model for keeping track of column selections

tableColumns

protected Vector tableColumns

Array of TableColumn objects in this model

totalColumnWidth

protected int totalColumnWidth

A local cache of the combined width of all columns

DefaultTableColumnModel

public DefaultTableColumnModel()

Creates a default table column model.

addColumn

public void addColumn(TableColumn aColumn)

Appends aColumn to the end of the tableColumns array. This method also posts the columnAdded event to its listeners.

Parameters:

aColumn - the TableColumn to be added

addColumnModelListener

public void addColumnModelListener(TableColumnModelListener x)

Adds a listener for table column model events.

Parameters:

x - a TableColumnModelListener object

createSelectionModel

protected ListSelectionModel createSelectionModel()

Creates a new default list selection model.

fireColumnAdded

protected void fireColumnAdded(TableColumnModelEvent e)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

Parameters:

e - the event received

fireColumnMarginChanged

protected void fireColumnMarginChanged()

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

fireColumnMoved

protected void fireColumnMoved(TableColumnModelEvent e)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

Parameters:

e - the event received

fireColumnRemoved

protected void fireColumnRemoved(TableColumnModelEvent e)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

Parameters:

e - the event received

fireColumnSelectionChanged

protected void fireColumnSelectionChanged(ListSelectionEvent e)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

Parameters:

e - the event received

getColumn

public TableColumn getColumn(int columnIndex)

Returns the TableColumn object for the column at columnIndex.

Parameters:

columnIndex - the index of the column desired

Returns:

the TableColumn object for the column at columnIndex

getColumnCount

public int getColumnCount()

Returns the number of columns in the tableColumns array.

Returns:

the number of columns in the tableColumns array

getColumnIndex

public int getColumnIndex(Object identifier)

Returns the index of the first column in the tableColumns array whose identifier is equal to identifier, when compared using equals.

Parameters:

identifier - the identifier object

Returns:

the index of the first column in the tableColumns array whose identifier is equal to identifier

getColumnIndexAtX

public int getColumnIndexAtX(int x)

Returns the index of the column that lies at position x, or -1 if no column covers this point. In keeping with Swing's separable model architecture, a TableColumnModel does not know how the table columns actually appear on screen. The visual presentation of the columns is the responsibility of the view/controller object using this model (typically JTable). The view/controller need not display the columns sequentially from left to right. For example, columns could be displayed from right to left to accomodate a locale preference or some columns might be hidden at the request of the user. Because the model does not know how the columns are laid out on screen, the given xPosition should not be considered to be a coordinate in 2D graphics space. Instead, it should be considered to be a width from the start of the first column in the model. If the column index for a given X coordinate in 2D space is required, JTable.columnAtPoint can be used instead.

Parameters:

x - the horizontal location of interest

Returns:

the index of the column or -1 if no column is found

getColumnMargin

public int getColumnMargin()

Returns the width margin for TableColumn. The default columnMargin is 1.

Returns:

the maximum width for the TableColumn

getColumnModelListeners

public TableColumnModelListener[] getColumnModelListeners()

Returns an array of all the column model listeners registered on this model.

Returns:

all of this default table column model's ColumnModelListeners or an empty array if no column model listeners are currently registered

getColumns

public Enumeration getColumns()

Returns an Enumeration of all the columns in the model.

Returns:

an Enumeration of the columns in the model

getColumnSelectionAllowed

public boolean getColumnSelectionAllowed()

Returns true if column selection is allowed, otherwise false. The default is false.

Returns:

the columnSelectionAllowed property

getListeners

public EventListener[] getListeners(Class listenerType)

Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a DefaultTableColumnModel m for its column model listeners with the following code:

ColumnModelListener[] cmls = (ColumnModelListener[])(m.getListeners(ColumnModelListener.class));

If no such listeners exist, this method returns an empty array.

Parameters:

listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:

an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added

getSelectedColumnCount

public int getSelectedColumnCount()

Returns the number of columns selected.

Returns:

the number of columns selected

getSelectedColumns

public int[] getSelectedColumns()

Returns an array of selected columns. If selectionModel is null, returns an empty array.

Returns:

an array of selected columns or an empty array if nothing is selected or the selectionModel is null

getSelectionModel

public ListSelectionModel getSelectionModel()

Returns the ListSelectionModel that is used to maintain column selection state.

Returns:

the object that provides column selection state. Or null if row selection is not allowed.

getTotalColumnWidth

public int getTotalColumnWidth()

Returns the total combined width of all columns.

Returns:

the totalColumnWidth property

moveColumn

public void moveColumn(int columnIndex,
                       int newIndex)

Moves the column and heading at columnIndex to newIndex. The old column at columnIndex will now be found at newIndex. The column that used to be at newIndex is shifted left or right to make room. This will not move any columns if columnIndex equals newIndex. This method also posts a columnMoved event to its listeners.

Parameters:

columnIndex - the index of column to be moved

newIndex - new index to move the column

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Property Change Listener change method. Used to track changes to the column width or preferred column width.

Parameters:

evt - PropertyChangeEvent

recalcWidthCache

protected void recalcWidthCache()

Recalculates the total combined width of all columns. Updates the totalColumnWidth property.

removeColumn

public void removeColumn(TableColumn column)

Deletes the column from the tableColumns array. This method will do nothing if column is not in the table's columns list. tile is called to resize both the header and table views. This method also posts a columnRemoved event to its listeners.

Parameters:

column - the TableColumn to be removed

removeColumnModelListener

public void removeColumnModelListener(TableColumnModelListener x)

Removes a listener for table column model events.

Parameters:

x - a TableColumnModelListener object

setColumnMargin

public void setColumnMargin(int newMargin)

Sets the column margin to newMargin. This method also posts a columnMarginChanged event to its listeners.

Parameters:

newMargin - the new margin width, in pixels

setColumnSelectionAllowed

public void setColumnSelectionAllowed(boolean flag)

Sets whether column selection is allowed. The default is false.

Parameters:

flag - true if column selection will be allowed, false otherwise

setSelectionModel

public void setSelectionModel(ListSelectionModel newModel)

Sets the selection model for this TableColumnModel to newModel and registers for listener notifications from the new selection model. If newModel is null, an exception is thrown.

Parameters:

newModel - the new selection model

valueChanged

public void valueChanged(ListSelectionEvent e)

A ListSelectionListener that forwards ListSelectionEvents when there is a column selection change.

Parameters:

e - the change event