-
- All Known Implementing Classes:
- DefaultTableColumnModel
public interface TableColumnModel
Defines the requirements for a table column model object suitable for use withJTable
.- See Also:
DefaultTableColumnModel
-
-
Method Summary
Methods Modifier and Type Method and Description void
addColumn(TableColumn aColumn)
AppendsaColumn
to the end of thetableColumns
array.void
addColumnModelListener(TableColumnModelListener x)
Adds a listener for table column model events.TableColumn
getColumn(int columnIndex)
Returns theTableColumn
object for the column atcolumnIndex
.int
getColumnCount()
Returns the number of columns in the model.int
getColumnIndex(Object columnIdentifier)
Returns the index of the first column in the table whose identifier is equal toidentifier
, when compared usingequals
.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.int
getColumnMargin()
Returns the width between the cells in each column.Enumeration<TableColumn>
getColumns()
Returns anEnumeration
of all the columns in the model.boolean
getColumnSelectionAllowed()
Returns true if columns may be selected.int
getSelectedColumnCount()
Returns the number of selected columns.int[]
getSelectedColumns()
Returns an array of indicies of all selected columns.ListSelectionModel
getSelectionModel()
Returns the current selection model.int
getTotalColumnWidth()
Returns the total width of all the columns.void
moveColumn(int columnIndex, int newIndex)
Moves the column and its header atcolumnIndex
tonewIndex
.void
removeColumn(TableColumn column)
Deletes theTableColumn
column
from thetableColumns
array.void
removeColumnModelListener(TableColumnModelListener x)
Removes a listener for table column model events.void
setColumnMargin(int newMargin)
Sets theTableColumn
's column margin tonewMargin
.void
setColumnSelectionAllowed(boolean flag)
Sets whether the columns in this model may be selected.void
setSelectionModel(ListSelectionModel newModel)
Sets the selection model.
-
-
-
Method Detail
-
addColumn
void addColumn(TableColumn aColumn)
AppendsaColumn
to the end of thetableColumns
array. This method posts acolumnAdded
event to its listeners.- Parameters:
aColumn
- theTableColumn
to be added- See Also:
removeColumn(javax.swing.table.TableColumn)
-
removeColumn
void removeColumn(TableColumn column)
Deletes theTableColumn
column
from thetableColumns
array. This method will do nothing ifcolumn
is not in the table's column list. This method posts acolumnRemoved
event to its listeners.- Parameters:
column
- theTableColumn
to be removed- See Also:
addColumn(javax.swing.table.TableColumn)
-
moveColumn
void moveColumn(int columnIndex, int newIndex)
Moves the column and its header atcolumnIndex
tonewIndex
. The old column atcolumnIndex
will now be found atnewIndex
. The column that used to be atnewIndex
is shifted left or right to make room. This will not move any columns ifcolumnIndex
equalsnewIndex
. This method posts acolumnMoved
event to its listeners.- Parameters:
columnIndex
- the index of column to be movednewIndex
- index of the column's new location- Throws:
IllegalArgumentException
- ifcolumnIndex
ornewIndex
are not in the valid range
-
setColumnMargin
void setColumnMargin(int newMargin)
Sets theTableColumn
's column margin tonewMargin
. This method posts acolumnMarginChanged
event to its listeners.- Parameters:
newMargin
- the width, in pixels, of the new column margins- See Also:
getColumnMargin()
-
getColumnCount
int getColumnCount()
Returns the number of columns in the model.- Returns:
- the number of columns in the model
-
getColumns
Enumeration<TableColumn> getColumns()
Returns anEnumeration
of all the columns in the model.- Returns:
- an
Enumeration
of all the columns in the model
-
getColumnIndex
int getColumnIndex(Object columnIdentifier)
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
- ifidentifier
isnull
, or noTableColumn
has thisidentifier
- See Also:
getColumn(int)
-
getColumn
TableColumn getColumn(int columnIndex)
Returns theTableColumn
object for the column atcolumnIndex
.- Parameters:
columnIndex
- the index of the desired column- Returns:
- the
TableColumn
object 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 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 givenxPosition
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)
-
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()
-
getColumnSelectionAllowed
boolean getColumnSelectionAllowed()
Returns true if columns may be selected.- Returns:
- true if columns may be selected
- See Also:
setColumnSelectionAllowed(boolean)
-
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
void setSelectionModel(ListSelectionModel newModel)
Sets the selection model.- Parameters:
newModel
- aListSelectionModel
object- See Also:
getSelectionModel()
-
getSelectionModel
ListSelectionModel getSelectionModel()
Returns the current selection model.- Returns:
- a
ListSelectionModel
object - See Also:
setSelectionModel(javax.swing.ListSelectionModel)
-
addColumnModelListener
void addColumnModelListener(TableColumnModelListener x)
Adds a listener for table column model events.- Parameters:
x
- aTableColumnModelListener
object
-
removeColumnModelListener
void removeColumnModelListener(TableColumnModelListener x)
Removes a listener for table column model events.- Parameters:
x
- aTableColumnModelListener
object
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/table/tablecolumnmodel.html/.html/
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.