javax.swing.table
Interface TableColumnModel

All Known Implementing Classes:
DefaultTableColumnModel sample code for javax.swing.table.DefaultTableColumnModel definition code for javax.swing.table.DefaultTableColumnModel

public interface TableColumnModel

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

See Also:
DefaultTableColumnModel sample code for javax.swing.table.DefaultTableColumnModel definition code for javax.swing.table.DefaultTableColumnModel

Method Summary
 void addColumn sample code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn) (TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.TableColumn  aColumn)
          Appends aColumn to the end of the tableColumns array.
 void addColumnModelListener sample code for javax.swing.table.TableColumnModel.addColumnModelListener(javax.swing.event.TableColumnModelListener) definition code for javax.swing.table.TableColumnModel.addColumnModelListener(javax.swing.event.TableColumnModelListener) (TableColumnModelListener sample code for javax.swing.event.TableColumnModelListener definition code for javax.swing.event.TableColumnModelListener  x)
          Adds a listener for table column model events.
 TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.TableColumn getColumn sample code for javax.swing.table.TableColumnModel.getColumn(int) definition code for javax.swing.table.TableColumnModel.getColumn(int) (int columnIndex)
          Returns the TableColumn object for the column at columnIndex.
 int getColumnCount sample code for javax.swing.table.TableColumnModel.getColumnCount() definition code for javax.swing.table.TableColumnModel.getColumnCount() ()
          Returns the number of columns in the model.
 int getColumnIndex sample code for javax.swing.table.TableColumnModel.getColumnIndex(java.lang.Object) definition code for javax.swing.table.TableColumnModel.getColumnIndex(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  columnIdentifier)
          Returns the index of the first column in the table whose identifier is equal to identifier, when compared using equals.
 int getColumnIndexAtX sample code for javax.swing.table.TableColumnModel.getColumnIndexAtX(int) definition code for javax.swing.table.TableColumnModel.getColumnIndexAtX(int) (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.
 int getColumnMargin sample code for javax.swing.table.TableColumnModel.getColumnMargin() definition code for javax.swing.table.TableColumnModel.getColumnMargin() ()
          Returns the width between the cells in each column.
 Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.TableColumn > getColumns sample code for javax.swing.table.TableColumnModel.getColumns() definition code for javax.swing.table.TableColumnModel.getColumns() ()
          Returns an Enumeration of all the columns in the model.
 boolean getColumnSelectionAllowed sample code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed() definition code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed() ()
          Returns true if columns may be selected.
 int getSelectedColumnCount sample code for javax.swing.table.TableColumnModel.getSelectedColumnCount() definition code for javax.swing.table.TableColumnModel.getSelectedColumnCount() ()
          Returns the number of selected columns.
 int[] getSelectedColumns sample code for javax.swing.table.TableColumnModel.getSelectedColumns() definition code for javax.swing.table.TableColumnModel.getSelectedColumns() ()
          Returns an array of indicies of all selected columns.
 ListSelectionModel sample code for javax.swing.ListSelectionModel definition code for javax.swing.ListSelectionModel getSelectionModel sample code for javax.swing.table.TableColumnModel.getSelectionModel() definition code for javax.swing.table.TableColumnModel.getSelectionModel() ()
          Returns the current selection model.
 int getTotalColumnWidth sample code for javax.swing.table.TableColumnModel.getTotalColumnWidth() definition code for javax.swing.table.TableColumnModel.getTotalColumnWidth() ()
          Returns the total width of all the columns.
 void moveColumn sample code for javax.swing.table.TableColumnModel.moveColumn(int, int) definition code for javax.swing.table.TableColumnModel.moveColumn(int, int) (int columnIndex, int newIndex)
          Moves the column and its header at columnIndex to newIndex.
 void removeColumn sample code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn) (TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.TableColumn  column)
          Deletes the TableColumn column from the tableColumns array.
 void removeColumnModelListener sample code for javax.swing.table.TableColumnModel.removeColumnModelListener(javax.swing.event.TableColumnModelListener) definition code for javax.swing.table.TableColumnModel.removeColumnModelListener(javax.swing.event.TableColumnModelListener) (TableColumnModelListener sample code for javax.swing.event.TableColumnModelListener definition code for javax.swing.event.TableColumnModelListener  x)
          Removes a listener for table column model events.
 void setColumnMargin sample code for javax.swing.table.TableColumnModel.setColumnMargin(int) definition code for javax.swing.table.TableColumnModel.setColumnMargin(int) (int newMargin)
          Sets the TableColumn's column margin to newMargin.
 void setColumnSelectionAllowed sample code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean) definition code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean) (boolean flag)
          Sets whether the columns in this model may be selected.
 void setSelectionModel sample code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel) definition code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel) (ListSelectionModel sample code for javax.swing.ListSelectionModel definition code for javax.swing.ListSelectionModel  newModel)
          Sets the selection model.
 

Method Detail

addColumn sample code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn)

void addColumn(TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.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
See Also:
removeColumn(javax.swing.table.TableColumn) sample code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn)

removeColumn sample code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.removeColumn(javax.swing.table.TableColumn)

void removeColumn(TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.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
See Also:
addColumn(javax.swing.table.TableColumn) sample code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn) definition code for javax.swing.table.TableColumnModel.addColumn(javax.swing.table.TableColumn)

moveColumn sample code for javax.swing.table.TableColumnModel.moveColumn(int, int) definition code for javax.swing.table.TableColumnModel.moveColumn(int, int)

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if columnIndex or newIndex are not in the valid range

