Module com.gluonhq.charm.glisten

Package com.gluonhq.charm.glisten.control

Class NavigationDrawer.Header

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.gluonhq.charm.glisten.control.NavigationDrawer.Header

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

Enclosing class:

NavigationDrawer

public static final class NavigationDrawer.Header
extends Control

A convenience class for creating a default header for NavigationDrawer with styled implementations according to Material Design Guidelines. It consists of an image, title and subtitle.

Since:

2.0.0

Property Summary

Properties

Type	Property	Description
ObjectProperty<Node>	graphic	The Node adds extra information to the Header.
ObjectProperty<EventHandler<ActionEvent>>	onAction	An EventHandler which is invoked whenever the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed.
StringProperty	subtitle	The title in header generally reflects the current user email.
StringProperty	title	The title in Header generally reflects the current user.

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
Header(String title)	Allocates a new header object with title assigned from the specified String.
Header(String title, String subtitle)	Allocates a new header object with title and sub-title assigned from the specified Strings.
Header(String title, String subtitle, Node graphic)	Allocates a new header object with title, sub-title and primary image assigned.

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
Node	getGraphic()	Returns an node which is used as the graphic of the Header.
EventHandler<ActionEvent>	getOnAction()	Returns the EventHandler which was set for the header.
String	getSubtitle()	Returns a String with the subtitle of the Header.
String	getTitle()	Returns a String with the title of the Header.
ObjectProperty<Node>	graphicProperty()	The Node adds extra information to the Header.
ObjectProperty<EventHandler<ActionEvent>>	onActionProperty()	An EventHandler which is invoked whenever the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed.
void	setGraphic(Node graphic)	Sets a node as the graphic in the Header.
void	setOnAction(EventHandler<ActionEvent> value)	Accepts an EventHandler which will be fired when the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed.
void	setSubtitle(String subtitle)	Sets the current subtitle of the Header.
void	setTitle(String title)	Sets current title of the Header.
StringProperty	subtitleProperty()	The title in header generally reflects the current user email.
StringProperty	titleProperty()	The title in Header generally reflects the current user.

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 in Header generally reflects the current user. Nevertheless, it can be used to show any other information as seem appropriate to the user.

Returns:

An ObjectProperty representing the Header title.

subtitle

public final StringProperty subtitleProperty

The title in header generally reflects the current user email. Nevertheless, it can be used to show any other information as seem appropriate to the user.

Returns:

An ObjectProperty representing the subtitle of the Header.

graphic

public final ObjectProperty<Node> graphicProperty

The Node adds extra information to the Header. For Example - A profile picture. It is highly recommended to either pass an ImageView or an Avatar.

See Also:

getGraphic(), setGraphic(Node)

onAction

public final ObjectProperty<EventHandler<ActionEvent>> onActionProperty

An EventHandler which is invoked whenever the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed. If this property is not set the arrow will not be visible.

See Also:

getOnAction(), setOnAction(EventHandler)

Constructor Detail

Header

public Header(String title)

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

Parameters:

title - The string representing the Title.

Header

public Header(String title,
              String subtitle)

Allocates a new header object with title and sub-title assigned from the specified Strings.

Parameters:

title - The string representing the title.

subtitle - The string representing the subtitle.

Header

public Header(String title,
              String subtitle,
              Node graphic)

Allocates a new header object with title, sub-title and primary image assigned.

Parameters:

title - A String representing the title of the Header.

subtitle - A String representing the subtitle of the Header.

graphic - A Node representing the graphic of the Header.

Method Detail

getTitle

public final String getTitle()

Returns a String with the title of the Header.

Returns:

A String representing the title of the Header.

titleProperty

public final StringProperty titleProperty()

The title in Header generally reflects the current user. Nevertheless, it can be used to show any other information as seem appropriate to the user.

Returns:

An ObjectProperty representing the Header title.

setTitle

public final void setTitle(String title)

Sets current title of the Header.

Parameters:

title - The current title to be set.

getSubtitle

public final String getSubtitle()

Returns a String with the subtitle of the Header.

Returns:

A String representing the subtitle of the Header.

subtitleProperty

public final StringProperty subtitleProperty()

The title in header generally reflects the current user email. Nevertheless, it can be used to show any other information as seem appropriate to the user.

Returns:

An ObjectProperty representing the subtitle of the Header.

setSubtitle

public final void setSubtitle(String subtitle)

Sets the current subtitle of the Header.

Parameters:

subtitle - The current subtitle to be set.

getGraphic

public final Node getGraphic()

Returns an node which is used as the graphic of the Header.

Returns:

A Node representing the graphic of the Header.

graphicProperty

public final ObjectProperty<Node> graphicProperty()

The Node adds extra information to the Header. For Example - A profile picture. It is highly recommended to either pass an ImageView or an Avatar.

See Also:

getGraphic(), setGraphic(Node)

setGraphic

public final void setGraphic(Node graphic)

Sets a node as the graphic in the Header.

Parameters:

graphic - A Node to set as the graphic.

onActionProperty

public final ObjectProperty<EventHandler<ActionEvent>> onActionProperty()

An EventHandler which is invoked whenever the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed. If this property is not set the arrow will not be visible.

See Also:

getOnAction(), setOnAction(EventHandler)

setOnAction

public final void setOnAction(EventHandler<ActionEvent> value)

Accepts an EventHandler which will be fired when the arrow, placed on the right bottom corner of the header, is touched, clicked or pressed. If this property is not set or set as null, then the arrow will not be visible.

Parameters:

value - The EventHandler for the header.

getOnAction

public final EventHandler<ActionEvent> getOnAction()

Returns the EventHandler which was set for the header. This can be null.

Returns:

An EventHandler.

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control