Class Menu

java.lang.Object

javafx.scene.control.MenuItem

javafx.scene.control.Menu

All Implemented Interfaces:

Styleable, EventTarget

@DefaultProperty("items")
public class Menu
extends MenuItem

A popup menu of actionable items which is displayed to the user only upon request. When a menu is visible, in most use cases, the user can select one menu item before the menu goes back to its hidden state. This means the menu is a good place to put important functionality that does not necessarily need to be visible at all times to the user.

Menus are typically placed in a MenuBar, or as a submenu of another Menu. If the intention is to offer a context menu when the user right-clicks in a certain area of their user interface, then this is the wrong control to use. This is because when Menu is added to the scenegraph, it has a visual representation that will result in it appearing on screen. Instead, ContextMenu should be used in this circumstance.

Creating a Menu and inserting it into a MenuBar is easy, as shown below:

 Menu menu1 = new Menu("File");
MenuBar menuBar = new MenuBar(menu1);

A Menu is a subclass of MenuItem which means that it can be inserted into a Menu's items ObservableList, resulting in a submenu being created:

 MenuItem menu12 = new MenuItem("Open");
menu1.getItems().add(menu12);

The items ObservableList allows for any MenuItem type to be inserted, including its subclasses Menu, MenuItem, RadioMenuItem, CheckMenuItem, CustomMenuItem and SeparatorMenuItem. In order to insert an arbitrary Node to a Menu, a CustomMenuItem can be used. One exception to this general rule is that SeparatorMenuItem could be used for inserting a separator.

Since:

JavaFX 2.0

See Also:

• MenuBar
• MenuItem

Property Summary

Properties

Type	Property	Description
final ObjectProperty<EventHandler<Event>>	onHidden	Called just after the ContextMenu has been hidden.
final ObjectProperty<EventHandler<Event>>	onHiding	Called just prior to the ContextMenu being hidden.
final ObjectProperty<EventHandler<Event>>	onShowing	Called just prior to the ContextMenu being shown, even if the menu has no items to show.
final ObjectProperty<EventHandler<Event>>	onShown	Called just after the ContextMenu is shown.
final ReadOnlyBooleanProperty	showing	Indicates whether the ContextMenu is currently visible.

Properties declared in class MenuItem

accelerator, disable, graphic, id, mnemonicParsing, onAction, onMenuValidation, parentMenu, parentPopup, style, text, visible

Type	Property	Description
final ObjectProperty<KeyCombination>	accelerator	The accelerator property enables accessing the associated action in one keystroke.
final BooleanProperty	disable	Sets the individual disabled state of this MenuItem.
final ObjectProperty<Node>	graphic	An optional graphic for the MenuItem.
final StringProperty	id	The id of this MenuItem.
final BooleanProperty	mnemonicParsing	Determines whether the mnemonic character in the menu item text will be parsed.
final ObjectProperty<EventHandler<ActionEvent>>	onAction	The action, which is invoked whenever the MenuItem is fired.
final ObjectProperty<EventHandler<Event>>	onMenuValidation	The event handler that is associated with invocation of an accelerator for a MenuItem.
final ReadOnlyObjectProperty<Menu>	parentMenu	This is the Menu in which this MenuItem exists.
final ReadOnlyObjectProperty<ContextMenu>	parentPopup	This is the ContextMenu in which this MenuItem exists.
final StringProperty	style	A string representation of the CSS style associated with this specific MenuItem.
final StringProperty	text	The text to display in the MenuItem.
final BooleanProperty	visible	Specifies whether this MenuItem should be rendered as part of the scene graph.

Field Summary

Fields

Modifier and Type	Field	Description
static final EventType<Event>	ON_HIDDEN	Called when the contextMenu for this menu is hidden.
static final EventType<Event>	ON_HIDING	Called when the contextMenu for this menu will be hidden.
static final EventType<Event>	ON_SHOWING	Called when the contextMenu for this menu will be shown.
static final EventType<Event>	ON_SHOWN	Called when the contextMenu for this menu shows.

Fields declared in class MenuItem

MENU_VALIDATION_EVENT

Modifier and Type	Field	Description
static final EventType<Event>	MENU_VALIDATION_EVENT	Called when a accelerator for the Menuitem is invoked

Constructor Summary

Constructors

Constructor	Description
Menu()	Constructs a Menu with an empty string for its display text.
Menu(String text)	Constructs a Menu and sets the display text with the specified text.
Menu(String text, Node graphic)	Constructs a Menu and sets the display text with the specified text and sets the graphic Node to the given node.
Menu(String text, Node graphic, MenuItem... items)	Constructs a Menu and sets the display text with the specified text, the graphic Node to the given node, and inserts the given items into the items list.

Method Summary

Modifier and Type	Method	Description
final ObservableList<MenuItem>	getItems()	The items to show within this menu.
final EventHandler<Event>	getOnHidden()	Gets the value of the onHidden property.
final EventHandler<Event>	getOnHiding()	Gets the value of the onHiding property.
final EventHandler<Event>	getOnShowing()	Gets the value of the onShowing property.
final EventHandler<Event>	getOnShown()	Gets the value of the onShown property.
void	hide()	Hides the ContextMenu if it was previously showing, and any showing submenus.
final boolean	isShowing()	Gets the value of the showing property.
final ObjectProperty<EventHandler<Event>>	onHiddenProperty()	Called just after the ContextMenu has been hidden.
final ObjectProperty<EventHandler<Event>>	onHidingProperty()	Called just prior to the ContextMenu being hidden.
final ObjectProperty<EventHandler<Event>>	onShowingProperty()	Called just prior to the ContextMenu being shown, even if the menu has no items to show.
final ObjectProperty<EventHandler<Event>>	onShownProperty()	Called just after the ContextMenu is shown.
final void	setOnHidden(EventHandler<Event> value)	Sets the value of the onHidden property.
final void	setOnHiding(EventHandler<Event> value)	Sets the value of the onHiding property.
final void	setOnShowing(EventHandler<Event> value)	Sets the value of the onShowing property.
final void	setOnShown(EventHandler<Event> value)	Sets the value of the onShown property.
void	show()	If the Menu is not disabled and the ContextMenu is not already showing, then this will cause the ContextMenu to be shown.
final ReadOnlyBooleanProperty	showingProperty()	Indicates whether the ContextMenu is currently visible.

Methods declared in class MenuItem

acceleratorProperty, buildEventDispatchChain, disableProperty, fire, getAccelerator, getCssMetaData, getGraphic, getId, getOnAction, getOnMenuValidation, getParentMenu, getParentPopup, getProperties, getPseudoClassStates, getStyle, getStyleableParent, getStyleClass, getText, getTypeSelector, getUserData, graphicProperty, idProperty, isDisable, isMnemonicParsing, isVisible, mnemonicParsingProperty, onActionProperty, onMenuValidationProperty, parentMenuProperty, parentPopupProperty, setAccelerator, setDisable, setGraphic, setId, setMnemonicParsing, setOnAction, setOnMenuValidation, setParentMenu, setParentPopup, setStyle, setText, setUserData, setVisible, styleProperty, textProperty, visibleProperty

Modifier and Type	Method	Description
final ObjectProperty<KeyCombination>	acceleratorProperty()	The accelerator property enables accessing the associated action in one keystroke.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
final BooleanProperty	disableProperty()	Sets the individual disabled state of this MenuItem.
void	fire()	Fires a new ActionEvent.
final KeyCombination	getAccelerator()	Gets the value of the accelerator property.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	The CssMetaData of this Styleable.
final Node	getGraphic()	Gets the value of the graphic property.
final String	getId()	Gets the value of the id property.
final EventHandler<ActionEvent>	getOnAction()	Gets the value of the onAction property.
final EventHandler<Event>	getOnMenuValidation()	Gets the value of the onMenuValidation property.
final Menu	getParentMenu()	Gets the value of the parentMenu property.
final ContextMenu	getParentPopup()	Gets the value of the parentPopup property.
ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this menu item for use primarily by application developers.
final ObservableSet<PseudoClass>	getPseudoClassStates()	Return the pseudo-class state of this Styleable.
final String	getStyle()	Gets the value of the style property.
Styleable	getStyleableParent()	Return the parent of this Styleable, or null if there is no parent.
ObservableList<String>	getStyleClass()	A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
final String	getText()	Gets the value of the text property.
String	getTypeSelector()	The type of this Styleable that is to be used in selector matching.
Object	getUserData()	Returns the Object that was set by MenuItem.setUserData(Object), or null if no object has been set.
final ObjectProperty<Node>	graphicProperty()	An optional graphic for the MenuItem.
final StringProperty	idProperty()	The id of this MenuItem.
final boolean	isDisable()	Gets the value of the disable property.
final boolean	isMnemonicParsing()	Gets the value of the mnemonicParsing property.
final boolean	isVisible()	Gets the value of the visible property.
final BooleanProperty	mnemonicParsingProperty()	Determines whether the mnemonic character in the menu item text will be parsed.
final ObjectProperty<EventHandler<ActionEvent>>	onActionProperty()	The action, which is invoked whenever the MenuItem is fired.
final ObjectProperty<EventHandler<Event>>	onMenuValidationProperty()	The event handler that is associated with invocation of an accelerator for a MenuItem.
final ReadOnlyObjectProperty<Menu>	parentMenuProperty()	This is the Menu in which this MenuItem exists.
final ReadOnlyObjectProperty<ContextMenu>	parentPopupProperty()	This is the ContextMenu in which this MenuItem exists.
final void	setAccelerator(KeyCombination value)	Sets the value of the accelerator property.
final void	setDisable(boolean value)	Sets the value of the disable property.
final void	setGraphic(Node value)	Sets the value of the graphic property.
final void	setId(String value)	Sets the value of the id property.
final void	setMnemonicParsing(boolean value)	Sets the value of the mnemonicParsing property.
final void	setOnAction(EventHandler<ActionEvent> value)	Sets the value of the onAction property.
final void	setOnMenuValidation(EventHandler<Event> value)	Sets the value of the onMenuValidation property.
protected final void	setParentMenu(Menu value)	Sets the value of the parentMenu property.
protected final void	setParentPopup(ContextMenu value)	Sets the value of the parentPopup property.
final void	setStyle(String value)	Sets the value of the style property.
final void	setText(String value)	Sets the value of the text property.
void	setUserData(Object value)	Stores a user object that contains data at their discretion.
final void	setVisible(boolean value)	Sets the value of the visible property.
final StringProperty	styleProperty()	A string representation of the CSS style associated with this specific MenuItem.
final StringProperty	textProperty()	The text to display in the MenuItem.
final BooleanProperty	visibleProperty()	Specifies whether this MenuItem should be rendered as part of the scene graph.

Methods declared in class Object

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

Methods declared in interface EventTarget

addEventFilter, addEventHandler, removeEventFilter, removeEventHandler

Modifier and Type	Method	Description
default <E extends Event> void	addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)	Registers an event filter for this target.
default <E extends Event> void	addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)	Registers an event handler for this target.
default <E extends Event> void	removeEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)	Unregisters a previously registered event filter from this target.
default <E extends Event> void	removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)	Unregisters a previously registered event handler from this target.

Methods declared in interface Styleable

getStyleableNode

Modifier and Type	Method	Description
default Node	getStyleableNode()	Returns the Node that represents this Styleable object.

Property Details

showing

public final ReadOnlyBooleanProperty showingProperty

Indicates whether the ContextMenu is currently visible.

Default value:

false

See Also:

• isShowing()
• showingProperty()

onShowing

public final ObjectProperty<EventHandler<Event>> onShowingProperty

Called just prior to the ContextMenu being shown, even if the menu has no items to show. Note however that this won't be called if the menu does not have a valid anchor node.

See Also:

• getOnShowing()
• setOnShowing(EventHandler)
• onShowingProperty()

onShown

public final ObjectProperty<EventHandler<Event>> onShownProperty

Called just after the ContextMenu is shown.

See Also:

• getOnShown()
• setOnShown(EventHandler)
• onShownProperty()

onHiding

public final ObjectProperty<EventHandler<Event>> onHidingProperty

Called just prior to the ContextMenu being hidden.

See Also:

• getOnHiding()
• setOnHiding(EventHandler)
• onHidingProperty()

onHidden

public final ObjectProperty<EventHandler<Event>> onHiddenProperty

Called just after the ContextMenu has been hidden.

See Also:

• getOnHidden()
• setOnHidden(EventHandler)
• onHiddenProperty()

Field Details

ON_SHOWING

public static final EventType<Event> ON_SHOWING

Called when the contextMenu for this menu will be shown. However if the contextMenu is empty then this will not be called.

ON_SHOWN

public static final EventType<Event> ON_SHOWN

Called when the contextMenu for this menu shows. However if the contextMenu is empty then this will not be called.

ON_HIDING

public static final EventType<Event> ON_HIDING

Called when the contextMenu for this menu will be hidden. However if the contextMenu is empty then this will not be called.

ON_HIDDEN

public static final EventType<Event> ON_HIDDEN

Called when the contextMenu for this menu is hidden. However if the contextMenu is empty then this will not be called.

Constructor Details

Menu

public Menu()

Constructs a Menu with an empty string for its display text.

Since:

JavaFX 2.2

Menu

public Menu(String text)

Constructs a Menu and sets the display text with the specified text.

Parameters:

text - the text to display on the menu button

Menu

public Menu(String text,
 Node graphic)

Constructs a Menu and sets the display text with the specified text and sets the graphic Node to the given node.

Parameters:

text - the text to display on the menu button

graphic - the graphic to display on the menu button

Menu

public Menu(String text,
 Node graphic,
 MenuItem... items)

Constructs a Menu and sets the display text with the specified text, the graphic Node to the given node, and inserts the given items into the items list.

Parameters:

text - the text to display on the menu button

graphic - the graphic to display on the menu button

items - The items to display in the popup menu.

Since:

JavaFX 8u40

Method Details

isShowing

public final boolean isShowing()

Gets the value of the showing property.

Property description:

Indicates whether the ContextMenu is currently visible.

Default value:

false

Returns:

the value of the showing property

See Also:

• showingProperty()

showingProperty

public final ReadOnlyBooleanProperty showingProperty()

Indicates whether the ContextMenu is currently visible.

Default value:

false

Returns:

the showing property

See Also:

• isShowing()

onShowingProperty

public final ObjectProperty<EventHandler<Event>> onShowingProperty()

Called just prior to the ContextMenu being shown, even if the menu has no items to show. Note however that this won't be called if the menu does not have a valid anchor node.

Returns:

the on showing property

See Also:

• getOnShowing()
• setOnShowing(EventHandler)

setOnShowing

public final void setOnShowing(EventHandler<Event> value)

Sets the value of the onShowing property.

Property description:

Called just prior to the ContextMenu being shown, even if the menu has no items to show. Note however that this won't be called if the menu does not have a valid anchor node.

Parameters:

value - the value for the onShowing property

See Also:

• getOnShowing()
• onShowingProperty()

getOnShowing

public final EventHandler<Event> getOnShowing()

Gets the value of the onShowing property.

Property description:

Called just prior to the ContextMenu being shown, even if the menu has no items to show. Note however that this won't be called if the menu does not have a valid anchor node.

Returns:

the value of the onShowing property

See Also:

• setOnShowing(EventHandler)
• onShowingProperty()

onShownProperty

public final ObjectProperty<EventHandler<Event>> onShownProperty()

Called just after the ContextMenu is shown.

Returns:

the on shown property

See Also:

• getOnShown()
• setOnShown(EventHandler)

setOnShown

public final void setOnShown(EventHandler<Event> value)

Sets the value of the onShown property.

Property description:

Called just after the ContextMenu is shown.

Parameters:

value - the value for the onShown property

See Also:

• getOnShown()
• onShownProperty()

getOnShown

public final EventHandler<Event> getOnShown()

Gets the value of the onShown property.

Property description:

Called just after the ContextMenu is shown.

Returns:

the value of the onShown property

See Also:

• setOnShown(EventHandler)
• onShownProperty()

onHidingProperty

public final ObjectProperty<EventHandler<Event>> onHidingProperty()

Called just prior to the ContextMenu being hidden.

Returns:

the on hiding property

See Also:

• getOnHiding()
• setOnHiding(EventHandler)

setOnHiding

public final void setOnHiding(EventHandler<Event> value)

Sets the value of the onHiding property.

Property description:

Called just prior to the ContextMenu being hidden.

Parameters:

value - the value for the onHiding property

See Also:

• getOnHiding()
• onHidingProperty()

getOnHiding

public final EventHandler<Event> getOnHiding()

Gets the value of the onHiding property.

Property description:

Called just prior to the ContextMenu being hidden.

Returns:

the value of the onHiding property

See Also:

• setOnHiding(EventHandler)
• onHidingProperty()

onHiddenProperty

public final ObjectProperty<EventHandler<Event>> onHiddenProperty()

Called just after the ContextMenu has been hidden.

Returns:

the on hidden property

See Also:

• getOnHidden()
• setOnHidden(EventHandler)

setOnHidden

public final void setOnHidden(EventHandler<Event> value)

Sets the value of the onHidden property.

Property description:

Called just after the ContextMenu has been hidden.

Parameters:

value - the value for the onHidden property

See Also:

• getOnHidden()
• onHiddenProperty()

getOnHidden

public final EventHandler<Event> getOnHidden()

Gets the value of the onHidden property.

Property description:

Called just after the ContextMenu has been hidden.

Returns:

the value of the onHidden property

See Also:

• setOnHidden(EventHandler)
• onHiddenProperty()

getItems

public final ObservableList<MenuItem> getItems()

The items to show within this menu. If this ObservableList is modified at runtime, the Menu will update as expected.

Returns:

the list of items

show

public void show()

If the Menu is not disabled and the ContextMenu is not already showing, then this will cause the ContextMenu to be shown.

Throws:

IllegalStateException - if this method is called on a thread other than the JavaFX Application Thread.

hide

public void hide()

Hides the ContextMenu if it was previously showing, and any showing submenus. If this menu is not showing, then invoking this function has no effect.

Throws:

IllegalStateException - if this method is called on a thread other than the JavaFX Application Thread.