javax.swing.table
Class TableColumn

java.lang.Object
  |
  +--javax.swing.table.TableColumn

public class TableColumn

extends Object

implements Serializable

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 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(Class) method in the JTable. 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. This, 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.

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. A future release of Swing will provide support for long term persistence.

See Also:

TableColumnModel, DefaultTableColumnModel, JTable.getDefaultRenderer(Class), JTable.getDefaultEditor(Class), JTable.getCellRenderer(int, int), JTable.getCellEditor(int, int), Serialized Form

Field Summary

static String	CELL_RENDERER_PROPERTY Bound property name.
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 String	COLUMN_WIDTH_PROPERTY Bound property name.
static String	HEADER_RENDERER_PROPERTY Bound property name.
static String	HEADER_VALUE_PROPERTY Bound property name.
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.
protected boolean	isResizable Resizable flag
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 Counter used to disable posting of resizing notifications until the end of the resize
protected int	width The width of the column

Constructor Summary

TableColumn()
Cover method, using a default model index of 0, default width of 75, a null renderer and a null editor.

TableColumn(int modelIndex)
Cover method, using a default width of 75, a null renderer and a null editor.

TableColumn(int modelIndex, int width)
Cover method, using a null renderer and a null editor.

TableColumn(int modelIndex, int width, TableCellRenderer cellRenderer, TableCellEditor cellEditor)
Creates and initializes an instance of TableColumn with modelIndex.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
protected TableCellRenderer	createDefaultHeaderRenderer()
void	disableResizedPosting() Turns off listener-notifications would otherwise occur when a column is resized.
void	enableResizedPosting() Turns on listener-notifications so that listeners are once again informed when a column is resized.
TableCellEditor	getCellEditor() Returns the TableCellEditor used by the JTable to draw 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() Gets the model index for this column.
int	getPreferredWidth() Returns the preferred width of the TableColumn.
boolean	getResizable() Returns true if the user is allowed to resize the TableColumn width, false otherwise.
int	getWidth() Returns the width of the TableColumn.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.
void	setCellEditor(TableCellEditor anEditor) Sets the TableCellEditor used by JTable to draw individual values for this column to anEditor.
void	setCellRenderer(TableCellRenderer aRenderer) Sets the TableCellRenderer used by JTable to draw individual values for this column to aRenderer.
void	setHeaderRenderer(TableCellRenderer aRenderer) Sets the TableCellRenderer used to draw the TableColumn's header to aRenderer.
void	setHeaderValue(Object aValue) Sets the Object used as the value for the headerRenderer Posts a bound property change notification with the name HEADER_VALUE_PROPERTY.
void	setIdentifier(Object anIdentifier) Sets the TableColumn's identifier to anIdentifier.
void	setMaxWidth(int maxWidth) Sets the TableColumn's maximum width to newMaxWidth, also adjusting the current width if it's greater than this value.
void	setMinWidth(int minWidth) Sets the TableColumn's minimum width to newMinWidth, also adjusting the current width if it's less than this value.
void	setModelIndex(int anIndex) Sets the model index for this column.
void	setPreferredWidth(int preferredWidth) Sets this column's preferred width to preferredWidth.
void	setResizable(boolean flag) Sets whether the user can resize the receiver in its JTableView.
void	setWidth(int width) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLUMN_WIDTH_PROPERTY

public static final String COLUMN_WIDTH_PROPERTY

Bound property name.

HEADER_VALUE_PROPERTY

public static final String HEADER_VALUE_PROPERTY

Bound property name.

HEADER_RENDERER_PROPERTY

public static final String HEADER_RENDERER_PROPERTY

Bound property name.

CELL_RENDERER_PROPERTY

public static final String CELL_RENDERER_PROPERTY

Bound property name.

modelIndex

protected int modelIndex

The index of the column in the model which is to be displayed by this TableColumn. As columns are moved around in the view the model index remains constant.

identifier

protected Object 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 TableColumns. The table package does not modify or invoke any methods in these identifer objects other than the equals method which is used in the getColumnIndex() method in the DefaultTableColumnModel.

width

protected int width

The width of the column

minWidth

protected int minWidth

The minimum width of the column

maxWidth

protected int maxWidth

The maximum width of the column

headerRenderer

