public interface

TableColumnModel

javax.swing.table.TableColumnModel
Known Indirect Subclasses

Class Overview

Defines the requirements for a table column model object suitable for use with JTable.

Summary

Public Methods
abstract void addColumn(TableColumn aColumn)
Appends aColumn to the end of the tableColumns array.
abstract void addColumnModelListener(TableColumnModelListener x)
Adds a listener for table column model events.
abstract TableColumn getColumn(int columnIndex)
Returns the TableColumn object for the column at columnIndex.
abstract int getColumnCount()
Returns the number of columns in the model.
abstract int getColumnIndex(Object columnIdentifier)
Returns the index of the first column in the table whose identifier is equal to identifier, when compared using equals.
abstract int getColumnIndexAtX(int xPosition)
Returns the index of the column that lies on the horizontal point, xPosition; or -1 if it lies outside the any of the column's bounds.
abstract int getColumnMargin()
Returns the width between the cells in each column.
abstract boolean getColumnSelectionAllowed()
Returns true if columns may be selected.
abstract Enumeration<TableColumn> getColumns()
Returns an Enumeration of all the columns in the model.
abstract int getSelectedColumnCount()
Returns the number of selected columns.
abstract int[] getSelectedColumns()
Returns an array of indicies of all selected columns.
abstract ListSelectionModel getSelectionModel()
Returns the current selection model.
abstract int getTotalColumnWidth()
Returns the total width of all the columns.
abstract void moveColumn(int columnIndex, int newIndex)
Moves the column and its header at columnIndex to newIndex.
abstract void removeColumn(TableColumn column)
Deletes the TableColumn column from the tableColumns array.
abstract void removeColumnModelListener(TableColumnModelListener x)
Removes a listener for table column model events.
abstract void setColumnMargin(int newMargin)
Sets the TableColumn's column margin to newMargin.
abstract void setColumnSelectionAllowed(boolean flag)
Sets whether the columns in this model may be selected.
abstract void setSelectionModel(ListSelectionModel newModel)
Sets the selection model.

Public Methods

public abstract void addColumn (TableColumn aColumn)

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

Parameters
aColumn the TableColumn to be added

public abstract void addColumnModelListener (TableColumnModelListener x)

Adds a listener for table column model events.

Parameters
x a TableColumnModelListener object

public abstract TableColumn getColumn (int columnIndex)

Returns the TableColumn object for the column at columnIndex.

Parameters
columnIndex the index of the desired column
Returns
  • the TableColumn object for the column at columnIndex

public abstract int getColumnCount ()

Returns the number of columns in the model.

Returns
  • the number of columns in the model

public abstract int getColumnIndex (Object columnIdentifier)

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

Parameters
columnIdentifier the identifier object
Returns
  • the index of the first table column whose identifier is equal to identifier
Throws
IllegalArgumentException if identifier is null, or no TableColumn has this identifier
See Also

public abstract int getColumnIndexAtX (int xPosition)

Returns the index of the column that lies on the horizontal point, xPosition; or -1 if it lies outside the any of the column's bounds. 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.

Returns
  • the index of the column; or -1 if no column is found

public abstract int getColumnMargin ()

Returns the width between the cells in each column.

Returns
  • the margin, in pixels, between the cells

public abstract boolean getColumnSelectionAllowed ()

Returns true if columns may be selected.

Returns
  • true if columns may be selected

public abstract Enumeration<TableColumn> getColumns ()

Returns an Enumeration of all the columns in the model.

Returns
  • an Enumeration of all the columns in the model

public abstract int getSelectedColumnCount ()

Returns the number of selected columns.

Returns
  • the number of selected columns; or 0 if no columns are selected

public abstract int[] getSelectedColumns ()

Returns an array of indicies of all selected columns.

Returns
  • an array of integers containing the indicies of all selected columns; or an empty array if nothing is selected

public abstract ListSelectionModel getSelectionModel ()

Returns the current selection model.

Returns
  • a ListSelectionModel object

public abstract int getTotalColumnWidth ()

Returns the total width of all the columns.

Returns
  • the total computed width of all columns

public abstract void moveColumn (int columnIndex, int newIndex)

Moves the column and its header 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 posts a columnMoved event to its listeners.

Parameters
columnIndex the index of column to be moved
newIndex index of the column's new location
Throws
IllegalArgumentException if columnIndex or newIndex are not in the valid range

public abstract void removeColumn (TableColumn column)

Deletes the TableColumn column from the tableColumns array. This method will do nothing if column is not in the table's column list. This method posts a columnRemoved event to its listeners.

Parameters
column the TableColumn to be removed

public abstract void removeColumnModelListener (TableColumnModelListener x)

Removes a listener for table column model events.

Parameters
x a TableColumnModelListener object

public abstract void setColumnMargin (int newMargin)

Sets the TableColumn's column margin to newMargin. This method posts a columnMarginChanged event to its listeners.

Parameters
newMargin the width, in pixels, of the new column margins

public abstract void setColumnSelectionAllowed (boolean flag)

Sets whether the columns in this model may be selected.

Parameters
flag true if columns may be selected; otherwise false

public abstract void setSelectionModel (ListSelectionModel newModel)

Sets the selection model.

Parameters
newModel a ListSelectionModel object