jfxtras.labs.scene.control

Class BreadcrumbBar

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

jfxtras.labs.scene.control.BreadcrumbBar

All Implemented Interfaces:

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

public class BreadcrumbBar
extends javafx.scene.control.Control

The container that will host BreadcrumbItem.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<BreadcrumbItem>	homeItem The item considered ad home for the bar.
javafx.beans.property.ReadOnlyListProperty<BreadcrumbItem>	items Contains all items added to the bar.
javafx.beans.property.ObjectProperty<BreadcrumbBarEventHandler>	onItemAction Get the event handler that is applied to each item in the bar.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

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
BreadcrumbBar() Create a new BreadcrumbBar.

Method Summary

Modifier and Type	Method and Description
BreadcrumbItem	addHome(javafx.scene.Node content) Define the home item for this bar.
BreadcrumbItem	addItem(BreadcrumbItem item) Add a new item at the end of the bar.
BreadcrumbItem	addItem(javafx.scene.image.Image icon, javafx.scene.Node content) Create a new item in the bar with no text.
BreadcrumbItem	addItem(java.lang.String text, javafx.scene.image.Image icon, javafx.scene.Node content) Create a new item in the bar.
BreadcrumbItem	addItem(java.lang.String text, javafx.scene.Node content) Create a new item in the bar without an icon.
BreadcrumbItem	addItem(java.lang.String text, javafx.scene.shape.SVGPath svgIcon, javafx.scene.Node content) Create a new item in the bar.
BreadcrumbItem	getHomeItem() Get the BreadcrumbItem considered as home for this bar.
BreadcrumbBarEventHandler	getOnItemAction() Get the event handler that is applied to each item in the bar.
java.lang.String	getUserAgentStylesheet()
javafx.beans.property.ObjectProperty<BreadcrumbItem>	homeItemProperty() The item considered ad home for the bar.
javafx.beans.property.ReadOnlyListProperty<BreadcrumbItem>	itemsProperty() Contains all items added to the bar.
javafx.beans.property.ObjectProperty<BreadcrumbBarEventHandler>	onItemActionProperty() Get the event handler that is applied to each item in the bar.
boolean	removeItem(BreadcrumbItem item) Remove an item and every following items in the bar.
boolean	removeItem(int index) Remove the item at the given index and every following item.
void	setHomeItem(BreadcrumbItem homeItem) Set the home item for the bar.
void	setOnItemAction(BreadcrumbBarEventHandler handler) Define the event handler that will be applied to each item in the bar.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, 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, 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

items

public final javafx.beans.property.ReadOnlyListProperty<BreadcrumbItem> itemsProperty

Contains all items added to the bar. The property won’t never be null.

homeItem

public final javafx.beans.property.ObjectProperty<BreadcrumbItem> homeItemProperty

The item considered ad home for the bar. The value of this property will be <b>null</b> if the item has not been initialized. The home item is not mandatory.

See Also:

getHomeItem(), setHomeItem(BreadcrumbItem)

onItemAction

public final javafx.beans.property.ObjectProperty<BreadcrumbBarEventHandler> onItemActionProperty

Get the event handler that is applied to each item in the bar.

See Also:

getOnItemAction(), setOnItemAction(BreadcrumbBarEventHandler)

Constructor Detail

BreadcrumbBar

public BreadcrumbBar()

Create a new BreadcrumbBar.

Method Detail

itemsProperty

public final javafx.beans.property.ReadOnlyListProperty<BreadcrumbItem> itemsProperty()

Contains all items added to the bar. The property won’t never be null.

homeItemProperty

public final javafx.beans.property.ObjectProperty<BreadcrumbItem> homeItemProperty()

The item considered ad home for the bar. The value of this property will be <b>null</b> if the item has not been initialized. The home item is not mandatory.

See Also:

getHomeItem(), setHomeItem(BreadcrumbItem)

getHomeItem

public final BreadcrumbItem getHomeItem()

Get the BreadcrumbItem considered as home for this bar.

Returns:

The item if any, null otherwise.

setHomeItem

public final void setHomeItem(BreadcrumbItem homeItem)

Set the home item for the bar.

Parameters:

homeItem -

onItemActionProperty

public final javafx.beans.property.ObjectProperty<BreadcrumbBarEventHandler> onItemActionProperty()

Get the event handler that is applied to each item in the bar.

See Also:

getOnItemAction(), setOnItemAction(BreadcrumbBarEventHandler)

getOnItemAction

public final BreadcrumbBarEventHandler getOnItemAction()

Get the event handler that is applied to each item in the bar.

Returns:

the event handler if any, <b>null</b> otherwise.

setOnItemAction

public final void setOnItemAction(BreadcrumbBarEventHandler handler)

Define the event handler that will be applied to each item in the bar. If a previous handler has been defined, it will be removed for every item present in the bar. If the new handler is null, only the older one is removed for every item.

Parameters:

handler - the new handler that will be executed for a click on each item in the bar.

addItem

public final BreadcrumbItem addItem(BreadcrumbItem item)

Add a new item at the end of the bar. If the item null, nothing is performed.

Parameters:

item - the item to add in the bar.

Returns:

The added item.

addHome

public final BreadcrumbItem addHome(javafx.scene.Node content)

Define the home item for this bar. The home item will always be the first item of the bar. If a previous home item has been set it will be replaced.

Parameters:

content - the content of the home item.

Returns:

The home item.

addItem

public final BreadcrumbItem addItem(java.lang.String text,
                                    javafx.scene.image.Image icon,
                                    javafx.scene.Node content)

Create a new item in the bar.

Parameters:

text - The text of the item, could be null

icon - The icon of the item, could be null

content - The content of the item, could be null

Returns:

The added item.

addItem

public final BreadcrumbItem addItem(java.lang.String text,
                                    javafx.scene.shape.SVGPath svgIcon,
                                    javafx.scene.Node content)

Create a new item in the bar.

Parameters:

text - The text of the item, could be null

svgIcon - The SVG icon of the item, could be null

content - The content of the item, could be null

Returns:

The added item.

addItem

public final BreadcrumbItem addItem(java.lang.String text,
                                    javafx.scene.Node content)

Create a new item in the bar without an icon.

Parameters:

text - The text of the item, could be null

content - The content of the item, could be null

Returns:

The added item.

addItem

public final BreadcrumbItem addItem(javafx.scene.image.Image icon,
                                    javafx.scene.Node content)

Create a new item in the bar with no text.

Parameters:

icon - The icon of the item, could be null

content - The content of the item, could be null

Returns:

The added item.

removeItem

public final boolean removeItem(BreadcrumbItem item)

Remove an item and every following items in the bar.

Parameters:

item - The item to remove.

Returns:

true if something has been deleted, false otherwise.

removeItem

public final boolean removeItem(int index)

Remove the item at the given index and every following item.

Parameters:

index - the index of the item to remove.

Returns:

true if something has been deleted, false otherwise.

getUserAgentStylesheet

public java.lang.String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class javafx.scene.layout.Region