com.gluonhq.charm.glisten.control

Class AppBar

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:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class AppBar
extends javafx.scene.control.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 button. Appropriate styling is automatically applied to buttons. To create a button without any text and only an Icon, use MaterialDesignIcon.button(). However, a user is not restricted to use buttons and can use any Node, with custom style(s). For developers, it is recommended to use the same color for all icons.

If you wish to style the AppBar on a particular View, using CSS, just add a styleclass to the AppBar in the View.updateAppBar(AppBar) method or in a listener for View.showingProperty() and remove it in the View 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 overriding View.updateAppBar(com.gluonhq.charm.glisten.control.AppBar), by adding an event handler to the SHOWING event or by listening to View.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:

MobileApplication, View

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	autoHideProgressBar Decides if a determinate ProgressBar should hide itself when the progressProperty() reaches the threshold value i.e.
javafx.beans.property.ObjectProperty<javafx.scene.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.
javafx.beans.property.BooleanProperty	progressBarVisible The visible property of the ProgressBar shown on the AppBar.
javafx.beans.property.DoubleProperty	progress The progress of the ProgressBar attached to the AppBar.
javafx.css.StyleableDoubleProperty	spacing The amount of horizontal space between each child in the AppBar.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	title The title in the app bar reflects the current page.
javafx.beans.property.StringProperty	titleText The title in the app bar reflects the current page.

Properties inherited from class javafx.scene.control.Control

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

