JavaFX 25 · javafx.scene.control.skin.TableHeaderRow

Modifier and Type	Field and Description
private Rectangle	clip
pack-priv boolean	columnDragLock There are two different mouse dragged event handlers in the header code.
private Map<TableColumnBase<S, T>, CheckMenuItem>	columnMenuItems
private ContextMenu	columnPopupMenu PopupMenu shown to users to allow for them to hide/show columns in the table.
private final InvalidationListener	columnTextListener
pack-priv final DoubleProperty	cornerPadding
private final ChangeListener<Boolean>	cornerPaddingListener
private Pane	cornerRegion This is the region where the user can interact with to show/hide columns.
private StackPane	dragHeader This is the ghosted region representing the table column that is being dragged.
private final Label	dragHeaderLabel
private Region	filler
private final VirtualFlow<T extends IndexedCell<T>>	flow
private final String	MENU_SEPARATOR
private BooleanProperty	reordering Indicates if a reordering operation of a column is in progress.
private TableColumnHeader	reorderingRegion
private ReadOnlyObjectWrapper<NestedTableColumnHeader>	rootHeader
private double	scrollX
private final ListChangeListener<E>	tableColumnsListener
private InvalidationListener	tablePaddingListener
pack-priv final TableViewSkinBase<?, ?, ?, ?, ?>	tableSkin
private double	tableWidth
private InvalidationListener	tableWidthListener
private InvalidationListener	visibleColumnListener
private ListChangeListener<E>	visibleLeafColumnsListener
private final WeakInvalidationListener	weakColumnTextListener
private final WeakChangeListener<Boolean>	weakCornerPaddingListener
private final WeakListChangeListener<E>	weakTableColumnsListener
private final WeakInvalidationListener	weakTablePaddingListener
private final WeakInvalidationListener	weakTableWidthListener
private final WeakInvalidationListener	weakVisibleColumnListener
private final WeakListChangeListener<E>	weakVisibleLeafColumnsListener

Access	Constructor and Description
public	TableHeaderRow(final TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> The skin used by the UI control. skin) Creates a new TableHeaderRow instance to visually represent the column header area of controls such as `javafx.scene.control.TableView` and `javafx.scene.control.TreeTableView`.

Method Summary

Modifier and Type	Method and Description
protected double	computeMinHeight(double width) Overrides javafx.scene.layout.StackPane.computeMinHeight. Computes the minimum height of this region.
protected double	computePrefHeight(double width) Overrides javafx.scene.layout.StackPane.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double height) Overrides javafx.scene.layout.StackPane.computePrefWidth. Computes the preferred width of this region for the given height.
private void	createMenuItem(TableColumnBase<?, ?> col)
protected NestedTableColumnHeader	Returns: A new NestedTableColumnHeader instance. createRootHeader() Creates a new NestedTableColumnHeader instance.
pack-priv TableColumnHeader	getColumnHeaderFor(final TableColumnBase<?, ?> col)
private TableColumnHeader	getColumnHeaderFor(final TableColumnBase<?, ?> col, TableColumnHeader currentHeader)
pack-priv ContextMenu	getColumnPopupMenu()
pack-priv Pane	getCornerRegion()
private List<TableColumnBase<?, ?>>	getLeafColumns(TableColumnBase<?, ?> col)
protected TableColumnHeader	Returns: the current `TableColumnHeader` being moved getReorderingRegion() Returns the current `TableColumnHeader` being moved during reordering.
public final NestedTableColumnHeader	Returns: the root header getRootHeader() Returns the root header for all columns.
private String	getText(String text, TableColumnBase<S, T> col)
private boolean	isColumnVisibleInHeader(TableColumnBase<S, T> col, List<E> columns)
public final boolean	isReordering()
protected void	layoutChildren() Overrides javafx.scene.layout.StackPane.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
private void	rebuildColumnMenu()
private void	remove(TableColumnBase<?, ?> col)
public final BooleanProperty	reorderingProperty()
private final ReadOnlyObjectProperty<NestedTableColumnHeader>	rootHeaderProperty()
pack-priv void	setDragHeaderX(double dragHeaderX)
public final void	setReordering(boolean value)
pack-priv void	setReorderingColumn(TableColumnBase<S, T> rc)
protected void	setReorderingRegion(TableColumnHeader the `TableColumnHeader` being reordered reorderingRegion) Sets the `TableColumnHeader` that is being moved during a reordering operation.
private final void	setRootHeader(NestedTableColumnHeader value)
protected void	showColumnMenu(MouseEvent the `MouseEvent` which was generated when the table menu button was pressed mouseEvent) Shows a menu containing all leaf columns as items.
private void	updateCornerPadding()
protected void	updateScrollX() Called whenever the value of the horizontal scrollbar changes in order to request layout changes, shifting the `TableColumnHeader`s.
private void	updateTableColumnListeners(List<? extends TableColumnBase<?, ?>> added, List<? extends TableColumnBase<?, ?>> removed)
protected void	updateTableWidth() Updates the table width when a resize operation occurs.

