File	Doc	Category	Size	Date	Package
TableColumn.java	API Doc	Java SE 6 API	28072	Tue Jun 10 00:26:56 BST 2008	javax.swing.table

TableColumn

• java.lang.Object

Fields Summary
public static final String	COLUMN_WIDTH_PROPERTY Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
public static final String	HEADER_VALUE_PROPERTY Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
public static final String	HEADER_RENDERER_PROPERTY Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
public static final String	CELL_RENDERER_PROPERTY Obsolete as of Java 2 platform v1.3. Please use string literals to identify properties.
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 modelIndex remains constant.
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 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 The width of the column.
protected int	minWidth The minimum width of the column.
private int	preferredWidth The preferred width of the column.
protected int	maxWidth The maximum width of the column.
protected TableCellRenderer	headerRenderer The renderer used to draw the header of the column.
protected Object	headerValue The header value of the column.
protected TableCellRenderer	cellRenderer The renderer used to draw the data cells of the column.
protected TableCellEditor	cellEditor The editor used to edit the data cells of the column.
protected boolean	isResizable If true, the user is allowed to resize the column; the default is true.
protected transient int	resizedPostingDisableCount This field was not used in previous releases and there are currently no plans to support it in the future.
private SwingPropertyChangeSupport	changeSupport If any PropertyChangeListeners have been registered, the changeSupport field describes them.

Constructors Summary
public TableColumn() 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. see #TableColumn(int, int, TableCellRenderer, TableCellEditor) // // Constructors // this(0);
public TableColumn(int modelIndex) Cover method, using a default width of 75, a null renderer and a null editor. see #TableColumn(int, int, TableCellRenderer, TableCellEditor) this(modelIndex, 75, null, null);
public TableColumn(int modelIndex, int width) Cover method, using a null renderer and a null editor. see #TableColumn(int, int, TableCellRenderer, TableCellEditor) this(modelIndex, width, null, null);
public TableColumn(int modelIndex, int width, TableCellRenderer cellRenderer, TableCellEditor cellEditor) 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. param 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 param width this column's preferred width and initial width param cellRenderer the object used to render values in this column param cellEditor the object used to edit values in this column see #getMinWidth() see JTable#getDefaultRenderer(Class) see JTable#getDefaultEditor(Class) see JTable#getCellRenderer(int, int) see JTable#getCellEditor(int, int) super(); this.modelIndex = modelIndex; preferredWidth = this.width = Math.max(width, 0); this.cellRenderer = cellRenderer; this.cellEditor = cellEditor; // Set other instance variables to default values. minWidth = Math.min(15, this.width); maxWidth = Integer.MAX_VALUE; isResizable = true; resizedPostingDisableCount = 0; headerValue = null;