setColumnMargin sample code for javax.swing.table.TableColumnModel.setColumnMargin(int) definition code for javax.swing.table.TableColumnModel.setColumnMargin(int)

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
See Also:
getColumnMargin() sample code for javax.swing.table.TableColumnModel.getColumnMargin() definition code for javax.swing.table.TableColumnModel.getColumnMargin()

getColumnCount sample code for javax.swing.table.TableColumnModel.getColumnCount() definition code for javax.swing.table.TableColumnModel.getColumnCount()

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

Returns:
the number of columns in the model

getColumns sample code for javax.swing.table.TableColumnModel.getColumns() definition code for javax.swing.table.TableColumnModel.getColumns()

Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.TableColumn > getColumns()
Returns an Enumeration of all the columns in the model.

Returns:
an Enumeration of all the columns in the model

getColumnIndex sample code for javax.swing.table.TableColumnModel.getColumnIndex(java.lang.Object) definition code for javax.swing.table.TableColumnModel.getColumnIndex(java.lang.Object)

int getColumnIndex(Object sample code for java.lang.Object definition code for java.lang.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if identifier is null, or no TableColumn has this identifier
See Also:
getColumn(int) sample code for javax.swing.table.TableColumnModel.getColumn(int) definition code for javax.swing.table.TableColumnModel.getColumn(int)

getColumn sample code for javax.swing.table.TableColumnModel.getColumn(int) definition code for javax.swing.table.TableColumnModel.getColumn(int)

TableColumn sample code for javax.swing.table.TableColumn definition code for javax.swing.table.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

getColumnMargin sample code for javax.swing.table.TableColumnModel.getColumnMargin() definition code for javax.swing.table.TableColumnModel.getColumnMargin()

int getColumnMargin()
Returns the width between the cells in each column.

Returns:
the margin, in pixels, between the cells

getColumnIndexAtX sample code for javax.swing.table.TableColumnModel.getColumnIndexAtX(int) definition code for javax.swing.table.TableColumnModel.getColumnIndexAtX(int)

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
See Also:
JTable.columnAtPoint(java.awt.Point) sample code for javax.swing.JTable.columnAtPoint(java.awt.Point) definition code for javax.swing.JTable.columnAtPoint(java.awt.Point)

getTotalColumnWidth sample code for javax.swing.table.TableColumnModel.getTotalColumnWidth() definition code for javax.swing.table.TableColumnModel.getTotalColumnWidth()

int getTotalColumnWidth()
Returns the total width of all the columns.

Returns:
the total computed width of all columns

setColumnSelectionAllowed sample code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean) definition code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean)

void setColumnSelectionAllowed(boolean flag)
Sets whether the columns in this model may be selected.

Parameters:
flag - true if columns may be selected; otherwise false
See Also:
getColumnSelectionAllowed() sample code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed() definition code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed()

getColumnSelectionAllowed sample code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed() definition code for javax.swing.table.TableColumnModel.getColumnSelectionAllowed()

boolean getColumnSelectionAllowed()
Returns true if columns may be selected.

Returns:
true if columns may be selected
See Also:
setColumnSelectionAllowed(boolean) sample code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean) definition code for javax.swing.table.TableColumnModel.setColumnSelectionAllowed(boolean)

getSelectedColumns sample code for javax.swing.table.TableColumnModel.getSelectedColumns() definition code for javax.swing.table.TableColumnModel.getSelectedColumns()

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

getSelectedColumnCount sample code for javax.swing.table.TableColumnModel.getSelectedColumnCount() definition code for javax.swing.table.TableColumnModel.getSelectedColumnCount()

int getSelectedColumnCount()
Returns the number of selected columns.

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

setSelectionModel sample code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel) definition code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel)

void setSelectionModel(ListSelectionModel sample code for javax.swing.ListSelectionModel definition code for javax.swing.ListSelectionModel  newModel)
Sets the selection model.

Parameters:
newModel - a ListSelectionModel object
See Also:
getSelectionModel() sample code for javax.swing.table.TableColumnModel.getSelectionModel() definition code for javax.swing.table.TableColumnModel.getSelectionModel()

getSelectionModel sample code for javax.swing.table.TableColumnModel.getSelectionModel() definition code for javax.swing.table.TableColumnModel.getSelectionModel()

ListSelectionModel sample code for javax.swing.ListSelectionModel definition code for javax.swing.ListSelectionModel  getSelectionModel()
Returns the current selection model.

Returns:
a ListSelectionModel object
See Also:
setSelectionModel(javax.swing.ListSelectionModel) sample code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel) definition code for javax.swing.table.TableColumnModel.setSelectionModel(javax.swing.ListSelectionModel)

addColumnModelListener sample code for javax.swing.table.TableColumnModel.addColumnModelListener(javax.swing.event.TableColumnModelListener) definition code for javax.swing.table.TableColumnModel.addColumnModelListener(javax.swing.event.TableColumnModelListener)

void addColumnModelListener(TableColumnModelListener sample code for javax.swing.event.TableColumnModelListener definition code for javax.swing.event.TableColumnModelListener  x)
Adds a listener for table column model events.

Parameters:
x - a TableColumnModelListener object

removeColumnModelListener sample code for javax.swing.table.TableColumnModel.removeColumnModelListener(javax.swing.event.TableColumnModelListener) definition code for javax.swing.table.TableColumnModel.removeColumnModelListener(javax.swing.event.TableColumnModelListener)

void removeColumnModelListener(TableColumnModelListener sample code for javax.swing.event.TableColumnModelListener definition code for javax.swing.event.TableColumnModelListener  x)
Removes a listener for table column model events.

Parameters:
x - a TableColumnModelListener object