impl_traversalEngine, 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, hover, id, impl_showMnemonics, impl_treeVisible, 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, 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 and Description
AppBar() Creates a new instance of AppBar.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	autoHideProgressBarProperty() Decides if a determinate ProgressBar should hide itself when the progressProperty() reaches the threshold value i.e.
void	clear() Clears the AppBar leaving it with no nav icon, title, action icons or menu items.
protected javafx.scene.control.Skin<?>	createDefaultSkin()
javafx.collections.ObservableList<javafx.scene.Node>	getActionItems() Gets the action items.
static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()
java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getControlCssMetaData()
javafx.collections.ObservableList<javafx.scene.control.MenuItem>	getMenuItems() Gets the menu items listed in the overflow menu.
javafx.scene.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.
javafx.scene.Node	getTitle() Returns the title of the AppBar.
java.lang.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.
javafx.beans.property.ObjectProperty<javafx.scene.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.
javafx.beans.property.BooleanProperty	progressBarVisibleProperty() The visible property of the ProgressBar shown on the AppBar.
javafx.beans.property.DoubleProperty	progressProperty() The progress of the ProgressBar attached to the AppBar.
void	setAutoHideProgressBar(boolean autoHideProgressBar) Sets the value of the property autoHideProgressBar.
void	setNavIcon(javafx.scene.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(javafx.scene.Node title) Changes the title of the AppBar.
void	setTitleText(java.lang.String titleText) Sets the title of the AppBar.
javafx.css.StyleableDoubleProperty	spacingProperty() The amount of horizontal space between each child in the AppBar.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	titleProperty() The title in the app bar reflects the current page.
javafx.beans.property.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, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, 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, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

title

public final javafx.beans.property.ObjectProperty<javafx.scene.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 the navIcon in the AppBar.

Returns:

An ObjectProperty representing the AppBar title.

See Also:

titleTextProperty()

titleText

public final javafx.beans.property.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 the titleProperty() being a Label with this property value as the text. This property might not reflect the actual title since this is not always synchronized with titleProperty().

See Also:

getTitleText(), setTitleText(String)

navIcon

public final javafx.beans.property.ObjectProperty<javafx.scene.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 javafx.beans.property.DoubleProperty progressProperty

The progress of the ProgressBar attached to the AppBar. The ProgressBar 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 javafx.beans.property.BooleanProperty progressBarVisibleProperty

The visible property of the ProgressBar shown on the AppBar.

Default value:

false

Since:

4.2.0

See Also:

isProgressBarVisible(), setProgressBarVisible(boolean)

autoHideProgressBar

public final javafx.beans.property.BooleanProperty autoHideProgressBarProperty

Decides if a determinate ProgressBar should hide itself when the progressProperty() reaches the threshold value i.e. 1.0. If set as true and the progressProperty() is greater than equal to 1.0, the progressBarVisibleProperty() 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 javafx.css.StyleableDoubleProperty spacingProperty

The amount of horizontal space between each child in the AppBar. This horizontal space is also applied to the children of getActionItems().

See Also:

getSpacing(), setSpacing(double)

Constructor Detail

AppBar

public AppBar()

Creates a new instance of AppBar.

Method Detail

getTitle

public final javafx.scene.Node getTitle()

Returns the title of the AppBar.

Returns:

The title Node.

See Also:

getTitleText()

titleProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.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 the navIcon in the AppBar.

Returns:

An ObjectProperty representing the AppBar title.

See Also:

titleTextProperty()

setTitle

public final void setTitle(javafx.scene.Node title)

Changes the title of the AppBar.

Parameters:

title - The new title Node.

See Also:

setTitleText(String)

getTitleText

public final java.lang.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 the AppBar since setTitle(Node) might be called and titleProperty() and titleTextProperty() are not always synchronized.

See Also:

getTitle()

titleTextProperty

public final javafx.beans.property.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 the titleProperty() being a Label with this property value as the text. This property might not reflect the actual title since this is not always synchronized with titleProperty().

See Also:

getTitleText(), setTitleText(String)

setTitleText

public final void setTitleText(java.lang.String titleText)

Sets the title of the AppBar.

Parameters:

titleText - The current title of AppBar.

See Also:

setTitle(Node)

getActionItems

public final javafx.collections.ObservableList<javafx.scene.Node> getActionItems()

Gets the action items. Typical use case for an AppBar suggest that the most common actionItems to place within it are Buttons with just a graphic, but you are not restricted to just these, and can insert any Node. The actionItems are placed between the title and the overflow menu, aligned right to left. The actionItems added must not be null.

Returns:

ObservableList of Node containing the action items.

getMenuItems

public final javafx.collections.ObservableList<javafx.scene.control.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 a MenuItem to the ObservableList returned by this method.

Returns:

ObservableList of MenuItem which is shown when an ActionEvent is triggered on the menu icon of the AppBar.

getNavIcon

public final javafx.scene.Node getNavIcon()

Returns a node which is used as the nav icon.

Returns:

A Node containing the nav icon instance.

navIconProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.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(javafx.scene.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. A Button will receive the appropriate styling automatically. Nevertheless, a user is not restricted to a Button and may add any node with custom style.

Parameters:

navIcon - The nav icon of the AppBar

progressProperty

public final javafx.beans.property.DoubleProperty progressProperty()

The progress of the ProgressBar attached to the AppBar. The ProgressBar 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 the AppBar. The ProgressBar 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 the AppBar. The ProgressBar 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 javafx.beans.property.BooleanProperty progressBarVisibleProperty()

The visible property of the ProgressBar 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 javafx.beans.property.BooleanProperty autoHideProgressBarProperty()

Decides if a determinate ProgressBar should hide itself when the progressProperty() reaches the threshold value i.e. 1.0. If set as true and the progressProperty() is greater than equal to 1.0, the progressBarVisibleProperty() 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 the progressProperty() reaches the threshold value i.e. 1.0. If set as true and the progressProperty() is greater than equal to 1.0, the progressBarVisibleProperty() 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 the progressProperty() reaches the threshold value i.e. 1.0. If set as true and the progressProperty() is greater than equal to 1.0, the progressBarVisibleProperty() will be set to false.

This property has no effect on an indeterminate ProgressBar.

Default value:

false

Since:

4.2.0

spacingProperty

public final javafx.css.StyleableDoubleProperty spacingProperty()

The amount of horizontal space between each child in the AppBar. This horizontal space is also applied to the children of getActionItems().

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 the AppBar leaving it with no nav icon, title, action icons or menu items. The visibility of AppBar is also reset to true.

createDefaultSkin

protected javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

getClassCssMetaData

public static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Since:

JavaFX 8.0

getControlCssMetaData

public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class javafx.scene.control.Control

Since:

JavaFX 8.0