Methods Summary
public synchronized void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) 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. param listener the listener to be added if (changeSupport == null) { changeSupport = new SwingPropertyChangeSupport(this); } changeSupport.addPropertyChangeListener(listener);
protected javax.swing.table.TableCellRenderer	createDefaultHeaderRenderer() 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. return the default header renderer see javax.swing.table.JTableHeader#createDefaultRenderer() DefaultTableCellRenderer label = new DefaultTableCellRenderer() { public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) { if (table != null) { JTableHeader header = table.getTableHeader(); if (header != null) { setForeground(header.getForeground()); setBackground(header.getBackground()); setFont(header.getFont()); } } setText((value == null) ? "" : value.toString()); setBorder(UIManager.getBorder("TableHeader.cellBorder")); return this; } }; label.setHorizontalAlignment(JLabel.CENTER); return label;
public void	disableResizedPosting() This field was not used in previous releases and there are currently no plans to support it in the future. deprecated as of Java 2 platform v1.3 resizedPostingDisableCount++;
public void	enableResizedPosting() This field was not used in previous releases and there are currently no plans to support it in the future. deprecated as of Java 2 platform v1.3 resizedPostingDisableCount--;
private void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) if (changeSupport != null) { changeSupport.firePropertyChange(propertyName, oldValue, newValue); }
private void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue) if (oldValue != newValue) { firePropertyChange(propertyName, new Integer(oldValue), new Integer(newValue)); }
private void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue) if (oldValue != newValue) { firePropertyChange(propertyName, Boolean.valueOf(oldValue), Boolean.valueOf(newValue)); }
public javax.swing.table.TableCellEditor	getCellEditor() 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. return the cellEditor property see #setCellEditor see JTable#setDefaultEditor return cellEditor;
public javax.swing.table.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. 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. return the cellRenderer property see #setCellRenderer see JTable#setDefaultRenderer return cellRenderer;
public javax.swing.table.TableCellRenderer	getHeaderRenderer() Returns 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. return the headerRenderer property see #setHeaderRenderer see #setHeaderValue see javax.swing.table.JTableHeader#getDefaultRenderer() return headerRenderer;
public java.lang.Object	getHeaderValue() Returns the Object used as the value for the header renderer. return the headerValue property see #setHeaderValue return headerValue;
public java.lang.Object	getIdentifier() Returns 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. return the identifier property see #setIdentifier return (identifier != null) ? identifier : getHeaderValue();
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 Integer.MAX_VALUE. return the maxWidth property see #setMaxWidth return maxWidth;
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. return the minWidth property see #setMinWidth see #TableColumn(int, int, TableCellRenderer, TableCellEditor) return minWidth;
public int	getModelIndex() Returns the model index for this column. return the modelIndex property return modelIndex;
public int	getPreferredWidth() Returns the preferred width of the TableColumn. The default preferred width is 75. return the preferredWidth property see #setPreferredWidth return preferredWidth;
public synchronized java.beans.PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the PropertyChangeListeners added to this TableColumn with addPropertyChangeListener(). return all of the PropertyChangeListeners added or an empty array if no listeners have been added since 1.4 if (changeSupport == null) { return new PropertyChangeListener[0]; } return changeSupport.getPropertyChangeListeners();
public boolean	getResizable() Returns 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. return the isResizable property see #setResizable return isResizable;
public int	getWidth() Returns the width of the TableColumn. The default width is 75. return the width property see #setWidth return width;
public synchronized void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list. The PropertyChangeListener to be removed was registered for all properties. param listener the listener to be removed if (changeSupport != null) { changeSupport.removePropertyChangeListener(listener); }
public void	setCellEditor(javax.swing.table.TableCellEditor cellEditor) Sets the editor to used by when a cell in this column is edited. param cellEditor the new cellEditor see #getCellEditor beaninfo bound: true description: The editor to use for cell values. TableCellEditor old = this.cellEditor; this.cellEditor = cellEditor; firePropertyChange("cellEditor", old, cellEditor);
public void	setCellRenderer(javax.swing.table.TableCellRenderer cellRenderer) Sets the TableCellRenderer used by JTable to draw individual values for this column. param cellRenderer the new cellRenderer see #getCellRenderer beaninfo bound: true description: The renderer to use for cell values. TableCellRenderer old = this.cellRenderer; this.cellRenderer = cellRenderer; firePropertyChange("cellRenderer", old, cellRenderer);
public void	setHeaderRenderer(javax.swing.table.TableCellRenderer headerRenderer) 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. param headerRenderer the new headerRenderer see #getHeaderRenderer beaninfo bound: true description: The header renderer. TableCellRenderer old = this.headerRenderer; this.headerRenderer = headerRenderer; firePropertyChange("headerRenderer", old, headerRenderer);
public void	setHeaderValue(java.lang.Object headerValue) 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. param headerValue the new headerValue see #getHeaderValue beaninfo bound: true description: The text to be used by the header renderer. Object old = this.headerValue; this.headerValue = headerValue; firePropertyChange("headerValue", old, headerValue);
public void	setIdentifier(java.lang.Object identifier) 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. param identifier an identifier for this column see #getIdentifier beaninfo bound: true description: A unique identifier for this column. Object old = this.identifier; this.identifier = identifier; firePropertyChange("identifier", old, identifier);
public void	setMaxWidth(int maxWidth) 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. param maxWidth the new maximum width see #getMaxWidth see #setPreferredWidth see #setMinWidth beaninfo bound: true description: The maximum width of the column. int old = this.maxWidth; this.maxWidth = Math.max(minWidth, maxWidth); if (width > this.maxWidth) { setWidth(this.maxWidth); } if (preferredWidth > this.maxWidth) { setPreferredWidth(this.maxWidth); } firePropertyChange("maxWidth", old, this.maxWidth);
public void	setMinWidth(int minWidth) 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. param minWidth the new minimum width see #getMinWidth see #setPreferredWidth see #setMaxWidth beaninfo bound: true description: The minimum width of the column. int old = this.minWidth; this.minWidth = Math.max(Math.min(minWidth, maxWidth), 0); if (width < this.minWidth) { setWidth(this.minWidth); } if (preferredWidth < this.minWidth) { setPreferredWidth(this.minWidth); } firePropertyChange("minWidth", old, this.minWidth);
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 this TableColumn. As the TableColumn is moved around in the view the model index remains constant. param modelIndex the new modelIndex beaninfo bound: true description: The model index. int old = this.modelIndex; this.modelIndex = modelIndex; firePropertyChange("modelIndex", old, modelIndex);
public void	setPreferredWidth(int preferredWidth) 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. param preferredWidth the new preferred width see #getPreferredWidth see JTable#doLayout() beaninfo bound: true description: The preferred width of the column. int old = this.preferredWidth; this.preferredWidth = Math.min(Math.max(preferredWidth, minWidth), maxWidth); firePropertyChange("preferredWidth", old, this.preferredWidth);
public void	setResizable(boolean isResizable) Sets whether this column can be resized. param isResizable if true, resizing is allowed; otherwise false see #getResizable beaninfo bound: true description: Whether or not this column can be resized. boolean old = this.isResizable; this.isResizable = isResizable; firePropertyChange("isResizable", old, this.isResizable);
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 method sets this column's width to width. If width exceeds the minimum or maximum width, it is adjusted to the appropriate limiting value. param width the new width see #getWidth see #setMinWidth see #setMaxWidth see #setPreferredWidth see JTable#doLayout() beaninfo bound: true description: The width of the column. int old = this.width; this.width = Math.min(Math.max(width, minWidth), maxWidth); firePropertyChange("width", old, this.width);
public void	sizeWidthToFit() 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. see #setPreferredWidth if (headerRenderer == null) { return; } Component c = headerRenderer.getTableCellRendererComponent(null, getHeaderValue(), false, false, 0, 0); setMinWidth(c.getMinimumSize().width); setMaxWidth(c.getMaximumSize().width); setPreferredWidth(c.getPreferredSize().width); setWidth(getPreferredWidth());