Package com.gluonhq.charm.glisten.layout

Class Layer

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.StackPane

com.gluonhq.charm.glisten.layout.Layer

Direct Known Subclasses:

MenuPopupView, PopupView, SidePopupView

public class Layer
extends javafx.scene.layout.StackPane

A Layer is an overlay that can be shown above any MobileLayoutPane, or the application-wide GlassPane. To install a Layer into either location, simply call MobileLayoutPane.getLayers() and add the layer into that list. Showing a Layer is then achieved either by calling show(), or by using API available on MobileApplication.

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.

Since:

1.0.0

See Also:

MobileLayoutPane, GlassPane, MobileApplication

Property Summary

Properties

Type	Property	Description
javafx.beans.property.BooleanProperty	autoHide	Represents whether this Layer should hide when it is clicked outside its bounds - by default this is true.
javafx.beans.property.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.
javafx.beans.property.ObjectProperty<MobileLayoutPane>	mobileLayoutPane	The MobileLayoutPane that this Layer is installed in - note that GlassPane is also a MobileLayoutPane, so it is valid to install it directly into the GlassPane by retrieving it from the MobileApplication using MobileApplication.getGlassPane().
javafx.beans.property.BooleanProperty	showing	Represents whether this Layer is currently showing on screen or not.
javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>>	showTransitionFactory

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

Properties inherited from class javafx.scene.Parent

needsLayout

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.layout.StackPane

alignment

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_BACKGROUND_FADE_LEVEL	The default amount of background fade to use when obscuring the view.

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor	Description
Layer()	Creates a new Layer instance.

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.BooleanProperty	autoHideProperty()	Represents whether this Layer should hide when it is clicked outside its bounds - by default this is true.
javafx.beans.property.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.
protected void	dispose()	Call this method to encourage (but not necessarily enforce) that the container that this layer is placed in (commonly the GlassPane, but not necessarily) attempt to remove this layer from itself.
double	getBackgroundFade()	Gets the value of the property backgroundFade.
MobileLayoutPane	getMobileLayoutPane()	Returns the value of the mobileLayoutPane property
javafx.animation.Transition	getShowTransition()	Returns current show transition for the Layer This method never returns null, so transition can be played safely
java.util.function.Function<Layer,javafx.animation.Transition>	getShowTransitionFactory()	Gets the value of the property showTransitionFactory.
void	hide()	If this layer is showing, calling this method will immediately hide it.
protected void	initialize()	This method is called whenever the MobileLayoutPane is changed.
boolean	isAutoHide()	Returns the value of the autoHideProperty
boolean	isShowing()	Gets the value of the showingProperty
void	layoutChildren()	Override this method to add the layout logic for your layer.
javafx.beans.property.ObjectProperty<MobileLayoutPane>	mobileLayoutPaneProperty()	The MobileLayoutPane that this Layer is installed in - note that GlassPane is also a MobileLayoutPane, so it is valid to install it directly into the GlassPane by retrieving it from the MobileApplication using MobileApplication.getGlassPane().
void	setAutoHide(boolean value)	Sets the value of the autoHideProperty.
void	setBackgroundFade(double level)	Sets the value of the property backgroundFade.
void	setShowing(boolean show)	Sets the value of the showingProperty
void	setShowTransitionFactory(java.util.function.Function<Layer,javafx.animation.Transition> value)	Sets the value of the property showTransitionFactory.
void	show()	If this Layer is installed in the GlassPane, calling this method will show the Layer regardless of the current View.
javafx.beans.property.BooleanProperty	showingProperty()	Represents whether this Layer is currently showing on screen or not.
javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>>	showTransitionFactoryProperty()

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, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, 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, 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 class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.Parent

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

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, 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.layout.StackPane

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Detail

showing

public final javafx.beans.property.BooleanProperty showingProperty

Represents whether this Layer is currently showing on screen or not.

See Also:

isShowing(), setShowing(boolean)

autoHide

public final javafx.beans.property.BooleanProperty autoHideProperty

Represents whether this Layer should hide when it is clicked outside its bounds - by default this is true.

See Also:

isAutoHide(), setAutoHide(boolean)

mobileLayoutPane

public final javafx.beans.property.ObjectProperty<MobileLayoutPane> mobileLayoutPaneProperty

