GemsFX 3.10.1 · com.dlsc.gemsfx.DrawerStackPane · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final BooleanProperty	animateDrawer
private final ObjectProperty<Duration>	animationDuration
private final BooleanProperty	autoHide
private VBox	drawer
private final ObjectProperty<Node>	drawerContent
private final DoubleProperty	drawerHeight
private final StringProperty	drawerTitle
private final ObjectProperty<Node>	drawerTitleExtra
private final BooleanProperty	fadeInOut
private GlassPane	glassPane
private HBox	headerBox
private static final Logger	LOG
private final DoubleProperty	maxDrawerHeight
private final DoubleProperty	minDrawerHeight
private final ObjectProperty<Runnable>	onCloseRequest
private final ObjectProperty<Runnable>	onDrawerClose
private final StringProperty	preferencesKey
private final DoubleProperty	preferredDrawerWidth
private final BooleanProperty	showDrawer
private final BooleanProperty	showDrawerTitle
private final DoubleProperty	sidePadding
private double	startY
private Timeline	timeline
private final ListProperty<Node>	toolbarItems
private final DoubleProperty	topPadding

Access	Constructor and Description
public	DrawerStackPane(Node... the children nodes nodes) Constructs a new drawer stack pane.
public	DrawerStackPane() Constructs a new drawer stack pane.

Method Summary

