Class ResponsivePane
- All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
CSS Styleable Properties:
| Property | Type | Description |
|---|---|---|
-fx-gap | Double | Gap between sidebar and main content area. |
-fx-side | Side | The side on which the sidebar is displayed. |
-
Property Summary
PropertiesTypePropertyDescriptionfinal javafx.beans.property.ObjectProperty<javafx.scene.Node> The main content node displayed next to the active sidebar.final javafx.beans.property.BooleanPropertyThis property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.final javafx.beans.property.DoublePropertyThe gap between the sidebar and the main content area.final javafx.beans.property.BooleanPropertyThis property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display.final javafx.beans.property.ObjectProperty<javafx.scene.Node> The large sidebar node shown when enough space is available or display is forced.final javafx.beans.property.ObjectProperty<javafx.geometry.Side> Controls the side on which the sidebar (content area) is displayed relative to the main content.final javafx.beans.property.ObjectProperty<javafx.scene.Node> The compact sidebar node shown when there is not enough space for the large sidebar.Properties inherited from class javafx.scene.layout.StackPane
alignmentProperties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthProperties inherited from class javafx.scene.Parent
needsLayoutProperties 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 -
Field Summary
FieldsModifier and TypeFieldDescriptionjavafx.beans.property.ObjectProperty<javafx.scene.Node> The large sidebar node shown when enough space is available or display is forced.javafx.beans.property.ObjectProperty<javafx.scene.Node> The compact sidebar node shown when there is not enough space for the large sidebar.Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZEFields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal javafx.beans.property.ObjectProperty<javafx.scene.Node> The main content node displayed next to the active sidebar.final javafx.beans.property.BooleanPropertyThis property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.final javafx.beans.property.DoublePropertyThe gap between the sidebar and the main content area.static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> Returns the CSS metadata for this class.final javafx.scene.NodeGets the value of thecontentproperty.List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> final doublegetGap()Gets the value of thegapproperty.final javafx.scene.NodeGets the value of thelargeSidebarproperty.final javafx.geometry.SidegetSide()Gets the value of thesideproperty.final javafx.scene.NodeGets the value of thesmallSidebarproperty.final booleanGets the value of theforceLargeSidebarDisplayproperty.final booleanGets the value of thelargeSidebarCoversSmallproperty.final javafx.beans.property.BooleanPropertyThis property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display.final javafx.beans.property.ObjectProperty<javafx.scene.Node> The large sidebar node shown when enough space is available or display is forced.protected voidfinal voidsetContent(javafx.scene.Node value) Sets the value of thecontentproperty.final voidsetForceLargeSidebarDisplay(boolean forceLargeSidebarDisplay) Sets the value of theforceLargeSidebarDisplayproperty.final voidsetGap(double gap) Sets the value of thegapproperty.final voidsetLargeSidebar(javafx.scene.Node value) Sets the value of thelargeSidebarproperty.final voidsetLargeSidebarCoversSmall(boolean largeSidebarCoversSmall) Sets the value of thelargeSidebarCoversSmallproperty.final voidsetSide(javafx.geometry.Side side) Sets the value of thesideproperty.final voidsetSmallSidebar(javafx.scene.Node value) Sets the value of thesmallSidebarproperty.final javafx.beans.property.ObjectProperty<javafx.geometry.Side> Controls the side on which the sidebar (content area) is displayed relative to the main content.final javafx.beans.property.ObjectProperty<javafx.scene.Node> The compact sidebar node shown when there is not enough space for the large sidebar.Methods inherited from class javafx.scene.layout.StackPane
alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getContentBias, getMargin, requestLayout, setAlignment, setAlignment, setMarginMethods inherited from class javafx.scene.layout.Pane
getChildrenMethods 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, widthPropertyMethods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBoundsMethods 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, visiblePropertyMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
content
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentPropertyThe main content node displayed next to the active sidebar.- See Also:
-
smallSidebar
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> smallSidebarPropertyThe compact sidebar node shown when there is not enough space for the large sidebar.- See Also:
-
largeSidebar
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> largeSidebarPropertyThe large sidebar node shown when enough space is available or display is forced.- See Also:
-
largeSidebarCoversSmall
public final javafx.beans.property.BooleanProperty largeSidebarCoversSmallPropertyThis property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display. When set to true, the large sidebar will cover the small sidebar. When set to false, the large sidebar will position itself next to the small sidebar without overlaying, ensuring both sidebars are visible and accessible to the user.- See Also:
-
forceLargeSidebarDisplay
public final javafx.beans.property.BooleanProperty forceLargeSidebarDisplayPropertyThis property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.- See Also:
-
side
public final javafx.beans.property.ObjectProperty<javafx.geometry.Side> sidePropertyControls the side on which the sidebar (content area) is displayed relative to the main content.Can be set via CSS using the
-fx-sideproperty. Valid values are:top,bottom,left,right. The default value isleft.- See Also:
-
gap
public final javafx.beans.property.DoubleProperty gapPropertyThe gap between the sidebar and the main content area.Can be set via CSS using the
-fx-gapproperty. Valid values are: positive numbers. The default value is0.- See Also:
-
-
Field Details
-
smallSidebar
public javafx.beans.property.ObjectProperty<javafx.scene.Node> smallSidebarThe compact sidebar node shown when there is not enough space for the large sidebar. -
largeSidebar
public javafx.beans.property.ObjectProperty<javafx.scene.Node> largeSidebarThe large sidebar node shown when enough space is available or display is forced.
-
-
Constructor Details
-
ResponsivePane
public ResponsivePane()Constructs a new responsive pane.
-
-
Method Details
-
getUserAgentStylesheet
- Overrides:
getUserAgentStylesheetin classjavafx.scene.layout.Region
-
contentProperty
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty()The main content node displayed next to the active sidebar.- Returns:
- the content property
- See Also:
-
setContent
public final void setContent(javafx.scene.Node value) Sets the value of thecontentproperty.- Property description:
- The main content node displayed next to the active sidebar.
- Parameters:
value- the value for thecontentproperty- See Also:
-
getContent
public final javafx.scene.Node getContent()Gets the value of thecontentproperty.- Property description:
- The main content node displayed next to the active sidebar.
- Returns:
- the value of the
contentproperty - See Also:
-
smallSidebarProperty
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> smallSidebarProperty()The compact sidebar node shown when there is not enough space for the large sidebar.- Returns:
- the
smallSidebarproperty - See Also:
-
setSmallSidebar
public final void setSmallSidebar(javafx.scene.Node value) Sets the value of thesmallSidebarproperty.- Property description:
- The compact sidebar node shown when there is not enough space for the large sidebar.
- Parameters:
value- the value for thesmallSidebarproperty- See Also:
-
getSmallSidebar
public final javafx.scene.Node getSmallSidebar()Gets the value of thesmallSidebarproperty.- Property description:
- The compact sidebar node shown when there is not enough space for the large sidebar.
- Returns:
- the value of the
smallSidebarproperty - See Also:
-
largeSidebarProperty
public final javafx.beans.property.ObjectProperty<javafx.scene.Node> largeSidebarProperty()The large sidebar node shown when enough space is available or display is forced.- Returns:
- the
largeSidebarproperty - See Also:
-
setLargeSidebar
public final void setLargeSidebar(javafx.scene.Node value) Sets the value of thelargeSidebarproperty.- Property description:
- The large sidebar node shown when enough space is available or display is forced.
- Parameters:
value- the value for thelargeSidebarproperty- See Also:
-
getLargeSidebar
public final javafx.scene.Node getLargeSidebar()Gets the value of thelargeSidebarproperty.- Property description:
- The large sidebar node shown when enough space is available or display is forced.
- Returns:
- the value of the
largeSidebarproperty - See Also:
-
isLargeSidebarCoversSmall
public final boolean isLargeSidebarCoversSmall()Gets the value of thelargeSidebarCoversSmallproperty.- Property description:
- This property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display. When set to true, the large sidebar will cover the small sidebar. When set to false, the large sidebar will position itself next to the small sidebar without overlaying, ensuring both sidebars are visible and accessible to the user.
- Returns:
- the value of the
largeSidebarCoversSmallproperty - See Also:
-
largeSidebarCoversSmallProperty
public final javafx.beans.property.BooleanProperty largeSidebarCoversSmallProperty()This property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display. When set to true, the large sidebar will cover the small sidebar. When set to false, the large sidebar will position itself next to the small sidebar without overlaying, ensuring both sidebars are visible and accessible to the user.- Returns:
- the large-sidebar-covers-small property
- See Also:
-
setLargeSidebarCoversSmall
public final void setLargeSidebarCoversSmall(boolean largeSidebarCoversSmall) Sets the value of thelargeSidebarCoversSmallproperty.- Property description:
- This property determines the display behavior of the large sidebar in relation to the small sidebar when the large sidebar is forced to display. When set to true, the large sidebar will cover the small sidebar. When set to false, the large sidebar will position itself next to the small sidebar without overlaying, ensuring both sidebars are visible and accessible to the user.
- Parameters:
largeSidebarCoversSmall- the value for thelargeSidebarCoversSmallproperty- See Also:
-
isForceLargeSidebarDisplay
public final boolean isForceLargeSidebarDisplay()Gets the value of theforceLargeSidebarDisplayproperty.- Property description:
- This property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.
- Returns:
- the value of the
forceLargeSidebarDisplayproperty - See Also:
-
forceLargeSidebarDisplayProperty
public final javafx.beans.property.BooleanProperty forceLargeSidebarDisplayProperty()This property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.- Returns:
- the force-large-sidebar-display property
- See Also:
-
setForceLargeSidebarDisplay
public final void setForceLargeSidebarDisplay(boolean forceLargeSidebarDisplay) Sets the value of theforceLargeSidebarDisplayproperty.- Property description:
- This property, when value is true, forces the display of the large sidebar even when the small sidebar is visible.
- Parameters:
forceLargeSidebarDisplay- the value for theforceLargeSidebarDisplayproperty- See Also:
-
sideProperty
public final javafx.beans.property.ObjectProperty<javafx.geometry.Side> sideProperty()Controls the side on which the sidebar (content area) is displayed relative to the main content.Can be set via CSS using the
-fx-sideproperty. Valid values are:top,bottom,left,right. The default value isleft.- Returns:
- the side property
- See Also:
-
getSide
public final javafx.geometry.Side getSide()Gets the value of thesideproperty.- Property description:
- Controls the side on which the sidebar (content area) is displayed relative to the main content.
Can be set via CSS using the
-fx-sideproperty. Valid values are:top,bottom,left,right. The default value isleft. - Returns:
- the value of the
sideproperty - See Also:
-
setSide
public final void setSide(javafx.geometry.Side side) Sets the value of thesideproperty.- Property description:
- Controls the side on which the sidebar (content area) is displayed relative to the main content.
Can be set via CSS using the
-fx-sideproperty. Valid values are:top,bottom,left,right. The default value isleft. - Parameters:
side- the value for thesideproperty- See Also:
-
gapProperty
public final javafx.beans.property.DoubleProperty gapProperty()The gap between the sidebar and the main content area.Can be set via CSS using the
-fx-gapproperty. Valid values are: positive numbers. The default value is0.- Returns:
- the gap property
- See Also:
-
getGap
public final double getGap()Gets the value of thegapproperty.- Property description:
- The gap between the sidebar and the main content area.
Can be set via CSS using the
-fx-gapproperty. Valid values are: positive numbers. The default value is0. - Returns:
- the value of the
gapproperty - See Also:
-
setGap
public final void setGap(double gap) Sets the value of thegapproperty.- Property description:
- The gap between the sidebar and the main content area.
Can be set via CSS using the
-fx-gapproperty. Valid values are: positive numbers. The default value is0. - Parameters:
gap- the value for thegapproperty- See Also:
-
getClassCssMetaData
Returns the CSS metadata for this class.- Returns:
- the CSS metadata for this class
-
getCssMetaData
- Specified by:
getCssMetaDatain interfacejavafx.css.Styleable- Overrides:
getCssMetaDatain classjavafx.scene.layout.StackPane
-
layoutChildren
protected void layoutChildren()- Overrides:
layoutChildrenin classjavafx.scene.layout.StackPane
-