Module atlantafx.base

Package atlantafx.base.layout

Class DeckPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.AnchorPane

atlantafx.base.layout.DeckPane

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class DeckPane
extends javafx.scene.layout.AnchorPane

Represents a pane that displays all of its child nodes in a deck, where only one node can be visible at a time. It does not maintain any sequence (model), but only cares about the top node, which can be changed by various transition effects.

View Order

DeckPane manages Node.viewOrderProperty() of its children. Topmost visible node always has the highest view order value, while the rest of the nodes have the default value, which is zero. Following that logic, one must not set child nodes view order manually, because it will break the contract.

If all child nodes have the same view order value (default state after creating a new DeckPane), they are displayed in order specified by the root container, which is AnchorPane. When a node is removed from the pane, its view order is restored automatically.

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	afterHideCallback	Sets the callback action to be called after removing the top node from the top of the DeckPane.
javafx.beans.property.ReadOnlyBooleanProperty	animationActive	Indicates whether the transition is in progress.
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDuration	Represents the duration of the transition effect that is played when changing the top node.
javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	beforeShowCallback	Sets the callback action to be called before setting a node at the top of the DeckPane.

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, 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, 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

Modifier and Type	Field	Description
protected final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	afterHideCallback
protected final javafx.beans.property.ReadOnlyBooleanWrapper	animationActive
protected final javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDuration
protected final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	beforeShowCallback
protected static final int	Z_ANIMATED_IN
protected static final int	Z_ANIMATED_OUT
protected static final Comparator<javafx.scene.Node>	Z_COMPARATOR
protected static final int	Z_DECK_TOP
protected static final int	Z_DEFAULT

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
DeckPane()	Creates a new empty DeckPane.
DeckPane(javafx.scene.Node... children)	Creates an DeckPane with the given children.

Method Summary

Modifier and Type	Method	Description
void	addChildren(javafx.geometry.Insets offset, javafx.scene.Node... nodes)	Adds the given nodes to the pane and binds them to the pane edges using the provided offset.
javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	afterHideCallbackProperty()	Sets the callback action to be called after removing the top node from the top of the DeckPane.
javafx.beans.property.ReadOnlyBooleanProperty	animationActiveProperty()	Indicates whether the transition is in progress.
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDurationProperty()	Represents the duration of the transition effect that is played when changing the top node.
javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>>	beforeShowCallbackProperty()	Sets the callback action to be called before setting a node at the top of the DeckPane.
@Nullable Consumer<javafx.scene.Node>	getAfterHideCallback()	Gets the value of the afterHideCallback property.
javafx.util.Duration	getAnimationDuration()	Gets the value of the animationDuration property.
@Nullable Consumer<javafx.scene.Node>	getBeforeShowCallback()	Gets the value of the beforeShowCallback property.
@Nullable javafx.scene.Node	getTopNode()	Returns the node with the highest view order value, or the last node if all child nodes have the same view order value.
boolean	isAnimationActive()	Gets the value of the animationActive property.
protected javafx.animation.Timeline	moveXLeftFromLeftBorderToOffCanvas(javafx.scene.Node node)
protected javafx.animation.Timeline	moveXLeftFromRightBorderToLeftBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveXRightFromLeftBorderToRightBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveXRightFromOffCanvasToLeftBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveYDownFromOffCanvasToTopBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveYDownFromTopBorderToBottomBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveYUpFromBottomBorderToTopBorder(javafx.scene.Node node)
protected javafx.animation.Timeline	moveYUpFromTopBorderToOffCanvas(javafx.scene.Node node)
protected void	onTransitionFinished(javafx.scene.Node topNode, javafx.scene.Node target)	Cleans-up properties after transition finished.
protected boolean	prepareAndCheck(@Nullable javafx.scene.Node topNode, @Nullable javafx.scene.Node target)	Verifies that transition is possible and prepares initial conditions.
protected void	resetNode(javafx.scene.Node node)	Resets given node to the default state.
void	resetTopNode()	Sets current top node view order to the default value.
protected void	runAfterHideCallback(javafx.scene.Node node)
protected void	runBeforeShowCallback(javafx.scene.Node node)
void	setAfterHideCallback(@Nullable Consumer<javafx.scene.Node> callback)	Sets the value of the afterHideCallback property.
protected void	setAnimationActive(boolean animationActive)	Sets the value of the animationActive property.
void	setAnimationDuration(@Nullable javafx.util.Duration animationDuration)	Sets the value of the animationDuration property.
void	setBeforeShowCallback(@Nullable Consumer<javafx.scene.Node> callback)	Sets the value of the beforeShowCallback property.
void	setTopNode(javafx.scene.Node target)	Sets given node on top without playing any transition.
protected void	setViewOrder(javafx.scene.Node node, int viewOrder)	Sets the node view order.
void	slideDown(javafx.scene.Node target)	Places target node on the top of the pane while playing the slide transition from top to bottom.
void	slideLeft(javafx.scene.Node target)	Places target node on the top of the pane while playing the slide transition from right to left.
void	slideRight(javafx.scene.Node target)	Places target node on the top of the pane while playing the slide transition from left to right.
void	slideUp(javafx.scene.Node target)	Places target node on the top of the pane while playing the slide transition from bottom to top.
void	swipeDown(javafx.scene.Node target)	Places target node on the top of the pane while playing the swipe transition from top to bottom.
void	swipeLeft(javafx.scene.Node target)	Places target node on the top of the pane while playing the swipe transition from right to left.
void	swipeRight(javafx.scene.Node target)	Places target node on the top of the pane while playing the swipe transition from left to right.
void	swipeUp(javafx.scene.Node target)	Places target node on the top of the pane while playing the swipe transition from bottom to top.