Modifier and Type	Method and Description
private void	addExtra(HBox headerBox, Node oldExtra, Node newExtra)
public final BooleanProperty	Returns: true if the drawer will be animated (slide in / out) animateDrawerProperty() Determines whether the drawer will smoothly slide in / out when the user opens / closes it.
public final ObjectProperty<Duration>	Returns: the animation duration animationDurationProperty() The duration it takes to show / hide the drawer.
public BooleanProperty	Returns: true if the drawer hides when user clicks on background autoHideProperty() Makes the drawer close if the user clicks in the background (onto the glass pane).
private VBox	createContainer()
private StackPane	createDragHandle()
private String	createPreferenceKey()
private Label	createTitleLabel()
private ToolBar	createToolBar()
public final ObjectProperty<Node>	Returns: the drawer content drawerContentProperty() Stores the content of the drawer.
public final DoubleProperty	Returns: the drawer height (value between 0 and 1) drawerHeightProperty() Stores the current height of the drawer as a value between 0 (not showing) and 1 (using full height of stackpane).
public final ObjectProperty<Node>	Returns: an extra node that will be added to the title bar drawerTitleExtraProperty() An extra node that will be added to the title bar.
public final StringProperty	Returns: the drawer title text drawerTitleProperty() The text shown as the title of the drawer.
public final BooleanProperty	Returns: true if the glass pane will fade in / out smoothly when appearing / disappearing fadeInOutProperty() Specifies whether the glass pane (used for blocking user input to nodes in the background) will use a fade transition when it becomes visible.
public final Duration	getAnimationDuration()
public final Node	getDrawerContent()
public final double	getDrawerHeight()
public final String	getDrawerTitle()
public final Node	getDrawerTitleExtra()
public double	getMaxDrawerHeight()
public double	getMinDrawerHeight()
public Runnable	getOnCloseRequest()
public final Runnable	getOnDrawerClose()
public final String	Returns: the preferences key getPreferencesKey() Returns the key that will be used when storing the last drawer height via the Java preferences API.
public final double	getPreferredDrawerWidth()
public final double	getSidePadding()
public final ObservableList<Node>	getToolbarItems()
public final double	getTopPadding()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
private void	hideDrawer()
private void	init()
public final boolean	isAnimateDrawer()
public boolean	isAutoHide()
public final boolean	isFadeInOut()
public boolean	isShowDrawer()
public final boolean	isShowDrawerTitle()
protected void	layoutChildren() Overrides javafx.scene.layout.StackPane.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
private double	loadDrawerHeightFromUserPreferences()
public DoubleProperty	Returns: the maximum drawer height (value between 0 and 1) maxDrawerHeightProperty() The maximum drawer height, a value between 0 and 1 with 1 meaning that the drawer can be as high as the stackpane.
public DoubleProperty	Returns: the minimum drawer height (value between 0 and 1) minDrawerHeightProperty() The minimum drawer height, a value between 0 and 1 with 0 meaning that the drawer can be made completely invisible.
public ObjectProperty<Runnable>	Returns: the callback for closing the drawer onCloseRequestProperty() A callback that will be called when the user clicks on the close button or onto the glass pane.
public final ObjectProperty<Runnable>	Returns: a callback that will be invoked when the drawer gets closed onDrawerCloseProperty() A callback that will be invoked when the drawer gets closed.
private void	postHiding()
public final StringProperty	Returns: the preferences key property preferencesKeyProperty() Stores the key used to store the drawer height via the preferences store.
public final DoubleProperty	Returns: the preferred drawer width preferredDrawerWidthProperty() Stores the preferred width of the drawer.
private void	saveDrawerHeightToUserPreferences()
public final void	setAnimateDrawer(boolean animateDrawer)
public final void	setAnimationDuration(Duration animationDuration)
public void	setAutoHide(boolean autoHide)
public final void	setDrawerContent(Node drawerContent)
public final void	setDrawerHeight(double drawerHeight)
public void	setDrawerTitle(String drawerTitle)
public final void	setDrawerTitleExtra(Node drawerTitleExtra)
public final void	setFadeInOut(boolean fadeInOut)
public void	setMaxDrawerHeight(double maxDrawerHeight)
public void	setMinDrawerHeight(double minDrawerHeight)
public void	setOnCloseRequest(Runnable onCloseRequest)
public final void	setOnDrawerClose(Runnable onDrawerClose)
public final void	setPreferencesKey(String the preferences key key) Sets the key that will be used when storing the last drawer height via the Java preferences API.
public final void	setPreferredDrawerWidth(double preferredDrawerWidth)
public final void	setShowDrawer(boolean showDrawer)
public final void	setShowDrawerTitle(boolean showDrawerTitle)
public final void	setSidePadding(double sidePadding)
public final void	setToolbarItems(ObservableList<Node> items)
public final void	setTopPadding(double topPadding)
private void	showDrawer()
public final BooleanProperty	Returns: true if the drawer should show itself showDrawerProperty() A flag used to control whether the drawer should show itself or not.
public final BooleanProperty	Returns: true if the drawer shows a title showDrawerTitleProperty() A flag used to signal whether the drawer should have a title bar or not.
public final DoubleProperty	Returns: the padding used for the left and right side next to the drawer sidePaddingProperty() Specifies a value used for padding to the left and the right of the drawer.
private void	stopCurrentlyRunningTimeline()
public final ListProperty<Node>	Returns: the toolbar items / toolbar buttons toolbarItemsProperty() The list of items to display in the toolbar.
public final DoubleProperty	Returns: the padding used for the top of the drawer topPaddingProperty() Specifies a value used for padding at the top of the drawer.

Inherited from javafx.scene.layout.StackPane:: alignmentProperty clearConstraints computeMinHeight computeMinWidth computePrefHeight computePrefWidth getAlignment getAlignment getClassCssMetaData getContentBias getCssMetaData getMargin requestLayout setAlignment setAlignment setMargin

animateDrawer	back to summary
private final BooleanProperty animateDrawer

animationDuration	back to summary
private final ObjectProperty<Duration> animationDuration

autoHide	back to summary
private final BooleanProperty autoHide

drawer	back to summary
private VBox drawer

drawerContent	back to summary
private final ObjectProperty<Node> drawerContent

drawerHeight	back to summary
private final DoubleProperty drawerHeight

drawerTitle	back to summary
private final StringProperty drawerTitle

drawerTitleExtra	back to summary
private final ObjectProperty<Node> drawerTitleExtra

fadeInOut	back to summary
private final BooleanProperty fadeInOut

glassPane	back to summary
private GlassPane glassPane

headerBox	back to summary
private HBox headerBox

LOG	back to summary
private static final Logger LOG

