Class VirtualContainerBase<C extends Control, I extends IndexedCell>

java.lang.Object

javafx.scene.control.SkinBase<C>

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

Type Parameters:

C - the type of the control

I - the type of the index cell

All Implemented Interfaces:

Skin<C>

Direct Known Subclasses:

ListViewSkin, TableViewSkinBase, TreeViewSkin

public abstract class VirtualContainerBase<C extends Control, I extends IndexedCell>
extends SkinBase<C>

Parent class to control skins whose contents are virtualized and scrollable. This class handles the interaction with the VirtualFlow class, which is the main class handling the virtualization of the contents of this container.

Since:

9

Constructor Summary

Constructors

Constructor	Description
VirtualContainerBase(C control)	Constructor for subclasses to call.

Method Summary

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.
protected abstract void	updateItemCount()	This method is called when it is possible that the item count has changed (i.e.

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

VirtualContainerBase

public VirtualContainerBase(C control)

Constructor for subclasses to call.

Parameters:

control - the control

Method Details

getItemCount

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.

Returns:

the total number of items in this container

updateItemCount

protected abstract 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 getItemCount() method.

createVirtualFlow

protected VirtualFlow<I> createVirtualFlow()

Create the virtualized container that handles the layout and scrolling of all the cells. This enables skin subclasses to provide a custom VirtualFlow implementation. If not overridden, this method instantiates a default VirtualFlow instance.

Returns:

newly created VirtualFlow instance

Since:

10

dispose

public void dispose()

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, Skin.getSkinnable() and Skin.getNode() should return null.

Calling Skin.dispose() more than once has no effect.

Overridden to remove EventHandler.

getVirtualFlow

protected final VirtualFlow<I> getVirtualFlow()

Get the virtualized container. Subclasses can invoke this method to get the VirtualFlow instance.

Returns:

the virtualized container

Since:

10

markItemCountDirty

protected final void markItemCountDirty()

Call this method to indicate that the item count should be updated on the next pulse.