- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.layout.Pane
-
- com.gluonhq.charm.glisten.layout.Layer
-
- All Implemented Interfaces:
Styleable
,EventTarget
- Direct Known Subclasses:
PopupView
,SidePopupView
public class Layer extends Pane
A Layer is an overlay that can be shown above any
View
. Layer is managed byGlassPane
and is automatically added/removed depending on the value of theshowingProperty()
.A Layer follows a life cycle triggering various life cycle events during the process. The life cycle event 'showing' is called as soon as
show()
is called followed by playing theshow transition
. Once the show transition is complete, the life cycle event 'shown' is triggered. Similarly, whenhide()
is called, life cycle event 'hiding' is triggered followed by a call to 'hidden' event when thehide transition
has completed animating.A background fade can be set by calling
setBackgroundFade(double)
this will fade the background to a darker color, bringing more attention to what is shown by this layer making it distinct from the content underneath. The background can also be set transparent to mouse events by usingNode.mouseTransparentProperty()
.- Since:
- 1.0.0
- See Also:
View
,GlassPane
,AppManager
-
-
Property Summary
Properties Type Property Description BooleanProperty
autoHide
Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.DoubleProperty
backgroundFade
Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.ObjectProperty<Function<Layer,Transition>>
hideTransitionFactory
The factory that returns theTransition
for the given layer which should be used during its disappearance.ObjectProperty<EventHandler<LifecycleEvent>>
onHidden
Called just after the Layer has been hidden.ObjectProperty<EventHandler<LifecycleEvent>>
onHiding
Called just prior to the Layer being hidden.ObjectProperty<EventHandler<LifecycleEvent>>
onShowing
Called just prior to the Layer being shown.ObjectProperty<EventHandler<LifecycleEvent>>
onShown
Called just after the Layer is shown.ReadOnlyBooleanProperty
showing
Represents whether this Layer is currently showing on screen or not.ObjectProperty<Function<Layer,Transition>>
showTransitionFactory
The factory that returns theTransition
for the given layer which should be used during its appearance.-
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 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 Layer()
Creates a new Layer instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanProperty
autoHideProperty()
Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.DoubleProperty
backgroundFadeProperty()
Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.double
getBackgroundFade()
Gets the value of the property backgroundFade.Function<Layer,Transition>
getHideTransitionFactory()
Gets the value of the property hideTransitionFactory.EventHandler<LifecycleEvent>
getOnHidden()
Gets the value of the property onHidden.EventHandler<LifecycleEvent>
getOnHiding()
Gets the value of the property onHiding.EventHandler<LifecycleEvent>
getOnShowing()
Gets the value of the property onShowing.EventHandler<LifecycleEvent>
getOnShown()
Gets the value of the property onShown.Function<Layer,Transition>
getShowTransitionFactory()
Gets the value of the property showTransitionFactory.void
hide()
If this layer is showing, calling this method will hide it.ObjectProperty<Function<Layer,Transition>>
hideTransitionFactoryProperty()
The factory that returns theTransition
for the given layer which should be used during its disappearance.boolean
isAutoHide()
Gets the value of the property autoHide.boolean
isShowing()
Gets the value of the property showing.void
layoutChildren()
Override this method to add the layout logic for your layer.ObjectProperty<EventHandler<LifecycleEvent>>
onHiddenProperty()
Called just after the Layer has been hidden.ObjectProperty<EventHandler<LifecycleEvent>>
onHidingProperty()
Called just prior to the Layer being hidden.ObjectProperty<EventHandler<LifecycleEvent>>
onShowingProperty()
Called just prior to the Layer being shown.ObjectProperty<EventHandler<LifecycleEvent>>
onShownProperty()
Called just after the Layer is shown.void
setAutoHide(boolean value)
Sets the value of the property autoHide.void
setBackgroundFade(double level)
Sets the value of the property backgroundFade.void
setHideTransitionFactory(Function<Layer,Transition> value)
Sets the value of the property hideTransitionFactory.void
setOnHidden(EventHandler<LifecycleEvent> value)
Sets the value of the property onHidden.void
setOnHiding(EventHandler<LifecycleEvent> value)
Sets the value of the property onHiding.void
setOnShowing(EventHandler<LifecycleEvent> value)
Sets the value of the property onShowing.void
setOnShown(EventHandler<LifecycleEvent> value)
Sets the value of the property onShown.void
setShowTransitionFactory(Function<Layer,Transition> value)
Sets the value of the property showTransitionFactory.void
show()
Shows the layer by installing it on theGlassPane
.ReadOnlyBooleanProperty
showingProperty()
Represents whether this Layer is currently showing on screen or not.ObjectProperty<Function<Layer,Transition>>
showTransitionFactoryProperty()
The factory that returns theTransition
for the given layer which should be used during its appearance.-
Methods inherited from class javafx.scene.layout.Pane
getChildren
-
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
-
Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
-
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, 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 Detail
-
showing
public final ReadOnlyBooleanProperty showingProperty
Represents whether this Layer is currently showing on screen or not.- See Also:
isShowing()
-
autoHide
public final BooleanProperty autoHideProperty
Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.- Default value:
- true
- See Also:
isAutoHide()
,setAutoHide(boolean)
-
showTransitionFactory
public final ObjectProperty<Function<Layer,Transition>> showTransitionFactoryProperty
The factory that returns theTransition
for the given layer which should be used during its appearance.- Since:
- 5.0.0
- See Also:
getShowTransitionFactory()
,setShowTransitionFactory(Function)
-
hideTransitionFactory
public final ObjectProperty<Function<Layer,Transition>> hideTransitionFactoryProperty
The factory that returns theTransition
for the given layer which should be used during its disappearance.- Since:
- 5.0.0
- See Also:
getHideTransitionFactory()
,setHideTransitionFactory(Function)
-
backgroundFade
public final DoubleProperty backgroundFadeProperty
Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.- Default value:
- 0.0
- See Also:
getBackgroundFade()
,setBackgroundFade(double)
-
onShowing
public final ObjectProperty<EventHandler<LifecycleEvent>> onShowingProperty
Called just prior to the Layer being shown. This happens just before theshow transition
starts.- Since:
- 5.0.0
- See Also:
getOnShowing()
,setOnShowing(EventHandler)
-
onShown
public final ObjectProperty<EventHandler<LifecycleEvent>> onShownProperty
Called just after the Layer is shown. This happens just after theshow transition
ends.- Since:
- 5.0.0
- See Also:
getOnShown()
,setOnShown(EventHandler)
-
onHiding
public final ObjectProperty<EventHandler<LifecycleEvent>> onHidingProperty
Called just prior to the Layer being hidden. This happens just before thehide transition
starts.- Since:
- 5.0.0
- See Also:
getOnHiding()
,setOnHiding(EventHandler)
-
onHidden
public final ObjectProperty<EventHandler<LifecycleEvent>> onHiddenProperty
Called just after the Layer has been hidden. This happens just after thehide transition
ends. This allows the developer to clean up resources or perform other tasks when the Layer is hidden.- Since:
- 5.0.0
- See Also:
getOnHidden()
,setOnHidden(EventHandler)
-
-
Method Detail
-
showingProperty
public final ReadOnlyBooleanProperty showingProperty()
Represents whether this Layer is currently showing on screen or not.- See Also:
isShowing()
-
isShowing
public final boolean isShowing()
Gets the value of the property showing.- Property description:
- Represents whether this Layer is currently showing on screen or not.
-
autoHideProperty
public final BooleanProperty autoHideProperty()
Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.- Default value:
- true
- See Also:
isAutoHide()
,setAutoHide(boolean)
-
isAutoHide
public final boolean isAutoHide()
Gets the value of the property autoHide.- Property description:
- Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.
- Default value:
- true
-
setAutoHide
public final void setAutoHide(boolean value)
Sets the value of the property autoHide.- Property description:
- Represents whether this Layer should hide when it is clicked outside its bounds.When set to false, the background is transparent to mouse events.
- Default value:
- true
-
showTransitionFactoryProperty
public final ObjectProperty<Function<Layer,Transition>> showTransitionFactoryProperty()
The factory that returns theTransition
for the given layer which should be used during its appearance.- Since:
- 5.0.0
- See Also:
getShowTransitionFactory()
,setShowTransitionFactory(Function)
-
getShowTransitionFactory
public final Function<Layer,Transition> getShowTransitionFactory()
Gets the value of the property showTransitionFactory.- Property description:
- The factory that returns the
Transition
for the given layer which should be used during its appearance. - Since:
- 5.0.0
-
setShowTransitionFactory
public final void setShowTransitionFactory(Function<Layer,Transition> value)
Sets the value of the property showTransitionFactory.- Property description:
- The factory that returns the
Transition
for the given layer which should be used during its appearance. - Since:
- 5.0.0
-
hideTransitionFactoryProperty
public final ObjectProperty<Function<Layer,Transition>> hideTransitionFactoryProperty()
The factory that returns theTransition
for the given layer which should be used during its disappearance.- Since:
- 5.0.0
- See Also:
getHideTransitionFactory()
,setHideTransitionFactory(Function)
-
getHideTransitionFactory
public final Function<Layer,Transition> getHideTransitionFactory()
Gets the value of the property hideTransitionFactory.- Property description:
- The factory that returns the
Transition
for the given layer which should be used during its disappearance. - Since:
- 5.0.0
-
setHideTransitionFactory
public final void setHideTransitionFactory(Function<Layer,Transition> value)
Sets the value of the property hideTransitionFactory.- Property description:
- The factory that returns the
Transition
for the given layer which should be used during its disappearance. - Since:
- 5.0.0
-
backgroundFadeProperty
public final DoubleProperty backgroundFadeProperty()
Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.- Default value:
- 0.0
- See Also:
getBackgroundFade()
,setBackgroundFade(double)
-
setBackgroundFade
public final void setBackgroundFade(double level)
Sets the value of the property backgroundFade.- Property description:
- Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.
- Default value:
- 0.0
-
getBackgroundFade
public final double getBackgroundFade()
Gets the value of the property backgroundFade.- Property description:
- Sets a background fade making the background a darker color and with this bringing more attention to what is shown by this Layer.
- Default value:
- 0.0
-
onShowingProperty
public final ObjectProperty<EventHandler<LifecycleEvent>> onShowingProperty()
Called just prior to the Layer being shown. This happens just before theshow transition
starts.- Since:
- 5.0.0
- See Also:
getOnShowing()
,setOnShowing(EventHandler)
-
setOnShowing
public final void setOnShowing(EventHandler<LifecycleEvent> value)
Sets the value of the property onShowing.- Property description:
- Called just prior to the Layer being shown. This happens just before the
show transition
starts. - Since:
- 5.0.0
-
getOnShowing
public final EventHandler<LifecycleEvent> getOnShowing()
Gets the value of the property onShowing.- Property description:
- Called just prior to the Layer being shown. This happens just before the
show transition
starts. - Since:
- 5.0.0
-
onShownProperty
public final ObjectProperty<EventHandler<LifecycleEvent>> onShownProperty()
Called just after the Layer is shown. This happens just after theshow transition
ends.- Since:
- 5.0.0
- See Also:
getOnShown()
,setOnShown(EventHandler)
-
setOnShown
public final void setOnShown(EventHandler<LifecycleEvent> value)
Sets the value of the property onShown.- Property description:
- Called just after the Layer is shown. This happens just after the
show transition
ends. - Since:
- 5.0.0
-
getOnShown
public final EventHandler<LifecycleEvent> getOnShown()
Gets the value of the property onShown.- Property description:
- Called just after the Layer is shown. This happens just after the
show transition
ends. - Since:
- 5.0.0
-
onHidingProperty
public final ObjectProperty<EventHandler<LifecycleEvent>> onHidingProperty()
Called just prior to the Layer being hidden. This happens just before thehide transition
starts.- Since:
- 5.0.0
- See Also:
getOnHiding()
,setOnHiding(EventHandler)
-
setOnHiding
public final void setOnHiding(EventHandler<LifecycleEvent> value)
Sets the value of the property onHiding.- Property description:
- Called just prior to the Layer being hidden. This happens just before the
hide transition
starts. - Since:
- 5.0.0
-
getOnHiding
public final EventHandler<LifecycleEvent> getOnHiding()
Gets the value of the property onHiding.- Property description:
- Called just prior to the Layer being hidden. This happens just before the
hide transition
starts. - Since:
- 5.0.0
-
onHiddenProperty
public final ObjectProperty<EventHandler<LifecycleEvent>> onHiddenProperty()
Called just after the Layer has been hidden. This happens just after thehide transition
ends. This allows the developer to clean up resources or perform other tasks when the Layer is hidden.- Since:
- 5.0.0
- See Also:
getOnHidden()
,setOnHidden(EventHandler)
-
setOnHidden
public final void setOnHidden(EventHandler<LifecycleEvent> value)
Sets the value of the property onHidden.- Property description:
- Called just after the Layer has been hidden. This happens just after the
hide transition
ends. This allows the developer to clean up resources or perform other tasks when the Layer is hidden. - Since:
- 5.0.0
-
getOnHidden
public final EventHandler<LifecycleEvent> getOnHidden()
Gets the value of the property onHidden.- Property description:
- Called just after the Layer has been hidden. This happens just after the
hide transition
ends. This allows the developer to clean up resources or perform other tasks when the Layer is hidden. - Since:
- 5.0.0
-
show
public void show()
Shows the layer by installing it on theGlassPane
.Also, fires
LifecycleEvent.SHOWING
event. This is followed by playing the show transition, if any. After the animation is complete,LifecycleEvent.SHOWN
is fired.No-op if
showingProperty()
is true.
-
hide
public void hide()
If this layer is showing, calling this method will hide it. If a hide transition is present, it is played before hiding the Layer. Care should be taken to call this only onceLifecycleEvent.SHOWN
has been fired.LifecycleEvent.HIDING
is fired as soon as the method is called.LifecycleEvent.HIDDEN
is fired after the hide transition has finished.No-op if
showingProperty()
is false.
-
layoutChildren
public void layoutChildren()
Override this method to add the layout logic for your layer. Care should be taken to call this method in overriden methods for proper functioning of the Layer.- Overrides:
layoutChildren
in classParent
-
-