Module atlantafx.base

Package atlantafx.base.controls

Class Breadcrumbs<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

atlantafx.base.controls.Breadcrumbs<T>

All Implemented Interfaces:

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

public class Breadcrumbs<T>
extends javafx.scene.control.Control

A bread crumb bar. This control is useful to visualize and navigate a hierarchical path structure, such as file systems.

 String[] list = {"Root", "Folder", "file.txt"};
 BreadCrumbItem<String> selectedCrumb = Breadcrumbs.buildTreeModel(list);
 Breadcrumbs<String> breadcrumbs = new Breadcrumbs<>(selectedCrumb);
 

A breadcrumbs consist of two types of elements: a button (default is Hyperlink) and a divider (default is for Label). You can customize both by providing the corresponding factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Breadcrumbs.BreadCrumbActionEvent<T>	An Event which is fired when a bread crumb was activated.
static class	Breadcrumbs.BreadCrumbItem<T>	BreadCrumbItem extends TreeItem, providing support for navigating hierarchical structures.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.BooleanProperty	autoNavigationEnabled	Enables or disables auto navigation (default is enabled).
final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>>	crumbFactory	The crumb factory is used to create custom bread crumb instances.
final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>>	dividerFactory	The divider factory is used to create custom instances of dividers.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>>	onCrumbAction	Represents the EventHandler that is called when a user selects a bread crumb.
final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>>	selectedCrumb	Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar).

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

Modifier and Type	Field	Description
protected final javafx.beans.property.BooleanProperty	autoNavigation
protected final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>>	crumbFactory
protected static final String	DEFAULT_STYLE_CLASS
protected final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>	defaultCrumbNodeFactory
protected final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>	defaultDividerFactory
protected final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>>	dividerFactory
protected final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>>	onCrumbAction
protected final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>>	selectedCrumb

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
Breadcrumbs()	Creates an empty bread crumb bar.
Breadcrumbs(@Nullable Breadcrumbs.BreadCrumbItem<T> selectedCrumb)	Creates a bread crumb bar with the given BreadCrumbItem as the currently selectedCrumbProperty().

Method Summary

Modifier and Type	Method	Description
final javafx.beans.property.BooleanProperty	autoNavigationEnabledProperty()	Enables or disables auto navigation (default is enabled).
static <T> Breadcrumbs.BreadCrumbItem<T>	buildTreeModel(T... crumbs)	Constructs a tree model from the flat list which then can be set as the selectedCrumb node to be shown.
protected javafx.scene.control.Skin<?>	createDefaultSkin()
final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>>	crumbFactoryProperty()	The crumb factory is used to create custom bread crumb instances.
final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>>	dividerFactoryProperty()	The divider factory is used to create custom instances of dividers.
final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>	getCrumbFactory()	Gets the value of the crumbFactory property.
final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>	getDividerFactory()	Gets the value of the dividerFactory property.
final javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>	getOnCrumbAction()	Gets the value of the onCrumbAction property.
final Breadcrumbs.BreadCrumbItem<T>	getSelectedCrumb()	Gets the value of the selectedCrumb property.
final boolean	isAutoNavigationEnabled()	Gets the value of the autoNavigationEnabled property.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>>	onCrumbActionProperty()	Represents the EventHandler that is called when a user selects a bread crumb.
final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>>	selectedCrumbProperty()	Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar).
final void	setAutoNavigationEnabled(boolean enabled)	Sets the value of the autoNavigationEnabled property.
final void	setCrumbFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase> value)	Sets the value of the crumbFactory property.
final void	setDividerFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node> value)	Sets the value of the dividerFactory property.
final void	setOnCrumbAction(javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>> value)	Sets the value of the onCrumbAction property.
final void	setSelectedCrumb(Breadcrumbs.BreadCrumbItem<T> selectedCrumb)	Sets the value of the selectedCrumb property.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, 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 Details

selectedCrumb

public final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>> selectedCrumbProperty

Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar). The full path is then being constructed using getParent() of the tree-items.

Consider the following hierarchy: [Root] > [Folder] > [SubFolder] > [file.txt]

To show the above bread crumb bar, you have to set the [file.txt] tree-node as selected crumb.

See Also:

• getSelectedCrumb()
• setSelectedCrumb(Breadcrumbs.BreadCrumbItem)
• selectedCrumbProperty()

autoNavigationEnabled

public final javafx.beans.property.BooleanProperty autoNavigationEnabledProperty

Enables or disables auto navigation (default is enabled). If auto navigation is enabled, it will automatically navigate to the crumb which was clicked by the user, meaning it will set the selectedCrumbProperty() upon click.

See Also:

• isAutoNavigationEnabled()
• setAutoNavigationEnabled(boolean)
• autoNavigationEnabledProperty()