maxDrawerHeight	back to summary
private final DoubleProperty maxDrawerHeight

minDrawerHeight	back to summary
private final DoubleProperty minDrawerHeight

onCloseRequest	back to summary
private final ObjectProperty<Runnable> onCloseRequest

onDrawerClose	back to summary
private final ObjectProperty<Runnable> onDrawerClose

preferencesKey	back to summary
private final StringProperty preferencesKey

preferredDrawerWidth	back to summary
private final DoubleProperty preferredDrawerWidth

showDrawer	back to summary
private final BooleanProperty showDrawer

showDrawerTitle	back to summary
private final BooleanProperty showDrawerTitle

sidePadding	back to summary
private final DoubleProperty sidePadding

startY	back to summary
private double startY

timeline	back to summary
private Timeline timeline

toolbarItems	back to summary
private final ListProperty<Node> toolbarItems

topPadding	back to summary
private final DoubleProperty topPadding

DrawerStackPane	back to summary
public DrawerStackPane(Node... nodes) Constructs a new drawer stack pane. Parameters nodes:Node[] the children nodes

DrawerStackPane	back to summary
public DrawerStackPane() Constructs a new drawer stack pane.

Method Detail

addExtra	back to summary
private void addExtra(HBox headerBox, Node oldExtra, Node newExtra)

animateDrawerProperty	back to summary
public final BooleanProperty animateDrawerProperty() Determines whether the drawer will smoothly slide in / out when the user opens / closes it. If not then the drawer will just appear instantly. Returns:BooleanProperty true if the drawer will be animated (slide in / out)

animateDrawerProperty

back to summary

public final BooleanProperty animateDrawerProperty()

Determines whether the drawer will smoothly slide in / out when the user opens / closes it. If not then the drawer will just appear instantly.

Returns:BooleanProperty: true if the drawer will be animated (slide in / out)

animationDurationProperty	back to summary
public final ObjectProperty<Duration> animationDurationProperty() The duration it takes to show / hide the drawer. Returns:ObjectProperty<Duration> the animation duration

animationDurationProperty

back to summary

public final ObjectProperty<Duration> animationDurationProperty()

The duration it takes to show / hide the drawer.

Returns:ObjectProperty<Duration>: the animation duration

autoHideProperty	back to summary
public BooleanProperty autoHideProperty() Makes the drawer close if the user clicks in the background (onto the glass pane). Returns:BooleanProperty true if the drawer hides when user clicks on background

autoHideProperty

back to summary

public BooleanProperty autoHideProperty()

Makes the drawer close if the user clicks in the background (onto the glass pane).

Returns:BooleanProperty: true if the drawer hides when user clicks on background

createContainer	back to summary
private VBox createContainer()

createDragHandle	back to summary
private StackPane createDragHandle()

createPreferenceKey	back to summary
private String createPreferenceKey()

createTitleLabel	back to summary
private Label createTitleLabel()

createToolBar	back to summary
private ToolBar createToolBar()

drawerContentProperty	back to summary
public final ObjectProperty<Node> drawerContentProperty() Stores the content of the drawer. Returns:ObjectProperty<Node> the drawer content

drawerContentProperty

back to summary

public final ObjectProperty<Node> drawerContentProperty()

Stores the content of the drawer.

Returns:ObjectProperty<Node>: the drawer content

drawerHeightProperty	back to summary
public final DoubleProperty drawerHeightProperty() Stores the current height of the drawer as a value between 0 (not showing) and 1 (using full height of stackpane). Returns:DoubleProperty the drawer height (value between 0 and 1)

drawerHeightProperty

back to summary

public final DoubleProperty drawerHeightProperty()

Stores the current height of the drawer as a value between 0 (not showing) and 1 (using full height of stackpane).

Returns:DoubleProperty: the drawer height (value between 0 and 1)

drawerTitleExtraProperty	back to summary
public final ObjectProperty<Node> drawerTitleExtraProperty() An extra node that will be added to the title bar. Returns:ObjectProperty<Node> an extra node that will be added to the title bar

drawerTitleExtraProperty

back to summary

