javafx.scene.control

Class ToolBar

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.ToolBar

All Implemented Interfaces:

Skinnable

public class ToolBar
extends Control

A ToolBar is a control which displays items horizontally or vertically. The most common items to place within a ToolBar are Buttons, ToggleButtons and Separators, but you are not restricted to just these, and can insert any Node into them.

If there are too many items to fit in the ToolBar an overflow button will appear. The overflow button allows you to select items that are not currently visible in the toolbar.

ToolBar sets focusTraversable to false.

Example of a horizontal ToolBar with eight buttons separated with two vertical separators.

 ToolBar toolBar = new ToolBar(
     new Button("New"),
     new Button("Open"),
     new Button("Save"),
     new Separator(true),
     new Button("Clean"),
     new Button("Compile"),
     new Button("Run"),
     new Separator(true),
     new Button("Debug"),
     new Button("Profile")
 );
 

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	orientation The orientation of the ToolBar - this can either be horizontal or vertical.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ToolBar.StyleableProperties

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_STYLE_CLASS * Stylesheet Handling * *
private static PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE
private <any>	items
private <any>	orientation The orientation of the ToolBar - this can either be horizontal or vertical.
private static PseudoClass	VERTICAL_PSEUDOCLASS_STATE

Constructor Summary

Constructors

Constructor and Description
ToolBar() Creates an empty tool bar.
ToolBar(Node... items) Creates a tool bar populated with the specified nodes.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
static java.util.List<<any>>	getClassCssMetaData()
java.util.List<<any>>	getControlCssMetaData()
protected java.lang.Boolean	getInitialFocusTraversable() Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
<any>	getItems() The items contained in the ToolBar.
Orientation	getOrientation() Gets the value of the property orientation.
private void	initialize()
<any>	orientationProperty() The orientation of the ToolBar - this can either be horizontal or vertical.
void	setOrientation(Orientation value) Sets the value of the property orientation.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

orientation

public final <any> orientationProperty

The orientation of the ToolBar - this can either be horizontal or vertical.

See Also:

getOrientation(), setOrientation(Orientation)

Field Detail

items

private final <any> items

orientation

private <any> orientation

The orientation of the ToolBar - this can either be horizontal or vertical.

DEFAULT_STYLE_CLASS

private static final java.lang.String DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

See Also:

Constant Field Values

VERTICAL_PSEUDOCLASS_STATE

private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE

HORIZONTAL_PSEUDOCLASS_STATE

private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE

Constructor Detail

ToolBar

public ToolBar()

Creates an empty tool bar.

ToolBar

public ToolBar(Node... items)

Creates a tool bar populated with the specified nodes. None of the items can be null.

Parameters:

items - the items to add

Method Detail

initialize

private void initialize()

getItems

public final <any> getItems()

The items contained in the ToolBar. Typical use case for a ToolBar suggest that the most common items to place within it are Buttons, ToggleButtons, and Separators, but you are not restricted to just these, and can insert any Node. The items added must not be null.

Returns:

the list of items

setOrientation

public final void setOrientation(Orientation value)

Sets the value of the property orientation.

getOrientation

public final Orientation getOrientation()

Gets the value of the property orientation.

orientationProperty

public final <any> orientationProperty()

The orientation of the ToolBar - this can either be horizontal or vertical.

See Also:

getOrientation(), setOrientation(Orientation)

createDefaultSkin

protected Skin<?> 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(...).

Overrides:

createDefaultSkin in class Control

Returns:

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

getClassCssMetaData

public static java.util.List<<any>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Since:

JavaFX 8.0

getControlCssMetaData

public java.util.List<<any>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Control

Returns:

unmodifiable list of the controls css styleable properties

Since:

JavaFX 8.0

getInitialFocusTraversable

protected java.lang.Boolean getInitialFocusTraversable()

Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden as by default UI controls have focus traversable set to true, but that is not appropriate for this control.

Overrides:

getInitialFocusTraversable in class Control

Returns:

the initial focus traversable state of this control

Since:

9