Inherited from javafx.scene.layout.StackPane:: alignmentProperty clearConstraints computeMinWidth getAlignment getAlignment getClassCssMetaData getContentBias getCssMetaData getMargin requestLayout setAlignment setAlignment setMargin

Field Detail

clip	back to summary
private Rectangle clip

columnDragLock	back to summary
pack-priv boolean columnDragLock There are two different mouse dragged event handlers in the header code. Firstly, the column reordering functionality, and secondly, the column resizing functionality. Because these are handled in separate classes and with separate event handlers, we occasionally run into the issue where both event handlers were being called, resulting in bad UX. To remove this issue, we lock when the column dragging happens, and prevent resize operations from taking place.

columnDragLock

back to summary

pack-priv boolean columnDragLock

There are two different mouse dragged event handlers in the header code. Firstly, the column reordering functionality, and secondly, the column resizing functionality. Because these are handled in separate classes and with separate event handlers, we occasionally run into the issue where both event handlers were being called, resulting in bad UX. To remove this issue, we lock when the column dragging happens, and prevent resize operations from taking place.

columnMenuItems	back to summary
private Map<TableColumnBase<S, T>, CheckMenuItem> columnMenuItems

columnPopupMenu	back to summary
private ContextMenu columnPopupMenu PopupMenu shown to users to allow for them to hide/show columns in the table.

columnTextListener	back to summary
private final InvalidationListener columnTextListener

cornerPadding	back to summary
pack-priv final DoubleProperty cornerPadding

cornerPaddingListener	back to summary
private final ChangeListener<Boolean> cornerPaddingListener

cornerRegion	back to summary
private Pane cornerRegion This is the region where the user can interact with to show/hide columns. It is positioned in the top-right hand corner of the TableHeaderRow, and when clicked shows a PopupMenu consisting of all leaf columns.

dragHeader	back to summary
private StackPane dragHeader This is the ghosted region representing the table column that is being dragged. It moves along the x-axis but is fixed in the y-axis.

dragHeaderLabel	back to summary
private final Label dragHeaderLabel

filler	back to summary
private Region filler

flow	back to summary
private final VirtualFlow<T extends IndexedCell<T>> flow

MENU_SEPARATOR	back to summary
private final String MENU_SEPARATOR

reordering back to summary

reordering	back to summary
private BooleanProperty reordering Indicates if a reordering operation of a column is in progress. The value is `true` during a column reordering operation, and `false` otherwise. When a column is reordered (for example, by dragging its header), this property is updated automatically. Setting the value manually should be done when a subclass overrides the default reordering behavior. Calling `setReorderingRegion(TableColumnHeader)` before setting this property is required as well. Since 12

private BooleanProperty reordering

Indicates if a reordering operation of a column is in progress. The value is true during a column reordering operation, and false otherwise. When a column is reordered (for example, by dragging its header), this property is updated automatically. Setting the value manually should be done when a subclass overrides the default reordering behavior. Calling setReorderingRegion(TableColumnHeader) before setting this property is required as well.

Since: 12

reorderingRegion	back to summary
private TableColumnHeader reorderingRegion