Methods inherited from class javafx.scene.layout.AnchorPane

clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBottomAnchor, getLeftAnchor, getRightAnchor, getTopAnchor, layoutChildren, setBottomAnchor, setLeftAnchor, setRightAnchor, setTopAnchor

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

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

Methods inherited from class javafx.scene.Parent

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

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, 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, 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, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

animationDuration

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty

Represents the duration of the transition effect that is played when changing the top node.

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)
• animationDurationProperty()

animationActive

public javafx.beans.property.ReadOnlyBooleanProperty animationActiveProperty

Indicates whether the transition is in progress. Subscribe to this property to be notified when the animation starts or finishes.

See Also:

• isAnimationActive()
• setAnimationActive(boolean)
• animationActiveProperty()

beforeShowCallback

public javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> beforeShowCallbackProperty

Sets the callback action to be called before setting a node at the top of the DeckPane.

See Also:

• getBeforeShowCallback()
• setBeforeShowCallback(Consumer)
• beforeShowCallbackProperty()

afterHideCallback

public javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> afterHideCallbackProperty

Sets the callback action to be called after removing the top node from the top of the DeckPane.

See Also:

• getAfterHideCallback()
• setAfterHideCallback(Consumer)
• afterHideCallbackProperty()

Field Details

Z_COMPARATOR

protected static final Comparator<javafx.scene.Node> Z_COMPARATOR

Z_ANIMATED_IN

protected static final int Z_ANIMATED_IN

See Also:

• Constant Field Values

Z_ANIMATED_OUT

protected static final int Z_ANIMATED_OUT

See Also:

• Constant Field Values

Z_DECK_TOP

protected static final int Z_DECK_TOP

See Also:

• Constant Field Values

Z_DEFAULT

protected static final int Z_DEFAULT

See Also:

• Constant Field Values

animationDuration

protected final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDuration

animationActive

protected final javafx.beans.property.ReadOnlyBooleanWrapper animationActive

beforeShowCallback

protected final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> beforeShowCallback

afterHideCallback

protected final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> afterHideCallback

Constructor Details

DeckPane

public DeckPane()

Creates a new empty DeckPane.

DeckPane

public DeckPane(javafx.scene.Node... children)

Creates an DeckPane with the given children.

Parameters:

children - The initial set of children for this pane.

Method Details

getTopNode

@Nullable
public @Nullable javafx.scene.Node getTopNode()

Returns the node with the highest view order value, or the last node if all child nodes have the same view order value.

setTopNode

public void setTopNode(javafx.scene.Node target)

Sets given node on top without playing any transition. Does nothing if that node isn't added to the pane.

Parameters:

target - The node to be set on top.

resetTopNode

public void resetTopNode()

Sets current top node view order to the default value.

addChildren

public void addChildren(javafx.geometry.Insets offset,
 javafx.scene.Node... nodes)

Adds the given nodes to the pane and binds them to the pane edges using the provided offset. See AnchorPane.setTopAnchor(Node, Double) for the reference.

Parameters:

offset - The offset values for each othe the specified nodes.

nodes - The array of the nodes to be added.

swipeUp

public void swipeUp(javafx.scene.Node target)

Places target node on the top of the pane while playing the swipe transition from bottom to top. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

swipeDown

public void swipeDown(javafx.scene.Node target)

Places target node on the top of the pane while playing the swipe transition from top to bottom. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

swipeLeft

public void swipeLeft(javafx.scene.Node target)

Places target node on the top of the pane while playing the swipe transition from right to left. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

swipeRight

public void swipeRight(javafx.scene.Node target)

Places target node on the top of the pane while playing the swipe transition from left to right. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

slideUp

public void slideUp(javafx.scene.Node target)

Places target node on the top of the pane while playing the slide transition from bottom to top. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

slideDown

public void slideDown(javafx.scene.Node target)

Places target node on the top of the pane while playing the slide transition from top to bottom. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

slideLeft

public void slideLeft(javafx.scene.Node target)

Places target node on the top of the pane while playing the slide transition from right to left. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

slideRight

public void slideRight(javafx.scene.Node target)

Places target node on the top of the pane while playing the slide transition from left to right. If the pane doesn't contain that node, it will be added to the end before playing transition.

Parameters:

target - The node to be set on top.

animationDurationProperty

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty()

Represents the duration of the transition effect that is played when changing the top node.

Returns:

the animationDuration property

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)

getAnimationDuration

public javafx.util.Duration getAnimationDuration()

Gets the value of the animationDuration property.

Property description:

Represents the duration of the transition effect that is played when changing the top node.

Returns:

the value of the animationDuration property

See Also:

• setAnimationDuration(Duration)
• animationDurationProperty()

setAnimationDuration

public void setAnimationDuration(@Nullable
 @Nullable javafx.util.Duration animationDuration)

Sets the value of the animationDuration property.

Property description:

Represents the duration of the transition effect that is played when changing the top node.

Parameters:

animationDuration - the value for the animationDuration property

See Also:

• getAnimationDuration()
• animationDurationProperty()

animationActiveProperty

public javafx.beans.property.ReadOnlyBooleanProperty animationActiveProperty()

Indicates whether the transition is in progress. Subscribe to this property to be notified when the animation starts or finishes.

Returns:

the animationActive property

See Also:

• isAnimationActive()
• setAnimationActive(boolean)

isAnimationActive

public boolean isAnimationActive()

Gets the value of the animationActive property.

Property description:

Indicates whether the transition is in progress. Subscribe to this property to be notified when the animation starts or finishes.

Returns:

the value of the animationActive property

See Also:

• setAnimationActive(boolean)
• animationActiveProperty()

setAnimationActive

protected void setAnimationActive(boolean animationActive)

Sets the value of the animationActive property.

Property description:

Indicates whether the transition is in progress. Subscribe to this property to be notified when the animation starts or finishes.

Parameters:

animationActive - the value for the animationActive property

See Also:

• isAnimationActive()
• animationActiveProperty()

beforeShowCallbackProperty

public javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> beforeShowCallbackProperty()

Sets the callback action to be called before setting a node at the top of the DeckPane.

Returns:

the beforeShowCallback property

See Also:

• getBeforeShowCallback()
• setBeforeShowCallback(Consumer)

getBeforeShowCallback

