Module com.gluonhq.charm.glisten

Package com.gluonhq.charm.glisten.control

Class NavigationDrawer.Item

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.gluonhq.charm.glisten.control.NavigationDrawer.Item

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Direct Known Subclasses:

NavigationDrawer.ViewItem

Enclosing class:

NavigationDrawer

public static class NavigationDrawer.Item
extends Control

A convenience class for creating a default items for NavigationDrawer with styled implementations according to Material Design Guidelines. Whenever an item is clicked, the selected property of the item is automatically set to true. If the autoClose is set to true, clicking on the item will close the NavigationDrawer.

Since:

2.0.0

Property Summary

Properties

Type	Property	Description
BooleanProperty	autoClose	When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.
ObjectProperty<Node>	graphic	The graphic reflects the icon of the Item.
BooleanProperty	selected	Indicates whether an item is selected.
StringProperty	title	The title reflects the title of the Item.

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
Item(String title)	Allocates a new item object with title assigned from the specified String.
Item(String title, Node graphic)	Allocates a new item object with title and graphic.

Method Summary

Modifier and Type	Method	Description
BooleanProperty	autoCloseProperty()	When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.
protected Skin<?>	createDefaultSkin()
Node	getGraphic()	Returns a node which is used as the icon of the Item.
String	getTitle()	Returns a String with the title of the Item.
ObjectProperty<Node>	graphicProperty()	The graphic reflects the icon of the Item.
boolean	isAutoClose()	Gets the value of the property autoClose.
boolean	isSelected()	Gets the value of the property selected.
BooleanProperty	selectedProperty()	Indicates whether an item is selected.
void	setAutoClose(boolean value)	Sets the value of the property autoClose.
void	setGraphic(Node graphic)	Sets a node as an icon of the Item.
void	setSelected(boolean value)	Sets the value of the property selected.
void	setTitle(String title)	Sets the current title of the Item.
StringProperty	titleProperty()	The title reflects the title of the Item.

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 Detail

title

public final StringProperty titleProperty

The title reflects the title of the Item.

See Also:

getTitle(), setTitle(String)

graphic

public final ObjectProperty<Node> graphicProperty

The graphic reflects the icon of the Item.

See Also:

getGraphic(), setGraphic(Node)

selected

public final BooleanProperty selectedProperty

Indicates whether an item is selected. This can be manipulated programmatically.

See Also:

isSelected(), setSelected(boolean)

autoClose

public final BooleanProperty autoCloseProperty

When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.

Default value:

true

Since:

5.0.0

See Also:

isAutoClose(), setAutoClose(boolean)

Constructor Detail

Item

public Item(String title)

Allocates a new item object with title assigned from the specified String.

Parameters:

title - A String representing the title.

Item

public Item(String title,
            Node graphic)

Allocates a new item object with title and graphic.

Parameters:

title - A String representing the title.

graphic - A graphic node representing icon.

Method Detail

getTitle

public final String getTitle()

Returns a String with the title of the Item.

Returns:

A String representing the title of the Item.

titleProperty

public final StringProperty titleProperty()

The title reflects the title of the Item.

See Also:

getTitle(), setTitle(String)

setTitle

public final void setTitle(String title)

Sets the current title of the Item.

Parameters:

title - The current title to be set.

getGraphic

public final Node getGraphic()

Returns a node which is used as the icon of the Item.

Returns:

A Node containing the icon of the Item.

graphicProperty

public final ObjectProperty<Node> graphicProperty()

The graphic reflects the icon of the Item.

See Also:

getGraphic(), setGraphic(Node)

setGraphic

public final void setGraphic(Node graphic)

Sets a node as an icon of the Item.

Parameters:

graphic - A Node to set as the icon of the Item.

setSelected

public final void setSelected(boolean value)

Sets the value of the property selected.

Property description:

Indicates whether an item is selected. This can be manipulated programmatically.

isSelected

public final boolean isSelected()

Gets the value of the property selected.

Property description:

Indicates whether an item is selected. This can be manipulated programmatically.

selectedProperty

public final BooleanProperty selectedProperty()

Indicates whether an item is selected. This can be manipulated programmatically.

See Also:

isSelected(), setSelected(boolean)

autoCloseProperty

public final BooleanProperty autoCloseProperty()

When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.

Default value:

true

Since:

5.0.0

See Also:

isAutoClose(), setAutoClose(boolean)

isAutoClose

public final boolean isAutoClose()

Gets the value of the property autoClose.

Property description:

When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.

Default value:

true

Since:

5.0.0

setAutoClose

public final void setAutoClose(boolean value)

Sets the value of the property autoClose.

Property description:

When set to false, prevents the NavigationDrawer from auto-closing when an item is pressed.

Default value:

true

Since:

5.0.0

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control