public final ObjectProperty<Node> drawerTitleExtraProperty()

An extra node that will be added to the title bar.

Returns:ObjectProperty<Node>: an extra node that will be added to the title bar

drawerTitleProperty	back to summary
public final StringProperty drawerTitleProperty() The text shown as the title of the drawer. Returns:StringProperty the drawer title text

drawerTitleProperty

back to summary

public final StringProperty drawerTitleProperty()

The text shown as the title of the drawer.

Returns:StringProperty: the drawer title text

fadeInOutProperty	back to summary
public final BooleanProperty fadeInOutProperty() Specifies whether the glass pane (used for blocking user input to nodes in the background) will use a fade transition when it becomes visible. Returns:BooleanProperty true if the glass pane will fade in / out smoothly when appearing / disappearing

fadeInOutProperty

back to summary

public final BooleanProperty fadeInOutProperty()

Specifies whether the glass pane (used for blocking user input to nodes in the background) will use a fade transition when it becomes visible.

Returns:BooleanProperty: true if the glass pane will fade in / out smoothly when appearing / disappearing

getAnimationDuration	back to summary
public final Duration getAnimationDuration()

getDrawerContent	back to summary
public final Node getDrawerContent()

getDrawerHeight	back to summary
public final double getDrawerHeight()

getDrawerTitle	back to summary
public final String getDrawerTitle()

getDrawerTitleExtra	back to summary
public final Node getDrawerTitleExtra()

getMaxDrawerHeight	back to summary
public double getMaxDrawerHeight()

getMinDrawerHeight	back to summary
public double getMinDrawerHeight()

getOnCloseRequest	back to summary
public Runnable getOnCloseRequest()

getOnDrawerClose	back to summary
public final Runnable getOnDrawerClose()

getPreferencesKey

back to summary

public final String getPreferencesKey()

Returns the key that will be used when storing the last drawer height via the Java preferences API.

Returns:String: the preferences key

getPreferredDrawerWidth	back to summary
public final double getPreferredDrawerWidth()

getSidePadding	back to summary
public final double getSidePadding()

getToolbarItems	back to summary
public final ObservableList<Node> getToolbarItems()

getTopPadding	back to summary
public final double getTopPadding()

getUserAgentStylesheet back to summary

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

hideDrawer	back to summary
private void hideDrawer()

init	back to summary
private void init()

isAnimateDrawer	back to summary
public final boolean isAnimateDrawer()

isAutoHide	back to summary
public boolean isAutoHide()

isFadeInOut	back to summary
public final boolean isFadeInOut()

isShowDrawer	back to summary
public boolean isShowDrawer()

isShowDrawerTitle	back to summary
public final boolean isShowDrawerTitle()

layoutChildren back to summary

protected void layoutChildren()

Overrides javafx.scene.layout.StackPane.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

loadDrawerHeightFromUserPreferences	back to summary
private double loadDrawerHeightFromUserPreferences()

maxDrawerHeightProperty

back to summary

public DoubleProperty maxDrawerHeightProperty()

The maximum drawer height, a value between 0 and 1 with 1 meaning that the drawer can be as high as the stackpane.

Returns:DoubleProperty: the maximum drawer height (value between 0 and 1)

minDrawerHeightProperty

back to summary

public DoubleProperty minDrawerHeightProperty()

The minimum drawer height, a value between 0 and 1 with 0 meaning that the drawer can be made completely invisible. Even with a value larger than 0 the drawer can be made to hide by the user by continuing to drag below the drawer.

Returns:DoubleProperty: the minimum drawer height (value between 0 and 1)

onCloseRequestProperty back to summary

public ObjectProperty<Runnable> onCloseRequestProperty()

A callback that will be called when the user clicks on the close button or onto the glass pane. The default implementation of this callback will eventually call setShowDrawer(boolean).

Returns:ObjectProperty<Runnable>: the callback for closing the drawer

onDrawerCloseProperty

back to summary

public final ObjectProperty<Runnable> onDrawerCloseProperty()

A callback that will be invoked when the drawer gets closed.

