Class ScreensView

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.ScreensView
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class ScreensView extends javafx.scene.control.Control
A view for displaying the geometry of the currently available screens. This view displays each screen in its correct size. Big screens will be big, small ones will be smaller. In addition, the view can also display the currently showing windows of the application. For debugging purposes the view is also capable of showing arbitrary shapes inside the within the unified bounds of all screens.
  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.BooleanProperty
    A flag used to control whether the user will be able to drag the miniature windows on the miniature screens around or not.
    final javafx.beans.property.ObjectProperty<javafx.scene.effect.Reflection>
    Stores the instance of the Reflection effect that will be applied to the screens in this view.
    final javafx.beans.property.ObjectProperty<javafx.scene.effect.DropShadow>
    Stores the instance of the DropShadow effect that will be applied to the screens in this view.
    final javafx.beans.property.BooleanProperty
    Determines if a reflection effect will be applied to the miniature screens.
    final javafx.beans.property.BooleanProperty
    Determines if a shadow effect will be applied to the miniature screens.
    final javafx.beans.property.BooleanProperty
    Determines if the miniature screens should show a wallpaper or not.
    final javafx.beans.property.BooleanProperty
    Determines if the view should also show the currently active windows of the running application.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image>>
    A callback used for looking up images that will be used as wallpapers on the miniature screens.

    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
    Constructs a new view.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
     
    final javafx.beans.property.BooleanProperty
    A flag used to control whether the user will be able to drag the miniature windows on the miniature screens around or not.
    final javafx.scene.effect.Reflection
    Gets the value of the reflection property.
    final javafx.scene.effect.DropShadow
    Gets the value of the shadow property.
    final javafx.collections.ObservableList<javafx.scene.shape.Shape>
    A list of arbitrary shapes that can be added to this view.
     
    final javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image>
    Gets the value of the wallpaperProvider property.
    final boolean
    Gets the value of the enableWindowDragging property.
    final boolean
    Gets the value of the showReflection property.
    final boolean
    Gets the value of the showShadow property.
    final boolean
    Gets the value of the showWallpaper property.
    final boolean
    Gets the value of the showWindows property.
    final javafx.beans.property.ObjectProperty<javafx.scene.effect.Reflection>
    Stores the instance of the Reflection effect that will be applied to the screens in this view.
    final void
    setEnableWindowDragging(boolean enableWindowDragging)
    Sets the value of the enableWindowDragging property.
    final void
    setReflection(javafx.scene.effect.Reflection reflection)
    Sets the value of the reflection property.
    final void
    setShadow(javafx.scene.effect.DropShadow shadow)
    Sets the value of the shadow property.
    final void
    setShowReflection(boolean showReflection)
    Sets the value of the showReflection property.
    final void
    setShowShadow(boolean showShadow)
    Sets the value of the showShadow property.
    final void
    setShowWallpaper(boolean showWallpaper)
    Sets the value of the showWallpaper property.
    final void
    setShowWindows(boolean showWindows)
    Sets the value of the showWindows property.
    final void
    setWallpaperProvider(javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image> wallpaperProvider)
    Sets the value of the wallpaperProvider property.
    final javafx.beans.property.ObjectProperty<javafx.scene.effect.DropShadow>
    Stores the instance of the DropShadow effect that will be applied to the screens in this view.
    Utility method to quickly bring up an instance of this view.
    final javafx.beans.property.BooleanProperty
    Determines if a reflection effect will be applied to the miniature screens.
    final javafx.beans.property.BooleanProperty
    Determines if a shadow effect will be applied to the miniature screens.
    final javafx.beans.property.BooleanProperty
    Determines if the miniature screens should show a wallpaper or not.
    final javafx.beans.property.BooleanProperty
    Determines if the view should also show the currently active windows of the running application.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image>>
    A callback used for looking up images that will be used as wallpapers on the miniature screens.

    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, 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

    • ScreensView

      public ScreensView()
      Constructs a new view.
  • Method Details

    • createDefaultSkin

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

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

      public static ScreensView show()
      Utility method to quickly bring up an instance of this view.
      Returns:
      the view that was created by the method call (can be used for further configuration)
    • getShadow

      public final javafx.scene.effect.DropShadow getShadow()
      Gets the value of the shadow property.
      Property description:
      Stores the instance of the DropShadow effect that will be applied to the screens in this view.
      Returns:
      the value of the shadow property
      See Also:
    • shadowProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.effect.DropShadow> shadowProperty()
      Stores the instance of the DropShadow effect that will be applied to the screens in this view.
      Returns:
      the drop shadow effect
      See Also:
    • setShadow

      public final void setShadow(javafx.scene.effect.DropShadow shadow)
      Sets the value of the shadow property.
      Property description:
      Stores the instance of the DropShadow effect that will be applied to the screens in this view.
      Parameters:
      shadow - the value for the shadow property
      See Also:
    • getReflection

      public final javafx.scene.effect.Reflection getReflection()
      Gets the value of the reflection property.
      Property description:
      Stores the instance of the Reflection effect that will be applied to the screens in this view.
      Returns:
      the value of the reflection property
      See Also:
    • reflectionProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.effect.Reflection> reflectionProperty()
      Stores the instance of the Reflection effect that will be applied to the screens in this view.
      Returns:
      the reflection effect
      See Also:
    • setReflection

      public final void setReflection(javafx.scene.effect.Reflection reflection)
      Sets the value of the reflection property.
      Property description:
      Stores the instance of the Reflection effect that will be applied to the screens in this view.
      Parameters:
      reflection - the value for the reflection property
      See Also:
    • getShapes

      public final javafx.collections.ObservableList<javafx.scene.shape.Shape> getShapes()
      A list of arbitrary shapes that can be added to this view.
      Returns:
      list of shapes to add to this view.
    • isShowShadow

      public final boolean isShowShadow()
      Gets the value of the showShadow property.
      Property description:
      Determines if a shadow effect will be applied to the miniature screens.
      Returns:
      the value of the showShadow property
      See Also:
    • showShadowProperty

      public final javafx.beans.property.BooleanProperty showShadowProperty()
      Determines if a shadow effect will be applied to the miniature screens.
      Returns:
      true if a shadow effect shall be shown
      See Also:
    • setShowShadow

      public final void setShowShadow(boolean showShadow)
      Sets the value of the showShadow property.
      Property description:
      Determines if a shadow effect will be applied to the miniature screens.
      Parameters:
      showShadow - the value for the showShadow property
      See Also:
    • isShowReflection

      public final boolean isShowReflection()
      Gets the value of the showReflection property.
      Property description:
      Determines if a reflection effect will be applied to the miniature screens.
      Returns:
      the value of the showReflection property
      See Also:
    • showReflectionProperty

      public final javafx.beans.property.BooleanProperty showReflectionProperty()
      Determines if a reflection effect will be applied to the miniature screens.
      Returns:
      true if a reflection effect shall be shown
      See Also:
    • setShowReflection

      public final void setShowReflection(boolean showReflection)
      Sets the value of the showReflection property.
      Property description:
      Determines if a reflection effect will be applied to the miniature screens.
      Parameters:
      showReflection - the value for the showReflection property
      See Also:
    • isShowWallpaper

      public final boolean isShowWallpaper()
      Gets the value of the showWallpaper property.
      Property description:
      Determines if the miniature screens should show a wallpaper or not. The wallpapers are controlled via the wallpaperProviderProperty(). If no wallpapers are shown then the appearance of the miniature screens solely depends on CSS.
      Returns:
      the value of the showWallpaper property
      See Also:
    • showWallpaperProperty

      public final javafx.beans.property.BooleanProperty showWallpaperProperty()
      Determines if the miniature screens should show a wallpaper or not. The wallpapers are controlled via the wallpaperProviderProperty(). If no wallpapers are shown then the appearance of the miniature screens solely depends on CSS.
      Returns:
      true if the view should display wallpapers on the miniature screens
      See Also:
    • setShowWallpaper

      public final void setShowWallpaper(boolean showWallpaper)
      Sets the value of the showWallpaper property.
      Property description:
      Determines if the miniature screens should show a wallpaper or not. The wallpapers are controlled via the wallpaperProviderProperty(). If no wallpapers are shown then the appearance of the miniature screens solely depends on CSS.
      Parameters:
      showWallpaper - the value for the showWallpaper property
      See Also:
    • isShowWindows

      public final boolean isShowWindows()
      Gets the value of the showWindows property.
      Property description:
      Determines if the view should also show the currently active windows of the running application.
      Returns:
      the value of the showWindows property
      See Also:
    • showWindowsProperty

      public final javafx.beans.property.BooleanProperty showWindowsProperty()
      Determines if the view should also show the currently active windows of the running application.
      Returns:
      true if the windows should also be showing
      See Also:
    • setShowWindows

      public final void setShowWindows(boolean showWindows)
      Sets the value of the showWindows property.
      Property description:
      Determines if the view should also show the currently active windows of the running application.
      Parameters:
      showWindows - the value for the showWindows property
      See Also:
    • getWallpaperProvider

      public final javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image> getWallpaperProvider()
      Gets the value of the wallpaperProvider property.
      Property description:
      A callback used for looking up images that will be used as wallpapers on the miniature screens.
      Returns:
      the value of the wallpaperProvider property
      See Also:
    • wallpaperProviderProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image>> wallpaperProviderProperty()
      A callback used for looking up images that will be used as wallpapers on the miniature screens.
      Returns:
      a callback for determining which wallpaper to use for which screen
      See Also:
    • setWallpaperProvider

      public final void setWallpaperProvider(javafx.util.Callback<javafx.stage.Screen,javafx.scene.image.Image> wallpaperProvider)
      Sets the value of the wallpaperProvider property.
      Property description:
      A callback used for looking up images that will be used as wallpapers on the miniature screens.
      Parameters:
      wallpaperProvider - the value for the wallpaperProvider property
      See Also:
    • isEnableWindowDragging

      public final boolean isEnableWindowDragging()
      Gets the value of the enableWindowDragging property.
      Property description:
      A flag used to control whether the user will be able to drag the miniature windows on the miniature screens around or not.
      Returns:
      the value of the enableWindowDragging property
      See Also:
    • enableWindowDraggingProperty

      public final javafx.beans.property.BooleanProperty enableWindowDraggingProperty()
      A flag used to control whether the user will be able to drag the miniature windows on the miniature screens around or not.
      Returns:
      true if the user can modify the window positions
      See Also:
    • setEnableWindowDragging

      public final void setEnableWindowDragging(boolean enableWindowDragging)
      Sets the value of the enableWindowDragging property.
      Property description:
      A flag used to control whether the user will be able to drag the miniature windows on the miniature screens around or not.
      Parameters:
      enableWindowDragging - the value for the enableWindowDragging property
      See Also: