Class TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S,?>>

java.lang.Object

javafx.scene.control.SkinBase<C>

javafx.scene.control.skin.VirtualContainerBase<C,I>

javafx.scene.control.skin.TableViewSkinBase<M,S,C,I,TC>

Type Parameters:

M - The type of the item stored in each row (for TableView, this is the type of the items list, and for TreeTableView, this is the type of the TreeItem).

S - The type of the item, as represented by the selection model (for TableView, this is, again, the type of the items list, and for TreeTableView, this is TreeItem typed to the same type as M).

C - The type of the virtualised control (e.g TableView, TreeTableView)

I - The type of cell used by this virtualised control (e.g. TableRow, TreeTableRow)

TC - The type of TableColumnBase used by this virtualised control (e.g. TableColumn, TreeTableColumn)

All Implemented Interfaces:

Skin<C>

Direct Known Subclasses:

TableViewSkin, TreeTableViewSkin

public abstract class TableViewSkinBase<M, S, C extends Control, I extends IndexedCell<M>, TC extends TableColumnBase<S,?>>
extends VirtualContainerBase<C,I>

TableViewSkinBase is the base skin class used by controls such as TableView and TreeTableView (the concrete classes are TableViewSkin and TreeTableViewSkin, respectively).

Since:

9

See Also:

• TableView
• TreeTableView
• TableViewSkin
• TreeTableViewSkin

Constructor Summary

Constructors

Constructor	Description
TableViewSkinBase(C control)	Constructs a TableViewSkinBase for the given control.

Method Summary

