javax.swing.table
Interface TableColumnModel

All Known Implementing Classes:
DefaultTableColumnModel

public interface TableColumnModel

The interface used by 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 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 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.
 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 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 TableColumnModelEvent notifications.
 void setColumnMargin(int margin)
          Sets the column margin and sends a ChangeEvent to all registered TableColumnModelListeners 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

void addColumn(TableColumn column)
Adds a column to the model.

Parameters:
column - the new column (null not permitted).
Throws:
IllegalArgumentException - if column is null.

removeColumn

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

moveColumn

void moveColumn(int columnIndex,
                int newIndex)
Moves a column.

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

setColumnMargin

void setColumnMargin(int margin)
Sets the column margin and sends a ChangeEvent to all registered TableColumnModelListeners registered with the model.

Parameters:
margin - the column margin.
See Also:
getColumnMargin()

getColumnCount

int getColumnCount()
Returns the number of columns in the model.

Returns:
The column count.

getColumns

Enumeration<TableColumn> getColumns()
Returns an enumeration of the columns in the model.

Returns:
An enumeration of the columns in the model.

getColumnIndex

int getColumnIndex(Object identifier)
Returns the index of the TableColumn with the given identifier.

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.

getColumn

TableColumn getColumn(int columnIndex)
Returns the TableColumn at the specified index.

Parameters:
columnIndex - the column index.
Returns:
The table column.

getColumnMargin

int getColumnMargin()
Returns the column margin.

Returns:
The column margin.
See Also:
setColumnMargin(int)

getColumnIndexAtX

int getColumnIndexAtX(int xPosition)
Returns the index of the column that contains the specified x-coordinate, assuming that: If no column contains the specified position, this method returns -1.

Parameters:
xPosition - the x-position.
Returns:
The column index, or -1.

getTotalColumnWidth

int getTotalColumnWidth()
Returns total width of all the columns in the model, ignoring the column margin (see getColumnMargin()).

Returns:
The total width of all the columns.

setColumnSelectionAllowed

void setColumnSelectionAllowed(boolean allowed)
Sets the flag that indicates whether or not column selection is allowed.

Parameters:
allowed - the new flag value.
See Also:
getColumnSelectionAllowed()

getColumnSelectionAllowed

boolean getColumnSelectionAllowed()
Returns true if column selection is allowed, and false if column selection is not allowed.

Returns:
A boolean.
See Also:
setColumnSelectionAllowed(boolean)

getSelectedColumns

int[] getSelectedColumns()
getSelectedColumns

Returns:
Selected columns

getSelectedColumnCount

int getSelectedColumnCount()
Returns the number of selected columns in the model.

Returns:
The selected column count.
See Also:
getSelectionModel()

setSelectionModel

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.

getSelectionModel

ListSelectionModel getSelectionModel()
Returns the selection model used to track table column selections.

Returns:
The selection model.
See Also:
setSelectionModel(ListSelectionModel)

addColumnModelListener

void addColumnModelListener(TableColumnModelListener listener)
Registers a listener with the model, so that it will receive TableColumnModelEvent notifications.

Parameters:
listener - the listener (null ignored).

removeColumnModelListener

void removeColumnModelListener(TableColumnModelListener listener)
Deregisters a listener, so that it will no longer receive TableColumnModelEvent notifications.

Parameters:
listener - the listener.