Class JXTableHeader
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,EventListener
,Accessible
,TableColumnModelListener
,TableColumnModelExtListener
Extended user interaction
- Supports column pack (== auto-resize to exactly fit the contents) on double-click in resize region.
- Configurable to resort a column on the second click of a mouseClicked event (feature request #271-swingx)
- Does its best to not sort if the mouse click happens in the resize region.
- Supports horizontal auto-scroll if a column is dragged outside visible rectangle. This feature is enabled if the autoscrolls property is true. The default is false (because of Issue #788-swingx which still isn't fixed for jdk1.6).
Extended functionality
- Listens to TableColumn propertyChanges to update itself accordingly.
- Supports per-column header ToolTips.
- Guarantees reasonable minimal height > 0 for header preferred height.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
A MouseListener implementation to support enhanced tableHeader functionality.Nested classes/interfaces inherited from class javax.swing.table.JTableHeader
JTableHeader.AccessibleJTableHeader
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
FieldsModifier and TypeFieldDescriptionprivate MouseInputListener
private static final Logger
private boolean
private PropertyChangeListener
Fields inherited from class javax.swing.table.JTableHeader
columnModel, draggedColumn, draggedDistance, reorderingAllowed, resizingAllowed, resizingColumn, table, updateTableInRealTime
Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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
ConstructorsConstructorDescriptionConstructs aJTableHeader
with a defaultTableColumnModel
.JXTableHeader
(TableColumnModel columnModel) Constructs aJTableHeader
which is initialized withcm
as the column model. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Implements TableColumnModelExt to allow internal update after column property changes.protected PropertyChangeListener
Creates and returns the PropertyChangeListener to register on the owning table.getCellRenderer
(int columnIndex) Returns the TableCellRenderer to use for the column with the given index.protected String
getColumnToolTipText
(MouseEvent event) Returns the column tooltip of the column at the position of the MouseEvent, if a tooltip is available.Returns the the dragged column if and only if, a drag is in process and the column is visible, otherwise returnsnull
.protected int
getMinimumHeight
(int height) Returns a reasonable minimal preferred height for the header.protected Dimension
getPreferredSize
(Dimension pref) Returns a preferred size which is adjusted to the maximum of all header renderers' height requirement.boolean
Returns the resortsOnDoubleClick property.protected PropertyChangeListener
Returns the PropertyChangeListener to register on the owning table, lazily created.getToolTipText
(MouseEvent event) private int
getViewIndexForColumn
(TableColumn aColumn) Returns the (visible) view index for the table column or -1 if not visible or not contained in this header's columnModel.Returns the associated table if it is of type JXTable, or null if not.protected void
Creates and installs header listeners to service the extended functionality.protected void
Installs the table.protected boolean
isColumnEvent
(PropertyChangeEvent event) Returns a boolean indicating if a property change event received from column changes is expected to be already broadcasted by the core TableColumnModel.private boolean
isVisible
(TableColumn column) Checks and returns the column's visibility.void
setDraggedColumn
(TableColumn column) void
setDraggedDistance
(int distance) void
setResizingColumn
(TableColumn aColumn) void
setResortsOnDoubleClick
(boolean resortsOnDoubleClick) Sets the resortsOnDoubleClick property.void
protected void
Uninstalls header listeners to service the extended functionality.protected void
Uninstalls the table.protected void
Synchs the header's enabled with the table's enabled property.Methods inherited from class javax.swing.table.JTableHeader
columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, createDefaultColumnModel, createDefaultRenderer, getAccessibleContext, getColumnModel, getDefaultRenderer, getDraggedDistance, getHeaderRect, getReorderingAllowed, getResizingAllowed, getResizingColumn, getTable, getUI, getUIClassID, getUpdateTableInRealTime, initializeLocalVars, paramString, resizeAndRepaint, setColumnModel, setDefaultRenderer, setReorderingAllowed, setResizingAllowed, setUI, setUpdateTableInRealTime, updateUI
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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 inherited from 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 inherited from 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, 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, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javax.swing.event.TableColumnModelListener
columnAdded, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged
-
Field Details
-
LOG
-
tablePropertyChangeListener
-
resortsOnDoubleClick
private boolean resortsOnDoubleClick -
headerListener
-
-
Constructor Details
-
JXTableHeader
public JXTableHeader()Constructs aJTableHeader
with a defaultTableColumnModel
.- See Also:
-
JXTableHeader
Constructs aJTableHeader
which is initialized withcm
as the column model. Ifcm
isnull
this method will initialize the table header with a defaultTableColumnModel
.- Parameters:
columnModel
- the column model for the table- See Also:
-
-
Method Details
-
setTable
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 classJTableHeader
-
installTable
protected void installTable()Installs the table.This implemenation synchs enabled state and installs the PropertyChangeListener.
-
updateEnabledFromTable
protected void updateEnabledFromTable()Synchs the header's enabled with the table's enabled property. -
uninstallTable
protected void uninstallTable()Uninstalls the table.This implementation uninstalls the PropertyChangeListener.
-
columnPropertyChange
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 interfaceTableColumnModelExtListener
- Parameters:
event
- change notification from a contained TableColumn.- See Also:
-
isColumnEvent
Returns a boolean indicating if a property change event received from column changes is expected to be already broadcasted by the core TableColumnModel.This implementation returns true for notification of width, preferredWidth and visible properties, false otherwise.
- Parameters:
event
- the PropertyChangeEvent received as TableColumnModelExtListener.- Returns:
- a boolean to decide whether the same event triggers a base columnModelEvent.
-
getToolTipText
Overridden to respect the column tooltip, if available.
- Overrides:
getToolTipText
in classJTableHeader
- Returns:
- the column tooltip of the column at the mouse position if not null or super if not available.
-
getColumnToolTipText
Returns the column tooltip of the column at the position of the MouseEvent, if a tooltip is available.- Parameters:
event
- the mouseEvent representing the mouse location.- Returns:
- the column tooltip of the column below the mouse location, or null if not available.
-
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.
-
getResortsOnDoubleClick
public boolean getResortsOnDoubleClick()Returns the resortsOnDoubleClick property.- Returns:
- a flag indicating whether or not the second click in a mouseClicked event should toggle the sort order again.
- See Also:
-
setResortsOnDoubleClick
public void setResortsOnDoubleClick(boolean resortsOnDoubleClick) Sets the resortsOnDoubleClick property. If enabled, the second click of a mouseClicked event will toggle the sort order again if the column has been unsorted before. This is introduced to support feature request #271-swingx. It is effective only if the coupled table is of type JXTable and has full control about its RowSorter's properties. The default value is false.- Parameters:
resortsOnDoubleClick
- a boolean indicating whether or not the second click in a mouseClicked event should resort the column.- See Also:
-
getCellRenderer
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
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 classJTableHeader
- See Also:
-
getPreferredSize
Returns a preferred size which is adjusted to the maximum of all header renderers' height requirement.- Parameters:
pref
- an initial preferred size- Returns:
- the initial preferred size with its height property adjusted to the maximum of all renderers preferred height requirement.
- See Also:
-
getMinimumHeight
protected int getMinimumHeight(int height) Returns a reasonable minimal preferred height for the header. This is meant as a last straw if all header values are null, renderers report 0 as their preferred height.This implementation returns the default header renderer's preferred height as measured with a dummy value if the input height is 0, otherwise returns the height unchanged.
- Parameters:
height
- the initial height.- Returns:
- a reasonable minimal preferred height.
- See Also:
-
setDraggedColumn
- Overrides:
setDraggedColumn
in classJTableHeader
-
setResizingColumn
- Overrides:
setResizingColumn
in classJTableHeader
-
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 classJTableHeader
-
getDraggedColumn
Returns the the dragged column if and only if, a drag is in process and the column is visible, otherwise returnsnull
.- Overrides:
getDraggedColumn
in classJTableHeader
- Returns:
- the dragged column, if a drag is in process and the column is
visible, otherwise returns
null
- See Also:
-
isVisible
Checks and returns the column's visibility.- Parameters:
column
- theTableColumn
to check- Returns:
- a boolean indicating if the column is visible
-
getViewIndexForColumn
Returns the (visible) view index for the table column or -1 if not visible or not contained in this header's columnModel.- Parameters:
aColumn
- the TableColumn to find the view index for- Returns:
- the view index of the given table column or -1 if not visible or not contained in the column model.
-
getTablePropertyChangeListener
Returns the PropertyChangeListener to register on the owning table, lazily created.- Returns:
- the PropertyChangeListener to use on the owning table.
-
createTablePropertyChangeListener
Creates and returns the PropertyChangeListener to register on the owning table.This implementation synchs the header's enabled properties with the table's enabled.
- Returns:
- the PropertyChangeListener to register on the owning table.
-
installHeaderListener
protected void installHeaderListener()Creates and installs header listeners to service the extended functionality. This implementation creates and installs a custom mouse input listener. -
uninstallHeaderListener
protected void uninstallHeaderListener()Uninstalls header listeners to service the extended functionality. This implementation uninstalls a custom mouse input listener.
-