Class VirtualFlow<T extends IndexedCell>
- Type Parameters:
T- The type of the item contained within the virtual flow cells
- All Implemented Interfaces:
Styleable, EventTarget
ListView, TreeView,
TableView, and TreeTableView.- Since:
- 9
-
Property Summary
PropertiesTypePropertyDescriptionfinal IntegerPropertyIndicates the number of cells that should be in the flow.final ObjectProperty<Callback<VirtualFlow<T>, T>> Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell.final DoublePropertyFor optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.final BooleanPropertyIndicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).final DoublePropertyThe position of the VirtualFlow within its list of cells.final BooleanPropertyIndicates the primary direction of virtualization.Properties declared in class Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthTypePropertyDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final DoublePropertyProperty for overriding the region's computed maximum height.final DoublePropertyProperty for overriding the region's computed maximum width.final DoublePropertyProperty for overriding the region's computed minimum height.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.final DoublePropertyProperty for overriding the region's computed preferred height.final DoublePropertyProperty for overriding the region's computed preferred width.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Properties declared in class Parent
needsLayoutTypePropertyDescriptionfinal ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.Properties declared in class Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragDone, 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, visibleTypePropertyDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.final StringPropertyA string representation of the CSS style associated with this specificNode.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph. -
Field Summary
Fields declared in class Region
USE_COMPUTED_SIZE, USE_PREF_SIZEModifier and TypeFieldDescriptionstatic final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setPrefWidth,setPrefHeight,setMaxWidth,setMaxHeightmethods to reset the region's size constraint back to it's intrinsic size returned bycomputeMinWidth,computeMinHeight,computePrefWidth,computePrefHeight,computeMaxWidth, orcomputeMaxHeight.static final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setMaxWidthorsetMaxHeightmethods to indicate that the preferred dimension should be used for that max and/or min constraint.Fields declared in class Node
BASELINE_OFFSET_SAME_AS_HEIGHTModifier and TypeFieldDescriptionstatic final doubleThis is a special value that might be returned byNode.getBaselineOffset(). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidThis method will remove all cells from the VirtualFlow and remove them, adding them to the 'pile' (that is, a place from where cells can be used at a later date).final IntegerPropertyIndicates the number of cells that should be in the flow.final ObjectProperty<Callback<VirtualFlow<T>, T>> Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell.final DoublePropertyFor optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.protected TgetAvailableCell(int prefIndex) Get a cell which can be used in the layout.getCell(int index) Return a cell for the given index.final intGets the value of thecellCountproperty.final Callback<VirtualFlow<T>, T> Returns the current cell factory.protected intgetCellIndex(T cell) Return the index for a given cell.getCells()Returns the list of cells displayed in the current viewport.Locates and returns the first non-empty IndexedCell that is partially or completely visible.protected TReturns the first visible cell whose bounds are entirely within the viewport.final doubleGets the value of thefixedCellSizeproperty.protected final ScrollBargetHbar()Returns the scroll bar used for scrolling horizontally.Locates and returns the last non-empty IndexedCell that is currently partially or completely visible.protected TReturns the last visible cell whose bounds are entirely within the viewport.final doubleGets the value of thepositionproperty.protected TgetPrivateCell(int index) Creates and returns a new cell for the given index.protected final ScrollBargetVbar()Returns the scroll bar used for scrolling vertically.doubleReturns the length of the viewport portion of theVirtualFlowas computed during the layout pass.getVisibleCell(int index) Gets a cell for the given index if the cell has been created and laid out.final booleanGets the value of thepannableproperty.final booleanGets the value of theverticalproperty.final BooleanPropertyIndicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).final DoublePropertyThe position of the VirtualFlow within its list of cells.protected voidInforms theVirtualFlowthat a layout pass should be done, and cell contents have changed.protected voidInforms theVirtualFlowthat a layout pass should be done, and the cell contents have not changed.protected voidInforms theVirtualFlowthat a layout pass should be done, and that the cell factory has changed.protected voidInforms theVirtualFlowthat a layout pass should be done and only the cell layout will be requested.voidOverridden to implement somewhat more efficient support for layout.protected voidresizeCell(T cell) Resizes the given cell.doublescrollPixels(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.voidscrollTo(int index) Adjusts the cells such that the cell in the given index will be fully visible in the viewport.voidAdjusts the cells such that the selected cell will be fully visible in the viewport (but only just).voidscrollToBottom(T lastCell) Adjust the position of cells so that the specified cell will be positioned at the end of the viewport.voidscrollToTop(int index) Adjusts the cells such that the cell in the given index will be fully visible in the viewport, and positioned at the very top of the viewport.voidscrollToTop(T firstCell) Adjust the position of cells so that the specified cell will be positioned at the start of the viewport.final voidsetCellCount(int value) Sets the value of thecellCountproperty.final voidsetCellFactory(Callback<VirtualFlow<T>, T> value) Sets a new cell factory to use in the VirtualFlow.protected voidsetCellIndex(T cell, int index) The VirtualFlow uses this method to set a cells index (rather than callingIndexedCell.updateIndex(int)directly), so it is a perfect place for subclasses to override if this if of interest.final voidsetFixedCellSize(double value) Sets the value of thefixedCellSizeproperty.final voidsetPannable(boolean value) Sets the value of thepannableproperty.final voidsetPosition(double value) Sets the value of thepositionproperty.final voidsetVertical(boolean value) Sets the value of theverticalproperty.final BooleanPropertyIndicates the primary direction of virtualization.Methods declared in class 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, widthPropertyModifier and TypeMethodDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.protected doublecomputeMaxHeight(double width) Computes the maximum height of this region for the specified width.protected doublecomputeMaxWidth(double height) Computes the maximum width of this region for the specified height.protected doublecomputeMinHeight(double width) Computes the minimum height of this region for the specified width.protected doublecomputeMinWidth(double height) Computes the minimum width of this region for the specified height.protected doublecomputePrefHeight(double width) Computes the preferred height of this region for the specified width.protected doublecomputePrefWidth(double height) Computes the preferred width of this region for the specified height.final BackgroundGets the value of thebackgroundproperty.final BorderGets the value of theborderproperty.static List<CssMetaData<? extends Styleable, ?>> Gets theCssMetaDataassociated with this class, which may include theCssMetaDataof its superclasses.List<CssMetaData<? extends Styleable, ?>> This method should delegate toNode.getClassCssMetaData()so that a Node's CssMetaData can be accessed without the need for reflection.final doubleGets the value of theheightproperty.final InsetsGets the value of theinsetsproperty.final doubleGets the value of themaxHeightproperty.final doubleGets the value of themaxWidthproperty.final doubleGets the value of theminHeightproperty.final doubleGets the value of theminWidthproperty.final InsetsGets the value of theopaqueInsetsproperty.final InsetsGets the value of thepaddingproperty.final doubleGets the value of theprefHeightproperty.final doubleGets the value of theprefWidthproperty.final ShapegetShape()Gets the value of theshapeproperty.An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.final doublegetWidth()Gets the value of thewidthproperty.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final booleanGets the value of thecacheShapeproperty.final booleanGets the value of thecenterShapeproperty.booleanReturnstruesince all Regions are resizable.final booleanGets the value of thescaleShapeproperty.final booleanGets the value of thesnapToPixelproperty.protected voidlayoutInArea(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 region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(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 region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which lays out the child within an area of it's parent defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(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 region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doublemaxHeight(double width) Called during layout to determine the maximum height for this node.final DoublePropertyProperty for overriding the region's computed maximum height.final doublemaxWidth(double height) Called during layout to determine the maximum width for this node.final DoublePropertyProperty for overriding the region's computed maximum width.final doubleminHeight(double width) Called during layout to determine the minimum height for this node.final DoublePropertyProperty for overriding the region's computed minimum height.final doubleminWidth(double height) Called during layout to determine the minimum width for this node.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.protected voidpositionInArea(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 region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidpositionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which positions the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doubleprefHeight(double width) Called during layout to determine the preferred height for this node.final DoublePropertyProperty for overriding the region's computed preferred height.final doubleprefWidth(double height) Called during layout to determine the preferred width for this node.final DoublePropertyProperty for overriding the region's computed preferred width.voidresize(double width, double height) Invoked by the region's parent during layout to set the region's width and height.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final voidsetBackground(Background value) Sets the value of thebackgroundproperty.final voidSets the value of theborderproperty.final voidsetCacheShape(boolean value) Sets the value of thecacheShapeproperty.final voidsetCenterShape(boolean value) Sets the value of thecenterShapeproperty.protected voidsetHeight(double value) Sets the value of theheightproperty.final voidsetMaxHeight(double value) Sets the value of themaxHeightproperty.voidsetMaxSize(double maxWidth, double maxHeight) Convenience method for overriding the region's computed maximum width and height.final voidsetMaxWidth(double value) Sets the value of themaxWidthproperty.final voidsetMinHeight(double value) Sets the value of theminHeightproperty.voidsetMinSize(double minWidth, double minHeight) Convenience method for overriding the region's computed minimum width and height.final voidsetMinWidth(double value) Sets the value of theminWidthproperty.final voidsetOpaqueInsets(Insets value) Sets the value of theopaqueInsetsproperty.final voidsetPadding(Insets value) Sets the value of thepaddingproperty.final voidsetPrefHeight(double value) Sets the value of theprefHeightproperty.voidsetPrefSize(double prefWidth, double prefHeight) Convenience method for overriding the region's computed preferred width and height.final voidsetPrefWidth(double value) Sets the value of theprefWidthproperty.final voidsetScaleShape(boolean value) Sets the value of thescaleShapeproperty.final voidSets the value of theshapeproperty.final voidsetSnapToPixel(boolean value) Sets the value of thesnapToPixelproperty.protected voidsetWidth(double value) Sets the value of thewidthproperty.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final doubleUtility method to get the bottom inset which includes padding and border inset.final doubleUtility method to get the left inset which includes padding and border inset.final doubleUtility method to get the right inset which includes padding and border inset.final doubleUtility method to get the top inset which includes padding and border inset.protected doublesnapPosition(double value) Deprecated, for removal: This API element is subject to removal in a future version.doublesnapPositionX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapPositionY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSize(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSizeX()andsnapSizeY()doublesnapSizeX(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSizeY(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSpace(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSpaceX()andsnapSpaceY()doublesnapSpaceX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSpaceY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Methods declared in class Parent
getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestParentLayout, setNeedsLayout, updateBoundsModifier and TypeMethodDescriptiondoubleCalculates the baseline offset based on the first managed child.protected ObservableList<Node> Gets the list of children of thisParent.Gets the list of children of thisParentas a read-only list.Gets the list of all managed children of thisParent.final ObservableList<String> Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.final booleanGets the value of theneedsLayoutproperty.final voidlayout()Executes a top-down layout pass on the scene graph under this parent.protected voidInvoked byParent.layout()during a layout pass to position and resize the managed children.final ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.protected final voidRequests a layout pass of the parent to be performed before the next scene is rendered.protected final voidsetNeedsLayout(boolean value) Sets the value of theneedsLayoutproperty.protected voidUpdates the bounds of thisParentand its children.Methods declared in class 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, focusVisibleProperty, focusWithinProperty, 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, getOnMouseDragDone, 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, isFocusVisible, isFocusWithin, 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, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragDoneProperty, 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, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, 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, setOnMouseDragDone, 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, visiblePropertyModifier and TypeMethodDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final <T extends Event>
voidaddEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Registers an event filter for this target.final <T extends Event>
voidaddEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Registers an event handler for this target.final voidapplyCss()If required, apply styles to this Node and its children, if any.final voidautosize()If the node is resizable, will set its layout bounds to its current preferred width and height.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.Construct an event dispatch chain for this target.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.doubleReturns the area of thisNodeprojected onto the physical screen in pixel units.booleancontains(double localX, double localY) Returnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.booleanReturnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.voidexecuteAccessibleAction(AccessibleAction action, Object... parameters) This method is called by the assistive technology to request the action indicated by the argument should be executed.final voidFires the specified event.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final StringGets the value of theaccessibleHelpproperty.final AccessibleRoleGets the value of theaccessibleRoleproperty.final StringGets the value of theaccessibleRoleDescriptionproperty.final StringGets the value of theaccessibleTextproperty.final BlendModeGets the value of theblendModeproperty.final BoundsGets the value of theboundsInLocalproperty.final BoundsGets the value of theboundsInParentproperty.final CacheHintGets the value of thecacheHintproperty.final NodegetClip()Gets the value of theclipproperty.Returns the orientation of a node's resizing bias for layout purposes.final CursorGets the value of thecursorproperty.final DepthTestGets the value of thedepthTestproperty.final EffectGets the value of theeffectproperty.final NodeOrientationGets the value of theeffectiveNodeOrientationproperty.final EventDispatcherGets the value of theeventDispatcherproperty.final StringgetId()The id of thisNode.protected CursorReturns the initial cursor state of this node, for use by the JavaFX CSS engine to correctly set its initial value.protected BooleanReturns the initial focus traversable state of this node, for use by the JavaFX CSS engine to correctly set its initial value.final InputMethodRequestsGets the value of theinputMethodRequestsproperty.final BoundsGets the value of thelayoutBoundsproperty.final doubleGets the value of thelayoutXproperty.final doubleGets the value of thelayoutYproperty.final TransformGets the value of thelocalToParentTransformproperty.final TransformGets the value of thelocalToSceneTransformproperty.final NodeOrientationGets the value of thenodeOrientationproperty.final EventHandler<? super ContextMenuEvent> Gets the value of theonContextMenuRequestedproperty.final EventHandler<? super MouseEvent> Gets the value of theonDragDetectedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDoneproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDroppedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragEnteredproperty.final EventHandler<? super DragEvent> Gets the value of theonDragExitedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragOverproperty.final EventHandler<? super InputMethodEvent> Gets the value of theonInputMethodTextChangedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyPressedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyReleasedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyTypedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseClickedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragDoneproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragEnteredproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseDraggedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragOverproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragReleasedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseEnteredproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseMovedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMousePressedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseReleasedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotateproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationFinishedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationStartedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollFinishedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollStartedproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeDownproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeLeftproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeRightproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeUpproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchMovedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchPressedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchReleasedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchStationaryproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomFinishedproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomStartedproperty.final doubleGets the value of theopacityproperty.final ParentGets the value of theparentproperty.final ObservableMap<Object, Object> Returns an observable map of properties on this node for use primarily by application developers.final ObservableSet<PseudoClass> Return the pseudo-class state of this Styleable.final doubleGets the value of therotateproperty.final Point3DGets the value of therotationAxisproperty.final doubleGets the value of thescaleXproperty.final doubleGets the value of thescaleYproperty.final doubleGets the value of thescaleZproperty.final ScenegetScene()Gets the value of thesceneproperty.final StringgetStyle()A string representation of the CSS style associated with this specificNode.Return the parent of this Styleable, or null if there is no parent.final ObservableList<String> A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.final ObservableList<Transform> final doubleGets the value of thetranslateXproperty.final doubleGets the value of thetranslateYproperty.final doubleGets the value of thetranslateZproperty.The type of thisStyleablethat is to be used in selector matching.Returns a previously set Object property, or null if no such property has been set using theNode.setUserData(java.lang.Object)method.final doubleGets the value of theviewOrderproperty.booleanTests if Node has properties.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.booleanintersects(double localX, double localY, double localWidth, double localHeight) Returnstrueif the given rectangle (specified in the local coordinate space of thisNode) intersects the shape of thisNode.booleanintersects(Bounds localBounds) Returnstrueif the given bounds (specified in the local coordinate space of thisNode) intersects the shape of thisNode.final booleanisCache()Gets the value of thecacheproperty.final booleanGets the value of thedisableproperty.final booleanGets the value of thedisabledproperty.final booleanGets the value of thefocusedproperty.final booleanGets the value of thefocusTraversableproperty.final booleanGets the value of thefocusVisibleproperty.final booleanGets the value of thefocusWithinproperty.final booleanisHover()Gets the value of thehoverproperty.final booleanGets the value of themanagedproperty.final booleanGets the value of themouseTransparentproperty.final booleanGets the value of thepickOnBoundsproperty.final booleanGets the value of thepressedproperty.final booleanGets the value of thevisibleproperty.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.localToParent(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.localToScene(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds, boolean rootScene) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.localToScreen(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(double localX, double localY, double localZ) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.Finds thisNode, or the first sub-node, based on the given CSS selector.Finds allNodes, including this one and any children, which match the given CSS selector.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final voidnotifyAccessibleAttributeChanged(AccessibleAttribute attributes) This method is called by the application to notify the assistive technology that the value for an attribute has changed.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.parentToLocal(double parentX, double parentY) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(double parentX, double parentY, double parentZ) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Bounds parentBounds) Transforms a rectangle from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point2D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point3D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final voidpseudoClassStateChanged(PseudoClass pseudoClass, boolean active) Used to specify that a pseudo-class of this Node has changed.queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) This method is called by the assistive technology to request the value for an attribute.voidrelocate(double x, double y) Sets the node's layoutX and layoutY translation properties in order to relocate this node to the x,y location in the parent.final <T extends Event>
voidremoveEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Unregisters a previously registered event filter from this target.final <T extends Event>
voidremoveEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Unregisters a previously registered event handler from this target.voidRequests that thisNodeget the input focus, and that thisNode's top-level ancestor become the focused window.final booleanrequestFocusTraversal(TraversalDirection direction) Requests to move the focus from thisNodein the specified direction.voidresizeRelocate(double x, double y, double width, double height) If the node is resizable, will set its layout bounds to the specified width and height.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.sceneToLocal(double sceneX, double sceneY) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double x, double y, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double sceneX, double sceneY, double sceneZ) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds sceneBounds) Transforms a rectangle from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds bounds, boolean rootScene) Transforms a bounds from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D point, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point3D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.screenToLocal(double screenX, double screenY) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Bounds screenBounds) Transforms a rectangle from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Point2D screenPoint) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.final voidsetAccessibleHelp(String value) Sets the value of theaccessibleHelpproperty.final voidsetAccessibleRole(AccessibleRole value) Sets the value of theaccessibleRoleproperty.final voidSets the value of theaccessibleRoleDescriptionproperty.final voidsetAccessibleText(String value) Sets the value of theaccessibleTextproperty.final voidsetBlendMode(BlendMode value) Sets the value of theblendModeproperty.final voidsetCache(boolean value) Sets the value of thecacheproperty.final voidsetCacheHint(CacheHint value) Sets the value of thecacheHintproperty.final voidSets the value of theclipproperty.final voidSets the value of thecursorproperty.final voidsetDepthTest(DepthTest value) Sets the value of thedepthTestproperty.final voidsetDisable(boolean value) Sets the value of thedisableproperty.protected final voidsetDisabled(boolean value) Sets the value of thedisabledproperty.final voidSets the value of theeffectproperty.final voidSets the value of theeventDispatcherproperty.protected final <T extends Event>
voidsetEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Sets the handler to use for this event type.protected final voidsetFocused(boolean value) Sets the value of thefocusedproperty.final voidsetFocusTraversable(boolean value) Sets the value of thefocusTraversableproperty.protected final voidsetHover(boolean value) Sets the value of thehoverproperty.final voidSets the value of theidproperty.final voidSets the value of theinputMethodRequestsproperty.final voidsetLayoutX(double value) Sets the value of thelayoutXproperty.final voidsetLayoutY(double value) Sets the value of thelayoutYproperty.final voidsetManaged(boolean value) Sets the value of themanagedproperty.final voidsetMouseTransparent(boolean value) Sets the value of themouseTransparentproperty.final voidsetNodeOrientation(NodeOrientation orientation) Sets the value of thenodeOrientationproperty.final voidsetOnContextMenuRequested(EventHandler<? super ContextMenuEvent> value) Sets the value of theonContextMenuRequestedproperty.final voidsetOnDragDetected(EventHandler<? super MouseEvent> value) Sets the value of theonDragDetectedproperty.final voidsetOnDragDone(EventHandler<? super DragEvent> value) Sets the value of theonDragDoneproperty.final voidsetOnDragDropped(EventHandler<? super DragEvent> value) Sets the value of theonDragDroppedproperty.final voidsetOnDragEntered(EventHandler<? super DragEvent> value) Sets the value of theonDragEnteredproperty.final voidsetOnDragExited(EventHandler<? super DragEvent> value) Sets the value of theonDragExitedproperty.final voidsetOnDragOver(EventHandler<? super DragEvent> value) Sets the value of theonDragOverproperty.final voidsetOnInputMethodTextChanged(EventHandler<? super InputMethodEvent> value) Sets the value of theonInputMethodTextChangedproperty.final voidsetOnKeyPressed(EventHandler<? super KeyEvent> value) Sets the value of theonKeyPressedproperty.final voidsetOnKeyReleased(EventHandler<? super KeyEvent> value) Sets the value of theonKeyReleasedproperty.final voidsetOnKeyTyped(EventHandler<? super KeyEvent> value) Sets the value of theonKeyTypedproperty.final voidsetOnMouseClicked(EventHandler<? super MouseEvent> value) Sets the value of theonMouseClickedproperty.final voidsetOnMouseDragDone(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragDoneproperty.final voidsetOnMouseDragEntered(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragEnteredproperty.final voidsetOnMouseDragExited(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragExitedproperty.final voidsetOnMouseDragged(EventHandler<? super MouseEvent> value) Sets the value of theonMouseDraggedproperty.final voidsetOnMouseDragOver(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragOverproperty.final voidsetOnMouseDragReleased(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragReleasedproperty.final voidsetOnMouseEntered(EventHandler<? super MouseEvent> value) Sets the value of theonMouseEnteredproperty.final voidsetOnMouseExited(EventHandler<? super MouseEvent> value) Sets the value of theonMouseExitedproperty.final voidsetOnMouseMoved(EventHandler<? super MouseEvent> value) Sets the value of theonMouseMovedproperty.final voidsetOnMousePressed(EventHandler<? super MouseEvent> value) Sets the value of theonMousePressedproperty.final voidsetOnMouseReleased(EventHandler<? super MouseEvent> value) Sets the value of theonMouseReleasedproperty.final voidsetOnRotate(EventHandler<? super RotateEvent> value) Sets the value of theonRotateproperty.final voidsetOnRotationFinished(EventHandler<? super RotateEvent> value) Sets the value of theonRotationFinishedproperty.final voidsetOnRotationStarted(EventHandler<? super RotateEvent> value) Sets the value of theonRotationStartedproperty.final voidsetOnScroll(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollproperty.final voidsetOnScrollFinished(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollFinishedproperty.final voidsetOnScrollStarted(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollStartedproperty.final voidsetOnSwipeDown(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeDownproperty.final voidsetOnSwipeLeft(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeLeftproperty.final voidsetOnSwipeRight(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeRightproperty.final voidsetOnSwipeUp(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeUpproperty.final voidsetOnTouchMoved(EventHandler<? super TouchEvent> value) Sets the value of theonTouchMovedproperty.final voidsetOnTouchPressed(EventHandler<? super TouchEvent> value) Sets the value of theonTouchPressedproperty.final voidsetOnTouchReleased(EventHandler<? super TouchEvent> value) Sets the value of theonTouchReleasedproperty.final voidsetOnTouchStationary(EventHandler<? super TouchEvent> value) Sets the value of theonTouchStationaryproperty.final voidsetOnZoom(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomproperty.final voidsetOnZoomFinished(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomFinishedproperty.final voidsetOnZoomStarted(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomStartedproperty.final voidsetOpacity(double value) Sets the value of theopacityproperty.final voidsetPickOnBounds(boolean value) Sets the value of thepickOnBoundsproperty.protected final voidsetPressed(boolean value) Sets the value of thepressedproperty.final voidsetRotate(double value) Sets the value of therotateproperty.final voidsetRotationAxis(Point3D value) Sets the value of therotationAxisproperty.final voidsetScaleX(double value) Sets the value of thescaleXproperty.final voidsetScaleY(double value) Sets the value of thescaleYproperty.final voidsetScaleZ(double value) Sets the value of thescaleZproperty.final voidA string representation of the CSS style associated with this specificNode.final voidsetTranslateX(double value) Sets the value of thetranslateXproperty.final voidsetTranslateY(double value) Sets the value of thetranslateYproperty.final voidsetTranslateZ(double value) Sets the value of thetranslateZproperty.voidsetUserData(Object value) Convenience method for setting a single Object property that can be retrieved at a later date.final voidsetViewOrder(double value) Sets the value of theviewOrderproperty.final voidsetVisible(boolean value) Sets the value of thevisibleproperty.snapshot(SnapshotParameters params, WritableImage image) Takes a snapshot of this node and returns the rendered image when it is ready.voidsnapshot(Callback<SnapshotResult, Void> callback, SnapshotParameters params, WritableImage image) Takes a snapshot of this node at the next frame and calls the specified callback method when the image is ready.startDragAndDrop(TransferMode... transferModes) Confirms a potential drag and drop gesture that is recognized over thisNode.voidStarts a full press-drag-release gesture with this node as gesture source.final StringPropertyA string representation of the CSS style associated with this specificNode.voidtoBack()Moves thisNodeto the back of its sibling nodes in terms of z-order.voidtoFront()Moves thisNodeto the front of its sibling nodes in terms of z-order.toString()Returns a string representation for the object.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.booleanDetermines whether a node should be mirrored when node orientation is right-to-left.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface Styleable
getStyleableNodeModifier and TypeMethodDescriptiondefault NodeReturns the Node that represents this Styleable object.
-
Property Details
-
vertical
Indicates the primary direction of virtualization. If true, then the primary direction of virtualization is vertical, meaning that cells will stack vertically on top of each other. If false, then they will stack horizontally next to each other.- See Also:
-
pannable
Indicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).- See Also:
-
cellCount
Indicates the number of cells that should be in the flow. The user of the VirtualFlow must set this appropriately. When the cell count changes the VirtualFlow responds by updating the visuals. If the items backing the cells change, but the count has not changed, you must call the reconfigureCells() function to update the visuals.- See Also:
-
position
The position of the VirtualFlow within its list of cells. This is a value between 0 and 1.- See Also:
-
fixedCellSize
For optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.- See Also:
-
cellFactory
public final ObjectProperty<Callback<VirtualFlow<T extends IndexedCell>, T extends IndexedCell>> cellFactoryPropertySetting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell. Internally, the VirtualFlow is responsible for reusing cells - all that is necessary is for the custom cell factory to return from this function a cell which might be usable for representing any item in the VirtualFlow.
Refer to the
Cellclass documentation for more detail.- See Also:
-
-
Constructor Details
-
VirtualFlow
public VirtualFlow()Creates a new VirtualFlow instance.
-
-
Method Details
-
setVertical
public final void setVertical(boolean value) Sets the value of theverticalproperty.- Property description:
- Indicates the primary direction of virtualization. If true, then the primary direction of virtualization is vertical, meaning that cells will stack vertically on top of each other. If false, then they will stack horizontally next to each other.
- Parameters:
value- the value for theverticalproperty- See Also:
-
isVertical
public final boolean isVertical()Gets the value of theverticalproperty.- Property description:
- Indicates the primary direction of virtualization. If true, then the primary direction of virtualization is vertical, meaning that cells will stack vertically on top of each other. If false, then they will stack horizontally next to each other.
- Returns:
- the value of the
verticalproperty - See Also:
-
verticalProperty
Indicates the primary direction of virtualization. If true, then the primary direction of virtualization is vertical, meaning that cells will stack vertically on top of each other. If false, then they will stack horizontally next to each other.- Returns:
- the
verticalproperty - See Also:
-
isPannable
public final boolean isPannable()Gets the value of thepannableproperty.- Property description:
- Indicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).
- Returns:
- the value of the
pannableproperty - See Also:
-
setPannable
public final void setPannable(boolean value) Sets the value of thepannableproperty.- Property description:
- Indicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).
- Parameters:
value- the value for thepannableproperty- See Also:
-
pannableProperty
Indicates whether the VirtualFlow viewport is capable of being panned by the user (either via the mouse or touch events).- Returns:
- the
pannableproperty - See Also:
-
getCellCount
public final int getCellCount()Gets the value of thecellCountproperty.- Property description:
- Indicates the number of cells that should be in the flow. The user of the VirtualFlow must set this appropriately. When the cell count changes the VirtualFlow responds by updating the visuals. If the items backing the cells change, but the count has not changed, you must call the reconfigureCells() function to update the visuals.
- Returns:
- the value of the
cellCountproperty - See Also:
-
setCellCount
public final void setCellCount(int value) Sets the value of thecellCountproperty.- Property description:
- Indicates the number of cells that should be in the flow. The user of the VirtualFlow must set this appropriately. When the cell count changes the VirtualFlow responds by updating the visuals. If the items backing the cells change, but the count has not changed, you must call the reconfigureCells() function to update the visuals.
- Parameters:
value- the value for thecellCountproperty- See Also:
-
cellCountProperty
Indicates the number of cells that should be in the flow. The user of the VirtualFlow must set this appropriately. When the cell count changes the VirtualFlow responds by updating the visuals. If the items backing the cells change, but the count has not changed, you must call the reconfigureCells() function to update the visuals.- Returns:
- the
cellCountproperty - See Also:
-
getPosition
public final double getPosition()Gets the value of thepositionproperty.- Property description:
- The position of the VirtualFlow within its list of cells. This is a value between 0 and 1.
- Returns:
- the value of the
positionproperty - See Also:
-
setPosition
public final void setPosition(double value) Sets the value of thepositionproperty.- Property description:
- The position of the VirtualFlow within its list of cells. This is a value between 0 and 1.
- Parameters:
value- the value for thepositionproperty- See Also:
-
positionProperty
The position of the VirtualFlow within its list of cells. This is a value between 0 and 1.- Returns:
- the
positionproperty - See Also:
-
setFixedCellSize
public final void setFixedCellSize(double value) Sets the value of thefixedCellSizeproperty.- Property description:
- For optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.
- Parameters:
value- the value for thefixedCellSizeproperty- See Also:
-
getFixedCellSize
public final double getFixedCellSize()Gets the value of thefixedCellSizeproperty.- Property description:
- For optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.
- Returns:
- the value of the
fixedCellSizeproperty - See Also:
-
fixedCellSizeProperty
For optimisation purposes, some use cases can trade dynamic cell length for speed - if fixedCellSize is greater than zero we'll use that rather than determine it by querying the cell itself.- Returns:
- the
fixedCellSizeproperty - See Also:
-
setCellFactory
Sets a new cell factory to use in the VirtualFlow. This forces all old cells to be thrown away, and new cells to be created with the new cell factory.- Parameters:
value- the new cell factory
-
getCellFactory
Returns the current cell factory.- Returns:
- the current cell factory
-
cellFactoryProperty
Setting a custom cell factory has the effect of deferring all cell creation, allowing for total customization of the cell. Internally, the VirtualFlow is responsible for reusing cells - all that is necessary is for the custom cell factory to return from this function a cell which might be usable for representing any item in the VirtualFlow.
Refer to the
Cellclass documentation for more detail.- Returns:
- the cell factory property
- See Also:
-
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:
requestLayoutin classParent
-
getAvailableCell
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.- Parameters:
prefIndex- the preferred index- Returns:
- the available cell
-
addAllToPile
protected void addAllToPile()This method will remove all cells from the VirtualFlow and remove them, adding them to the 'pile' (that is, a place from where cells can be used at a later date). This method is protected to allow subclasses to clean up appropriately. -
getVisibleCell
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.- Parameters:
index- the index- Returns:
- the visible cell
-
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.- Returns:
- the last visible cell
-
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.- Returns:
- the first visible cell
-
scrollToTop
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".- Parameters:
firstCell- the first cell
-
scrollToBottom
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".- Parameters:
lastCell- the last cell
-
scrollTo
Adjusts the cells such that the selected cell will be fully visible in the viewport (but only just).- Parameters:
cell- the cell
-
scrollTo
public void scrollTo(int index) Adjusts the cells such that the cell in the given index will be fully visible in the viewport.- Parameters:
index- the index
-
scrollToTop
public void scrollToTop(int index) Adjusts the cells such that the cell in the given index will be fully visible in the viewport, and positioned at the very top of the viewport.- Parameters:
index- the index
-
scrollPixels
public double scrollPixels(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.- Parameters:
delta- the delta value- Returns:
- the number of pixels actually moved
-
getCell
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.- Parameters:
index- the index- Returns:
- the cell
-
setCellIndex
The VirtualFlow uses this method to set a cells index (rather than callingIndexedCell.updateIndex(int)directly), so it is a perfect place for subclasses to override if this if of interest.- Parameters:
cell- The cell whose index will be updated.index- The new index for the cell.
-
getCellIndex
Return the index for a given cell. This allows subclasses to customise how cell indices are retrieved.- Parameters:
cell- the cell- Returns:
- the index
-
getHbar
Returns the scroll bar used for scrolling horizontally. A developer who needs to be notified when a scroll is happening could attach a listener to theScrollBar.valueProperty().- Returns:
- the scroll bar used for scrolling horizontally
- Since:
- 12
-
getVbar
Returns the scroll bar used for scrolling vertically. A developer who needs to be notified when a scroll is happening could attach a listener to theScrollBar.valueProperty(). TheRegion.getWidth()is also useful when adding a component over theTableViewin order to clip it so that it doesn't overlap theScrollBar.- Returns:
- the scroll bar used for scrolling vertically
- Since:
- 12
-
getViewportLength
public double getViewportLength()Returns the length of the viewport portion of theVirtualFlowas computed during the layout pass. For a vertical flow this is based on the height and for a horizontal flow on the width of the clip view.- Returns:
- the viewport length in pixels
- Since:
- 23
-
resizeCell
Resizes the given cell. IfisVertical()is set totrue, the cell width will be the maximum between the viewport width and the sum of all the cells'prefWidth. The cell height will be computed by the cell itself unlessfixedCellSizeEnabledis set totrue, thengetFixedCellSize()is used. IfisVertical()is set tofalse, the width and height calculations are reversed.- Parameters:
cell- the cell to resize- Since:
- 12
-
getCells
Returns the list of cells displayed in the current viewport.The cells are ordered such that the first cell in this list is the first in the view, and the last cell is the last in the view. When pixel scrolling, the list is simply shifted and items drop off the beginning or the end, depending on the order of scrolling.
- Returns:
- the cells displayed in the current viewport
- Since:
- 12
-
getLastVisibleCellWithinViewport
Returns the last visible cell whose bounds are entirely within the viewport. When manually inserting rows, one may need to know which cell indices are visible in the viewport.- Returns:
- last visible cell whose bounds are entirely within the viewport
- Since:
- 12
-
getFirstVisibleCellWithinViewport
Returns the first visible cell whose bounds are entirely within the viewport. When manually inserting rows, one may need to know which cell indices are visible in the viewport.- Returns:
- first visible cell whose bounds are entirely within the viewport
- Since:
- 12
-
reconfigureCells
protected void reconfigureCells()Informs theVirtualFlowthat a layout pass should be done, and the cell contents have not changed. For example, this might be called from aTableVieworListViewwhen a layout is needed and no cells have been added or removed.- Since:
- 12
-
recreateCells
protected void recreateCells()Informs theVirtualFlowthat a layout pass should be done, and that the cell factory has changed. All cells in the viewport are recreated with the new cell factory.- Since:
- 12
-
rebuildCells
protected void rebuildCells()Informs theVirtualFlowthat a layout pass should be done, and cell contents have changed. All cells are removed and then added properly in the viewport.- Since:
- 12
-
requestCellLayout
protected void requestCellLayout()Informs theVirtualFlowthat a layout pass should be done and only the cell layout will be requested.- Since:
- 12
-
getPrivateCell
Creates and returns a new cell for the given index.If the requested index is not already an existing visible cell, it will create a cell for the given index and insert it into the
VirtualFlowcontainer. If the index exists, simply returns the visible cell. From that point on, it will be unmanaged, and is up to the caller of this method to manage it.This is useful if a row that should not be visible must be accessed (a row that always stick to the top for example). It can then be easily created, correctly initialized and inserted in the
VirtualFlowcontainer.- Parameters:
index- the cell index- Returns:
- a cell for the given index inserted in the VirtualFlow container
- Since:
- 12
-
snapPositionX()andsnapPositionY()