crumbFactory

public final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>> crumbFactoryProperty

The crumb factory is used to create custom bread crumb instances. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the tree item for creating bread crumb.
• ButtonBase stands for resulting bread crumb node.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

See Also:

• getCrumbFactory()
• setCrumbFactory(Callback)
• crumbFactoryProperty()

dividerFactory

public final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>> dividerFactoryProperty

The divider factory is used to create custom instances of dividers. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the preceding tree item. It can be null, which allows for inserting a divider before the first bread crumb, such as when creating a Unix path.
• ? extends Node stands for resulting divider node. It can also be null, indicating that there will be no divider inserted after the specified bread crumb.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

See Also:

• getDividerFactory()
• setDividerFactory(Callback)
• dividerFactoryProperty()

onCrumbAction

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>> onCrumbActionProperty

Represents the EventHandler that is called when a user selects a bread crumb.

See Also:

• getOnCrumbAction()
• setOnCrumbAction(EventHandler)
• onCrumbActionProperty()

Field Details

DEFAULT_STYLE_CLASS

protected static final String DEFAULT_STYLE_CLASS

See Also:

• Constant Field Values

defaultCrumbNodeFactory

protected final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase> defaultCrumbNodeFactory

defaultDividerFactory

protected final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node> defaultDividerFactory

selectedCrumb

protected final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>> selectedCrumb

autoNavigation

protected final javafx.beans.property.BooleanProperty autoNavigation

crumbFactory

protected final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>> crumbFactory

dividerFactory

protected final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>> dividerFactory

onCrumbAction

protected final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>> onCrumbAction

Constructor Details

Breadcrumbs

public Breadcrumbs()

Creates an empty bread crumb bar.

Breadcrumbs

public Breadcrumbs(@Nullable
 @Nullable Breadcrumbs.BreadCrumbItem<T> selectedCrumb)

Creates a bread crumb bar with the given BreadCrumbItem as the currently selectedCrumbProperty().

Parameters:

selectedCrumb - The currently selected crumb.

Method Details

createDefaultSkin

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

Overrides:

createDefaultSkin in class javafx.scene.control.Control

buildTreeModel

@SafeVarargs
public static <T> Breadcrumbs.BreadCrumbItem<T> buildTreeModel(T... crumbs)

Constructs a tree model from the flat list which then can be set as the selectedCrumb node to be shown.

Parameters:

crumbs - The flat list of values used to build the tree model

selectedCrumbProperty

public final javafx.beans.property.ObjectProperty<Breadcrumbs.BreadCrumbItem<T>> selectedCrumbProperty()

Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar). The full path is then being constructed using getParent() of the tree-items.

Consider the following hierarchy: [Root] > [Folder] > [SubFolder] > [file.txt]

To show the above bread crumb bar, you have to set the [file.txt] tree-node as selected crumb.

Returns:

the selectedCrumb property

See Also:

• getSelectedCrumb()
• setSelectedCrumb(Breadcrumbs.BreadCrumbItem)

getSelectedCrumb

public final Breadcrumbs.BreadCrumbItem<T> getSelectedCrumb()

Gets the value of the selectedCrumb property.

Property description:

Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar). The full path is then being constructed using getParent() of the tree-items.

Consider the following hierarchy: [Root] > [Folder] > [SubFolder] > [file.txt]

To show the above bread crumb bar, you have to set the [file.txt] tree-node as selected crumb.

Returns:

the value of the selectedCrumb property

See Also:

• setSelectedCrumb(Breadcrumbs.BreadCrumbItem)
• selectedCrumbProperty()

setSelectedCrumb

public final void setSelectedCrumb(Breadcrumbs.BreadCrumbItem<T> selectedCrumb)

Sets the value of the selectedCrumb property.

Property description:

Represents the bottom-most path node (the node on the most-right side in terms of the bread crumb bar). The full path is then being constructed using getParent() of the tree-items.

Consider the following hierarchy: [Root] > [Folder] > [SubFolder] > [file.txt]

To show the above bread crumb bar, you have to set the [file.txt] tree-node as selected crumb.

Parameters:

selectedCrumb - the value for the selectedCrumb property

See Also:

• getSelectedCrumb()
• selectedCrumbProperty()

autoNavigationEnabledProperty

public final javafx.beans.property.BooleanProperty autoNavigationEnabledProperty()

Enables or disables auto navigation (default is enabled). If auto navigation is enabled, it will automatically navigate to the crumb which was clicked by the user, meaning it will set the selectedCrumbProperty() upon click.

Returns:

the autoNavigationEnabled property

See Also:

• isAutoNavigationEnabled()
• setAutoNavigationEnabled(boolean)

isAutoNavigationEnabled

