- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.control.Control
-
- com.gluonhq.charm.glisten.control.AppBar
-
- All Implemented Interfaces:
Styleable
,EventTarget
,Skinnable
public class AppBar extends Control
The AppBar is a special kind of toolbar that is used for branding, navigation, search, and actions. It is placed at the top of the view and is generally made up of:
- Nav Icon - Left-most icon of the AppBar and is generally used for showing
the
NavigationDrawer
or to move back in the view stack - Title -
Label
used to describe the current view - Action Icons - Icons with specific actions related to the current view
- Menu Icon - Right-most icon of the AppBar and is used to show an overflow menu, which contains secondary actions and menu items
A single instance of the AppBar is initialized by the application during its construction and therefore, need not be instantiated by the user. To change the elements of this control its instance can be fetched from
MobileApplication.getInstance().getAppBar()
.The recommended node for Nav Icon and Action Icons is a
If you wish to style the AppBar on a particular View, using CSS, just add a styleclass to the AppBar in thebutton
. Appropriate styling is automatically applied tobuttons
. To create abutton
without any text and only an Icon, useMaterialDesignIcon.button()
. However, a user is not restricted to usebuttons
and can use anyNode
, with custom style(s). For developers, it is recommended to use the same color for all icons.View.updateAppBar(AppBar)
method or in a listener forView.showingProperty()
and remove it in theView
HIDDEN event, the following code illustrates this:public SomeView(String name) { ... setOnHidden(event -> { appBar.getStyleClass().remove("foo"); }); }
@Override protected void updateAppBar(AppBar appBar) { appBar.getStyleClass().add("foo"); ... }The following example fills the contents of an AppBar:
AppBar appBar = MobileApplication.getInstance().getAppBar(); appBar.setNavIcon(MaterialDesignIcon.MENU.button()); appBar.setTitleText("The AppBar"); appBar.getActionItems().addAll(MaterialDesignIcon.SEARCH.button(), MaterialDesignIcon.FAVORITE.button()); appBar.getMenuItems().add(new MenuItem("Settings"));
Every time a new
View
is loaded, the AppBar controls are removed, and its visibility is reset to true, so developers will need to provide at this point the new controls for the AppBar in this new View, either by overridingView.updateAppBar(com.gluonhq.charm.glisten.control.AppBar)
, by adding an event handler to theSHOWING
event or by listening toView.showingProperty()
.The method
clear()
can be called to remove all the elements from AppBar and reset visibility of the control to true.- Since:
- 2.0.0
- See Also:
AppManager
,View
-
-
Property Summary
Properties Type Property Description BooleanProperty
autoHideProgressBar
Decides if a determinateProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e.ObjectProperty<Node>
navIcon
The left-most node in the app bar, and is often used to show a side popup menu or to move back in the view stack.BooleanProperty
progressBarVisible
The visible property of theProgressBar
shown on the AppBar.DoubleProperty
progress
The progress of theProgressBar
attached to theAppBar
.StyleableDoubleProperty
spacing
The amount of horizontal space between each child in the AppBar.ObjectProperty<Node>
title
The title in the app bar reflects the current page.StringProperty
titleText
The title in the app bar reflects the current page.-
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 AppBar()
Creates a new instance of AppBar.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanProperty
autoHideProgressBarProperty()
Decides if a determinateProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e.void
clear()
Clears theAppBar
leaving it with no nav icon, title, action icons or menu items.protected Skin<?>
createDefaultSkin()
ObservableList<Node>
getActionItems()
Gets the action items.static List<CssMetaData<? extends Styleable,?>>
getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>
getControlCssMetaData()
ObservableList<MenuItem>
getMenuItems()
Gets the menu items listed in the overflow menu.Node
getNavIcon()
Returns a node which is used as the nav icon.double
getProgress()
Gets the value of the property progress.double
getSpacing()
Gets the value of the property spacing.Node
getTitle()
Returns the title of the AppBar.String
getTitleText()
Returns a String with the title of the AppBar.boolean
isAutoHideProgressBar()
Gets the value of the property autoHideProgressBar.boolean
isProgressBarVisible()
Gets the value of the property progressBarVisible.ObjectProperty<Node>
navIconProperty()
The left-most node in the app bar, and is often used to show a side popup menu or to move back in the view stack.BooleanProperty
progressBarVisibleProperty()
The visible property of theProgressBar
shown on the AppBar.DoubleProperty
progressProperty()
The progress of theProgressBar
attached to theAppBar
.void
setAutoHideProgressBar(boolean autoHideProgressBar)
Sets the value of the property autoHideProgressBar.void
setNavIcon(Node navIcon)
Sets a node as the nav icon.void
setProgress(double value)
Sets the value of the property progress.void
setProgressBarVisible(boolean progressBarVisible)
Sets the value of the property progressBarVisible.void
setSpacing(double value)
Sets the value of the property spacing.void
setTitle(Node title)
Changes the title of the AppBar.void
setTitleText(String titleText)
Sets the title of the AppBar.StyleableDoubleProperty
spacingProperty()
The amount of horizontal space between each child in the AppBar.ObjectProperty<Node>
titleProperty()
The title in the app bar reflects the current page.StringProperty
titleTextProperty()
The title in the app bar reflects the current page.-
Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, 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 Detail
-
title
public final ObjectProperty<Node> titleProperty
The title in the app bar reflects the current page. It can be an app title or a page title. Setting this property to a value other than null will result in a node added right next to thenavIcon
in theAppBar
.- Returns:
- An ObjectProperty representing the AppBar title.
- See Also:
titleTextProperty()
-
titleText
public final StringProperty titleTextProperty
The title in the app bar reflects the current page. It can be an app title or a page title. Setting this property to a value other than null will result in thetitleProperty()
being aLabel
with this property value as the text. This property might not reflect the actual title since this is not always synchronized withtitleProperty()
.- See Also:
getTitleText()
,setTitleText(String)
-
navIcon
public final ObjectProperty<Node> navIconProperty
The left-most node in the app bar, and is often used to show a side popup menu or to move back in the view stack.- See Also:
getNavIcon()
,setNavIcon(Node)
-
progress
public final DoubleProperty progressProperty
The progress of theProgressBar
attached to theAppBar
. TheProgressBar
can be either indeterminate or determinate depending on the value of this property. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.- Default value:
ProgressIndicator.INDETERMINATE_PROGRESS
- Since:
- 4.2.0
- See Also:
getProgress()
,setProgress(double)
-
progressBarVisible
public final BooleanProperty progressBarVisibleProperty
The visible property of theProgressBar
shown on the AppBar.- Default value:
- false
- Since:
- 4.2.0
- See Also:
isProgressBarVisible()
,setProgressBarVisible(boolean)
-
autoHideProgressBar
public final BooleanProperty autoHideProgressBarProperty
Decides if a determinateProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e. 1.0. If set as true and theprogressProperty()
is greater than equal to 1.0, theprogressBarVisibleProperty()
will be set to false.This property has no effect on an indeterminate
ProgressBar
.- Default value:
- false
- Since:
- 4.2.0
- See Also:
isAutoHideProgressBar()
,setAutoHideProgressBar(boolean)
-
spacing
public final StyleableDoubleProperty spacingProperty
The amount of horizontal space between each child in the AppBar. This horizontal space is also applied to the children ofgetActionItems()
.- See Also:
getSpacing()
,setSpacing(double)
-
-
Method Detail
-
getTitle
public final Node getTitle()
Returns the title of the AppBar.- Returns:
- The title
Node
. - See Also:
getTitleText()
-
titleProperty
public final ObjectProperty<Node> titleProperty()
The title in the app bar reflects the current page. It can be an app title or a page title. Setting this property to a value other than null will result in a node added right next to thenavIcon
in theAppBar
.- Returns:
- An ObjectProperty representing the AppBar title.
- See Also:
titleTextProperty()
-
setTitle
public final void setTitle(Node title)
Changes the title of the AppBar.- Parameters:
title
- The new titleNode
.- See Also:
setTitleText(String)
-
getTitleText
public final String getTitleText()
Returns a String with the title of the AppBar.- Returns:
- A
String
with the title. This might not be the current title in theAppBar
sincesetTitle(Node)
might be called andtitleProperty()
andtitleTextProperty()
are not always synchronized. - See Also:
getTitle()
-
titleTextProperty
public final StringProperty titleTextProperty()
The title in the app bar reflects the current page. It can be an app title or a page title. Setting this property to a value other than null will result in thetitleProperty()
being aLabel
with this property value as the text. This property might not reflect the actual title since this is not always synchronized withtitleProperty()
.- See Also:
getTitleText()
,setTitleText(String)
-
setTitleText
public final void setTitleText(String titleText)
Sets the title of the AppBar.- Parameters:
titleText
- The current title ofAppBar
.- See Also:
setTitle(Node)
-
getActionItems
public final ObservableList<Node> getActionItems()
Gets the action items. Typical use case for anAppBar
suggest that the most common actionItems to place within it areButtons
with just a graphic, but you are not restricted to just these, and can insert anyNode
. The actionItems are placed between the title and the overflow menu, aligned right to left. The actionItems added must not be null.- Returns:
ObservableList
ofNode
containing the action items.
-
getMenuItems
public final ObservableList<MenuItem> getMenuItems()
Gets the menu items listed in the overflow menu. The menu icon opens the overflow menu, which contains secondary actions and menu items like help, settings, and feedback. These menu items can be set in the menu by adding aMenuItem
to theObservableList
returned by this method.- Returns:
ObservableList
ofMenuItem
which is shown when anActionEvent
is triggered on the menu icon of theAppBar
.
-
getNavIcon
public final Node getNavIcon()
Returns a node which is used as the nav icon.- Returns:
- A
Node
containing the nav icon instance.
-
navIconProperty
public final ObjectProperty<Node> navIconProperty()
The left-most node in the app bar, and is often used to show a side popup menu or to move back in the view stack.- See Also:
getNavIcon()
,setNavIcon(Node)
-
setNavIcon
public final void setNavIcon(Node navIcon)
Sets a node as the nav icon. The nav icon is the left-most node of the app bar and can be:
- A control to open a navigation drawer.
- An up arrow for navigating upward through your application hierarchy.
- Omitted entirely if no navigation is required from this screen.
Normally, a user is advised to add a
Button
as the node. AButton
will receive the appropriate styling automatically. Nevertheless, a user is not restricted to aButton
and may add any node with custom style.- Parameters:
navIcon
- The nav icon of theAppBar
-
progressProperty
public final DoubleProperty progressProperty()
The progress of theProgressBar
attached to theAppBar
. TheProgressBar
can be either indeterminate or determinate depending on the value of this property. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.- Default value:
ProgressIndicator.INDETERMINATE_PROGRESS
- Since:
- 4.2.0
- See Also:
getProgress()
,setProgress(double)
-
getProgress
public final double getProgress()
Gets the value of the property progress.- Property description:
- The progress of the
ProgressBar
attached to theAppBar
. TheProgressBar
can be either indeterminate or determinate depending on the value of this property. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%. - Default value:
ProgressIndicator.INDETERMINATE_PROGRESS
- Since:
- 4.2.0
-
setProgress
public final void setProgress(double value)
Sets the value of the property progress.- Property description:
- The progress of the
ProgressBar
attached to theAppBar
. TheProgressBar
can be either indeterminate or determinate depending on the value of this property. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%. - Default value:
ProgressIndicator.INDETERMINATE_PROGRESS
- Since:
- 4.2.0
-
progressBarVisibleProperty
public final BooleanProperty progressBarVisibleProperty()
The visible property of theProgressBar
shown on the AppBar.- Default value:
- false
- Since:
- 4.2.0
- See Also:
isProgressBarVisible()
,setProgressBarVisible(boolean)
-
isProgressBarVisible
public final boolean isProgressBarVisible()
Gets the value of the property progressBarVisible.- Property description:
- The visible property of the
ProgressBar
shown on the AppBar. - Default value:
- false
- Since:
- 4.2.0
-
setProgressBarVisible
public final void setProgressBarVisible(boolean progressBarVisible)
Sets the value of the property progressBarVisible.- Property description:
- The visible property of the
ProgressBar
shown on the AppBar. - Default value:
- false
- Since:
- 4.2.0
-
autoHideProgressBarProperty
public final BooleanProperty autoHideProgressBarProperty()
Decides if a determinateProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e. 1.0. If set as true and theprogressProperty()
is greater than equal to 1.0, theprogressBarVisibleProperty()
will be set to false.This property has no effect on an indeterminate
ProgressBar
.- Default value:
- false
- Since:
- 4.2.0
- See Also:
isAutoHideProgressBar()
,setAutoHideProgressBar(boolean)
-
isAutoHideProgressBar
public final boolean isAutoHideProgressBar()
Gets the value of the property autoHideProgressBar.- Property description:
- Decides if a determinate
ProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e. 1.0. If set as true and theprogressProperty()
is greater than equal to 1.0, theprogressBarVisibleProperty()
will be set to false.This property has no effect on an indeterminate
ProgressBar
. - Default value:
- false
- Since:
- 4.2.0
-
setAutoHideProgressBar
public final void setAutoHideProgressBar(boolean autoHideProgressBar)
Sets the value of the property autoHideProgressBar.- Property description:
- Decides if a determinate
ProgressBar
should hide itself when theprogressProperty()
reaches the threshold value i.e. 1.0. If set as true and theprogressProperty()
is greater than equal to 1.0, theprogressBarVisibleProperty()
will be set to false.This property has no effect on an indeterminate
ProgressBar
. - Default value:
- false
- Since:
- 4.2.0
-
spacingProperty
public final StyleableDoubleProperty spacingProperty()
The amount of horizontal space between each child in the AppBar. This horizontal space is also applied to the children ofgetActionItems()
.- See Also:
getSpacing()
,setSpacing(double)
-
setSpacing
public final void setSpacing(double value)
Sets the value of the property spacing.- Property description:
- The amount of horizontal space between each child in the AppBar.
This horizontal space is also applied to the children of
getActionItems()
.
-
getSpacing
public final double getSpacing()
Gets the value of the property spacing.- Property description:
- The amount of horizontal space between each child in the AppBar.
This horizontal space is also applied to the children of
getActionItems()
.
-
clear
public void clear()
Clears theAppBar
leaving it with no nav icon, title, action icons or menu items. The visibility of AppBar is also reset to true.
-
createDefaultSkin
protected Skin<?> createDefaultSkin()
- Overrides:
createDefaultSkin
in classControl
-
getClassCssMetaData
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
- Returns:
- The CssMetaData associated with this class, which may include the CssMetaData of its super classes.
- Since:
- JavaFX 8.0
-
getControlCssMetaData
public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()
- Overrides:
getControlCssMetaData
in classControl
- Since:
- JavaFX 8.0
-
-