rootHeader	back to summary
private ReadOnlyObjectWrapper<NestedTableColumnHeader> rootHeader

scrollX	back to summary
private double scrollX

tableColumnsListener	back to summary
private final ListChangeListener<E> tableColumnsListener

tablePaddingListener	back to summary
private InvalidationListener tablePaddingListener

tableSkin	back to summary
pack-priv final TableViewSkinBase<?, ?, ?, ?, ?> tableSkin

tableWidth	back to summary
private double tableWidth

tableWidthListener	back to summary
private InvalidationListener tableWidthListener

visibleColumnListener	back to summary
private InvalidationListener visibleColumnListener

visibleLeafColumnsListener	back to summary
private ListChangeListener<E> visibleLeafColumnsListener

weakColumnTextListener	back to summary
private final WeakInvalidationListener weakColumnTextListener

weakCornerPaddingListener	back to summary
private final WeakChangeListener<Boolean> weakCornerPaddingListener

weakTableColumnsListener	back to summary
private final WeakListChangeListener<E> weakTableColumnsListener

weakTablePaddingListener	back to summary
private final WeakInvalidationListener weakTablePaddingListener

weakTableWidthListener	back to summary
private final WeakInvalidationListener weakTableWidthListener

weakVisibleColumnListener	back to summary
private final WeakInvalidationListener weakVisibleColumnListener

weakVisibleLeafColumnsListener	back to summary
private final WeakListChangeListener<E> weakVisibleLeafColumnsListener

Constructor Detail

TableHeaderRow back to summary

TableHeaderRow	back to summary
public TableHeaderRow(final TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> skin) Creates a new TableHeaderRow instance to visually represent the column header area of controls such as `javafx.scene.control.TableView` and `javafx.scene.control.TreeTableView`. Parameters skin:TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> The skin used by the UI control.

public TableHeaderRow(final TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> skin)

Creates a new TableHeaderRow instance to visually represent the column header area of controls such as javafx.scene.control.TableView and javafx.scene.control.TreeTableView.

Parameters

skin:TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>>: The skin used by the UI control.

Method Detail

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.StackPane.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.StackPane.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.StackPane.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.StackPane.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.StackPane.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.StackPane.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

createMenuItem	back to summary
private void createMenuItem(TableColumnBase<?, ?> col)

createRootHeader	back to summary
protected NestedTableColumnHeader createRootHeader() Creates a new NestedTableColumnHeader instance. By default this method should not be overridden, but in some circumstances it makes sense (e.g. testing, or when extreme customization is desired). Returns:NestedTableColumnHeader A new NestedTableColumnHeader instance.

createRootHeader

back to summary

protected NestedTableColumnHeader createRootHeader()

Creates a new NestedTableColumnHeader instance. By default this method should not be overridden, but in some circumstances it makes sense (e.g. testing, or when extreme customization is desired).

Returns:NestedTableColumnHeader: A new NestedTableColumnHeader instance.

getColumnHeaderFor	back to summary
pack-priv TableColumnHeader getColumnHeaderFor(final TableColumnBase<?, ?> col)

getColumnHeaderFor	back to summary
private TableColumnHeader getColumnHeaderFor(final TableColumnBase<?, ?> col, TableColumnHeader currentHeader)

getColumnPopupMenu	back to summary
pack-priv ContextMenu getColumnPopupMenu()

getCornerRegion	back to summary
pack-priv Pane getCornerRegion()

getLeafColumns	back to summary
private List<TableColumnBase<?, ?>> getLeafColumns(TableColumnBase<?, ?> col)

getReorderingRegion back to summary

getReorderingRegion	back to summary
protected TableColumnHeader getReorderingRegion() Returns the current `TableColumnHeader` being moved during reordering. Returns:TableColumnHeader the current `TableColumnHeader` being moved Since 12

protected TableColumnHeader getReorderingRegion()

Returns the current TableColumnHeader being moved during reordering.

Returns:TableColumnHeader: the current TableColumnHeader being moved
Since: 12

getRootHeader back to summary

