Top Description Fields Constructors Methods
com.dlsc.workbenchfx.view.controls

public Class NavigationDrawer

extends Control
Class Inheritance
Imports
com.dlsc.workbenchfx.Workbench, javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.collections.ObservableList, javafx.scene.control.Control, .MenuItem, .Skin, javafx.scene.layout.Priority
Represents the standard control to be used for the navigation drawer in WorkbenchFX. Is shown in a modal way when the menu button has been pressed, with a GlassPane in the background.
Authors
Dirk Lemmermann, François Martin, Marco Sanfratello
See Also
Navigation Drawer

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<Workbench>
workbench

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

public final ObservableList<MenuItem>
getItems()

public final Priority
getMenuHoverBehavior()

public final Workbench
getWorkbench()

public final void
hide()

public final void
setMenuHoverBehavior(Priority menuHoverBehavior)

public final void
setWorkbench(Workbench workbench)

public final ObjectProperty<Workbench>
workbenchProperty()

Inherited from javafx.scene.control.Control:
computeMaxHeightcomputeMaxWidthcomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthcontextMenuPropertyexecuteAccessibleActiongetBaselineOffsetgetClassCssMetaDatagetContextMenugetControlCssMetaDatagetCssMetaDatagetInitialFocusTraversablegetSkingetTooltipisResizablelayoutChildrenqueryAccessibleAttributesetContextMenusetSkinsetTooltipskinPropertytooltipProperty

Field Detail

workbenchback to summary
private final ObjectProperty<Workbench> workbench

Constructor Detail

NavigationDrawerback to summary
public NavigationDrawer()

Creates a navigation drawer control.

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations
@Override
getItemsback to summary
public final ObservableList<MenuItem> getItems()
getMenuHoverBehaviorback to summary
public final Priority getMenuHoverBehavior()
getWorkbenchback to summary
public final Workbench getWorkbench()
hideback to summary
public final void hide()
menuHoverBehaviorPropertyback to summary
public final ObjectProperty<Priority> menuHoverBehaviorProperty()

Defines the showing behaviour of the MenuItems when hovering over them. The default value is set to ALWAYS. ALWAYS: Triggers whenever the mouse hovers over a MenuItem SOMETIMES: Requires one initial click on a MenuItem to open. After that, hovering over other Items shows their submenus automatically NEVER: No hover behaviour on the MenuItems

Returns:ObjectProperty<Priority>

the property of the menu hover behavior

Default Value
Priority.ALWAYS
setMenuHoverBehaviorback to summary
public final void setMenuHoverBehavior(Priority menuHoverBehavior)
setWorkbenchback to summary
public final void setWorkbench(Workbench workbench)
workbenchPropertyback to summary
public final ObjectProperty<Workbench> workbenchProperty()