Module com.dlsc.gemsfx
Package com.dlsc.gemsfx.infocenter

Class InfoCenterPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.infocenter.InfoCenterPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class InfoCenterPane extends javafx.scene.control.Control
A pane used for managing a single instance of InfoCenterView. The pane will show or hide the view depending on various criteria, e.g. events that have been received or the auto-hide feature is kicking in.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    autoHideDuration
    A duration after which the pane will automatically hide the info center (if it isn't currently pinned and the mouse cursor is not on top of the info center).
    final javafx.beans.property.BooleanProperty
    autoHide
    A flag that determines if the info center view should automatically disappear again after a certain timeout duration.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    content
    The property that is used to store a reference to the content node.
    final javafx.beans.property.BooleanProperty
    pinned
    A flag that can be used to pin the info center view so that it will not hide under any circumstances.
    final javafx.beans.property.BooleanProperty
    showInfoCenter
    The flag that controls whether the info center shall be shown or not.

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    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
    InfoCenterPane()
    Constructs a new pane with no content.
    InfoCenterPane(javafx.scene.Node content)
    Constructs a new pane with the given content node.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    autoHideDurationProperty()
    A duration after which the pane will automatically hide the info center (if it isn't currently pinned and the mouse cursor is not on top of the info center).
    final javafx.beans.property.BooleanProperty
    autoHideProperty()
    A flag that determines if the info center view should automatically disappear again after a certain timeout duration.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    contentProperty()
    The property that is used to store a reference to the content node.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.util.Duration
    getAutoHideDuration()
    Gets the value of the autoHideDuration property.
    final javafx.scene.Node
    getContent()
    Gets the value of the content property.
    final InfoCenterView
    getInfoCenterView()
     
    final javafx.util.Duration
    getSlideInDuration()
     
    final boolean
    isAutoHide()
    Gets the value of the autoHide property.
    final boolean
    isPinned()
    Gets the value of the pinned property.
    final boolean
    isShowInfoCenter()
    Gets the value of the showInfoCenter property.
    final javafx.beans.property.BooleanProperty
    pinnedProperty()
    A flag that can be used to pin the info center view so that it will not hide under any circumstances.
    final void
    setAutoHide(boolean autoHide)
    Sets the value of the autoHide property.
    final void
    setAutoHideDuration(javafx.util.Duration autoHideDuration)
    Sets the value of the autoHideDuration property.
    final void
    setContent(javafx.scene.Node content)
    Sets the value of the content property.
    final void
    setPinned(boolean pinned)
    Sets the value of the pinned property.
    final void
    setShowInfoCenter(boolean showInfoCenter)
    Sets the value of the showInfoCenter property.
    final void
    setSlideInDuration(javafx.util.Duration duration)
     
    final javafx.beans.property.BooleanProperty
    showInfoCenterProperty()
    The flag that controls whether the info center shall be shown or not.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    slideInDuration()
    The duration used for the "slide in" / "slide out" animation when the info center view gets shown or hidden.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, 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

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, 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, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, 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

  • Constructor Details

    • InfoCenterPane

      public InfoCenterPane()
      Constructs a new pane with no content.

    • InfoCenterPane

      public InfoCenterPane(javafx.scene.Node content)
      Constructs a new pane with the given content node.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control

    • getAutoHideDuration

      public final javafx.util.Duration getAutoHideDuration()
      Gets the value of the autoHideDuration property.
      Property description:
      A duration after which the pane will automatically hide the info center (if it isn't currently pinned and the mouse cursor is not on top of the info center).
      Returns:
      the value of the autoHideDuration property
      See Also:

    • autoHideDurationProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> autoHideDurationProperty()
      A duration after which the pane will automatically hide the info center (if it isn't currently pinned and the mouse cursor is not on top of the info center).
      Returns:
      the auto-hide duration
      See Also:

    • setAutoHideDuration

      public final void setAutoHideDuration(javafx.util.Duration autoHideDuration)
      Sets the value of the autoHideDuration property.
      Property description:
      A duration after which the pane will automatically hide the info center (if it isn't currently pinned and the mouse cursor is not on top of the info center).
      Parameters:
      autoHideDuration - the value for the autoHideDuration property
      See Also:

    • isPinned

      public final boolean isPinned()
      Gets the value of the pinned property.
      Property description:
      A flag that can be used to pin the info center view so that it will not hide under any circumstances.
      Returns:
      the value of the pinned property
      See Also:

    • pinnedProperty

      public final javafx.beans.property.BooleanProperty pinnedProperty()
      A flag that can be used to pin the info center view so that it will not hide under any circumstances.
      Returns:
      true if the info center view is pinned
      See Also:

    • setPinned

      public final void setPinned(boolean pinned)
      Sets the value of the pinned property.
      Property description:
      A flag that can be used to pin the info center view so that it will not hide under any circumstances.
      Parameters:
      pinned - the value for the pinned property
      See Also:

    • isAutoHide

      public final boolean isAutoHide()
      Gets the value of the autoHide property.
      Property description:
      A flag that determines if the info center view should automatically disappear again after a certain timeout duration.
      Returns:
      the value of the autoHide property
      See Also:

    • autoHideProperty

      public final javafx.beans.property.BooleanProperty autoHideProperty()
      A flag that determines if the info center view should automatically disappear again after a certain timeout duration.
      Returns:
      true if the info center hides automatically after a certain period of time
      See Also:

    • setAutoHide

      public final void setAutoHide(boolean autoHide)
      Sets the value of the autoHide property.
      Property description:
      A flag that determines if the info center view should automatically disappear again after a certain timeout duration.
      Parameters:
      autoHide - the value for the autoHide property
      See Also:

    • getInfoCenterView

      public final InfoCenterView getInfoCenterView()

    • contentProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty()
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Returns:
      the content node property
      See Also:

    • getContent

      public final javafx.scene.Node getContent()
      Gets the value of the content property.
      Property description:
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Returns:
      the value of the content property
      See Also:

    • setContent

      public final void setContent(javafx.scene.Node content)
      Sets the value of the content property.
      Property description:
      The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.
      Parameters:
      content - the value for the content property
      See Also:

    • slideInDuration

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> slideInDuration()
      The duration used for the "slide in" / "slide out" animation when the info center view gets shown or hidden.
      Returns:
      animation duration for the sliding in and out of the info center view

    • getSlideInDuration

      public final javafx.util.Duration getSlideInDuration()

    • setSlideInDuration

      public final void setSlideInDuration(javafx.util.Duration duration)

    • isShowInfoCenter

      public final boolean isShowInfoCenter()
      Gets the value of the showInfoCenter property.
      Property description:
      The flag that controls whether the info center shall be shown or not.
      Returns:
      the value of the showInfoCenter property
      See Also:

    • showInfoCenterProperty

      public final javafx.beans.property.BooleanProperty showInfoCenterProperty()
      The flag that controls whether the info center shall be shown or not.
      Returns:
      true if the info center shall be shown
      See Also:

    • setShowInfoCenter

      public final void setShowInfoCenter(boolean showInfoCenter)
      Sets the value of the showInfoCenter property.
      Property description:
      The flag that controls whether the info center shall be shown or not.
      Parameters:
      showInfoCenter - the value for the showInfoCenter property
      See Also: