javax.swing.table

Interface TableColumnModel

public interface TableColumnModel

The interface used by {@link JTable} to access the columns in the table view.

Method Summary
void	addColumn(TableColumn column) Adds a column to the model.
void	addColumnModelListener(TableColumnModelListener listener) Registers a listener with the model, so that it will receive {@link TableColumnModelEvent} notifications.
TableColumn	getColumn(int columnIndex) Returns the `TableColumn` at the specified index.
int	getColumnCount() Returns the number of columns in the model.
int	getColumnIndex(Object identifier) Returns the index of the {@link TableColumn} with the given identifier.
int	getColumnIndexAtX(int xPosition) Returns the index of the column that contains the specified x-coordinate, assuming 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`.
int	getColumnMargin() Returns the column margin.
Enumeration<TableColumn>	getColumns() Returns an enumeration of the columns in the model.
boolean	getColumnSelectionAllowed() Returns `true` if column selection is allowed, and `false` if column selection is not allowed.
int	getSelectedColumnCount() Returns the number of selected columns in the model.
int[]	getSelectedColumns() getSelectedColumns
ListSelectionModel	getSelectionModel() Returns the selection model used to track table column selections.
int	getTotalColumnWidth() Returns total width of all the columns in the model, ignoring the column margin (see {@link #getColumnMargin()}).
void	moveColumn(int columnIndex, int newIndex) Moves a column.
void	removeColumn(TableColumn column) Removes a column from the model.
void	removeColumnModelListener(TableColumnModelListener listener) Deregisters a listener, so that it will no longer receive {@link TableColumnModelEvent} notifications.
void	setColumnMargin(int margin) Sets the column margin and sends a {@link ChangeEvent} to all registered {@link TableColumnModelListener}s registered with the model.
void	setColumnSelectionAllowed(boolean allowed) Sets the flag that indicates whether or not column selection is allowed.
void	setSelectionModel(ListSelectionModel model) Sets the selection model that will be used to keep track of the selected columns.

Method Detail

addColumn

public void addColumn(TableColumn column)

Adds a column to the model.

Parameters: column the new column (null not permitted).

Throws: IllegalArgumentException if column is null.

addColumnModelListener

public void addColumnModelListener(TableColumnModelListener listener)

Registers a listener with the model, so that it will receive {@link TableColumnModelEvent} notifications.

Parameters: listener the listener (null ignored).

getColumn

public TableColumn getColumn(int columnIndex)

Returns the TableColumn at the specified index.

Parameters: columnIndex the column index.

Returns: The table column.

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.

Returns: The column count.

getColumnIndex

public int getColumnIndex(Object identifier)

Returns the index of the {@link TableColumn} with the given identifier.

Parameters: identifier the identifier (null not permitted).

Returns: The index of the {@link TableColumn} with the given identifier.

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

getColumnIndexAtX

public int getColumnIndexAtX(int xPosition)

Returns the index of the column that contains the specified x-coordinate, assuming 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.

Parameters: xPosition the x-position.

Returns: The column index, or -1.

getColumnMargin

public int getColumnMargin()

Returns the column margin.

Returns: The column margin.

getColumns

public Enumeration<TableColumn> getColumns()

Returns an enumeration of 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, and false if column selection is not allowed.

Returns: A boolean.

getSelectedColumnCount

public int getSelectedColumnCount()

Returns the number of selected columns in the model.

Returns: The selected column count.

getSelectedColumns

public int[] getSelectedColumns()

getSelectedColumns

Returns: Selected columns

getSelectionModel

public ListSelectionModel getSelectionModel()

Returns the selection model used to track table column selections.

Returns: The selection model.

getTotalColumnWidth

public int getTotalColumnWidth()

Returns total width of all the columns in the model, ignoring the column margin (see {@link #getColumnMargin()}).

Returns: The total width of all the columns.

moveColumn

public void moveColumn(int columnIndex, int newIndex)

Moves a column.

Parameters: columnIndex Index of column to move newIndex New index of column

removeColumn

public void removeColumn(TableColumn column)

Removes a column from the model. If column is not defined in the model, this method does nothing.

Parameters: column TableColumn

removeColumnModelListener

public void removeColumnModelListener(TableColumnModelListener listener)

Deregisters a listener, so that it will no longer receive {@link TableColumnModelEvent} notifications.

Parameters: listener the listener.

setColumnMargin

public void setColumnMargin(int margin)

Sets the column margin and sends a {@link ChangeEvent} to all registered {@link TableColumnModelListener}s registered with the model.

Parameters: margin the column margin.

setColumnSelectionAllowed

public void setColumnSelectionAllowed(boolean allowed)

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

Parameters: allowed the new flag value.

setSelectionModel

public void setSelectionModel(ListSelectionModel model)

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

Parameters: model the selection model (null not permitted).

Throws: IllegalArgumentException if model is null.