Package io.github.palexdev.virtualizedfx.flow.simple

Class SimpleVirtualFlowContainer<T,C extends Cell<T>>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

io.github.palexdev.virtualizedfx.flow.simple.SimpleVirtualFlowContainer<T,C>

Type Parameters:

T - the type of object to represent

C - the type of Cell to use

All Implemented Interfaces:

Styleable, EventTarget

public class SimpleVirtualFlowContainer<T,C extends Cell<T>>
extends Region

This is the Region used by SimpleVirtualFlow to contain the cells.

To keep things easy and organized this container makes use of two helper classes, the CellsManager and LayoutManager, and also acts as a bridge between those two helpers and the VirtualFlow.

Since it keeps references to the CellsManager and the LayoutManager too, it's also responsible for listening to changes to the items list, and the items list property.

Property Summary

Properties

Type	Property	Description
protected DoubleProperty	estimatedHeight	Delegate method for LayoutManager.estimatedHeightProperty().
protected DoubleProperty	estimatedWidth	Delegate method for LayoutManager.estimatedWidthProperty().

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
SimpleVirtualFlowContainer(SimpleVirtualFlow<T,C> virtualFlow)

Method Summary

Modifier and Type	Method	Description
protected DoubleProperty	estimatedHeightProperty()	Delegate method for LayoutManager.estimatedHeightProperty().
protected DoubleProperty	estimatedWidthProperty()	Delegate method for LayoutManager.estimatedWidthProperty().
double	getCellHeight()	Delegate method for LayoutManager.getCellHeight().
protected Map<Integer,C>	getCells()	Delegate method for CellsManager.getCells().
protected CellsManager<T,C>	getCellsManager()
double	getCellWidth()	Delegate method for LayoutManager.getCellWidth().
protected ObservableList<Node>	getChildren()
protected double	getEstimatedHeight()	Delegate method for LayoutManager.getEstimatedHeight().
protected double	getEstimatedWidth()	Delegate method for LayoutManager.getEstimatedWidth().
protected LayoutManager<T,C>	getLayoutManager()
double	getScrolled()	Delegate method for LayoutManager.getScrolled().
protected SimpleVirtualFlow<T,C>	getVirtualFlow()
protected void	initCells(int num)	Delegate method for CellsManager.initCells(int).
protected void	initialize()	Calls buildClip(), adds the needed listeners for the items list and the corresponding property, also calls LayoutManager.initialize().
protected void	layoutChildren()	Overridden to be empty.
void	reset()	Delegate method for CellsManager.reset().
void	update(double scrolled)	Delegate method for LayoutManager.update(double).
protected void	updateCells(int start)	Delegate method for CellsManager.updateCells(int).

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, 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

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

estimatedHeight

protected DoubleProperty estimatedHeightProperty

Delegate method for LayoutManager.estimatedHeightProperty().

See Also:

• getEstimatedHeight()

estimatedWidth

protected DoubleProperty estimatedWidthProperty

Delegate method for LayoutManager.estimatedWidthProperty().

See Also:

• getEstimatedWidth()

Constructor Details

SimpleVirtualFlowContainer

public SimpleVirtualFlowContainer(SimpleVirtualFlow<T,C> virtualFlow)

Method Details

initialize

protected void initialize()

Calls buildClip(), adds the needed listeners for the items list and the corresponding property, also calls LayoutManager.initialize().

initCells

protected void initCells(int num)

Delegate method for CellsManager.initCells(int).

updateCells

protected void updateCells(int start)

Delegate method for CellsManager.updateCells(int).

update

public void update(double scrolled)

Delegate method for LayoutManager.update(double).

reset

public void reset()

Delegate method for CellsManager.reset().

getCells

protected Map<Integer,C> getCells()

Delegate method for CellsManager.getCells().

getEstimatedHeight

protected double getEstimatedHeight()

Delegate method for LayoutManager.getEstimatedHeight().

estimatedHeightProperty

protected DoubleProperty estimatedHeightProperty()

Delegate method for LayoutManager.estimatedHeightProperty().

See Also:

• getEstimatedHeight()

getEstimatedWidth

protected double getEstimatedWidth()

Delegate method for LayoutManager.getEstimatedWidth().

estimatedWidthProperty

protected DoubleProperty estimatedWidthProperty()

Delegate method for LayoutManager.estimatedWidthProperty().

See Also:

• getEstimatedWidth()

getCellHeight

public double getCellHeight()

Delegate method for LayoutManager.getCellHeight().

getCellWidth

public double getCellWidth()

Delegate method for LayoutManager.getCellWidth().

getScrolled

public double getScrolled()

Delegate method for LayoutManager.getScrolled().

getVirtualFlow

protected SimpleVirtualFlow<T,C> getVirtualFlow()

Returns:

the VirtualFlow instance

getCellsManager

protected CellsManager<T,C> getCellsManager()

Returns:

the CellsManager instance

getLayoutManager

protected LayoutManager<T,C> getLayoutManager()

Returns:

the LayoutManager instance

getChildren

protected ObservableList<Node> getChildren()

Overridden to be accessible in this package.

Overrides:

getChildren in class Parent

Returns:

layoutChildren

protected void layoutChildren()

Overridden to be empty. Layout is managed by CellsManager.processLayout(List).

Overrides:

layoutChildren in class Parent