public class JTableHeader extends JComponent implements TableColumnModelListener, Accessible
This is the object which manages the header of the JTable.
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.
JTable| Modifier and Type | Class and Description |
|---|---|
protected class |
JTableHeader.AccessibleJTableHeader This class implements accessibility support for the |
JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy protected JTable table
The table for which this object is the header; the default is null.
protected TableColumnModel columnModel
The TableColumnModel of the table header.
protected boolean reorderingAllowed
If true, reordering of columns are allowed by the user; the default is true.
protected boolean resizingAllowed
If true, resizing of columns are allowed by the user; the default is true.
protected boolean updateTableInRealTime
Obsolete as of Java 2 platform v1.3. Real time repaints, in response to column dragging or resizing, are now unconditional.
protected transient TableColumn resizingColumn
The index of the column being resized. null if not resizing.
protected transient TableColumn draggedColumn
The index of the column being dragged. null if not dragging.
protected transient int draggedDistance
The distance from its original position the column has been dragged.
public JTableHeader()
Constructs a JTableHeader with a default TableColumnModel.
createDefaultColumnModel()public JTableHeader(TableColumnModel cm)
Constructs a JTableHeader which is initialized with cm as the column model. If cm is null this method will initialize the table header with a default TableColumnModel.
cm - the column model for the tablecreateDefaultColumnModel()public void setTable(JTable table)
Sets the table associated with this header.
table - the new tablepublic JTable getTable()
Returns the table associated with this header.
table propertypublic void setReorderingAllowed(boolean reorderingAllowed)
Sets whether the user can drag column headers to reorder columns.
reorderingAllowed - true if the table view should allow reordering; otherwise falsegetReorderingAllowed()public boolean getReorderingAllowed()
Returns true if the user is allowed to rearrange columns by dragging their headers, false otherwise. The default is true. You can rearrange columns programmatically regardless of this setting.
reorderingAllowed propertysetReorderingAllowed(boolean)public void setResizingAllowed(boolean resizingAllowed)
Sets whether the user can resize columns by dragging between headers.
resizingAllowed - true if table view should allow resizinggetResizingAllowed()public boolean getResizingAllowed()
Returns true if the user is allowed to resize columns by dragging between their headers, false otherwise. The default is true. You can resize columns programmatically regardless of this setting.
resizingAllowed propertysetResizingAllowed(boolean)public TableColumn getDraggedColumn()
Returns the the dragged column, if and only if, a drag is in process, otherwise returns null.
null
getDraggedDistance()public int getDraggedDistance()
Returns the column's horizontal distance from its original position, if and only if, a drag is in process. Otherwise, the the return value is meaningless.
getDraggedColumn()public TableColumn getResizingColumn()
Returns the resizing column. If no column is being resized this method returns null.
null
public void setUpdateTableInRealTime(boolean flag)
Obsolete as of Java 2 platform v1.3. Real time repaints, in response to column dragging or resizing, are now unconditional.
public boolean getUpdateTableInRealTime()
Obsolete as of Java 2 platform v1.3. Real time repaints, in response to column dragging or resizing, are now unconditional.
public void setDefaultRenderer(TableCellRenderer defaultRenderer)
Sets the default renderer to be used when no headerRenderer is defined by a TableColumn.
defaultRenderer - the default rendererpublic TableCellRenderer getDefaultRenderer()
Returns the default renderer used when no headerRenderer is defined by a TableColumn.
public int columnAtPoint(Point point)
Returns the index of the column that point lies in, or -1 if it lies out of bounds.
point lies in, or -1 if it lies out of boundspublic Rectangle getHeaderRect(int column)
Returns the rectangle containing the header tile at column. When the column parameter is out of bounds this method uses the same conventions as the JTable method getCellRect.
column
JTable.getCellRect(int, int, boolean)public String getToolTipText(MouseEvent event)
Allows the renderer's tips to be used if there is text set.
getToolTipText in class JComponent
event - the location of the event identifies the proper renderer and, therefore, the proper tippublic TableHeaderUI getUI()
Returns the look and feel (L&F) object that renders this component.
TableHeaderUI object that renders this componentpublic void setUI(TableHeaderUI ui)
Sets the look and feel (L&F) object that renders this component.
ui - the TableHeaderUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public void updateUI()
Notification from the UIManager that the look and feel (L&F) has changed. Replaces the current UI object with the latest version from the UIManager.
updateUI in class JComponent
JComponent.updateUI()public String getUIClassID()
Returns the suffix used to construct the name of the look and feel (L&F) class used to render this component.
getUIClassID in class JComponent
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)
public void setColumnModel(TableColumnModel columnModel)
Sets the column model for this table to newModel and registers for listener notifications from the new column model.
columnModel - the new data source for this tableIllegalArgumentException - if newModel is null
getColumnModel()public TableColumnModel getColumnModel()
Returns the TableColumnModel that contains all column information of this table header.
columnModel propertysetColumnModel(javax.swing.table.TableColumnModel)public void columnAdded(TableColumnModelEvent e)
Invoked when a column is added to the table column model.
Application code will not use these methods explicitly, they are used internally by JTable.
columnAdded in interface TableColumnModelListener
e - the event receivedTableColumnModelListenerpublic void columnRemoved(TableColumnModelEvent e)
Invoked when a column is removed from the table column model.
Application code will not use these methods explicitly, they are used internally by JTable.
columnRemoved in interface TableColumnModelListener
e - the event receivedTableColumnModelListenerpublic void columnMoved(TableColumnModelEvent e)
Invoked when a column is repositioned.
Application code will not use these methods explicitly, they are used internally by JTable.
columnMoved in interface TableColumnModelListener
e - the event receivedTableColumnModelListenerpublic void columnMarginChanged(ChangeEvent e)
Invoked when a column is moved due to a margin change.
Application code will not use these methods explicitly, they are used internally by JTable.
columnMarginChanged in interface TableColumnModelListener
e - the event receivedTableColumnModelListenerpublic void columnSelectionChanged(ListSelectionEvent e)
Invoked when the selection model of the TableColumnModel is changed. This method currently has no effect (the header is not redrawn).
Application code will not use these methods explicitly, they are used internally by JTable.
columnSelectionChanged in interface TableColumnModelListener
e - the event receivedTableColumnModelListenerprotected TableColumnModel createDefaultColumnModel()
Returns the default column model object which is a DefaultTableColumnModel. A subclass can override this method to return a different column model object
protected TableCellRenderer createDefaultRenderer()
Returns a default renderer to be used when no header renderer is defined by a TableColumn.
protected void initializeLocalVars()
Initializes the local variables and properties with default values. Used by the constructor methods.
public void resizeAndRepaint()
Sizes the header and marks it as needing display. Equivalent to revalidate followed by repaint.
public void setDraggedColumn(TableColumn aColumn)
Sets the header's draggedColumn to aColumn.
Application code will not use this method explicitly, it is used internally by the column dragging mechanism.
aColumn - the column being dragged, or null if no column is being draggedpublic void setDraggedDistance(int distance)
Sets the header's draggedDistance to distance.
distance - the distance draggedpublic void setResizingColumn(TableColumn aColumn)
Sets the header's resizingColumn to aColumn.
Application code will not use this method explicitly, it is used internally by the column sizing mechanism.
aColumn - the column being resized, or null if no column is being resizedprotected String paramString()
Returns a string representation of this JTableHeader. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
Overriding paramString to provide information about the specific new aspects of the JFC components.
paramString in class JComponent
JTableHeader
public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JTableHeader. For JTableHeaders, the AccessibleContext takes the form of an AccessibleJTableHeader. A new AccessibleJTableHeader instance is created if necessary.
getAccessibleContext in interface Accessible
getAccessibleContext in class Component
© 1993–2017, 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.