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.
MobileLayoutPane
,
GlassPane
,
MobileApplication
Type | Property and 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
The factory that given a
Layer returns the Transition
which should be used during its appearance. |
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty
impl_traversalEngineProperty, needsLayoutProperty
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty
Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_BACKGROUND_FADE_LEVEL
The default amount of background fade to use when obscuring the view.
|
Constructor and Description |
---|
Layer()
Creates a new Layer instance.
|
Modifier and Type | Method and 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()
The factory that given a
Layer returns the Transition
which should be used during its appearance. |
alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty
getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, 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, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty
public final javafx.beans.property.BooleanProperty showingProperty
isShowing()
,
setShowing(boolean)
public final javafx.beans.property.BooleanProperty autoHideProperty
isAutoHide()
,
setAutoHide(boolean)
public final javafx.beans.property.ObjectProperty<MobileLayoutPane> mobileLayoutPaneProperty
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()
.ObjectProperty
with the MobileLayoutPane
public final javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>> showTransitionFactoryProperty
Layer
returns the Transition
which should be used during its appearance.public final javafx.beans.property.DoubleProperty backgroundFadeProperty
getBackgroundFade()
,
setBackgroundFade(double)
public static final double DEFAULT_BACKGROUND_FADE_LEVEL
public final javafx.beans.property.BooleanProperty showingProperty()
isShowing()
,
setShowing(boolean)
public final boolean isShowing()
showingProperty
public final void setShowing(boolean show)
showingProperty
show
- a boolean value whether this Layer should be shown on screen or notpublic final javafx.beans.property.BooleanProperty autoHideProperty()
isAutoHide()
,
setAutoHide(boolean)
public final boolean isAutoHide()
autoHideProperty
public final void setAutoHide(boolean value)
autoHideProperty
.value
- a boolean value whether this Layer must hide when it is clicked
outside its boundspublic final MobileLayoutPane getMobileLayoutPane()
mobileLayoutPane
propertyMobileLayoutPane
public final javafx.beans.property.ObjectProperty<MobileLayoutPane> mobileLayoutPaneProperty()
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()
.ObjectProperty
with the MobileLayoutPane
public final javafx.beans.property.ObjectProperty<java.util.function.Function<Layer,javafx.animation.Transition>> showTransitionFactoryProperty()
Layer
returns the Transition
which should be used during its appearance.public final java.util.function.Function<Layer,javafx.animation.Transition> getShowTransitionFactory()
public final void setShowTransitionFactory(java.util.function.Function<Layer,javafx.animation.Transition> value)
public final javafx.beans.property.DoubleProperty backgroundFadeProperty()
getBackgroundFade()
,
setBackgroundFade(double)
public final void setBackgroundFade(double level)
public final double getBackgroundFade()
public void show()
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.public void hide()
protected void initialize()
MobileLayoutPane
is changed. The default implementation of this method is a no-op, but subclasses may
choose to override this.public void layoutChildren()
StackPane
algorithm.layoutChildren
in class javafx.scene.layout.StackPane
protected void dispose()
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.public javafx.animation.Transition getShowTransition()
Layer
This method never returns null, so transition can be played safelyNoTransition
if factory returned null