The MobileLayoutPane that this Layer is installed in - note that GlassPane is also a MobileLayoutPane, so it is valid to install it directly into the GlassPane by retrieving it from the MobileApplication using MobileApplication.getGlassPane().

Returns:

an ObjectProperty with the MobileLayoutPane

showTransitionFactory

public final javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>> showTransitionFactoryProperty

See Also:

getShowTransitionFactory(), setShowTransitionFactory(Function)

backgroundFade

public final javafx.beans.property.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.

See Also:

getBackgroundFade(), setBackgroundFade(double)

Field Detail

DEFAULT_BACKGROUND_FADE_LEVEL

public static final double DEFAULT_BACKGROUND_FADE_LEVEL

The default amount of background fade to use when obscuring the view.

See Also:

Constant Field Values

Constructor Detail

Layer

public Layer()

Creates a new Layer instance.

Method Detail

showingProperty

public final javafx.beans.property.BooleanProperty showingProperty()

Represents whether this Layer is currently showing on screen or not.

See Also:

isShowing(), setShowing(boolean)

isShowing

public final boolean isShowing()

Gets the value of the showingProperty

Returns:

a boolean value whether this Layer is currently showing on screen or not

setShowing

public final void setShowing(boolean show)

Sets the value of the showingProperty

Parameters:

show - a boolean value whether this Layer should be shown on screen or not

autoHideProperty

public final javafx.beans.property.BooleanProperty autoHideProperty()

Represents whether this Layer should hide when it is clicked outside its bounds - by default this is true.

See Also:

isAutoHide(), setAutoHide(boolean)

isAutoHide

public final boolean isAutoHide()

Returns the value of the autoHideProperty

Returns:

a boolean whether this Layer will hide when it is clicked outside its bounds

setAutoHide

public final void setAutoHide(boolean value)

Sets the value of the autoHideProperty.

Parameters:

value - a boolean value whether this Layer must hide when it is clicked outside its bounds

getMobileLayoutPane

public final MobileLayoutPane getMobileLayoutPane()

Returns the value of the mobileLayoutPane property

Returns:

MobileLayoutPane

mobileLayoutPaneProperty

public final javafx.beans.property.ObjectProperty<MobileLayoutPane> mobileLayoutPaneProperty()

The MobileLayoutPane that this Layer is installed in - note that GlassPane is also a MobileLayoutPane, so it is valid to install it directly into the GlassPane by retrieving it from the MobileApplication using MobileApplication.getGlassPane().

Returns:

an ObjectProperty with the MobileLayoutPane

showTransitionFactoryProperty

public final javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>> showTransitionFactoryProperty()

See Also:

getShowTransitionFactory(), setShowTransitionFactory(Function)

getShowTransitionFactory

public final java.util.function.Function<Layer,javafx.animation.Transition> getShowTransitionFactory()

Gets the value of the property showTransitionFactory.

Property description:

setShowTransitionFactory

public final void setShowTransitionFactory(java.util.function.Function<Layer,javafx.animation.Transition> value)

Sets the value of the property showTransitionFactory.

Property description:

backgroundFadeProperty

public final javafx.beans.property.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.

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.

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.

show

public void show()

If this Layer is installed in the GlassPane, calling this method will show the Layer regardless of the current View. If this Layer is installed in a specific MobileLayoutPane, and if that pane is currently showing, then calling this method will show this Layer atop the pane.

hide

public void hide()

If this layer is showing, calling this method will immediately hide it.

initialize

protected void initialize()

This method is called whenever the MobileLayoutPane is changed. The default implementation of this method is a no-op, but subclasses may choose to override this.

layoutChildren

public void layoutChildren()

Override this method to add the layout logic for your layer. The default layout algorithm is simply the JavaFX StackPane algorithm.

Overrides:

layoutChildren in class javafx.scene.layout.StackPane

dispose

protected void dispose()

Call this method to encourage (but not necessarily enforce) that the container that this layer is placed in (commonly the GlassPane, but not necessarily) attempt to remove this layer from itself. Note that this method is also called whenever the MobileLayoutPane is set to null.

getShowTransition

public javafx.animation.Transition getShowTransition()

Returns current show transition for the Layer This method never returns null, so transition can be played safely

Returns:

Current transition or NoTransition if factory returned null