Serializable
public class TableColumn extends Object implements Serializable
TableColumn
represents all the attributes of a column in a JTable
, such as width, resizability, minimum and maximum width. In addition, the TableColumn
provides slots for a renderer and an editor that can be used to display and edit the values in this column. It is also possible to specify renderers and editors on a per type basis rather than a per column basis - see the setDefaultRenderer
method in the JTable
class. This default mechanism is only used when the renderer (or editor) in the TableColumn
is null
.
The TableColumn
stores the link between the columns in the JTable
and the columns in the TableModel
. The modelIndex
is the column in the TableModel
, which will be queried for the data values for the cells in this column. As the column moves around in the view this modelIndex
does not change.
Note: Some implementations may assume that all TableColumnModel
s are unique, therefore we would recommend that the same TableColumn
instance not be added more than once to a TableColumnModel
. To show TableColumn
s with the same column of data from the model, create a new instance with the same modelIndex
.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans
package. Please see XMLEncoder
.
Modifier and Type | Field | Description |
---|---|---|
static final String |
CELL_RENDERER_PROPERTY |
Obsolete as of Java 2 platform v1.3. |
protected TableCellEditor |
cellEditor |
The editor used to edit the data cells of the column. |
protected TableCellRenderer |
cellRenderer |
The renderer used to draw the data cells of the column. |
static final String |
COLUMN_WIDTH_PROPERTY |
Obsolete as of Java 2 platform v1.3. |
static final String |
HEADER_RENDERER_PROPERTY |
Obsolete as of Java 2 platform v1.3. |
static final String |
HEADER_VALUE_PROPERTY |
Obsolete as of Java 2 platform v1.3. |
protected TableCellRenderer |
headerRenderer |
The renderer used to draw the header of the column. |
protected Object |
headerValue |
The header value of the column. |
protected Object |
identifier |
This object is not used internally by the drawing machinery of the JTable ; identifiers may be set in the TableColumn as an optional way to tag and locate table columns. |
protected boolean |
isResizable |
If true, the user is allowed to resize the column; the default is true. |
protected int |
maxWidth |
The maximum width of the column. |
protected int |
minWidth |
The minimum width of the column. |
protected int |
modelIndex |
The index of the column in the model which is to be displayed by this TableColumn . |
protected int |
resizedPostingDisableCount |
Deprecated. as of Java 2 platform v1.3 |
protected int |
width |
The width of the column. |
Constructor | Description |
---|---|
TableColumn() |
Cover method, using a default model index of 0, default width of 75, a null renderer and a null editor. |
TableColumn |
Cover method, using a default width of 75, a null renderer and a null editor. |
TableColumn |
Cover method, using a null renderer and a null editor. |
TableColumn |
Creates and initializes an instance of TableColumn with the specified model index, width, cell renderer, and cell editor; all TableColumn constructors delegate to this one. |
Modifier and Type | Method | Description |
---|---|---|
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list. |
protected TableCellRenderer |
createDefaultHeaderRenderer() |
As of Java 2 platform v1.3, this method is not called by the TableColumn constructor. |
void |
disableResizedPosting() |
Deprecated. as of Java 2 platform v1.3 |
void |
enableResizedPosting() |
Deprecated. as of Java 2 platform v1.3 |
TableCellEditor |
getCellEditor() |
Returns the TableCellEditor used by the JTable to edit values for this column. |
TableCellRenderer |
getCellRenderer() |
Returns the TableCellRenderer used by the JTable to draw values for this column. |
TableCellRenderer |
getHeaderRenderer() |
Returns the TableCellRenderer used to draw the header of the TableColumn . |
Object |
getHeaderValue() |
Returns the Object used as the value for the header renderer. |
Object |
getIdentifier() |
Returns the identifier object for this column. |
int |
getMaxWidth() |
Returns the maximum width for the TableColumn . |
int |
getMinWidth() |
Returns the minimum width for the TableColumn . |
int |
getModelIndex() |
Returns the model index for this column. |
int |
getPreferredWidth() |
Returns the preferred width of the TableColumn . |
PropertyChangeListener[] |
getPropertyChangeListeners() |
Returns an array of all the PropertyChangeListener s added to this TableColumn with addPropertyChangeListener(). |
boolean |
getResizable() |
Returns true if the user is allowed to resize the TableColumn 's width, false otherwise. |
int |
getWidth() |
Returns the width of the TableColumn . |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list. |
void |
setCellEditor |
Sets the editor to used by when a cell in this column is edited. |
void |
setCellRenderer |
Sets the TableCellRenderer used by JTable to draw individual values for this column. |
void |
setHeaderRenderer |
Sets the TableCellRenderer used to draw the TableColumn 's header to headerRenderer . |
void |
setHeaderValue |
Sets the Object whose string representation will be used as the value for the headerRenderer . |
void |
setIdentifier |
Sets the TableColumn 's identifier to anIdentifier . |
void |
setMaxWidth |
Sets the TableColumn 's maximum width to maxWidth or, if maxWidth is less than the minimum width, to the minimum width. |
void |
setMinWidth |
Sets the TableColumn 's minimum width to minWidth , adjusting the new minimum width if necessary to ensure that 0 <= minWidth <= maxWidth . |
void |
setModelIndex |
Sets the model index for this column. |
void |
setPreferredWidth |
Sets this column's preferred width to preferredWidth . |
void |
setResizable |
Sets whether this column can be resized. |
void |
setWidth |
This method should not be used to set the widths of columns in the JTable , use setPreferredWidth instead. |
void |
sizeWidthToFit() |
Resizes the TableColumn to fit the width of its header cell. |
public static final String COLUMN_WIDTH_PROPERTY
public static final String HEADER_VALUE_PROPERTY
public static final String HEADER_RENDERER_PROPERTY
public static final String CELL_RENDERER_PROPERTY
protected int modelIndex
TableColumn
. As columns are moved around in the view modelIndex
remains constant.protected Object identifier
JTable
; identifiers may be set in the TableColumn
as an optional way to tag and locate table columns. The table package does not modify or invoke any methods in these identifier objects other than the equals
method which is used in the getColumnIndex()
method in the DefaultTableColumnModel
.protected int width
protected int minWidth
protected int maxWidth
protected TableCellRenderer headerRenderer
protected Object headerValue
protected TableCellRenderer cellRenderer
protected TableCellEditor cellEditor
protected boolean isResizable
@Deprecated protected transient int resizedPostingDisableCount
public TableColumn()
null
renderer and a null
editor. This method is intended for serialization.public TableColumn(int modelIndex)
null
renderer and a null
editor.modelIndex
- the index of the column in the model that supplies the data for this column in the table; the model index remains the same even when columns are reordered in the viewpublic TableColumn(int modelIndex, int width)
null
renderer and a null
editor.modelIndex
- the index of the column in the model that supplies the data for this column in the table; the model index remains the same even when columns are reordered in the viewwidth
- this column's preferred width and initial widthpublic TableColumn(int modelIndex, int width, TableCellRenderer cellRenderer, TableCellEditor cellEditor)
TableColumn
with the specified model index, width, cell renderer, and cell editor; all TableColumn
constructors delegate to this one. The value of width
is used for both the initial and preferred width; if width
is negative, they're set to 0. The minimum width is set to 15 unless the initial width is less, in which case the minimum width is set to the initial width. When the cellRenderer
or cellEditor
parameter is null
, a default value provided by the JTable
getDefaultRenderer
or getDefaultEditor
method, respectively, is used to provide defaults based on the type of the data in this column. This column-centric rendering strategy can be circumvented by overriding the getCellRenderer
methods in JTable
.
modelIndex
- the index of the column in the model that supplies the data for this column in the table; the model index remains the same even when columns are reordered in the viewwidth
- this column's preferred width and initial widthcellRenderer
- the object used to render values in this columncellEditor
- the object used to edit values in this column@BeanProperty(description="The model index.") public void setModelIndex(int modelIndex)
TableColumn
. As the TableColumn
is moved around in the view the model index remains constant.modelIndex
- the new modelIndexpublic int getModelIndex()
modelIndex
property@BeanProperty(description="A unique identifier for this column.") public void setIdentifier(Object identifier)
TableColumn
's identifier to anIdentifier
. Note: identifiers are not used by the JTable
, they are purely a convenience for the external tagging and location of columns.
identifier
- an identifier for this columnpublic Object getIdentifier()
identifier
object for this column. Note identifiers are not used by JTable
, they are purely a convenience for external use. If the identifier
is null
, getIdentifier()
returns getHeaderValue
as a default.identifier
property@BeanProperty(description="The text to be used by the header renderer.") public void setHeaderValue(Object headerValue)
Object
whose string representation will be used as the value for the headerRenderer
. When the TableColumn
is created, the default headerValue
is null
.headerValue
- the new headerValuepublic Object getHeaderValue()
Object
used as the value for the header renderer.headerValue
property@BeanProperty(description="The header renderer.") public void setHeaderRenderer(TableCellRenderer headerRenderer)
TableCellRenderer
used to draw the TableColumn
's header to headerRenderer
. It is the header renderers responsibility to render the sorting indicator. If you are using sorting and specify a renderer your renderer must render the sorting indication.
headerRenderer
- the new headerRendererpublic TableCellRenderer getHeaderRenderer()
TableCellRenderer
used to draw the header of the TableColumn
. When the headerRenderer
is null
, the JTableHeader
uses its defaultRenderer
. The default value for a headerRenderer
is null
.headerRenderer
property@BeanProperty(description="The renderer to use for cell values.") public void setCellRenderer(TableCellRenderer cellRenderer)
TableCellRenderer
used by JTable
to draw individual values for this column.cellRenderer
- the new cellRendererpublic TableCellRenderer getCellRenderer()
TableCellRenderer
used by the JTable
to draw values for this column. The cellRenderer
of the column not only controls the visual look for the column, but is also used to interpret the value object supplied by the TableModel
. When the cellRenderer
is null
, the JTable
uses a default renderer based on the class of the cells in that column. The default value for a cellRenderer
is null
.cellRenderer
property@BeanProperty(description="The editor to use for cell values.") public void setCellEditor(TableCellEditor cellEditor)
cellEditor
- the new cellEditorpublic TableCellEditor getCellEditor()
TableCellEditor
used by the JTable
to edit values for this column. When the cellEditor
is null
, the JTable
uses a default editor based on the class of the cells in that column. The default value for a cellEditor
is null
.cellEditor
property@BeanProperty(description="The width of the column.") public void setWidth(int width)
JTable
, use setPreferredWidth
instead. Like a layout manager in the AWT, the JTable
adjusts a column's width automatically whenever the table itself changes size, or a column's preferred width is changed. Setting widths programmatically therefore has no long term effect. This method sets this column's width to width
. If width
exceeds the minimum or maximum width, it is adjusted to the appropriate limiting value.
width
- the new widthpublic int getWidth()
TableColumn
. The default width is 75.width
property@BeanProperty(description="The preferred width of the column.") public void setPreferredWidth(int preferredWidth)
preferredWidth
. If preferredWidth
exceeds the minimum or maximum width, it is adjusted to the appropriate limiting value. For details on how the widths of columns in the JTable
(and JTableHeader
) are calculated from the preferredWidth
, see the doLayout
method in JTable
.
preferredWidth
- the new preferred widthpublic int getPreferredWidth()
TableColumn
. The default preferred width is 75.preferredWidth
property@BeanProperty(description="The minimum width of the column.") public void setMinWidth(int minWidth)
TableColumn
's minimum width to minWidth
, adjusting the new minimum width if necessary to ensure that 0 <= minWidth
<= maxWidth
. For example, if the minWidth
argument is negative, this method sets the minWidth
property to 0. If the value of the width
or preferredWidth
property is less than the new minimum width, this method sets that property to the new minimum width.
minWidth
- the new minimum widthpublic int getMinWidth()
TableColumn
. The TableColumn
's width can't be made less than this either by the user or programmatically.minWidth
property@BeanProperty(description="The maximum width of the column.") public void setMaxWidth(int maxWidth)
TableColumn
's maximum width to maxWidth
or, if maxWidth
is less than the minimum width, to the minimum width. If the value of the width
or preferredWidth
property is more than the new maximum width, this method sets that property to the new maximum width.
maxWidth
- the new maximum widthpublic int getMaxWidth()
TableColumn
. The TableColumn
's width can't be made larger than this either by the user or programmatically. The default maxWidth is Integer.MAX_VALUE.maxWidth
property@BeanProperty(description="Whether or not this column can be resized.") public void setResizable(boolean isResizable)
isResizable
- if true, resizing is allowed; otherwise falsepublic boolean getResizable()
TableColumn
's width, false otherwise. You can change the width programmatically regardless of this setting. The default is true.isResizable
propertypublic void sizeWidthToFit()
TableColumn
to fit the width of its header cell. This method does nothing if the header renderer is null
(the default case). Otherwise, it sets the minimum, maximum and preferred widths of this column to the widths of the minimum, maximum and preferred sizes of the Component delivered by the header renderer. The transient "width" property of this TableColumn is also set to the preferred width. Note this method is not used internally by the table package.@Deprecated public void disableResizedPosting()
@Deprecated public void enableResizedPosting()
public void addPropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener
to the listener list. The listener is registered for all bound properties of this class, including the following: listener
- the listener to be addedpublic void removePropertyChangeListener(PropertyChangeListener listener)
PropertyChangeListener
from the listener list. The PropertyChangeListener
to be removed was registered for all properties.listener
- the listener to be removedpublic PropertyChangeListener[] getPropertyChangeListeners()
PropertyChangeListener
s added to this TableColumn with addPropertyChangeListener().PropertyChangeListener
s added or an empty array if no listeners have been addedprotected TableCellRenderer createDefaultHeaderRenderer()
TableColumn
constructor. Previously this method was used by the TableColumn
to create a default header renderer. As of Java 2 platform v1.3, the default header renderer is null
. JTableHeader
now provides its own shared default renderer, just as the JTable
does for its cell renderers.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/table/TableColumn.html