getRootHeader	back to summary
public final NestedTableColumnHeader getRootHeader() Returns the root header for all columns. The root header is a `NestedTableColumnHeader` that contains the `NestedTableColumnHeader`s that represent each column. It spans the entire width of the `TableView`. This allows any developer overriding a `TableColumnHeader` to easily access the root header and all others `TableColumnHeader`s. Implementation Note This design enforces that column reordering occurs only within a single `NestedTableColumnHeader` and only at that level. Returns:NestedTableColumnHeader the root header Since 12

public final NestedTableColumnHeader getRootHeader()

Returns the root header for all columns. The root header is a NestedTableColumnHeader that contains the NestedTableColumnHeaders that represent each column. It spans the entire width of the TableView. This allows any developer overriding a TableColumnHeader to easily access the root header and all others TableColumnHeaders.

Implementation Note

This design enforces that column reordering occurs only within a single NestedTableColumnHeader and only at that level.

Returns:NestedTableColumnHeader: the root header
Since: 12

getText	back to summary
private String getText(String text, TableColumnBase<S, T> col)

isColumnVisibleInHeader	back to summary
private boolean isColumnVisibleInHeader(TableColumnBase<S, T> col, List<E> columns)

isReordering	back to summary
public final boolean isReordering()

layoutChildren back to summary

protected void layoutChildren()

Overrides javafx.scene.layout.StackPane.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

rebuildColumnMenu	back to summary
private void rebuildColumnMenu()

remove	back to summary
private void remove(TableColumnBase<?, ?> col)

reorderingProperty	back to summary
public final BooleanProperty reorderingProperty()

rootHeaderProperty	back to summary
private final ReadOnlyObjectProperty<NestedTableColumnHeader> rootHeaderProperty()

setDragHeaderX	back to summary
pack-priv void setDragHeaderX(double dragHeaderX)

setReordering	back to summary
public final void setReordering(boolean value)

setReorderingColumn	back to summary
pack-priv void setReorderingColumn(TableColumnBase<S, T> rc)

setReorderingRegion back to summary

protected void setReorderingRegion(TableColumnHeader reorderingRegion)

Sets the TableColumnHeader that is being moved during a reordering operation. This is automatically set by the TableColumnHeader when reordering starts. This method should only be called manually if the default reordering behavior is overridden. Calling setReordering(boolean) after the call is required.

Parameters

reorderingRegion:TableColumnHeader: the TableColumnHeader being reordered

Since

setRootHeader	back to summary
private final void setRootHeader(NestedTableColumnHeader value)

showColumnMenu back to summary

protected void showColumnMenu(MouseEvent mouseEvent)

Shows a menu containing all leaf columns as items. An item can be selected/deselected to make the corresponding column visible/invisible.

Implementation Note

This method can be overridden to create and show a custom menu.

Parameters

mouseEvent:MouseEvent: the MouseEvent which was generated when the table menu button was pressed

Since

updateCornerPadding	back to summary
private void updateCornerPadding()

updateScrollX back to summary

protected void updateScrollX()

Called whenever the value of the horizontal scrollbar changes in order to request layout changes, shifting the TableColumnHeaders.

For example, if custom components are added around a TableColumnHeader (such as icons above), they will also need to be shifted. When overriding, calling super() is required to shift the TableColumnHeaders, and it's up to the developer to notify its own custom components of this change.

Since: 12

updateTableColumnListeners	back to summary
private void updateTableColumnListeners(List<? extends TableColumnBase<?, ?>> added, List<? extends TableColumnBase<?, ?>> removed)

updateTableWidth back to summary

protected void updateTableWidth()

Updates the table width when a resize operation occurs. This method is called continuously when the control width is resizing in order to properly clip this TableHeaderRow. Overriding this method allows a subclass to customize the resizing behavior.

Normally, the TableHeaderRow is using the full space (TableView width), but in some cases that space may be reduced. For example, if a vertical header that will display the row number is introduced, the TableHeaderRow would need to be clipped a bit shorter in order not to overlap that vertical header. Calling super() first when overriding this method allows getClip() to compute the right width in order apply a transformation.

Since: 12

public Class TableHeaderRow

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail