- All Implemented Interfaces:
Styleable
,EventTarget
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);
![Image of the Menu control](doc-files/Menu.png)
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:
-
Property Summary
PropertiesTypePropertyDescriptionfinal ObjectProperty
<EventHandler<Event>> Called just after theContextMenu
has been hidden.final ObjectProperty
<EventHandler<Event>> Called just prior to theContextMenu
being hidden.final ObjectProperty
<EventHandler<Event>> Called just prior to theContextMenu
being shown, even if the menu has no items to show.final ObjectProperty
<EventHandler<Event>> Called just after theContextMenu
is shown.final ReadOnlyBooleanProperty
Indicates whether theContextMenu
is currently visible.Properties declared in class javafx.scene.control.MenuItem
accelerator, disable, graphic, id, mnemonicParsing, onAction, onMenuValidation, parentMenu, parentPopup, style, text, visible
-
Field Summary
FieldsModifier and TypeFieldDescriptionCalled when the contextMenu for this menu is hidden.Called when the contextMenu for this menu will be hidden.Called when the contextMenu for this menu will be shown.Called when the contextMenu for this menu shows.Fields declared in class javafx.scene.control.MenuItem
MENU_VALIDATION_EVENT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal ObservableList
<MenuItem> getItems()
The items to show within this menu.final EventHandler
<Event> Gets the value of theonHidden
property.final EventHandler
<Event> Gets the value of theonHiding
property.final EventHandler
<Event> Gets the value of theonShowing
property.final EventHandler
<Event> Gets the value of theonShown
property.void
hide()
Hides theContextMenu
if it was previously showing, and any showing submenus.final boolean
Gets the value of theshowing
property.final ObjectProperty
<EventHandler<Event>> Called just after theContextMenu
has been hidden.final ObjectProperty
<EventHandler<Event>> Called just prior to theContextMenu
being hidden.final ObjectProperty
<EventHandler<Event>> Called just prior to theContextMenu
being shown, even if the menu has no items to show.final ObjectProperty
<EventHandler<Event>> Called just after theContextMenu
is shown.final void
setOnHidden
(EventHandler<Event> value) Sets the value of theonHidden
property.final void
setOnHiding
(EventHandler<Event> value) Sets the value of theonHiding
property.final void
setOnShowing
(EventHandler<Event> value) Sets the value of theonShowing
property.final void
setOnShown
(EventHandler<Event> value) Sets the value of theonShown
property.void
show()
If the Menu is not disabled and theContextMenu
is not already showing, then this will cause theContextMenu
to be shown.final ReadOnlyBooleanProperty
Indicates whether theContextMenu
is currently visible.Methods declared in class javafx.scene.control.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
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface javafx.event.EventTarget
addEventFilter, addEventHandler, removeEventFilter, removeEventHandler
Methods declared in interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
showing
Indicates whether theContextMenu
is currently visible.- Default value:
- false
- See Also:
-
onShowing
Called just prior to theContextMenu
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:
-
onShown
Called just after theContextMenu
is shown.- See Also:
-
onHiding
Called just prior to theContextMenu
being hidden.- See Also:
-
onHidden
Called just after theContextMenu
has been hidden.- See Also:
-
-
Field Details
-
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
Called when the contextMenu for this menu shows. However if the contextMenu is empty then this will not be called.
-
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
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
Constructs a Menu and sets the display text with the specified text.- Parameters:
text
- the text to display on the menu button
-
Menu
Constructs a Menu and sets the display text with the specified text and sets the graphicNode
to the given node.- Parameters:
text
- the text to display on the menu buttongraphic
- the graphic to display on the menu button
-
Menu
Constructs a Menu and sets the display text with the specified text, the graphicNode
to the given node, and inserts the given items into theitems
list.- Parameters:
text
- the text to display on the menu buttongraphic
- the graphic to display on the menu buttonitems
- The items to display in the popup menu.- Since:
- JavaFX 8u40
-
-
Method Details
-
isShowing
public final boolean isShowing()Gets the value of theshowing
property.- Property description:
- Indicates whether the
ContextMenu
is currently visible. - Default value:
- false
- Returns:
- the value of the
showing
property - See Also:
-
showingProperty
Indicates whether theContextMenu
is currently visible.- Default value:
- false
- Returns:
- the
showing
property - See Also:
-
onShowingProperty
Called just prior to theContextMenu
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:
-
setOnShowing
Sets the value of theonShowing
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 theonShowing
property- See Also:
-
getOnShowing
Gets the value of theonShowing
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:
-
onShownProperty
Called just after theContextMenu
is shown.- Returns:
- the on shown property
- See Also:
-
setOnShown
Sets the value of theonShown
property.- Property description:
- Called just after the
ContextMenu
is shown. - Parameters:
value
- the value for theonShown
property- See Also:
-
getOnShown
Gets the value of theonShown
property.- Property description:
- Called just after the
ContextMenu
is shown. - Returns:
- the value of the
onShown
property - See Also:
-
onHidingProperty
Called just prior to theContextMenu
being hidden.- Returns:
- the on hiding property
- See Also:
-
setOnHiding
Sets the value of theonHiding
property.- Property description:
- Called just prior to the
ContextMenu
being hidden. - Parameters:
value
- the value for theonHiding
property- See Also:
-
getOnHiding
Gets the value of theonHiding
property.- Property description:
- Called just prior to the
ContextMenu
being hidden. - Returns:
- the value of the
onHiding
property - See Also:
-
onHiddenProperty
Called just after theContextMenu
has been hidden.- Returns:
- the on hidden property
- See Also:
-
setOnHidden
Sets the value of theonHidden
property.- Property description:
- Called just after the
ContextMenu
has been hidden. - Parameters:
value
- the value for theonHidden
property- See Also:
-
getOnHidden
Gets the value of theonHidden
property.- Property description:
- Called just after the
ContextMenu
has been hidden. - Returns:
- the value of the
onHidden
property - See Also:
-
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 theContextMenu
is not already showing, then this will cause theContextMenu
to be shown. -
hide
public void hide()Hides theContextMenu
if it was previously showing, and any showing submenus. If this menu is not showing, then invoking this function has no effect.
-