@Nullable
public @Nullable Consumer<javafx.scene.Node> getBeforeShowCallback()

Gets the value of the beforeShowCallback property.

Property description:

Sets the callback action to be called before setting a node at the top of the DeckPane.

Returns:

the value of the beforeShowCallback property

See Also:

• setBeforeShowCallback(Consumer)
• beforeShowCallbackProperty()

setBeforeShowCallback

public void setBeforeShowCallback(@Nullable
 @Nullable Consumer<javafx.scene.Node> callback)

Sets the value of the beforeShowCallback property.

Property description:

Sets the callback action to be called before setting a node at the top of the DeckPane.

Parameters:

callback - the value for the beforeShowCallback property

See Also:

• getBeforeShowCallback()
• beforeShowCallbackProperty()

runBeforeShowCallback

protected void runBeforeShowCallback(javafx.scene.Node node)

afterHideCallbackProperty

public javafx.beans.property.ObjectProperty<Consumer<javafx.scene.Node>> afterHideCallbackProperty()

Sets the callback action to be called after removing the top node from the top of the DeckPane.

Returns:

the afterHideCallback property

See Also:

• getAfterHideCallback()
• setAfterHideCallback(Consumer)

getAfterHideCallback

@Nullable
public @Nullable Consumer<javafx.scene.Node> getAfterHideCallback()

Gets the value of the afterHideCallback property.

Property description:

Sets the callback action to be called after removing the top node from the top of the DeckPane.

Returns:

the value of the afterHideCallback property

See Also:

• setAfterHideCallback(Consumer)
• afterHideCallbackProperty()

setAfterHideCallback

public void setAfterHideCallback(@Nullable
 @Nullable Consumer<javafx.scene.Node> callback)

Sets the value of the afterHideCallback property.

Property description:

Sets the callback action to be called after removing the top node from the top of the DeckPane.

Parameters:

callback - the value for the afterHideCallback property

See Also:

• getAfterHideCallback()
• afterHideCallbackProperty()

runAfterHideCallback

protected void runAfterHideCallback(javafx.scene.Node node)

prepareAndCheck

protected boolean prepareAndCheck(@Nullable
 @Nullable javafx.scene.Node topNode,
 @Nullable
 @Nullable javafx.scene.Node target)

Verifies that transition is possible and prepares initial conditions.

onTransitionFinished

protected void onTransitionFinished(javafx.scene.Node topNode,
 javafx.scene.Node target)

Cleans-up properties after transition finished.

moveYUpFromTopBorderToOffCanvas

protected javafx.animation.Timeline moveYUpFromTopBorderToOffCanvas(javafx.scene.Node node)

moveYUpFromBottomBorderToTopBorder

protected javafx.animation.Timeline moveYUpFromBottomBorderToTopBorder(javafx.scene.Node node)

moveYDownFromTopBorderToBottomBorder

protected javafx.animation.Timeline moveYDownFromTopBorderToBottomBorder(javafx.scene.Node node)

moveYDownFromOffCanvasToTopBorder

protected javafx.animation.Timeline moveYDownFromOffCanvasToTopBorder(javafx.scene.Node node)

moveXLeftFromLeftBorderToOffCanvas

protected javafx.animation.Timeline moveXLeftFromLeftBorderToOffCanvas(javafx.scene.Node node)

moveXLeftFromRightBorderToLeftBorder

protected javafx.animation.Timeline moveXLeftFromRightBorderToLeftBorder(javafx.scene.Node node)

moveXRightFromLeftBorderToRightBorder

protected javafx.animation.Timeline moveXRightFromLeftBorderToRightBorder(javafx.scene.Node node)

moveXRightFromOffCanvasToLeftBorder

protected javafx.animation.Timeline moveXRightFromOffCanvasToLeftBorder(javafx.scene.Node node)

resetNode

protected void resetNode(javafx.scene.Node node)

Resets given node to the default state.

setViewOrder

protected void setViewOrder(javafx.scene.Node node,
 int viewOrder)

Sets the node view order. Only accept predefined values to avoid messing up with magical numbers.