java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.table.JTableHeader
public class JTableHeader
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 TM has been added to the java.beans package. Please see XMLEncoder .
Nested Class Summary | |
---|---|
protected class |
JTableHeader.AccessibleJTableHeader
This class implements accessibility support for the JTableHeader class. |
Nested classes/interfaces inherited from class javax.swing. JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt. Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt. Component |
---|
Component.AccessibleAWTComponent , Component.BaselineResizeBehavior , Component.BltBufferStrategy , Component.FlipBufferStrategy |
Field Summary | |
---|---|
protected TableColumnModel |
columnModel
The TableColumnModel of the table header. |
protected TableColumn |
draggedColumn
The index of the column being dragged. |
protected int |
draggedDistance
The distance from its original position the column has been dragged. |
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 TableColumn |
resizingColumn
The index of the column being resized. |
protected JTable |
table
The table for which this object is the header; the default is null. |
protected boolean |
updateTableInRealTime
Obsolete as of Java 2 platform v1.3. |
Fields inherited from class javax.swing. JComponent |
---|
accessibleContext , listenerList , TOOL_TIP_TEXT_KEY , ui , UNDEFINED_CONDITION , WHEN_ANCESTOR_OF_FOCUSED_COMPONENT , WHEN_FOCUSED , WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt. Component |
---|
BOTTOM_ALIGNMENT , CENTER_ALIGNMENT , LEFT_ALIGNMENT , RIGHT_ALIGNMENT , TOP_ALIGNMENT |
Fields inherited from interface java.awt.image. ImageObserver |
---|
ABORT , ALLBITS , ERROR , FRAMEBITS , HEIGHT , PROPERTIES , SOMEBITS , WIDTH |
Constructor Summary | |
---|---|
JTableHeader
() Constructs a JTableHeader with a default TableColumnModel. |
|
JTableHeader
(
TableColumnModel
cm) Constructs a JTableHeader which is initialized with cm as the column model. |
Method Summary | |
---|---|
void |
columnAdded
(
TableColumnModelEvent
e) Invoked when a column is added to the table column model. |
int |
columnAtPoint
(
Point
point) Returns the index of the column that point lies in, or -1 if it lies out of bounds. |
void |
columnMarginChanged
(
ChangeEvent
e) Invoked when a column is moved due to a margin change. |
void |
columnMoved
(
TableColumnModelEvent
e) Invoked when a column is repositioned. |
void |
columnRemoved
(
TableColumnModelEvent
e) Invoked when a column is removed from the table column model. |
void |
columnSelectionChanged
(
ListSelectionEvent
e) Invoked when the selection model of the TableColumnModel is changed. |
protected TableColumnModel |
createDefaultColumnModel
() Returns the default column model object which is a DefaultTableColumnModel. |
protected TableCellRenderer |
createDefaultRenderer
() Returns a default renderer to be used when no header renderer is defined by a TableColumn. |
AccessibleContext |
getAccessibleContext
() Gets the AccessibleContext associated with this JTableHeader. |
TableColumnModel |
getColumnModel
() Returns the TableColumnModel that contains all column information of this table header. |
TableCellRenderer |
getDefaultRenderer
() Returns the default renderer used when no headerRenderer is defined by a TableColumn. |
TableColumn |
getDraggedColumn
() Returns the the dragged column, if and only if, a drag is in process, otherwise returns null. |
int |
getDraggedDistance
() Returns the column's horizontal distance from its original position, if and only if, a drag is in process. |
Rectangle |
getHeaderRect
(int column) Returns the rectangle containing the header tile at column. |
boolean |
getReorderingAllowed
() Returns true if the user is allowed to rearrange columns by dragging their headers, false otherwise. |
boolean |
getResizingAllowed
() Returns true if the user is allowed to resize columns by dragging between their headers, false otherwise. |
TableColumn |
getResizingColumn
() Returns the resizing column. |
JTable |
getTable
() Returns the table associated with this header. |
String |
getToolTipText
(
MouseEvent
event) Allows the renderer's tips to be used if there is text set. |
TableHeaderUI |
getUI
() Returns the look and feel (L&F) object that renders this component. |
String |
getUIClassID
() Returns the suffix used to construct the name of the look and feel (L&F) class used to render this component. |
boolean |
getUpdateTableInRealTime
() Obsolete as of Java 2 platform v1.3. |
protected void |
initializeLocalVars
() Initializes the local variables and properties with default values. |
protected String |
paramString
() Returns a string representation of this JTableHeader. |
void |
resizeAndRepaint
() Sizes the header and marks it as needing display. |
void |
setColumnModel
(
TableColumnModel
columnModel) Sets the column model for this table to newModel and registers for listener notifications from the new column model. |
void |
setDefaultRenderer
(
TableCellRenderer
defaultRenderer) Sets the default renderer to be used when no headerRenderer is defined by a TableColumn. |
void |
setDraggedColumn
(
TableColumn
aColumn) Sets the header's draggedColumn to aColumn. |
void |
setDraggedDistance
(int distance) Sets the header's draggedDistance to distance. |
void |
setReorderingAllowed
(boolean reorderingAllowed) Sets whether the user can drag column headers to reorder columns. |
void |
setResizingAllowed
(boolean resizingAllowed) Sets whether the user can resize columns by dragging between headers. |
void |
setResizingColumn
(
TableColumn
aColumn) Sets the header's resizingColumn to aColumn. |
void |
setTable
(
JTable
table) Sets the table associated with this header. |
void |
setUI
(
TableHeaderUI
ui) Sets the look and feel (L&F) object that renders this component. |
void |
setUpdateTableInRealTime
(boolean flag) Obsolete as of Java 2 platform v1.3. |
void |
updateUI
() Notification from the UIManager that the look and feel (L&F) has changed. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait |
Field Detail |
---|
protected JTable table
protected TableColumnModel columnModel
protected boolean reorderingAllowed
protected boolean resizingAllowed
protected boolean updateTableInRealTime
protected transient TableColumn resizingColumn
protected transient TableColumn draggedColumn
protected transient int draggedDistance
Constructor Detail |
---|
public JTableHeader()
public JTableHeader(TableColumnModel cm)
Method Detail |
---|
public void setTable(JTable table)
public JTable getTable()
public void setReorderingAllowed(boolean reorderingAllowed)
public boolean getReorderingAllowed()
public void setResizingAllowed(boolean resizingAllowed)
public boolean getResizingAllowed()
public TableColumn getDraggedColumn()
public int getDraggedDistance()
public TableColumn getResizingColumn()
public void setUpdateTableInRealTime(boolean flag)
public boolean getUpdateTableInRealTime()
public void setDefaultRenderer(TableCellRenderer defaultRenderer)
public TableCellRenderer getDefaultRenderer()
public int columnAtPoint(Point point)
public Rectangle getHeaderRect(int column)
public String getToolTipText(MouseEvent event)
public TableHeaderUI getUI()
public void setUI(TableHeaderUI ui)
public void updateUI()
public String getUIClassID()
public void setColumnModel(TableColumnModel columnModel)
public TableColumnModel getColumnModel()
public void columnAdded(TableColumnModelEvent e)
Application code will not use these methods explicitly, they are used internally by JTable.
public void columnRemoved(TableColumnModelEvent e)
Application code will not use these methods explicitly, they are used internally by JTable.
public void columnMoved(TableColumnModelEvent e)
Application code will not use these methods explicitly, they are used internally by JTable.
public void columnMarginChanged(ChangeEvent e)
Application code will not use these methods explicitly, they are used internally by JTable.
public void columnSelectionChanged(ListSelectionEvent e)
Application code will not use these methods explicitly, they are used internally by JTable.
protected TableColumnModel createDefaultColumnModel()
protected TableCellRenderer createDefaultRenderer()
protected void initializeLocalVars()
public void resizeAndRepaint()
public void setDraggedColumn(TableColumn aColumn)
Application code will not use this method explicitly, it is used internally by the column dragging mechanism.
public void setDraggedDistance(int distance)
public void setResizingColumn(TableColumn aColumn)
Application code will not use this method explicitly, it is used internally by the column sizing mechanism.
protected String paramString()
Overriding paramString to provide information about the specific new aspects of the JFC components.
public AccessibleContext getAccessibleContext()