Class GlassPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.StackPane
com.dlsc.gemsfx.GlassPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
public class GlassPane extends javafx.scene.layout.StackPane
A simple pane that can be used to overlay the UI with a semi-transparent color, indicating that input is blocked. The glass pane can be animated, which means it will fade in / fade out when it becomes visible or invisible.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.DoubleProperty
    blockingOpacity
    The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    fadeInOutDuration
    Stores the duration of the fade in / fade out animation.
    final javafx.beans.property.BooleanProperty
    fadeInOut
    A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.
    final javafx.beans.property.BooleanProperty
    hide
    Controls whether the glass pane is hidden or shown.

    Properties inherited from class javafx.scene.layout.StackPane

    alignment

    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
    GlassPane()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.DoubleProperty
    blockingOpacityProperty()
    The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    fadeInOutDurationProperty()
    Stores the duration of the fade in / fade out animation.
    final javafx.beans.property.BooleanProperty
    fadeInOutProperty()
    A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.
    final double
    getBlockingOpacity()
    Gets the value of the blockingOpacity property.
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getClassCssMetaData()
     
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getCssMetaData()
     
    final javafx.util.Duration
    getFadeInOutDuration()
    Gets the value of the fadeInOutDuration property.
    String
    getUserAgentStylesheet()
     
    final javafx.beans.property.BooleanProperty
    hideProperty()
    Controls whether the glass pane is hidden or shown.
    final boolean
    isFadeInOut()
    Gets the value of the fadeInOut property.
    final boolean
    isHide()
    Gets the value of the hide property.
    final void
    setBlockingOpacity(double blockingOpacity)
    Sets the value of the blockingOpacity property.
    final void
    setFadeInOut(boolean fadeInOut)
    Sets the value of the fadeInOut property.
    final void
    setFadeInOutDuration(javafx.util.Duration fadeInOutDuration)
    Sets the value of the fadeInOutDuration property.
    final void
    setHide(boolean hide)
    Sets the value of the hide property.

    Methods inherited from class javafx.scene.layout.StackPane

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

    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, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, 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, 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, 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, requestFocusTraversal, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • blockingOpacity

      public final javafx.beans.property.DoubleProperty blockingOpacityProperty
      The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place. A separate opacity property is needed to support the fade in / fade out animation AND the regular opacity.

      Can be set via CSS using the -fx-blocking-opacity property. Valid values are: a number between 0 and 1. The default value is 0.5.

      See Also:

    • fadeInOutDuration

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> fadeInOutDurationProperty
      Stores the duration of the fade in / fade out animation.

      Can be set via CSS using the -fx-fade-in-out-duration property. Valid values are: a number in milliseconds. The default value is 100.

      See Also:

    • fadeInOut

      public final javafx.beans.property.BooleanProperty fadeInOutProperty
      A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.

      Can be set via CSS using the -fx-fade-in-out property. Valid values are: true or false. The default value is false.

      See Also:

    • hide

      public final javafx.beans.property.BooleanProperty hideProperty
      Controls whether the glass pane is hidden or shown.
      See Also:

  • Constructor Details

    • GlassPane

      public GlassPane()

  • Method Details

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region

    • getBlockingOpacity

      public final double getBlockingOpacity()
      Gets the value of the blockingOpacity property.
      Property description:
      The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place. A separate opacity property is needed to support the fade in / fade out animation AND the regular opacity.

      Can be set via CSS using the -fx-blocking-opacity property. Valid values are: a number between 0 and 1. The default value is 0.5.

      Returns:
      the value of the blockingOpacity property
      See Also:

    • blockingOpacityProperty

      public final javafx.beans.property.DoubleProperty blockingOpacityProperty()
      The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place. A separate opacity property is needed to support the fade in / fade out animation AND the regular opacity.

      Can be set via CSS using the -fx-blocking-opacity property. Valid values are: a number between 0 and 1. The default value is 0.5.

      Returns:
      the opacity of the glass pane
      See Also:

    • setBlockingOpacity

      public final void setBlockingOpacity(double blockingOpacity)
      Sets the value of the blockingOpacity property.
      Property description:
      The opacity value between 0 and 1 that will be used to gray out the content over which the glass pane is place. A separate opacity property is needed to support the fade in / fade out animation AND the regular opacity.

      Can be set via CSS using the -fx-blocking-opacity property. Valid values are: a number between 0 and 1. The default value is 0.5.

      Parameters:
      blockingOpacity - the value for the blockingOpacity property
      See Also:

    • getFadeInOutDuration

      public final javafx.util.Duration getFadeInOutDuration()
      Gets the value of the fadeInOutDuration property.
      Property description:
      Stores the duration of the fade in / fade out animation.

      Can be set via CSS using the -fx-fade-in-out-duration property. Valid values are: a number in milliseconds. The default value is 100.

      Returns:
      the value of the fadeInOutDuration property
      See Also:

    • fadeInOutDurationProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> fadeInOutDurationProperty()
      Stores the duration of the fade in / fade out animation.

      Can be set via CSS using the -fx-fade-in-out-duration property. Valid values are: a number in milliseconds. The default value is 100.

      Returns:
      the animation duration in milliseconds
      See Also:

    • setFadeInOutDuration

      public final void setFadeInOutDuration(javafx.util.Duration fadeInOutDuration)
      Sets the value of the fadeInOutDuration property.
      Property description:
      Stores the duration of the fade in / fade out animation.

      Can be set via CSS using the -fx-fade-in-out-duration property. Valid values are: a number in milliseconds. The default value is 100.

      Parameters:
      fadeInOutDuration - the value for the fadeInOutDuration property
      See Also:

    • isFadeInOut

      public final boolean isFadeInOut()
      Gets the value of the fadeInOut property.
      Property description:
      A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.

      Can be set via CSS using the -fx-fade-in-out property. Valid values are: true or false. The default value is false.

      Returns:
      the value of the fadeInOut property
      See Also:

    • fadeInOutProperty

      public final javafx.beans.property.BooleanProperty fadeInOutProperty()
      A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.

      Can be set via CSS using the -fx-fade-in-out property. Valid values are: true or false. The default value is false.

      Returns:
      true if the fade in / out process will be animated
      See Also:

    • setFadeInOut

      public final void setFadeInOut(boolean fadeInOut)
      Sets the value of the fadeInOut property.
      Property description:
      A property that determines whether we want to use a fade in / out animation of the glass pane when it gets shown or hidden.

      Can be set via CSS using the -fx-fade-in-out property. Valid values are: true or false. The default value is false.

      Parameters:
      fadeInOut - the value for the fadeInOut property
      See Also:

    • hideProperty

      public final javafx.beans.property.BooleanProperty hideProperty()
      Controls whether the glass pane is hidden or shown.
      Returns:
      true if the pane is currently hidden
      See Also:

    • setHide

      public final void setHide(boolean hide)
      Sets the value of the hide property.
      Property description:
      Controls whether the glass pane is hidden or shown.
      Parameters:
      hide - the value for the hide property
      See Also:

    • isHide

      public final boolean isHide()
      Gets the value of the hide property.
      Property description:
      Controls whether the glass pane is hidden or shown.
      Returns:
      the value of the hide property
      See Also:

    • getCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getCssMetaData()
      Specified by:
      getCssMetaData in interface javafx.css.Styleable
      Overrides:
      getCssMetaData in class javafx.scene.layout.StackPane

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getClassCssMetaData()