protected TableCellRenderer headerRenderer

The renderer used to draw the header of the column

headerValue

protected Object headerValue

The header value of the column

cellRenderer

protected TableCellRenderer cellRenderer

The renderer used to draw the data cells of the column

cellEditor

protected TableCellEditor cellEditor

The editor used to edit the data cells of the column

isResizable

protected boolean isResizable

Resizable flag

resizedPostingDisableCount

protected transient int resizedPostingDisableCount

Counter used to disable posting of resizing notifications until the end of the resize

Constructor Detail

TableColumn

public TableColumn()

Cover method, using a default model index of 0, default width of 75, a null renderer and a null editor. This methods is intended for serialization.

See Also:

TableColumn(int, int, TableCellRenderer, TableCellEditor)

TableColumn

public TableColumn(int modelIndex)

Cover method, using a default width of 75, a null renderer and a null editor.

See Also:

TableColumn(int, int, TableCellRenderer, TableCellEditor)

TableColumn

public TableColumn(int modelIndex,
                   int width)

Cover method, using a null renderer and a null editor.

See Also:

TableColumn(int, int, TableCellRenderer, TableCellEditor)

TableColumn

public TableColumn(int modelIndex,
                   int width,
                   TableCellRenderer cellRenderer,
                   TableCellEditor cellEditor)

Creates and initializes an instance of TableColumn with modelIndex. The modelIndex is the index of the column in the model which will supply the data for this column in the table. The modelIndex does not change as the columns are reordered in the view. The width parameter is used to set both the preferredWidth for this column and the intial width. The renderer and editor are the objects used repsectively to render and edit values in this column. When these are null, default values, provided by the getDefaultRenderer(Class) and getDefaultEditor(Class) methods in the JTable are 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 the JTable.

Parameters:

modelIndex - the column in the model which provides the values for this column

See Also:

JTable.getDefaultRenderer(Class), JTable.getDefaultEditor(Class), JTable.getCellRenderer(int, int), JTable.getCellEditor(int, int)

Method Detail

setModelIndex

public void setModelIndex(int anIndex)

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.

getModelIndex

public int getModelIndex()

Gets the model index for this column.

setIdentifier

public void setIdentifier(Object anIdentifier)

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.

Parameters:

anIdentifier - an identifier for this column

See Also:

getIdentifier()

getIdentifier

public Object getIdentifier()

Returns the identifier object for this column. Note identifiers are not used by the JTable, they are purely a convenience for external use. If the identifier is null getIdentifier() returns getHeaderValue() as a default.

Returns:

the idenitifer object for this column

See Also:

setIdentifier(java.lang.Object)

setHeaderRenderer

public void setHeaderRenderer(TableCellRenderer aRenderer)

Sets the TableCellRenderer used to draw the TableColumn's header to aRenderer. Posts a bound property change notification with the name HEADER_RENDERER_PROPERTY.

Parameters:

aRenderer - the new header renderer

Throws:

IllegalArgumentException - if aRenderer is null.

See Also:

getHeaderRenderer()

getHeaderRenderer

public TableCellRenderer getHeaderRenderer()

Returns the TableCellRenderer used to draw the header of the TableColumn. The default header renderer is a JCellRenderer initialized with a JLabel.

Returns:

the TableCellRenderer used to draw the header

See Also:

setHeaderRenderer(javax.swing.table.TableCellRenderer), setHeaderValue(java.lang.Object)

setHeaderValue

public void setHeaderValue(Object aValue)

Sets the Object used as the value for the headerRenderer Posts a bound property change notification with the name HEADER_VALUE_PROPERTY.

Parameters:

aValue - the new header value

See Also:

getHeaderValue()

getHeaderValue

public Object getHeaderValue()

Returns the Object used as the value for the header renderer.

Returns:

the Object used as the value for the header renderer

See Also:

setHeaderValue(java.lang.Object)

setCellRenderer

public void setCellRenderer(TableCellRenderer aRenderer)

Sets the TableCellRenderer used by JTable to draw individual values for this column to aRenderer. Posts a bound property change notification with the name CELL_RENDERER_PROPERTY.

Parameters:

aRenderer - the new data cell renderer

See Also:

getCellRenderer()

getCellRenderer

public TableCellRenderer getCellRenderer()

Returns 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. The default cellRenderer is a JCellRenderer initialized with a JLabel.

Returns:

the TableCellRenderer used by the JTable to draw values for this column

See Also:

setCellRenderer(javax.swing.table.TableCellRenderer)

setCellEditor

public void setCellEditor(TableCellEditor anEditor)

Sets the TableCellEditor used by JTable to draw individual values for this column to anEditor. A null editor means the column is not editable.

Parameters:

anEditor - the new data cell editor

See Also:

getCellEditor()

getCellEditor

public TableCellEditor getCellEditor()

Returns the TableCellEditor used by the JTable to draw values for this column. The cellEditor 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. The default cellEditor is null.

Returns:

the TableCellEditor used by the JTable to draw values for this column

See Also:

setCellEditor(javax.swing.table.TableCellEditor)

setWidth

public void setWidth(int width)

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 methods, sets this column's width to newWidth. If newWidth exceeds the minimum or maximum width, it's adjusted to the appropriate limiting value. Posts a bound property change notification with the name COLUMN_WIDTH_PROPERTY.

Parameters:

newWidth - The new width value

See Also:

getWidth(), setMinWidth(int), setMaxWidth(int), setPreferredWidth(int), JTable.sizeColumnsToFit(int)

getWidth

public int getWidth()

Returns the width of the TableColumn. The default width is 75.

Returns:

the width of the TableColumn

See Also:

setWidth(int)

setPreferredWidth

public void setPreferredWidth(int preferredWidth)

Sets this column's preferred width to preferredWidth. If preferredWidth exceeds the minimum or maximum width, it's 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 sizeColumnsToFit(int) method in the JTable.

Parameters:

preferredWidth - The new preferred width.

See Also:

getPreferredWidth(), JTable.sizeColumnsToFit(int)

getPreferredWidth

public int getPreferredWidth()

Returns the preferred width of the TableColumn. The default preferred width is 75.

Returns:

the width of the TableColumn

See Also:

setPreferredWidth(int)

setMinWidth

public void setMinWidth(int minWidth)

Sets the TableColumn's minimum width to newMinWidth, also adjusting the current width if it's less than this value.

Parameters:

newMinWidth - the new minimum width value

See Also:

getMinWidth(), setPreferredWidth(int), setMaxWidth(int)

getMinWidth

public int getMinWidth()

Returns the minimum width for the TableColumn. The TableColumn's width can't be made less than this either by the user or programmatically. The default minWidth is 15.

Returns:

the minimum width for the TableColumn

See Also:

setMinWidth(int)

setMaxWidth

public void setMaxWidth(int maxWidth)

Sets the TableColumn's maximum width to newMaxWidth, also adjusting the current width if it's greater than this value.

Parameters:

newMaxWidth - the new maximum width value

See Also:

getMaxWidth(), setPreferredWidth(int), setMinWidth(int)

getMaxWidth

public int getMaxWidth()

Returns 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 2000.

Returns:

the maximum width for the TableColumn.

See Also:

setMaxWidth(int)

setResizable

public void setResizable(boolean flag)

Sets whether the user can resize the receiver in its JTableView.

Parameters:

flag - true if the column isResizable

See Also:

getResizable()

getResizable

public boolean getResizable()

Returns true if the user is allowed to resize the TableColumn width, false otherwise. You can change the width programmatically regardless of this setting. The default is true.

Returns:

true if the user is allowed to resize the TableColumn width, false otherwise.

See Also:

setResizable(boolean)

sizeWidthToFit

public void sizeWidthToFit()

Resizes the TableColumn to fit the width of its header cell. If the maximum width is less than the width of the header, the maximum is increased to the header's width. Similarly, if the minimum width is greater than the width of the header, the minimum is reduced to the header's width.

See Also:

setPreferredWidth(int)

disableResizedPosting

public void disableResizedPosting()

Turns off listener-notifications would otherwise occur when a column is resized.

enableResizedPosting

public void enableResizedPosting()

Turns on listener-notifications so that listeners are once again informed when a column is resized.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired in response to an explicit 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.

Parameters:

listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:

listener - The PropertyChangeListener to be removed

createDefaultHeaderRenderer

protected TableCellRenderer createDefaultHeaderRenderer()