Class HiddenSidesPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.HiddenSidesPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class HiddenSidesPane extends javafx.scene.control.Control
A pane used to display a full-size content node and four initially hidden nodes on the four sides. The hidden nodes can be made visible by moving the mouse cursor to the edges (see setTriggerDistance(double)) of the pane. The hidden node will appear (at its preferred width or height) with a short slide-in animation. The node will disappear again as soon as the mouse cursor exits it. A hidden node / side can also be pinned by calling setPinnedSide(Side). It will remain visible as long as it stays pinned.

Screenshot

The following screenshots shows the right side node hovering over a table after it was made visible: Screenshot of HiddenSidesPane

Code Sample

HiddenSidesPane pane = new HiddenSidesPane();
pane.setContent(new TableView());
pane.setRight(new ListView());

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDelay
    Returns the animation delay property.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDuration
    Returns the animation duration property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    bottom
    The node displayed at the bottom of the pane.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    content
    The property that is used to store a reference to the content node.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    left
    The node displayed on the left side of the pane.
    final javafx.beans.property.ObjectProperty<javafx.geometry.Side>
    pinnedSide
    Returns the pinned side property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    right
    The node displayed on the right side of the pane.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    top
    The property used to store a reference to the node shown at the top side of the pane.
    final javafx.beans.property.DoubleProperty
    triggerDistance
    The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
    Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    Properties inherited from class javafx.scene.layout.Region

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

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

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

  • Field Summary

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    HiddenSidesPane()
    Constructs a new pane with no content and no side nodes.
    HiddenSidesPane(javafx.scene.Node content, javafx.scene.Node top, javafx.scene.Node right, javafx.scene.Node bottom, javafx.scene.Node left)
    Constructs a new pane with the given content node and the four side nodes.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDelayProperty()
    Returns the animation delay property.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDurationProperty()
    Returns the animation duration property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    bottomProperty()
    The node displayed at the bottom of the pane.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    contentProperty()
    The property that is used to store a reference to the content node.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
    Creates the default skin for this control.
    final javafx.util.Duration
    getAnimationDelay()
    Gets the value of the animationDelay property.
    final javafx.util.Duration
    getAnimationDuration()
    Gets the value of the animationDuration property.
    final javafx.scene.Node
    getBottom()
    Gets the value of the bottom property.
    final javafx.scene.Node
    getContent()
    Gets the value of the content property.
    final javafx.scene.Node
    getLeft()
    Gets the value of the left property.
    final javafx.geometry.Side
    getPinnedSide()
    Gets the value of the pinnedSide property.
    final javafx.scene.Node
    getRight()
    Gets the value of the right property.
    final javafx.scene.Node
    getTop()
    Gets the value of the top property.
    final double
    getTriggerDistance()
    Gets the value of the triggerDistance property.
    void
    hide()
    Hides the currently showing side
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    leftProperty()
    The node displayed on the left side of the pane.
    final javafx.beans.property.ObjectProperty<javafx.geometry.Side>
    pinnedSideProperty()
    Returns the pinned side property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    rightProperty()
    The node displayed on the right side of the pane.
    final void
    setAnimationDelay(javafx.util.Duration duration)
    Sets the value of the animationDelay property.
    final void
    setAnimationDuration(javafx.util.Duration duration)
    Sets the value of the animationDuration property.
    final void
    setBottom(javafx.scene.Node bottom)
    Sets the value of the bottom property.
    final void
    setContent(javafx.scene.Node content)
    Sets the value of the content property.
    final void
    setLeft(javafx.scene.Node left)
    Sets the value of the left property.
    final void
    setPinnedSide(javafx.geometry.Side side)
    Sets the value of the pinnedSide property.
    final void
    setRight(javafx.scene.Node right)
    Sets the value of the right property.
    final void
    setTop(javafx.scene.Node top)
    Sets the value of the top property.
    final void
    setTriggerDistance(double distance)
    Sets the value of the triggerDistance property.
    void
    show(javafx.geometry.Side side)
    Shows a specific side
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    topProperty()
    The property used to store a reference to the node shown at the top side of the pane.
    final javafx.beans.property.DoubleProperty
    triggerDistanceProperty()
    The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
    Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

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

    Methods inherited from class javafx.scene.Node

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

    Methods inherited from class Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • triggerDistance

      public final javafx.beans.property.DoubleProperty triggerDistanceProperty
      The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
      Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).
      See Also:

    • content

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      See Also:

    • top

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> topProperty
      The property used to store a reference to the node shown at the top side of the pane.
      See Also:

    • right

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> rightProperty
      The node displayed on the right side of the pane. It slides in when the cursor moves to the right edge.
      See Also:

    • bottom

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> bottomProperty
      The node displayed at the bottom of the pane. It slides in when the cursor moves to the bottom edge.
      See Also:

    • left

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> leftProperty
      The node displayed on the left side of the pane. It slides in when the cursor moves to the left edge.
      See Also:

    • pinnedSide

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Side> pinnedSideProperty
      Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.
      See Also:

    • animationDelay

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDelayProperty
      Returns the animation delay property. The value of this property determines the delay before the hidden side slide in / slide out animation starts to play.
      See Also:

    • animationDuration

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty
      Returns the animation duration property. The value of this property determines the fade in time for a hidden side to become visible.
      See Also:

  • Constructor Details

    • HiddenSidesPane

      public HiddenSidesPane(javafx.scene.Node content, javafx.scene.Node top, javafx.scene.Node right, javafx.scene.Node bottom, javafx.scene.Node left)
      Constructs a new pane with the given content node and the four side nodes. Each one of the side nodes may be null.
      Parameters:
      content - the primary node that will fill the entire width and height of the pane
      top - the hidden node on the top side
      right - the hidden node on the right side
      bottom - the hidden node on the bottom side
      left - the hidden node on the left side

    • HiddenSidesPane

      public HiddenSidesPane()
      Constructs a new pane with no content and no side nodes.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Creates the default skin for this control.
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control
      Returns:
      the default skin

    • triggerDistanceProperty

      public final javafx.beans.property.DoubleProperty triggerDistanceProperty()
      The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
      Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).
      Returns:
      the trigger distance property
      See Also:

    • getTriggerDistance

      public final double getTriggerDistance()
      Gets the value of the triggerDistance property.
      Property description:
      The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
      Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).
      Returns:
      the value of the triggerDistance property
      See Also:

    • setTriggerDistance

      public final void setTriggerDistance(double distance)
      Sets the value of the triggerDistance property.
      Property description:
      The property that stores the distance to the pane's edges that will trigger the appearance of the hidden side nodes.
      Setting the property to zero or a negative value will disable this functionality, so a hidden side can only be made visible with setPinnedSide(Side).
      Parameters:
      distance - the value for the triggerDistance property
      See Also:

    • contentProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty()
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Returns:
      the content node property
      See Also:

    • getContent

      public final javafx.scene.Node getContent()
      Gets the value of the content property.
      Property description:
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Returns:
      the value of the content property
      See Also:

    • setContent

      public final void setContent(javafx.scene.Node content)
      Sets the value of the content property.
      Property description:
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Parameters:
      content - the value for the content property
      See Also:

    • topProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> topProperty()
      The property used to store a reference to the node shown at the top side of the pane.
      Returns:
      the hidden node at the top side of the pane
      See Also:

    • getTop

      public final javafx.scene.Node getTop()
      Gets the value of the top property.
      Property description:
      The property used to store a reference to the node shown at the top side of the pane.
      Returns:
      the value of the top property
      See Also:

    • setTop

      public final void setTop(javafx.scene.Node top)
      Sets the value of the top property.
      Property description:
      The property used to store a reference to the node shown at the top side of the pane.
      Parameters:
      top - the value for the top property
      See Also:

    • rightProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> rightProperty()
      The node displayed on the right side of the pane. It slides in when the cursor moves to the right edge.
      Returns:
      the right node property
      See Also:

    • getRight

      public final javafx.scene.Node getRight()
      Gets the value of the right property.
      Property description:
      The node displayed on the right side of the pane. It slides in when the cursor moves to the right edge.
      Returns:
      the value of the right property
      See Also:

    • setRight

      public final void setRight(javafx.scene.Node right)
      Sets the value of the right property.
      Property description:
      The node displayed on the right side of the pane. It slides in when the cursor moves to the right edge.
      Parameters:
      right - the value for the right property
      See Also:

    • bottomProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> bottomProperty()
      The node displayed at the bottom of the pane. It slides in when the cursor moves to the bottom edge.
      Returns:
      the bottom node property
      See Also:

    • getBottom

      public final javafx.scene.Node getBottom()
      Gets the value of the bottom property.
      Property description:
      The node displayed at the bottom of the pane. It slides in when the cursor moves to the bottom edge.
      Returns:
      the value of the bottom property
      See Also:

    • setBottom

      public final void setBottom(javafx.scene.Node bottom)
      Sets the value of the bottom property.
      Property description:
      The node displayed at the bottom of the pane. It slides in when the cursor moves to the bottom edge.
      Parameters:
      bottom - the value for the bottom property
      See Also:

    • leftProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> leftProperty()
      The node displayed on the left side of the pane. It slides in when the cursor moves to the left edge.
      Returns:
      the left node property
      See Also:

    • getLeft

      public final javafx.scene.Node getLeft()
      Gets the value of the left property.
      Property description:
      The node displayed on the left side of the pane. It slides in when the cursor moves to the left edge.
      Returns:
      the value of the left property
      See Also:

    • setLeft

      public final void setLeft(javafx.scene.Node left)
      Sets the value of the left property.
      Property description:
      The node displayed on the left side of the pane. It slides in when the cursor moves to the left edge.
      Parameters:
      left - the value for the left property
      See Also:

    • pinnedSideProperty

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Side> pinnedSideProperty()
      Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.
      Returns:
      the pinned side property
      See Also:

    • getPinnedSide

      public final javafx.geometry.Side getPinnedSide()
      Gets the value of the pinnedSide property.
      Property description:
      Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.
      Returns:
      the value of the pinnedSide property
      See Also:

    • setPinnedSide

      public final void setPinnedSide(javafx.geometry.Side side)
      Sets the value of the pinnedSide property.
      Property description:
      Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.
      Parameters:
      side - the value for the pinnedSide property
      See Also:

    • animationDelayProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDelayProperty()
      Returns the animation delay property. The value of this property determines the delay before the hidden side slide in / slide out animation starts to play.
      Returns:
      animation delay property
      See Also:

    • getAnimationDelay

      public final javafx.util.Duration getAnimationDelay()
      Gets the value of the animationDelay property.
      Property description:
      Returns the animation delay property. The value of this property determines the delay before the hidden side slide in / slide out animation starts to play.
      Returns:
      the value of the animationDelay property
      See Also:

    • setAnimationDelay

      public final void setAnimationDelay(javafx.util.Duration duration)
      Sets the value of the animationDelay property.
      Property description:
      Returns the animation delay property. The value of this property determines the delay before the hidden side slide in / slide out animation starts to play.
      Parameters:
      duration - the value for the animationDelay property
      See Also:

    • animationDurationProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty()
      Returns the animation duration property. The value of this property determines the fade in time for a hidden side to become visible.
      Returns:
      animation delay property
      See Also:

    • getAnimationDuration

      public final javafx.util.Duration getAnimationDuration()
      Gets the value of the animationDuration property.
      Property description:
      Returns the animation duration property. The value of this property determines the fade in time for a hidden side to become visible.
      Returns:
      the value of the animationDuration property
      See Also:

    • setAnimationDuration

      public final void setAnimationDuration(javafx.util.Duration duration)
      Sets the value of the animationDuration property.
      Property description:
      Returns the animation duration property. The value of this property determines the fade in time for a hidden side to become visible.
      Parameters:
      duration - the value for the animationDuration property
      See Also:

    • show

      public void show(javafx.geometry.Side side)
      Shows a specific side
      Parameters:
      side - the side to show

    • hide

      public void hide()
      Hides the currently showing side