Modifier and Type	Method	Description
protected TableHeaderRow	createTableHeaderRow()	Creates a new TableHeaderRow instance.
protected TableHeaderRow	getTableHeaderRow()	Returns the TableHeaderRow created using createTableHeaderRow().
protected void	onFocusAboveCell()	Called when the focus is set on the cell above the current focused cell in order to scroll to it to make it visible.
protected void	onFocusBelowCell()	Called when the focus is set on the cell below the current focused cell in order to scroll to it to make it visible.
protected void	onFocusLeftCell()	Called when the focus is set on the left cell of the current selected one in order to horizontally scroll to it to make it visible.
protected void	onFocusRightCell()	Called when the focus is set on the right cell of the current selected one in order to horizontally scroll to it to make it visible.
protected void	onMoveToFirstCell()	Called when the selection is set on the first cell of the table (first row and first column) in order to scroll to it to make it visible.
protected void	onMoveToLastCell()	Called when the selection is set on the last cell of the table (last row and last column) in order to scroll to it to make it visible.
protected int	onScrollPageDown(boolean isFocusDriven)	Returns the index of the selected (or focused, if isFocusDriven is true) cell after a page scroll operation.
protected int	onScrollPageUp(boolean isFocusDriven)	Returns the index of the selected (or focused, if isFocusDriven is true) cell after a page scroll operation.
protected void	onSelectAboveCell()	Called when the selection is set on the the cell above the current focused cell in order to scroll to it to make it visible.
protected void	onSelectBelowCell()	Called when the selection is set on the cell below the current focused cell in order to scroll to it to make it visible.
protected void	onSelectLeftCell()	Called when the selection is set on the left cell of the current selected one in order to horizontally scroll to it to make it visible.
protected void	onSelectRightCell()	Called when the selection is set on the right cell of the current selected one in order to horizontally scroll to it to make it visible.
void	scrollHorizontally()	Scrolls to the column containing the current focused cell.
protected void	scrollHorizontally(TC col)	Programmatically scrolls to the given column.
protected void	updateItemCount()	This method is called when it is possible that the item count has changed (i.e.

Methods declared in class VirtualContainerBase

createVirtualFlow, dispose, getItemCount, getVirtualFlow, markItemCountDirty

Modifier and Type	Method	Description
protected VirtualFlow<I>	createVirtualFlow()	Create the virtualized container that handles the layout and scrolling of all the cells.
void	dispose()	Called when a previously installed skin is about to be removed from its associated control.
protected abstract int	getItemCount()	Returns the total number of items in this container, including those that are currently hidden because they are out of view.
protected final VirtualFlow<I>	getVirtualFlow()	Get the virtualized container.
protected final void	markItemCountDirty()	Call this method to indicate that the item count should be updated on the next pulse.

Methods declared in class SkinBase

computeBaselineOffset, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, consumeMouseEvents, executeAccessibleAction, getChildren, getClassCssMetaData, getCssMetaData, getNode, getSkinnable, layoutChildren, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, queryAccessibleAttribute, registerChangeListener, registerInvalidationListener, registerListChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners, unregisterInvalidationListeners, unregisterListChangeListeners

Modifier and Type	Method	Description
protected double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the baseline offset based on the first managed child.
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable height of the Skin, based on the provided width.
protected double	computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable width of the Skin, based on the provided height.
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable width of the Skin, based on the provided height.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
protected final void	consumeMouseEvents(boolean value)	Determines whether all mouse events should be automatically consumed.
protected void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final ObservableList<Node>	getChildren()	Returns the children of the skin.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
final Node	getNode()	Gets the Node which represents this Skin.
final C	getSkinnable()	Gets the Skinnable to which this Skin is assigned.
protected void	layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)	Called during the layout pass of the scenegraph.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
protected final void	registerChangeListener(ObservableValue<?> observable, Consumer<ObservableValue<?>> operation)	Registers an operation to perform when the given observable sends a change event.
protected final void	registerInvalidationListener(Observable observable, Consumer<Observable> operation)	Registers an operation to perform when the given observable sends an invalidation event.
protected final void	registerListChangeListener(ObservableList<?> observableList, Consumer<ListChangeListener.Change<?>> operation)	Registers an operation to perform when the given observableList sends a list change event.
protected double	snappedBottomInset()	Utility method to get the bottom inset which includes padding and border inset.
protected double	snappedLeftInset()	Utility method to get the left inset which includes padding and border inset.
protected double	snappedRightInset()	Utility method to get the right inset which includes padding and border inset.
protected double	snappedTopInset()	Utility method to get the top inset which includes padding and border inset.
protected double	snapPosition(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapPositionX() and snapPositionY()
protected double	snapPositionX(double value)	Convenience method for accessing the snapPositionX() method on the skinnable.
protected double	snapPositionY(double value)	Convenience method for accessing the snapPositionY() method on the skinnable.
protected double	snapSize(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSizeX() and snapSizeY()
protected double	snapSizeX(double value)	Convenience method for accessing the snapSizeX() method on the skinnable.
protected double	snapSizeY(double value)	Convenience method for accessing the snapSizeY() method on the skinnable.
protected double	snapSpace(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSpaceX() and snapSpaceY()
protected double	snapSpaceX(double value)	Convenience method for accessing the snapSpaceX() method on the skinnable.
protected double	snapSpaceY(double value)	Convenience method for accessing the snapSpaceY() method on the skinnable.
protected final Consumer<ObservableValue<?>>	unregisterChangeListeners(ObservableValue<?> observable)	Unregisters all operations that have been registered using SkinBase.registerChangeListener(ObservableValue, Consumer) for the given observable.
protected final Consumer<Observable>	unregisterInvalidationListeners(Observable observable)	Unregisters all operations that have been registered using SkinBase.registerInvalidationListener(Observable, Consumer) for the given observable.
protected final Consumer<ListChangeListener.Change<?>>	unregisterListChangeListeners(ObservableList<?> observableList)	Unregisters all operations that have been registered using SkinBase.registerListChangeListener(ObservableList, Consumer) for the given observableList.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods declared in interface Skin

install

Modifier and Type	Method	Description
default void	install()	Called once when Skin is set.

Constructor Details

TableViewSkinBase

public TableViewSkinBase(C control)

Constructs a TableViewSkinBase for the given control.

Parameters:

control - the control

Method Details

createTableHeaderRow

protected TableHeaderRow createTableHeaderRow()

Creates a new TableHeaderRow 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:

A new TableHeaderRow instance.

getTableHeaderRow

protected TableHeaderRow getTableHeaderRow()

Returns the TableHeaderRow created using createTableHeaderRow().

Returns:

the TableHeaderRow for this TableViewSkinBase

Since:

12

updateItemCount

protected void updateItemCount()

This method is called when it is possible that the item count has changed (i.e. scrolling has occurred, the control has resized, etc). This method should recalculate the item count and store that for future use by the VirtualContainerBase.getItemCount() method.

Specified by:

updateItemCount in class VirtualContainerBase<C extends Control, I extends IndexedCell<M>>

onFocusAboveCell

protected void onFocusAboveCell()

Called when the focus is set on the cell above the current focused cell in order to scroll to it to make it visible.

Since:

12

onFocusBelowCell

protected void onFocusBelowCell()

Called when the focus is set on the cell below the current focused cell in order to scroll to it to make it visible.

Since:

12

onSelectAboveCell

protected void onSelectAboveCell()

Called when the selection is set on the the cell above the current focused cell in order to scroll to it to make it visible.

Since:

12

onSelectBelowCell

protected void onSelectBelowCell()

Called when the selection is set on the cell below the current focused cell in order to scroll to it to make it visible.

Since:

12

onSelectLeftCell

protected void onSelectLeftCell()

Called when the selection is set on the left cell of the current selected one in order to horizontally scroll to it to make it visible.

Since:

12

onSelectRightCell

protected void onSelectRightCell()

Called when the selection is set on the right cell of the current selected one in order to horizontally scroll to it to make it visible.

Since:

12

onFocusLeftCell

protected void onFocusLeftCell()

Called when the focus is set on the left cell of the current selected one in order to horizontally scroll to it to make it visible.

Since:

12

onFocusRightCell

protected void onFocusRightCell()

Called when the focus is set on the right cell of the current selected one in order to horizontally scroll to it to make it visible.

Since:

12

onMoveToFirstCell

protected void onMoveToFirstCell()

Called when the selection is set on the first cell of the table (first row and first column) in order to scroll to it to make it visible.

Since:

12

onMoveToLastCell

protected void onMoveToLastCell()

Called when the selection is set on the last cell of the table (last row and last column) in order to scroll to it to make it visible.

Since:

12

onScrollPageDown

protected int onScrollPageDown(boolean isFocusDriven)

Returns the index of the selected (or focused, if isFocusDriven is true) cell after a page scroll operation. If the selected/focused cell is not the last fully visible cell, then the last fully visible cell is selected/focused. Otherwise, the content is scrolled such that the cell is made visible at the top of the viewport (and the new last fully visible cell is selected/focused instead).

Parameters:

isFocusDriven - true if focused cell should be considered over selection

Returns:

the new index to select, or to focus if isFocusDriven is true

Since:

12

onScrollPageUp

protected int onScrollPageUp(boolean isFocusDriven)

Returns the index of the selected (or focused, if isFocusDriven is true) cell after a page scroll operation. If the selected/focused cell is not the first fully visible cell, then the first fully visible cell is selected/focused. Otherwise, the content is scrolled such that the cell is made visible at the bottom of the viewport (and the new first fully visible cell is selected/focused instead).

Parameters:

isFocusDriven - true if focused cell should be considered over selection

Returns:

the new index to select, or to focus if isFocusDriven is true

Since:

12

scrollHorizontally

public void scrollHorizontally()

Scrolls to the column containing the current focused cell.

Handles the horizontal scrolling when the selection mode is cell-based and the newly selected cell belongs to a column which is not completely visible.

Since:

12

scrollHorizontally

protected void scrollHorizontally(TC col)

Programmatically scrolls to the given column. This call will ensure that the column is aligned on the left edge of the TableView and also that the columns don't become detached from the right edge of the table.

Parameters:

col - the column to scroll to

Since:

12