- java.lang.Object
-
- javax.swing.table.TableColumn
-
- All Implemented Interfaces:
- Serializable
public class TableColumn extends Object implements Serializable
ATableColumn
represents all the attributes of a column in aJTable
, such as width, resizibility, minimum and maximum width. In addition, theTableColumn
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 theJTable
class. This default mechanism is only used when the renderer (or editor) in theTableColumn
isnull
.The
TableColumn
stores the link between the columns in theJTable
and the columns in theTableModel
. ThemodelIndex
is the column in theTableModel
, which will be queried for the data values for the cells in this column. As the column moves around in the view thismodelIndex
does not change.Note: Some implementations may assume that all
TableColumnModel
s are unique, therefore we would recommend that the sameTableColumn
instance not be added more than once to aTableColumnModel
. To showTableColumn
s with the same column of data from the model, create a new instance with the samemodelIndex
.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 seeXMLEncoder
.
-
-
Field Summary
Fields Modifier and Type Field and Description static 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 String
COLUMN_WIDTH_PROPERTY
Obsolete as of Java 2 platform v1.3.static String
HEADER_RENDERER_PROPERTY
Obsolete as of Java 2 platform v1.3.static 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 theJTable
; identifiers may be set in theTableColumn
as 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 thisTableColumn
.protected int
resizedPostingDisableCount
Deprecated.as of Java 2 platform v1.3protected int
width
The width of the column.
-
Constructor Summary
Constructors Constructor and Description TableColumn()
Cover method, using a default model index of 0, default width of 75, anull
renderer and anull
editor.TableColumn(int modelIndex)
Cover method, using a default width of 75, anull
renderer and anull
editor.TableColumn(int modelIndex, int width)
Cover method, using anull
renderer and anull
editor.TableColumn(int modelIndex, int width, TableCellRenderer cellRenderer, TableCellEditor cellEditor)
Creates and initializes an instance ofTableColumn
with the specified model index, width, cell renderer, and cell editor; allTableColumn
constructors delegate to this one.
-
Method Summary
Methods Modifier and Type Method and Description void
addPropertyChangeListener(PropertyChangeListener listener)
Adds aPropertyChangeListener
to the listener list.protected TableCellRenderer
createDefaultHeaderRenderer()
As of Java 2 platform v1.3, this method is not called by theTableColumn
constructor.void
disableResizedPosting()
Deprecated.as of Java 2 platform v1.3void
enableResizedPosting()
Deprecated.as of Java 2 platform v1.3TableCellEditor
getCellEditor()
Returns theTableCellEditor
used by theJTable
to edit values for this column.TableCellRenderer
getCellRenderer()
Returns theTableCellRenderer
used by theJTable
to draw values for this column.TableCellRenderer
getHeaderRenderer()
Returns theTableCellRenderer
used to draw the header of theTableColumn
.Object
getHeaderValue()
Returns theObject
used as the value for the header renderer.Object
getIdentifier()
Returns theidentifier
object for this column.int
getMaxWidth()
Returns the maximum width for theTableColumn
.int
getMinWidth()
Returns the minimum width for theTableColumn
.int
getModelIndex()
Returns the model index for this column.int
getPreferredWidth()
Returns the preferred width of theTableColumn
.PropertyChangeListener[]
getPropertyChangeListeners()
Returns an array of all thePropertyChangeListener
s added to this TableColumn with addPropertyChangeListener().boolean
getResizable()
Returns true if the user is allowed to resize theTableColumn
's width, false otherwise.int
getWidth()
Returns the width of theTableColumn
.void
removePropertyChangeListener(PropertyChangeListener listener)
Removes aPropertyChangeListener
from the listener list.void
setCellEditor(TableCellEditor cellEditor)
Sets the editor to used by when a cell in this column is edited.void
setCellRenderer(TableCellRenderer cellRenderer)
Sets theTableCellRenderer
used byJTable
to draw individual values for this column.void
setHeaderRenderer(TableCellRenderer headerRenderer)
Sets theTableCellRenderer
used to draw theTableColumn
's header toheaderRenderer
.void
setHeaderValue(Object headerValue)
Sets theObject
whose string representation will be used as the value for theheaderRenderer
.void
setIdentifier(Object identifier)
Sets theTableColumn
's identifier toanIdentifier
.void
setMaxWidth(int maxWidth)
Sets theTableColumn
's maximum width tomaxWidth
or, ifmaxWidth
is less than the minimum width, to the minimum width.void
setMinWidth(int minWidth)
Sets theTableColumn
's minimum width tominWidth
, adjusting the new minimum width if necessary to ensure that 0 <=minWidth
<=maxWidth
.void
setModelIndex(int modelIndex)
Sets the model index for this column.void
setPreferredWidth(int preferredWidth)
Sets this column's preferred width topreferredWidth
.void
setResizable(boolean isResizable)
Sets whether this column can be resized.void
setWidth(int width)
This method should not be used to set the widths of columns in theJTable
, usesetPreferredWidth
instead.void
sizeWidthToFit()
Resizes theTableColumn
to fit the width of its header cell.
-
-
-
Field Detail
-
COLUMN_WIDTH_PROPERTY
public static final String COLUMN_WIDTH_PROPERTY
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.- See Also:
- Constant Field Values
-
HEADER_VALUE_PROPERTY
public static final String HEADER_VALUE_PROPERTY
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.- See Also:
- Constant Field Values
-
HEADER_RENDERER_PROPERTY
public static final String HEADER_RENDERER_PROPERTY
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.- See Also:
- Constant Field Values
-
CELL_RENDERER_PROPERTY
public static final String CELL_RENDERER_PROPERTY
Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.- See Also:
- Constant Field Values
-
modelIndex
protected int modelIndex
The index of the column in the model which is to be displayed by thisTableColumn
. As columns are moved around in the viewmodelIndex
remains constant.
-
identifier
protected Object identifier
This object is not used internally by the drawing machinery of theJTable
; identifiers may be set in theTableColumn
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 theequals
method which is used in thegetColumnIndex()
method in theDefaultTableColumnModel
.
-
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
If true, the user is allowed to resize the column; the default is true.
-
resizedPostingDisableCount
@Deprecated protected transient int resizedPostingDisableCount
Deprecated. as of Java 2 platform v1.3This field was not used in previous releases and there are currently no plans to support it in the future.
-
-
Constructor Detail
-
TableColumn
public TableColumn()
Cover method, using a default model index of 0, default width of 75, anull
renderer and anull
editor. This method is intended for serialization.
-
TableColumn
public TableColumn(int modelIndex)
Cover method, using a default width of 75, anull
renderer and anull
editor.
-
TableColumn
public TableColumn(int modelIndex, int width)
Cover method, using anull
renderer and anull
editor.
-
TableColumn
public TableColumn(int modelIndex, int width, TableCellRenderer cellRenderer, TableCellEditor cellEditor)
Creates and initializes an instance ofTableColumn
with the specified model index, width, cell renderer, and cell editor; allTableColumn
constructors delegate to this one. The value ofwidth
is used for both the initial and preferred width; ifwidth
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
orcellEditor
parameter isnull
, a default value provided by theJTable
getDefaultRenderer
orgetDefaultEditor
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 thegetCellRenderer
methods inJTable
.- Parameters:
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- See Also:
getMinWidth()
,JTable.getDefaultRenderer(Class)
,JTable.getDefaultEditor(Class)
,JTable.getCellRenderer(int, int)
,JTable.getCellEditor(int, int)
-
-
Method Detail
-
setModelIndex
public void setModelIndex(int modelIndex)
Sets the model index for this column. The model index is the index of the column in the model that will be displayed by thisTableColumn
. As theTableColumn
is moved around in the view the model index remains constant.- Parameters:
modelIndex
- the new modelIndex
-
getModelIndex
public int getModelIndex()
Returns the model index for this column.- Returns:
- the
modelIndex
property
-
setIdentifier
public void setIdentifier(Object identifier)
Sets theTableColumn
's identifier toanIdentifier
.Note: identifiers are not used by the
JTable
, they are purely a convenience for the external tagging and location of columns.- Parameters:
identifier
- an identifier for this column- See Also:
getIdentifier()
-
getIdentifier
public Object getIdentifier()
Returns theidentifier
object for this column. Note identifiers are not used byJTable
, they are purely a convenience for external use. If theidentifier
isnull
,getIdentifier()
returnsgetHeaderValue
as a default.- Returns:
- the
identifier
property - See Also:
setIdentifier(java.lang.Object)
-
setHeaderValue
public void setHeaderValue(Object headerValue)
Sets theObject
whose string representation will be used as the value for theheaderRenderer
. When theTableColumn
is created, the defaultheaderValue
isnull
.- Parameters:
headerValue
- the new headerValue- See Also:
getHeaderValue()
-
getHeaderValue
public Object getHeaderValue()
Returns theObject
used as the value for the header renderer.- Returns:
- the
headerValue
property - See Also:
setHeaderValue(java.lang.Object)
-
setHeaderRenderer
public void setHeaderRenderer(TableCellRenderer headerRenderer)
Sets theTableCellRenderer
used to draw theTableColumn
's header toheaderRenderer
.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.
- Parameters:
headerRenderer
- the new headerRenderer- See Also:
getHeaderRenderer()
-
getHeaderRenderer
public TableCellRenderer getHeaderRenderer()
Returns theTableCellRenderer
used to draw the header of theTableColumn
. When theheaderRenderer
isnull
, theJTableHeader
uses itsdefaultRenderer
. The default value for aheaderRenderer
isnull
.- Returns:
- the
headerRenderer
property - See Also:
setHeaderRenderer(javax.swing.table.TableCellRenderer)
,setHeaderValue(java.lang.Object)
,JTableHeader.getDefaultRenderer()
-
setCellRenderer
public void setCellRenderer(TableCellRenderer cellRenderer)
Sets theTableCellRenderer
used byJTable
to draw individual values for this column.- Parameters:
cellRenderer
- the new cellRenderer- See Also:
getCellRenderer()
-
getCellRenderer
public TableCellRenderer getCellRenderer()
Returns theTableCellRenderer
used by theJTable
to draw values for this column. ThecellRenderer
of the column not only controls the visual look for the column, but is also used to interpret the value object supplied by theTableModel
. When thecellRenderer
isnull
, theJTable
uses a default renderer based on the class of the cells in that column. The default value for acellRenderer
isnull
.- Returns:
- the
cellRenderer
property - See Also:
setCellRenderer(javax.swing.table.TableCellRenderer)
,JTable.setDefaultRenderer(java.lang.Class<?>, javax.swing.table.TableCellRenderer)
-
setCellEditor
public void setCellEditor(TableCellEditor cellEditor)
Sets the editor to used by when a cell in this column is edited.- Parameters:
cellEditor
- the new cellEditor- See Also:
getCellEditor()
-
getCellEditor
public TableCellEditor getCellEditor()
Returns theTableCellEditor
used by theJTable
to edit values for this column. When thecellEditor
isnull
, theJTable
uses a default editor based on the class of the cells in that column. The default value for acellEditor
isnull
.- Returns:
- the
cellEditor
property - See Also:
setCellEditor(javax.swing.table.TableCellEditor)
,JTable.setDefaultEditor(java.lang.Class<?>, javax.swing.table.TableCellEditor)
-
setWidth
public void setWidth(int width)
This method should not be used to set the widths of columns in theJTable
, usesetPreferredWidth
instead. Like a layout manager in the AWT, theJTable
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
. Ifwidth
exceeds the minimum or maximum width, it is adjusted to the appropriate limiting value.- Parameters:
width
- the new width- See Also:
getWidth()
,setMinWidth(int)
,setMaxWidth(int)
,setPreferredWidth(int)
,JTable.doLayout()
-
getWidth
public int getWidth()
Returns the width of theTableColumn
. The default width is 75.- Returns:
- the
width
property - See Also:
setWidth(int)
-
setPreferredWidth
public void setPreferredWidth(int preferredWidth)
Sets this column's preferred width topreferredWidth
. IfpreferredWidth
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
(andJTableHeader
) are calculated from thepreferredWidth
, see thedoLayout
method inJTable
.- Parameters:
preferredWidth
- the new preferred width- See Also:
getPreferredWidth()
,JTable.doLayout()
-
getPreferredWidth
public int getPreferredWidth()
Returns the preferred width of theTableColumn
. The default preferred width is 75.- Returns:
- the
preferredWidth
property - See Also:
setPreferredWidth(int)
-
setMinWidth
public void setMinWidth(int minWidth)
Sets theTableColumn
's minimum width tominWidth
, adjusting the new minimum width if necessary to ensure that 0 <=minWidth
<=maxWidth
. For example, if theminWidth
argument is negative, this method sets theminWidth
property to 0.If the value of the
width
orpreferredWidth
property is less than the new minimum width, this method sets that property to the new minimum width.- Parameters:
minWidth
- the new minimum width- See Also:
getMinWidth()
,setPreferredWidth(int)
,setMaxWidth(int)
-
getMinWidth
public int getMinWidth()
Returns the minimum width for theTableColumn
. TheTableColumn
's width can't be made less than this either by the user or programmatically.- Returns:
- the
minWidth
property - See Also:
setMinWidth(int)
,TableColumn(int, int, TableCellRenderer, TableCellEditor)
-
setMaxWidth
public void setMaxWidth(int maxWidth)
Sets theTableColumn
's maximum width tomaxWidth
or, ifmaxWidth
is less than the minimum width, to the minimum width.If the value of the
width
orpreferredWidth
property is more than the new maximum width, this method sets that property to the new maximum width.- Parameters:
maxWidth
- the new maximum width- See Also:
getMaxWidth()
,setPreferredWidth(int)
,setMinWidth(int)
-
getMaxWidth
public int getMaxWidth()
Returns the maximum width for theTableColumn
. TheTableColumn
's width can't be made larger than this either by the user or programmatically. The default maxWidth is Integer.MAX_VALUE.- Returns:
- the
maxWidth
property - See Also:
setMaxWidth(int)
-
setResizable
public void setResizable(boolean isResizable)
Sets whether this column can be resized.- Parameters:
isResizable
- if true, resizing is allowed; otherwise false- See Also:
getResizable()
-
getResizable
public boolean getResizable()
Returns true if the user is allowed to resize theTableColumn
's width, false otherwise. You can change the width programmatically regardless of this setting. The default is true.- Returns:
- the
isResizable
property - See Also:
setResizable(boolean)
-
sizeWidthToFit
public void sizeWidthToFit()
Resizes theTableColumn
to fit the width of its header cell. This method does nothing if the header renderer isnull
(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.- See Also:
setPreferredWidth(int)
-
disableResizedPosting
@Deprecated public void disableResizedPosting()
Deprecated. as of Java 2 platform v1.3This field was not used in previous releases and there are currently no plans to support it in the future.
-
enableResizedPosting
@Deprecated public void enableResizedPosting()
Deprecated. as of Java 2 platform v1.3This field was not used in previous releases and there are currently no plans to support it in the future.
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Adds aPropertyChangeListener
to the listener list. The listener is registered for all properties.A
PropertyChangeEvent
will get fired in response to an explicit call tosetFont
,setBackground
, orsetForeground
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 listener to be added
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Removes aPropertyChangeListener
from the listener list. ThePropertyChangeListener
to be removed was registered for all properties.- Parameters:
listener
- the listener to be removed
-
getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all thePropertyChangeListener
s added to this TableColumn with addPropertyChangeListener().- Returns:
- all of the
PropertyChangeListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-
createDefaultHeaderRenderer
protected TableCellRenderer createDefaultHeaderRenderer()
As of Java 2 platform v1.3, this method is not called by theTableColumn
constructor. Previously this method was used by theTableColumn
to create a default header renderer. As of Java 2 platform v1.3, the default header renderer isnull
.JTableHeader
now provides its own shared default renderer, just as theJTable
does for its cell renderers.- Returns:
- the default header renderer
- See Also:
JTableHeader.createDefaultRenderer()
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 09:53:08 Cette version de la page est en cache (à la date du 22/12/2024 09:53:08) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/table/TableColumn.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.