Returns:ObjectProperty<Runnable>: a callback that will be invoked when the drawer gets closed

postHiding	back to summary
private void postHiding()

preferencesKeyProperty

back to summary

public final StringProperty preferencesKeyProperty()

Stores the key used to store the drawer height via the preferences store.

Returns:StringProperty: the preferences key property

preferredDrawerWidthProperty back to summary

public final DoubleProperty preferredDrawerWidthProperty()

Stores the preferred width of the drawer. Normally this value is equal to -1, which indicates that the drawer should use the entire available width. A value larger than -1 will make the pane use that value for the width of the drawer. A value of Region#USE_PREF_SIZE will make the pane use the preferred width of the content shown inside the drawer.

Returns:DoubleProperty: the preferred drawer width

saveDrawerHeightToUserPreferences	back to summary
private void saveDrawerHeightToUserPreferences()

setAnimateDrawer	back to summary
public final void setAnimateDrawer(boolean animateDrawer)

setAnimationDuration	back to summary
public final void setAnimationDuration(Duration animationDuration)

setAutoHide	back to summary
public void setAutoHide(boolean autoHide)

setDrawerContent	back to summary
public final void setDrawerContent(Node drawerContent)

setDrawerHeight	back to summary
public final void setDrawerHeight(double drawerHeight)

setDrawerTitle	back to summary
public void setDrawerTitle(String drawerTitle)

setDrawerTitleExtra	back to summary
public final void setDrawerTitleExtra(Node drawerTitleExtra)

setFadeInOut	back to summary
public final void setFadeInOut(boolean fadeInOut)

setMaxDrawerHeight	back to summary
public void setMaxDrawerHeight(double maxDrawerHeight)

setMinDrawerHeight	back to summary
public void setMinDrawerHeight(double minDrawerHeight)

setOnCloseRequest	back to summary
public void setOnCloseRequest(Runnable onCloseRequest)

setOnDrawerClose	back to summary
public final void setOnDrawerClose(Runnable onDrawerClose)

setPreferencesKey

back to summary

public final void setPreferencesKey(String key)

Sets the key that will be used when storing the last drawer height via the Java preferences API.

Parameters

key:String: the preferences key

setPreferredDrawerWidth	back to summary
public final void setPreferredDrawerWidth(double preferredDrawerWidth)

setShowDrawer	back to summary
public final void setShowDrawer(boolean showDrawer)

setShowDrawerTitle	back to summary
public final void setShowDrawerTitle(boolean showDrawerTitle)

setSidePadding	back to summary
public final void setSidePadding(double sidePadding)

setToolbarItems	back to summary
public final void setToolbarItems(ObservableList<Node> items)

setTopPadding	back to summary
public final void setTopPadding(double topPadding)

showDrawer	back to summary
private void showDrawer()

showDrawerProperty

back to summary

public final BooleanProperty showDrawerProperty()

A flag used to control whether the drawer should show itself or not.

Returns:BooleanProperty: true if the drawer should show itself

showDrawerTitleProperty

back to summary

public final BooleanProperty showDrawerTitleProperty()

A flag used to signal whether the drawer should have a title bar or not.

Returns:BooleanProperty: true if the drawer shows a title

sidePaddingProperty

back to summary

public final DoubleProperty sidePaddingProperty()

Specifies a value used for padding to the left and the right of the drawer. This value will always be enforced, not matter what the preferred width of the drawer content is.

Returns:DoubleProperty: the padding used for the left and right side next to the drawer

stopCurrentlyRunningTimeline	back to summary
private void stopCurrentlyRunningTimeline()

toolbarItemsProperty

back to summary

public final ListProperty<Node> toolbarItemsProperty()

The list of items to display in the toolbar.

Returns:ListProperty<Node>: the toolbar items / toolbar buttons

topPaddingProperty

back to summary

public final DoubleProperty topPaddingProperty()

Specifies a value used for padding at the top of the drawer. This value will always be enforced,.

Returns:DoubleProperty: the padding used for the top of the drawer

public Class DrawerStackPane

Features

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail