Module java.desktop

Package javax.swing.table

Class JTableHeader

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.table.JTableHeader

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TableColumnModelListener

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.

See Also:

• JTable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JTableHeader.AccessibleJTableHeader	This class implements accessibility support for the JTableHeader class.

Nested classes/interfaces declared in class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces declared in class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces declared in class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
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 declared in class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields declared in class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields declared in interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
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

Modifier and Type	Method	Description
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 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.
Dimension	getPreferredSize()	Returns the preferred size of the table header.
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 declared in class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods declared in class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods declared in class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible,