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

Modifier and Type	Class and Description
private static class	TableColumnHeader.StyleableProperties

Modifier and Type	Field and Description
private Region	arrow
private boolean	autoSizeComplete
pack-priv final LambdaMultiplePropertyChangeListenerHandler	changeListenerHandler
pack-priv int	columnIndex
pack-priv Region	columnReorderLine
private static final EventHandler<ContextMenuEvent>	contextMenuRequestedHandler
pack-priv static final double	DEFAULT_COLUMN_WIDTH
pack-priv static final String	DEFAULT_STYLE_CLASS
private double	dragOffset
pack-priv boolean	isLastVisibleColumn
private boolean	isSizeDirty
private boolean	isSortColumn
pack-priv Label	label
private static final EventHandler<MouseEvent>	mouseDraggedHandler
private static final EventHandler<MouseEvent>	mousePressedHandler
private static final EventHandler<MouseEvent>	mouseReleasedHandler
private NestedTableColumnHeader	nestedColumnHeader
private int	newColumnPos
private NestedTableColumnHeader	parentHeader
private static boolean	popupTriggeredOnMousePressed
private static final PseudoClass	PSEUDO_CLASS_LAST_VISIBLE
private DoubleProperty	size
private Node	sortArrow
private HBox	sortOrderDots
private Label	sortOrderLabel
private ListChangeListener<TableColumnBase<?, ?>>	sortOrderListener
pack-priv int	sortPos
private ListChangeListener<String>	styleClassListener
private ReadOnlyObjectWrapper<TableColumnBase<?, ?>>	tableColumn A property that refers to the `TableColumnBase` instance that this header is visually represents.
private TableHeaderRow	tableHeaderRow
private ListChangeListener<TableColumnBase<?, ?>>	visibleLeafColumnsListener
private WeakListChangeListener<TableColumnBase<?, ?>>	weakSortOrderListener
private final WeakListChangeListener<String>	weakStyleClassListener
private final WeakListChangeListener<TableColumnBase<?, ?>>	weakVisibleLeafColumnsListener

Access	Constructor and Description
public	TableColumnHeader(final TableColumnBase<S, T> The table column to be visually represented by this instance. tc) Creates a new TableColumnHeader instance to visually represent the given `TableColumnBase` instance.

Method Summary

Modifier and Type	Method and Description
pack-priv void	columnReordering(double sceneX, double sceneY)
pack-priv void	columnReorderingComplete()
pack-priv void	columnReorderingStarted(double dragOffset)
protected double	computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computePrefHeight(double width) Overrides 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.
protected double	computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
private <T> TableRow<T>	createMeasureRow(TableView<T> tv, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, Callback<TableView<T>, TableRow<T>> rowFactory)
private <T> TreeTableRow<T>	createMeasureRow(TreeTableView<T> ttv, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, Callback<TreeTableView<T>, TreeTableRow<T>> rowFactory)
pack-priv void	dispose()
private void	doColumnAutoSize(int cellsToMeasure)
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
private ObservableList<TableColumnBase<?, ?>>	getColumns(TableColumnBase<S, T> column)
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
pack-priv double	getDragRectHeight()
private int	getIndex(TableColumnBase<?, ?> column)
pack-priv NestedTableColumnHeader	getNestedColumnHeader()
pack-priv NestedTableColumnHeader	getParentHeader()
private final double	getSize()
private int	getSortPosition()
public final TableColumnBase<?, ?>	getTableColumn()
protected TableHeaderRow	Returns: the `TableHeaderRow` associated with this `TableColumnHeader` getTableHeaderRow() Returns the `TableHeaderRow` associated with this `TableColumnHeader`.
protected TableViewSkinBase<?, ?, ?, ?, ?>	Returns: the `TableViewSkinBase` in which this `TableColumnHeader` is inserted, or `null` getTableSkin() Returns the `TableViewSkinBase` in which this `TableColumnHeader` is inserted.
private int	getVisibleSortOrderColumnCount()
private List<TableColumnBase<S, T>>	getVisibleSortOrderColumns()
pack-priv void	initStyleClasses()
private void	initUI()
pack-priv void	installTableColumnStyleClassListener()
private boolean	isColumnReorderingEnabled()
private boolean	isSortingEnabled()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
pack-priv void	moveColumn(TableColumnBase<S, T> column, final int newColumnPos)
public Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.Parent.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
pack-priv boolean	represents(TableColumnBase<?, ?> column)
protected void	resizeColumnToFitContent(int the number of rows considered when resizing. If -1 is given, all rows are considered. maxRows) Resizes this `TableColumnHeader`'s column to fit the width of its content.
private <T, S> void	resizeColumnToFitContent(TableView<T> tv, TableColumn<T, S> tc, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, int maxRows)
private <T, S> void	resizeColumnToFitContent(TreeTableView<T> ttv, TreeTableColumn<T, S> tc, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, int maxRows)
pack-priv void	setNestedColumnHeader(NestedTableColumnHeader nch)
pack-priv void	setParentHeader(NestedTableColumnHeader ph)
private final void	setTableColumn(TableColumnBase<?, ?> column)
pack-priv void	setTableHeaderRow(TableHeaderRow thr)
private final DoubleProperty	sizeProperty()
private void	sortColumn(final boolean addColumn)
public final ReadOnlyObjectProperty<TableColumnBase<?, ?>>	tableColumnProperty()
private void	updateAllHeaders(TableColumnHeader header)
private void	updateColumnIndex()
private void	updateScene()
private void	updateSortGrid()
private void	updateSortOrderDots(int sortPos)
private void	updateSortPosition()
private void	updateTableSkin()

Inherited from javafx.scene.layout.Region:: backgroundProperty borderProperty cacheShapeProperty centerShapeProperty computeMaxHeight computeMaxWidth computeMinWidth getBackground getBorder getHeight getInsets getMaxHeight getMaxWidth getMinHeight getMinWidth getOpaqueInsets getPadding getPrefHeight getPrefWidth getShape getUserAgentStylesheet getWidth heightProperty insetsProperty isCacheShape isCenterShape isResizable isScaleShape isSnapToPixel layoutInArea layoutInArea layoutInArea layoutInArea maxHeight maxHeightProperty maxWidth maxWidthProperty minHeight minHeightProperty minWidth minWidthProperty opaqueInsetsProperty paddingProperty positionInArea positionInArea prefHeight prefHeightProperty prefWidth prefWidthProperty resize scaleShapeProperty setBackground setBorder setCacheShape setCenterShape setHeight setMaxHeight setMaxSize setMaxWidth setMinHeight setMinSize setMinWidth setOpaqueInsets setPadding setPrefHeight setPrefSize setPrefWidth setScaleShape setShape setSnapToPixel setWidth shapeProperty snappedBottomInset snappedLeftInset snappedRightInset snappedTopInset snapPosition snapPositionX snapPositionY snapSize snapSizeX snapSizeY snapSpace snapSpaceX snapSpaceY snapToPixelProperty widthProperty

Field Detail

arrow	back to summary
private Region arrow

autoSizeComplete	back to summary
private boolean autoSizeComplete

changeListenerHandler	back to summary
pack-priv final LambdaMultiplePropertyChangeListenerHandler changeListenerHandler

columnIndex	back to summary
pack-priv int columnIndex

columnReorderLine	back to summary
pack-priv Region columnReorderLine

contextMenuRequestedHandler	back to summary
private static final EventHandler<ContextMenuEvent> contextMenuRequestedHandler

DEFAULT_COLUMN_WIDTH	back to summary
pack-priv static final double DEFAULT_COLUMN_WIDTH

DEFAULT_STYLE_CLASS	back to summary
pack-priv static final String DEFAULT_STYLE_CLASS

dragOffset	back to summary
private double dragOffset

isLastVisibleColumn	back to summary
pack-priv boolean isLastVisibleColumn

isSizeDirty	back to summary
private boolean isSizeDirty

isSortColumn	back to summary
private boolean isSortColumn

label	back to summary
pack-priv Label label

mouseDraggedHandler	back to summary
private static final EventHandler<MouseEvent> mouseDraggedHandler

mousePressedHandler	back to summary
private static final EventHandler<MouseEvent> mousePressedHandler

mouseReleasedHandler	back to summary
private static final EventHandler<MouseEvent> mouseReleasedHandler

nestedColumnHeader	back to summary
private NestedTableColumnHeader nestedColumnHeader

newColumnPos	back to summary
private int newColumnPos

parentHeader	back to summary
private NestedTableColumnHeader parentHeader

popupTriggeredOnMousePressed	back to summary
private static boolean popupTriggeredOnMousePressed

PSEUDO_CLASS_LAST_VISIBLE	back to summary
private static final PseudoClass PSEUDO_CLASS_LAST_VISIBLE

size	back to summary
private DoubleProperty size

sortArrow	back to summary
private Node sortArrow

sortOrderDots	back to summary
private HBox sortOrderDots

sortOrderLabel	back to summary
private Label sortOrderLabel

sortOrderListener	back to summary
private ListChangeListener<TableColumnBase<?, ?>> sortOrderListener

sortPos	back to summary
pack-priv int sortPos

styleClassListener	back to summary
private ListChangeListener<String> styleClassListener

tableColumn	back to summary
private ReadOnlyObjectWrapper<TableColumnBase<?, ?>> tableColumn A property that refers to the `TableColumnBase` instance that this header is visually represents.

tableHeaderRow	back to summary
private TableHeaderRow tableHeaderRow

visibleLeafColumnsListener	back to summary
private ListChangeListener<TableColumnBase<?, ?>> visibleLeafColumnsListener

weakSortOrderListener	back to summary
private WeakListChangeListener<TableColumnBase<?, ?>> weakSortOrderListener

weakStyleClassListener	back to summary
private final WeakListChangeListener<String> weakStyleClassListener

weakVisibleLeafColumnsListener	back to summary
private final WeakListChangeListener<TableColumnBase<?, ?>> weakVisibleLeafColumnsListener

Constructor Detail

TableColumnHeader back to summary

TableColumnHeader	back to summary
public TableColumnHeader(final TableColumnBase<S, T> tc) Creates a new TableColumnHeader instance to visually represent the given `TableColumnBase` instance. Parameters tc:TableColumnBase<S, T> The table column to be visually represented by this instance.

public TableColumnHeader(final TableColumnBase<S, T> tc)

Creates a new TableColumnHeader instance to visually represent the given TableColumnBase instance.

Parameters

tc:TableColumnBase<S, T>: The table column to be visually represented by this instance.

Method Detail

columnReordering	back to summary
pack-priv void columnReordering(double sceneX, double sceneY)

columnReorderingComplete	back to summary
pack-priv void columnReorderingComplete()

columnReorderingStarted	back to summary
pack-priv void columnReorderingStarted(double dragOffset)

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.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.Region.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.Region.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.Region.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.Region.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.Region.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

createMeasureRow	back to summary
private <T> TableRow<T> createMeasureRow(TableView<T> tv, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, Callback<TableView<T>, TableRow<T>> rowFactory)

createMeasureRow	back to summary
private <T> TreeTableRow<T> createMeasureRow(TreeTableView<T> ttv, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, Callback<TreeTableView<T>, TreeTableRow<T>> rowFactory)

dispose	back to summary
pack-priv void dispose()

doColumnAutoSize	back to summary
private void doColumnAutoSize(int cellsToMeasure)

getClassCssMetaData

back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses

getColumns	back to summary
private ObservableList<TableColumnBase<?, ?>> getColumns(TableColumnBase<S, T> column)

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations

@Override

getDragRectHeight	back to summary
pack-priv double getDragRectHeight()

getIndex	back to summary
private int getIndex(TableColumnBase<?, ?> column)

getNestedColumnHeader	back to summary
pack-priv NestedTableColumnHeader getNestedColumnHeader()

getParentHeader	back to summary
pack-priv NestedTableColumnHeader getParentHeader()

getSize	back to summary
private final double getSize()

getSortPosition	back to summary
private int getSortPosition()

getTableColumn	back to summary
public final TableColumnBase<?, ?> getTableColumn()

getTableHeaderRow back to summary

protected TableHeaderRow getTableHeaderRow()

Returns the TableHeaderRow associated with this TableColumnHeader.

Returns:TableHeaderRow: the TableHeaderRow associated with this TableColumnHeader
Since: 12

getTableSkin back to summary

protected TableViewSkinBase<?, ?, ?, ?, ?> getTableSkin()

Returns the TableViewSkinBase in which this TableColumnHeader is inserted. This will return null until the TableHeaderRow has been set.

Returns:TableViewSkinBase<?, ?, ?, ?, ?>: the TableViewSkinBase in which this TableColumnHeader is inserted, or null
Since: 12

getVisibleSortOrderColumnCount	back to summary
private int getVisibleSortOrderColumnCount()

getVisibleSortOrderColumns	back to summary
private List<TableColumnBase<S, T>> getVisibleSortOrderColumns()

initStyleClasses	back to summary
pack-priv void initStyleClasses()

initUI	back to summary
private void initUI()

installTableColumnStyleClassListener	back to summary
pack-priv void installTableColumnStyleClassListener()

isColumnReorderingEnabled	back to summary
private boolean isColumnReorderingEnabled()

isSortingEnabled	back to summary
private boolean isSortingEnabled()

layoutChildren back to summary

protected void layoutChildren()

Overrides javafx.scene.Parent.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

moveColumn	back to summary
pack-priv void moveColumn(TableColumnBase<S, T> column, final int newColumnPos)

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.Parent.queryAccessibleAttribute.

Doc from javafx.scene.Parent.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Annotations

@Override

represents	back to summary
pack-priv boolean represents(TableColumnBase<?, ?> column)

resizeColumnToFitContent back to summary

protected void resizeColumnToFitContent(int maxRows)

Resizes this TableColumnHeader's column to fit the width of its content.

Implementation Specification

The resulting column width for this implementation is the maximum of the preferred width of the header cell and the preferred width of the first maxRow cells.

Subclasses can either use this method or override it (without the need to call super()) to provide their custom implementation (such as ones that exclude the header, exclude null content, compute the minimum width, etc.).

Parameters

maxRows:int: the number of rows considered when resizing. If -1 is given, all rows are considered.

Since

resizeColumnToFitContent	back to summary
private <T, S> void resizeColumnToFitContent(TableView<T> tv, TableColumn<T, S> tc, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, int maxRows)

resizeColumnToFitContent	back to summary
private <T, S> void resizeColumnToFitContent(TreeTableView<T> ttv, TreeTableColumn<T, S> tc, TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S, ?>> tableSkin, int maxRows)

setNestedColumnHeader	back to summary
pack-priv void setNestedColumnHeader(NestedTableColumnHeader nch)

setParentHeader	back to summary
pack-priv void setParentHeader(NestedTableColumnHeader ph)

setTableColumn	back to summary
private final void setTableColumn(TableColumnBase<?, ?> column)

setTableHeaderRow	back to summary
pack-priv void setTableHeaderRow(TableHeaderRow thr)

sizeProperty	back to summary
private final DoubleProperty sizeProperty()

sortColumn	back to summary
private void sortColumn(final boolean addColumn)

tableColumnProperty	back to summary
public final ReadOnlyObjectProperty<TableColumnBase<?, ?>> tableColumnProperty()

updateAllHeaders	back to summary
private void updateAllHeaders(TableColumnHeader header)

updateColumnIndex	back to summary
private void updateColumnIndex()

updateScene	back to summary
private void updateScene()

updateSortGrid	back to summary
private void updateSortGrid()

updateSortOrderDots	back to summary
private void updateSortOrderDots(int sortPos)

updateSortPosition	back to summary
private void updateSortPosition()

updateTableSkin	back to summary
private void updateTableSkin()

Modifier and Type	Field and Description
private static final CssMetaData<TableColumnHeader, Number>	SIZE
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public Class TableColumnHeader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TableColumnHeader.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail