- All Known Implementing Classes:
DefaultTableColumnModel
public interface TableColumnModel
Defines the requirements for a table column model object suitable for
use with
JTable.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddColumn(TableColumn aColumn) AppendsaColumnto the end of thetableColumnsarray.voidAdds a listener for table column model events.getColumn(int columnIndex) Returns theTableColumnobject for the column atcolumnIndex.intReturns the number of columns in the model.intgetColumnIndex(Object columnIdentifier) Returns the index of the first column in the table whose identifier is equal toidentifier, when compared usingequals.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.intReturns the width between the cells in each column.Returns anEnumerationof all the columns in the model.booleanReturns true if columns may be selected.intReturns the number of selected columns.int[]Returns an array of indicies of all selected columns.Returns the current selection model.intReturns the total width of all the columns.voidmoveColumn(int columnIndex, int newIndex) Moves the column and its header atcolumnIndextonewIndex.voidremoveColumn(TableColumn column) Deletes theTableColumncolumnfrom thetableColumnsarray.voidRemoves a listener for table column model events.voidsetColumnMargin(int newMargin) Sets theTableColumn's column margin tonewMargin.voidsetColumnSelectionAllowed(boolean flag) Sets whether the columns in this model may be selected.voidsetSelectionModel(ListSelectionModel newModel) Sets the selection model.
-
Method Details
-
addColumn
AppendsaColumnto the end of thetableColumnsarray. This method posts acolumnAddedevent to its listeners.- Parameters:
aColumn- theTableColumnto be added- See Also:
-
removeColumn
Deletes theTableColumncolumnfrom thetableColumnsarray. This method will do nothing ifcolumnis not in the table's column list. This method posts acolumnRemovedevent to its listeners.- Parameters:
column- theTableColumnto be removed- See Also:
-
moveColumn
void moveColumn(int columnIndex, int newIndex) Moves the column and its header atcolumnIndextonewIndex. The old column atcolumnIndexwill now be found atnewIndex. The column that used to be atnewIndexis shifted left or right to make room. This will not move any columns ifcolumnIndexequalsnewIndex. This method posts acolumnMovedevent to its listeners.- Parameters:
columnIndex- the index of column to be movednewIndex- index of the column's new location- Throws:
IllegalArgumentException- ifcolumnIndexornewIndexare not in the valid range
-
setColumnMargin
void setColumnMargin(int newMargin) Sets theTableColumn's column margin tonewMargin. This method posts acolumnMarginChangedevent to its listeners.- Parameters:
newMargin- the width, in pixels, of the new column margins- See Also:
-
getColumnCount
int getColumnCount()Returns the number of columns in the model.- Returns:
- the number of columns in the model
-
getColumns
Enumeration<TableColumn> getColumns()Returns anEnumerationof all the columns in the model.- Returns:
- an
Enumerationof all the columns in the model
-
getColumnIndex
Returns the index of the first column in the table whose identifier is equal toidentifier, when compared usingequals.- Parameters:
columnIdentifier- the identifier object- Returns:
- the index of the first table column
whose identifier is equal to
identifier - Throws:
IllegalArgumentException- ifidentifierisnull, or noTableColumnhas thisidentifier- See Also:
-
getColumn
Returns theTableColumnobject for the column atcolumnIndex.- Parameters:
columnIndex- the index of the desired column- Returns:
- the
TableColumnobject for the column atcolumnIndex
-
getColumnMargin
int getColumnMargin()Returns the width between the cells in each column.- Returns:
- the margin, in pixels, between the cells
-
getColumnIndexAtX
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 accommodate 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 givenxPositionshould 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.columnAtPointcan be used instead.- Parameters:
xPosition- width from the start of the first column in the model.- Returns:
- the index of the column; or -1 if no column is found
- See Also:
-
getTotalColumnWidth
int getTotalColumnWidth()Returns the total width of all the columns.- Returns:
- the total computed width of all columns
-
setColumnSelectionAllowed
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
boolean getColumnSelectionAllowed()Returns true if columns may be selected.- Returns:
- true if columns may be selected
- See Also:
-
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
int getSelectedColumnCount()Returns the number of selected columns.- Returns:
- the number of selected columns; or 0 if no columns are selected
-
setSelectionModel
Sets the selection model.- Parameters:
newModel- aListSelectionModelobject- See Also:
-
getSelectionModel
ListSelectionModel getSelectionModel()Returns the current selection model.- Returns:
- a
ListSelectionModelobject - See Also:
-
addColumnModelListener
Adds a listener for table column model events.- Parameters:
x- aTableColumnModelListenerobject
-
removeColumnModelListener
Removes a listener for table column model events.- Parameters:
x- aTableColumnModelListenerobject
-