FileDocCategorySizeDatePackage
TableColumnModel.javaAPI DocJava SE 5 API7673Fri Aug 26 14:58:14 BST 2005javax.swing.table

TableColumnModel

public interface TableColumnModel
Defines the requirements for a table column model object suitable for use with JTable.
version
1.25 05/05/04
author
Alan Chung
author
Philip Milne
see
DefaultTableColumnModel

Fields Summary
Constructors Summary
Methods Summary
public voidaddColumn(javax.swing.table.TableColumn aColumn)
Appends aColumn to the end of the tableColumns array. This method posts a columnAdded event to its listeners.

param
aColumn the TableColumn to be added
see
#removeColumn

public voidaddColumnModelListener(javax.swing.event.TableColumnModelListener x)
Adds a listener for table column model events.

param
x a TableColumnModelListener object

public javax.swing.table.TableColumngetColumn(int columnIndex)
Returns the TableColumn object for the column at columnIndex.

param
columnIndex the index of the desired column
return
the TableColumn object for the column at columnIndex

public intgetColumnCount()
Returns the number of columns in the model.

return
the number of columns in the model

public intgetColumnIndex(java.lang.Object columnIdentifier)
Returns the index of the first column in the table whose identifier is equal to identifier, when compared using equals.

param
columnIdentifier the identifier object
return
the index of the first table column whose identifier is equal to identifier
exception
IllegalArgumentException if identifier is null, or no TableColumn has this identifier
see
#getColumn

public intgetColumnIndexAtX(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.

return
the index of the column; or -1 if no column is found
see
javax.swing.JTable#columnAtPoint

public intgetColumnMargin()
Returns the width between the cells in each column.

return
the margin, in pixels, between the cells

public booleangetColumnSelectionAllowed()
Returns true if columns may be selected.

return
true if columns may be selected
see
#setColumnSelectionAllowed

public java.util.EnumerationgetColumns()
Returns an Enumeration of all the columns in the model.

return
an Enumeration of all the columns in the model

public intgetSelectedColumnCount()
Returns the number of selected columns.

return
the number of selected columns; or 0 if no columns are selected

public int[]getSelectedColumns()
Returns an array of indicies of all selected columns.

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

public javax.swing.ListSelectionModelgetSelectionModel()
Returns the current selection model.

return
a ListSelectionModel object
see
#setSelectionModel

public intgetTotalColumnWidth()
Returns the total width of all the columns.

return
the total computed width of all columns

public voidmoveColumn(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.

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

public voidremoveColumn(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.

param
column the TableColumn to be removed
see
#addColumn

public voidremoveColumnModelListener(javax.swing.event.TableColumnModelListener x)
Removes a listener for table column model events.

param
x a TableColumnModelListener object

public voidsetColumnMargin(int newMargin)
Sets the TableColumn's column margin to newMargin. This method posts a columnMarginChanged event to its listeners.

param
newMargin the width, in pixels, of the new column margins
see
#getColumnMargin

public voidsetColumnSelectionAllowed(boolean flag)
Sets whether the columns in this model may be selected.

param
flag true if columns may be selected; otherwise false
see
#getColumnSelectionAllowed

public voidsetSelectionModel(javax.swing.ListSelectionModel newModel)
Sets the selection model.

param
newModel a ListSelectionModel object
see
#getSelectionModel