com.sun.javafx.scene.control.skin

Class VirtualFlow<T extends IndexedCell>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

com.sun.javafx.scene.control.skin.VirtualFlow<T>

All Implemented Interfaces:

Styleable, EventTarget

public class VirtualFlow<T extends IndexedCell>
extends Region

Implementation of a virtualized container using a cell based mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualFlow.ArrayLinkedList<T> A List-like implementation that is exceedingly efficient for the purposes of the VirtualFlow.

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 and Description
VirtualFlow()

Method Summary

Modifier and Type	Method and Description
protected void	addAllToPile()
protected void	addLeadingCells(int currentIndex, double startOffset) Adds all the cells prior to and including the given currentIndex, until no more can be added without falling off the flow.
protected boolean	addTrailingCells(boolean fillEmptyCells) Adds all the trailing cells that come after the last index in the cells ObservableList.
double	adjustPixels(double delta) Given a delta value representing a number of pixels, this method attempts to move the VirtualFlow in the given direction (positive is down/right, negative is up/left) the given number of pixels.
protected double	computePrefHeight(double width) 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) Computes the preferred width of this region for the given height.
protected T	getAvailableCell(int prefIndex) Get a cell which can be used in the layout.
T	getCell(int index) Return a cell for the given index.
protected double	getCellBreadth(Cell cell) Gets the breadth of a specific cell
protected double	getCellBreadth(int index)
int	getCellCount()
protected int	getCellIndex(T cell) Return the index for a given cell.
protected double	getCellLength(int index) Compute and return the length of the cell for the given index.
protected double	getCellLength(T cell) Gets the length of a specific cell
protected double	getCellPosition(T cell) Gets the layout position of the cell along the length axis
protected List<T>	getCells()
Callback<VirtualFlow,T>	getCreateCell()
T	getFirstVisibleCell() Locates and returns the first non-empty IndexedCell that is partially or completely visible.
T	getFirstVisibleCellWithinViewPort()
protected VirtualScrollBar	getHbar()
T	getLastVisibleCell() Locates and returns the last non-empty IndexedCell that is currently partially or completely visible.
T	getLastVisibleCellWithinViewPort()
protected double	getMaxPrefBreadth()
double	getPosition()
protected VirtualScrollBar	getVbar()
protected double	getViewportBreadth()
protected double	getViewportLength()
T	getVisibleCell(int index) Gets a cell for the given index if the cell has been created and laid out.
boolean	isPannable()
boolean	isVertical()
protected void	layoutChildren() Invoked during the layout pass to layout the children in this Parent.
protected void	positionCell(T cell, double position)
void	rebuildCells()
void	reconfigureCells()
void	recreateCells()
void	requestCellLayout()
void	requestLayout() Overridden to implement somewhat more efficient support for layout.
protected void	resizeCellSize(T cell)
protected void	scrollBarOn()
void	scrollTo(int index)
void	scrollToOffset(int offset)
void	setCellCount(int i)
void	setCellDirty(int index)
protected void	setCellIndex(T cell, int index)
void	setCreateCell(Callback<VirtualFlow,T> cc)
void	setFixedCellSize(double value)
protected void	setHeight(double value)
protected void	setMaxPrefBreadth(double value)
void	setPannable(boolean value)
void	setPosition(double newPosition)
void	setVertical(boolean value)
protected void	setViewportBreadth(double value)
protected void	setWidth(double value)
void	show(int index)
void	show(T cell) Adjusts the cells such that the selected cell will be fully visible in the viewport (but only just).
void	showAsFirst(T firstCell) Adjust the position of cells so that the specified cell will be positioned at the start of the viewport.
void	showAsLast(T lastCell) Adjust the position of cells so that the specified cell will be positioned at the end of the viewport.
protected void	startSBReleasedAnimation()
BooleanProperty	verticalProperty()

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, 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, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualFlow

public VirtualFlow()

Method Detail

setVertical

public final void setVertical(boolean value)

isVertical

public final boolean isVertical()

verticalProperty

public final BooleanProperty verticalProperty()

isPannable

public boolean isPannable()

setPannable

public void setPannable(boolean value)

getCellCount

public int getCellCount()

setCellCount

public void setCellCount(int i)

getPosition

public double getPosition()

setPosition

public void setPosition(double newPosition)

setFixedCellSize

public void setFixedCellSize(double value)

getCreateCell

public Callback<VirtualFlow,T> getCreateCell()

setCreateCell

public void setCreateCell(Callback<VirtualFlow,T> cc)

setMaxPrefBreadth

protected final void setMaxPrefBreadth(double value)

getMaxPrefBreadth

protected final double getMaxPrefBreadth()

setViewportBreadth

protected final void setViewportBreadth(double value)

getViewportBreadth

protected final double getViewportBreadth()

getViewportLength

protected double getViewportLength()

getCells

protected List<T> getCells()

getHbar

protected final VirtualScrollBar getHbar()

getVbar

protected final VirtualScrollBar getVbar()

requestLayout

public void requestLayout()

Overridden to implement somewhat more efficient support for layout. The VirtualFlow can generally be considered as being unmanaged, in that whenever the position changes, or other such things change, we need to perform a layout but there is no reason to notify the parent. However when things change which may impact the preferred size (such as vertical, createCell, and configCell) then we need to notify the parent.

Overrides:

requestLayout in class Parent

layoutChildren

protected void layoutChildren()

Description copied from class: Parent

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.

Overrides:

layoutChildren in class Parent

addLeadingCells

protected void addLeadingCells(int currentIndex,
                               double startOffset)

Adds all the cells prior to and including the given currentIndex, until no more can be added without falling off the flow. The startOffset indicates the distance from the leading edge (top) of the viewport to the leading edge (top) of the currentIndex.

addTrailingCells

protected boolean addTrailingCells(boolean fillEmptyCells)

Adds all the trailing cells that come after the last index in the cells ObservableList.

setWidth

protected void setWidth(double value)

Overrides:

setWidth in class Region

setHeight

protected void setHeight(double value)

Overrides:

setHeight in class Region

getCellIndex

protected int getCellIndex(T cell)

Return the index for a given cell. This allows subclasses to customise how cell indices are retrieved.

getCell

public T getCell(int index)

Return a cell for the given index. This may be called for any cell, including beyond the range defined by cellCount, in which case an empty cell will be returned. The returned value should not be stored for any reason.

getCellLength

protected double getCellLength(int index)

Compute and return the length of the cell for the given index. This is called both internally when adjusting by pixels, and also at times by PositionMapper (see the getItemSize callback). When called by PositionMapper, it is possible that it will be called for some index which is not associated with any cell, so we have to do a bit of work to use a cell as a helper for computing cell size in some cases.

getCellBreadth

protected double getCellBreadth(int index)

getCellLength

protected double getCellLength(T cell)

Gets the length of a specific cell

getCellBreadth

protected double getCellBreadth(Cell cell)

Gets the breadth of a specific cell

getCellPosition

protected double getCellPosition(T cell)

Gets the layout position of the cell along the length axis

positionCell

protected void positionCell(T cell,
                            double position)

resizeCellSize

protected void resizeCellSize(T cell)

setCellIndex

protected void setCellIndex(T cell,
                            int index)

getAvailableCell

protected T getAvailableCell(int prefIndex)

Get a cell which can be used in the layout. This function will reuse cells from the pile where possible, and will create new cells when necessary.

addAllToPile

protected void addAllToPile()

getVisibleCell

public T getVisibleCell(int index)

Gets a cell for the given index if the cell has been created and laid out. "Visible" is a bit of a misnomer, the cell might not be visible in the viewport (it may be clipped), but does distinguish between cells that have been created and are in use vs. those that are in the pile or not created.

getLastVisibleCell

public T getLastVisibleCell()

Locates and returns the last non-empty IndexedCell that is currently partially or completely visible. This function may return null if there are no cells, or if the viewport length is 0.

getFirstVisibleCell

public T getFirstVisibleCell()

Locates and returns the first non-empty IndexedCell that is partially or completely visible. This really only ever returns null if there are no cells or the viewport length is 0.

getLastVisibleCellWithinViewPort

public T getLastVisibleCellWithinViewPort()

getFirstVisibleCellWithinViewPort

public T getFirstVisibleCellWithinViewPort()

showAsFirst

public void showAsFirst(T firstCell)

Adjust the position of cells so that the specified cell will be positioned at the start of the viewport. The given cell must already be "live". This is bad public API!

showAsLast

public void showAsLast(T lastCell)

Adjust the position of cells so that the specified cell will be positioned at the end of the viewport. The given cell must already be "live". This is bad public API!

show

public void show(T cell)

Adjusts the cells such that the selected cell will be fully visible in the viewport (but only just).

show

public void show(int index)

scrollTo

public void scrollTo(int index)

scrollToOffset

public void scrollToOffset(int offset)

adjustPixels

public double adjustPixels(double delta)

Given a delta value representing a number of pixels, this method attempts to move the VirtualFlow in the given direction (positive is down/right, negative is up/left) the given number of pixels. It returns the number of pixels actually moved.

reconfigureCells

public void reconfigureCells()

recreateCells

public void recreateCells()

rebuildCells

public void rebuildCells()

requestCellLayout

public void requestCellLayout()

setCellDirty

public void setCellDirty(int index)

computePrefWidth

protected double computePrefWidth(double height)

Description copied from class: Region

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.

Overrides:

computePrefWidth in class Region

Parameters:

height - the height that should be used if preferred width depends on it

Returns:

the computed preferred width for this region

computePrefHeight

protected double computePrefHeight(double width)

Description copied from class: Region

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.

Overrides:

computePrefHeight in class Region

Parameters:

width - the width that should be used if preferred height depends on it

Returns:

the computed preferred height for this region

startSBReleasedAnimation

protected void startSBReleasedAnimation()

scrollBarOn

protected void scrollBarOn()