public final boolean isAutoNavigationEnabled()

Gets the value of the autoNavigationEnabled property.

Property description:

Enables or disables auto navigation (default is enabled). If auto navigation is enabled, it will automatically navigate to the crumb which was clicked by the user, meaning it will set the selectedCrumbProperty() upon click.

Returns:

the value of the autoNavigationEnabled property

See Also:

• setAutoNavigationEnabled(boolean)
• autoNavigationEnabledProperty()

setAutoNavigationEnabled

public final void setAutoNavigationEnabled(boolean enabled)

Sets the value of the autoNavigationEnabled property.

Property description:

Enables or disables auto navigation (default is enabled). If auto navigation is enabled, it will automatically navigate to the crumb which was clicked by the user, meaning it will set the selectedCrumbProperty() upon click.

Parameters:

enabled - the value for the autoNavigationEnabled property

See Also:

• isAutoNavigationEnabled()
• autoNavigationEnabledProperty()

crumbFactoryProperty

public final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>> crumbFactoryProperty()

The crumb factory is used to create custom bread crumb instances. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the tree item for creating bread crumb.
• ButtonBase stands for resulting bread crumb node.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Returns:

the crumbFactory property

See Also:

• getCrumbFactory()
• setCrumbFactory(Callback)

setCrumbFactory

public final void setCrumbFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase> value)

Sets the value of the crumbFactory property.

Property description:

The crumb factory is used to create custom bread crumb instances. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the tree item for creating bread crumb.
• ButtonBase stands for resulting bread crumb node.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Parameters:

value - the value for the crumbFactory property

See Also:

• getCrumbFactory()
• crumbFactoryProperty()

getCrumbFactory

public final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase> getCrumbFactory()

Gets the value of the crumbFactory property.

Property description:

The crumb factory is used to create custom bread crumb instances. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the tree item for creating bread crumb.
• ButtonBase stands for resulting bread crumb node.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Returns:

the value of the crumbFactory property

See Also:

• setCrumbFactory(Callback)
• crumbFactoryProperty()

dividerFactoryProperty

public final javafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>> dividerFactoryProperty()

The divider factory is used to create custom instances of dividers. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the preceding tree item. It can be null, which allows for inserting a divider before the first bread crumb, such as when creating a Unix path.
• ? extends Node stands for resulting divider node. It can also be null, indicating that there will be no divider inserted after the specified bread crumb.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Returns:

the dividerFactory property

See Also:

• getDividerFactory()
• setDividerFactory(Callback)

setDividerFactory

public final void setDividerFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node> value)

Sets the value of the dividerFactory property.

Property description:

The divider factory is used to create custom instances of dividers. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the preceding tree item. It can be null, which allows for inserting a divider before the first bread crumb, such as when creating a Unix path.
• ? extends Node stands for resulting divider node. It can also be null, indicating that there will be no divider inserted after the specified bread crumb.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Parameters:

value - the value for the dividerFactory property

See Also:

• getDividerFactory()
• dividerFactoryProperty()

getDividerFactory

public final javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node> getDividerFactory()

Gets the value of the dividerFactory property.

Property description:

The divider factory is used to create custom instances of dividers. A null value is not allowed and will result in a fallback to the default factory.

• BreadCrumbItem<T> specifies the preceding tree item. It can be null, which allows for inserting a divider before the first bread crumb, such as when creating a Unix path.
• ? extends Node stands for resulting divider node. It can also be null, indicating that there will be no divider inserted after the specified bread crumb.

Use Breadcrumbs.BreadCrumbItem.isFirst() and Breadcrumbs.BreadCrumbItem.isLast() to create bread crumb depending on item position.

Returns:

the value of the dividerFactory property

See Also:

• setDividerFactory(Callback)
• dividerFactoryProperty()

onCrumbActionProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>>> onCrumbActionProperty()

Represents the EventHandler that is called when a user selects a bread crumb.

Returns:

the onCrumbAction property

See Also:

• getOnCrumbAction()
• setOnCrumbAction(EventHandler)

setOnCrumbAction

public final void setOnCrumbAction(javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>> value)

Sets the value of the onCrumbAction property.

Property description:

Represents the EventHandler that is called when a user selects a bread crumb.

Parameters:

value - the value for the onCrumbAction property

See Also:

• getOnCrumbAction()
• onCrumbActionProperty()

getOnCrumbAction

public final javafx.event.EventHandler<Breadcrumbs.BreadCrumbActionEvent<T>> getOnCrumbAction()

Gets the value of the onCrumbAction property.

Property description:

Represents the EventHandler that is called when a user selects a bread crumb.

Returns:

the value of the onCrumbAction property

See Also:

• setOnCrumbAction(EventHandler)
• onCrumbActionProperty()