java.lang.Object | |
↳ | javax.swing.table.TableColumn |
A TableColumn
represents all the attributes of a column in a
JTable
, such as width, resizibility, 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 JavaBeansTM
has been added to the java.beans
package.
Please see XMLEncoder
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | CELL_RENDERER_PROPERTY | Obsolete as of Java 2 platform v1.3. | |||||||||
String | COLUMN_WIDTH_PROPERTY | Obsolete as of Java 2 platform v1.3. | |||||||||
String | HEADER_RENDERER_PROPERTY | Obsolete as of Java 2 platform v1.3. | |||||||||
String | HEADER_VALUE_PROPERTY | Obsolete as of Java 2 platform v1.3. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
cellEditor | The editor used to edit the data cells of the column. | ||||||||||
cellRenderer | The renderer used to draw the data cells of the column. | ||||||||||
headerRenderer | The renderer used to draw the header of the column. | ||||||||||
headerValue | The header value of the column. | ||||||||||
identifier | This object is not used internally by the drawing machinery of
the JTable ; identifiers may be set in the
TableColumn as as an
optional way to tag and locate table columns. |
||||||||||
isResizable | If true, the user is allowed to resize the column; the default is true. | ||||||||||
maxWidth | The maximum width of the column. | ||||||||||
minWidth | The minimum width of the column. | ||||||||||
modelIndex | The index of the column in the model which is to be displayed by
this TableColumn . |
||||||||||
resizedPostingDisableCount | This field is deprecated. as of Java 2 platform v1.3 | ||||||||||
width | The width of the column. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Cover method, using a default model index of 0,
default width of 75, a
null renderer and a
null editor. | |||||||||||
Cover method, using a default width of 75, a
null
renderer and a null editor. | |||||||||||
Cover method, using a
null renderer and a
null editor. | |||||||||||
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. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a
PropertyChangeListener to the listener list. | |||||||||||
This method is deprecated.
as of Java 2 platform v1.3
| |||||||||||
This method is deprecated.
as of Java 2 platform v1.3
| |||||||||||
Returns the
TableCellEditor used by the
JTable to edit values for this column. | |||||||||||
Returns the
TableCellRenderer used by the
JTable to draw
values for this column. | |||||||||||
Returns the
TableCellRenderer used to draw the header of the
TableColumn . | |||||||||||
Returns the
Object used as the value for the header
renderer. | |||||||||||
Returns the
identifier object for this column. | |||||||||||
Returns the maximum width for the
TableColumn . | |||||||||||
Returns the minimum width for the
TableColumn . | |||||||||||
Returns the model index for this column.
| |||||||||||
Returns the preferred width of the
TableColumn . | |||||||||||
Returns an array of all the
PropertyChangeListener s added
to this TableColumn with addPropertyChangeListener(). | |||||||||||
Returns true if the user is allowed to resize the
TableColumn 's
width, false otherwise. | |||||||||||
Returns the width of the
TableColumn . | |||||||||||
Removes a
PropertyChangeListener from the listener list. | |||||||||||
Sets the editor to used by when a cell in this column is edited.
| |||||||||||
Sets the
TableCellRenderer used by JTable
to draw individual values for this column. | |||||||||||
Sets the
TableCellRenderer used to draw the
TableColumn 's header to headerRenderer . | |||||||||||
Sets the
Object whose string representation will be
used as the value for the headerRenderer . | |||||||||||
Sets the
TableColumn 's identifier to
anIdentifier . | |||||||||||
Sets the
TableColumn 's maximum width to
maxWidth or,
if maxWidth is less than the minimum width,
to the minimum width. | |||||||||||
Sets the
TableColumn 's minimum width to
minWidth ,
adjusting the new minimum width if necessary to ensure that
0 <= minWidth <= maxWidth . | |||||||||||
Sets the model index for this column.
| |||||||||||
Sets this column's preferred width to
preferredWidth . | |||||||||||
Sets whether this column can be resized.
| |||||||||||
This method should not be used to set the widths of columns in the
JTable , use setPreferredWidth instead. | |||||||||||
Resizes the
TableColumn to fit the width of its header cell. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
As of Java 2 platform v1.3, this method is not called by the
TableColumn
constructor. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
This object is not used internally by the drawing machinery of
the JTable
; identifiers may be set in the
TableColumn
as 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
.
If true, the user is allowed to resize the column; the default is true.
The maximum width of the column.
The minimum width of the column.
The index of the column in the model which is to be displayed by
this TableColumn
. As columns are moved around in the
view modelIndex
remains constant.
This field is deprecated.
as of Java 2 platform v1.3
This field was not used in previous releases and there are currently no plans to support it in the future.
The width of the column.
Cover method, using a default model index of 0,
default width of 75, a null
renderer and a
null
editor.
This method is intended for serialization.
Cover method, using a default width of 75, a null
renderer and a null
editor.
Cover method, using a null
renderer and a
null
editor.
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.
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 view |
---|---|
width | this column's preferred width and initial width |
cellRenderer | the object used to render values in this column |
cellEditor | the object used to edit values in this column |
Adds a PropertyChangeListener
to the listener list.
The listener is registered for all properties.
A PropertyChangeEvent
will get fired in response to an
explicit call to setFont
, setBackground
,
or setForeground
on the
current component. Note that if the current component is
inheriting its foreground, background, or font from its
container, then no event will be fired in response to a
change in the inherited property.
listener | the listener to be added |
---|
This method is deprecated.
as of Java 2 platform v1.3
This field was not used in previous releases and there are currently no plans to support it in the future.
This method is deprecated.
as of Java 2 platform v1.3
This field was not used in previous releases and there are currently no plans to support it in the future.
Returns the 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
propertyReturns the 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
propertyReturns the 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
propertyReturns the Object
used as the value for the header
renderer.
headerValue
propertyReturns the 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
propertyReturns the maximum width for the 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
propertyReturns the minimum width for the TableColumn
. The
TableColumn
's width can't be made less than this either
by the user or programmatically.
minWidth
propertyReturns the model index for this column.
modelIndex
property
Returns the preferred width of the TableColumn
.
The default preferred width is 75.
preferredWidth
propertyReturns an array of all the PropertyChangeListener
s added
to this TableColumn with addPropertyChangeListener().
PropertyChangeListener
s added or an empty
array if no listeners have been addedReturns true if the user is allowed to resize the
TableColumn
's
width, false otherwise. You can change the width programmatically
regardless of this setting. The default is true.
isResizable
propertyReturns the width of the TableColumn
. The default width is
75.
width
propertyRemoves a PropertyChangeListener
from the listener list.
The PropertyChangeListener
to be removed was registered
for all properties.
listener | the listener to be removed |
---|
Sets the editor to used by when a cell in this column is edited.
cellEditor | the new cellEditor |
---|
Sets the TableCellRenderer
used by JTable
to draw individual values for this column.
cellRenderer | the new cellRenderer |
---|
Sets the 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 headerRenderer |
---|
Sets the 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 headerValue |
---|
Sets the 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 column |
---|
Sets the 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 width |
---|
Sets the 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 width |
---|
Sets the model index for this column. The model index is the
index of the column in the model that will be displayed by this
TableColumn
. As the TableColumn
is moved around in the view the model index remains constant.
modelIndex | the new modelIndex |
---|
Sets this column's preferred width to 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 width |
---|
Sets whether this column can be resized.
isResizable | if true, resizing is allowed; otherwise false |
---|
This method should not be used to set the widths of columns in the
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 width |
---|
Resizes the 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.
As of Java 2 platform v1.3, this method is not called by the 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.