org.jdesktop.swingx
Class JXTableHeader

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.table.JTableHeader
                  extended by org.jdesktop.swingx.JXTableHeader
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TableColumnModelListener, org.jdesktop.swingx.event.TableColumnModelExtListener

public class JXTableHeader
extends javax.swing.table.JTableHeader
implements org.jdesktop.swingx.event.TableColumnModelExtListener

TableHeader with extended functionality if associated Table is of type JXTable.

Extended user interaction

Extended functionality

Author:
Jeanette Winzenburg
See Also:
JXTable.toggleSortOrder(int), JXTable.resetSortOrder(), JXTableHeader.SortGestureRecognizer, ColumnHeaderRenderer, Serialized Form

Nested Class Summary
static class JXTableHeader.SortGestureRecognizer
          Controller for mapping left mouse clicks to sort/-unsort gestures for use in interested mouse listeners.
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
JXTableHeader()
          Constructs a JTableHeader with a default TableColumnModel.
JXTableHeader(javax.swing.table.TableColumnModel columnModel)
          Constructs a JTableHeader which is initialized with cm as the column model.
 
Method Summary
 void columnPropertyChange(java.beans.PropertyChangeEvent event)
          Implements TableColumnModelExt to allow internal update after column property changes.
 javax.swing.table.TableCellRenderer getCellRenderer(int columnIndex)
          Returns the TableCellRenderer to use for the column with the given index.
 javax.swing.table.TableColumn getDraggedColumn()
          Returns the the dragged column if and only if, a drag is in process and the column is visible, otherwise returns null.
 java.awt.Dimension getPreferredSize()
           Overridden to adjust for a reasonable minimum height.
 JXTableHeader.SortGestureRecognizer getSortGestureRecognizer()
          Returns the SortGestureRecognizer to use.
 java.lang.String getToolTipText(java.awt.event.MouseEvent event)
           Overridden to respect the column tooltip, if available.
 JXTable getXTable()
          Returns the associated table if it is of type JXTable, or null if not.
 void setDraggedDistance(int distance)
           Overridden to scroll the table to keep the dragged column visible.
 void setSortGestureRecognizer(JXTableHeader.SortGestureRecognizer recognizer)
          Sets the SortGestureRecognizer to use for interpreting mouse events as sort gestures.
 void setTable(javax.swing.JTable table)
           Sets the associated JTable.
 void updateUI()
           Overridden to update the default renderer.
 
Methods inherited from class javax.swing.table.JTableHeader
columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, getAccessibleContext, getColumnModel, getDefaultRenderer, getDraggedDistance, getHeaderRect, getReorderingAllowed, getResizingAllowed, getResizingColumn, getTable, getUI, getUIClassID, getUpdateTableInRealTime, resizeAndRepaint, setColumnModel, setDefaultRenderer, setDraggedColumn, setReorderingAllowed, setResizingAllowed, setResizingColumn, setUI, setUpdateTableInRealTime
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.swing.event.TableColumnModelListener
columnAdded, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged
 

Constructor Detail

JXTableHeader

public JXTableHeader()
Constructs a JTableHeader with a default TableColumnModel.

See Also:
JTableHeader.createDefaultColumnModel()

JXTableHeader

public JXTableHeader(javax.swing.table.TableColumnModel columnModel)
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.

Parameters:
columnModel - the column model for the table
See Also:
JTableHeader.createDefaultColumnModel()
Method Detail

setTable

public void setTable(javax.swing.JTable table)

Sets the associated JTable. Enables enhanced header features if table is of type JXTable.

PENDING: who is responsible for synching the columnModel?

Overrides:
setTable in class javax.swing.table.JTableHeader

columnPropertyChange

public void columnPropertyChange(java.beans.PropertyChangeEvent event)
Implements TableColumnModelExt to allow internal update after column property changes.

This implementation triggers a resizeAndRepaint on every propertyChange which doesn't already fire a "normal" columnModelEvent.

Specified by:
columnPropertyChange in interface org.jdesktop.swingx.event.TableColumnModelExtListener
Parameters:
event - change notification from a contained TableColumn.
See Also:
isColumnEvent(PropertyChangeEvent), TableColumnModelExtListener

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent event)

Overridden to respect the column tooltip, if available.

Overrides:
getToolTipText in class javax.swing.table.JTableHeader
Returns:
the column tooltip of the column at the mouse position if not null or super if not available.

getXTable

public JXTable getXTable()
Returns the associated table if it is of type JXTable, or null if not.

Returns:
the associated table if of type JXTable or null if not.

getCellRenderer

public javax.swing.table.TableCellRenderer getCellRenderer(int columnIndex)
Returns the TableCellRenderer to use for the column with the given index. This implementation returns the column's header renderer if available or this header's default renderer if not.

Parameters:
columnIndex - the index in view coordinates of the column
Returns:
the renderer to use for the column, guaranteed to be not null.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overridden to adjust for a reasonable minimum height. Done to fix Issue 334-swingx, which actually is a core issue misbehaving in returning a zero height if the first column has no text.

Overrides:
getPreferredSize in class javax.swing.JComponent
See Also:
getPreferredSize(Dimension), getMinimumHeight(int).

updateUI

public void updateUI()

Overridden to update the default renderer.

Overrides:
updateUI in class javax.swing.table.JTableHeader
See Also:
preUpdateRendererUI(), postUpdateRendererUI(TableCellRenderer), ColumnHeaderRenderer

setDraggedDistance

public void setDraggedDistance(int distance)

Overridden to scroll the table to keep the dragged column visible. This side-effect is enabled only if the header's autoscroll property is true and the associated table is of type JXTable.

The autoscrolls is disabled by default. With or without - core issue #6503981 has weird effects (for jdk 1.6 - 1.6u3) on a plain JTable as well as a JXTable, fixed in 1.6u4.

Overrides:
setDraggedDistance in class javax.swing.table.JTableHeader

getDraggedColumn

public javax.swing.table.TableColumn getDraggedColumn()
Returns the the dragged column if and only if, a drag is in process and the column is visible, otherwise returns null.

Overrides:
getDraggedColumn in class javax.swing.table.JTableHeader
Returns:
the dragged column, if a drag is in process and the column is visible, otherwise returns null
See Also:
JTableHeader.getDraggedDistance()

getSortGestureRecognizer

public JXTableHeader.SortGestureRecognizer getSortGestureRecognizer()
Returns the SortGestureRecognizer to use. If none available, lazily creates a default.

Returns:
the SortGestureRecognizer to use for interpreting mouse events as sort gestures.
See Also:
setSortGestureRecognizer(SortGestureRecognizer), createSortGestureRecognizer()

setSortGestureRecognizer

public void setSortGestureRecognizer(JXTableHeader.SortGestureRecognizer recognizer)
Sets the SortGestureRecognizer to use for interpreting mouse events as sort gestures. If null, a default as returned by createSortGestureRecognizer is used.

This is a bound property.

Parameters:
recognizer - the SortGestureRecognizer to use for interpreting mouse events as sort gestures
See Also:
getSortGestureRecognizer(), createSortGestureRecognizer()