JavaFX 24 · javafx.scene.control.MenuButton · APIdia, the JavaDoc alternative

MenuButton is a button which, when clicked or pressed, will show a ContextMenu. A MenuButton shares a very similar API to the Menu control, insofar that you set the items that should be shown in the items ObservableList, and there is a text property to specify the label shown within the MenuButton.

As mentioned, like the Menu API itself, you'll find an items ObservableList within which you can provide anything that extends from MenuItem. There are several useful subclasses of MenuItem including RadioMenuItem, CheckMenuItem, Menu, SeparatorMenuItem and CustomMenuItem.

A MenuButton can be set to show its menu on any side of the button. This is specified using the popupSide property. By default the menu appears below the button. However, regardless of the popupSide specified, if there is not enough room, the ContextMenu will be smartly repositioned, most probably to be on the opposite side of the MenuButton.

Example:

 MenuButton m = new MenuButton("Eats");
m.getItems().addAll(new MenuItem("Burger"), new MenuItem("Hot Dog"));

MnemonicParsing is enabled by default for MenuButton.

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_STYLE_CLASS
private final ObservableList<MenuItem>	items
public static final EventType<Event>	ON_HIDDEN Called when the MenuButton popup has been hidden.
public static final EventType<Event>	ON_HIDING Called when the MenuButton popup will be hidden.
public static final EventType<Event>	ON_SHOWING Called prior to the MenuButton showing its popup after the user has clicked or otherwise interacted with the MenuButton.
public static final EventType<Event>	ON_SHOWN Called after the MenuButton has shown its popup.
private ObjectProperty<EventHandler<Event>>	onHidden
private ObjectProperty<EventHandler<Event>>	onHiding
private ObjectProperty<EventHandler<Event>>	onShowing
private ObjectProperty<EventHandler<Event>>	onShown
private ObjectProperty<Side>	popupSide Indicates on which side the `ContextMenu` should open in relation to the MenuButton.
private static final PseudoClass	PSEUDO_CLASS_OPENVERTICALLY
private static final PseudoClass	PSEUDO_CLASS_SHOWING
private ReadOnlyBooleanWrapper	showing Indicates whether the `ContextMenu` is currently visible.

Constructor Summary

Access	Constructor and Description
public	MenuButton() Creates a new empty menu button.
public	MenuButton(String the text to display on the menu button text) Creates a new empty menu button with the given text to display on the button.
public	MenuButton(String the text to display on the menu button text, Node the graphic to display on the menu button graphic) Creates a new empty menu button with the given text and graphic to display on the button.
public	MenuButton(String the text to display on the menu button text, Node the graphic to display on the menu button graphic, MenuItem... The items to display in the popup menu. items) Creates a new menu button with the given text and graphic to display on the button, and inserts the given items into the `items` list.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public void	executeAccessibleAction(AccessibleAction the action to execute action, Object... optional list of parameters parameters) Overrides javafx.scene.control.ButtonBase.executeAccessibleAction. This method is called by the assistive technology to request the action indicated by the argument should be executed.
public void	fire() Implements abstract javafx.scene.control.ButtonBase.fire. This has no impact.
public final ObservableList<MenuItem>	Returns: the list of menu items within this buttons menu getItems() The items to show within this buttons menu.
public final EventHandler<Event>	getOnHidden()
public final EventHandler<Event>	getOnHiding()
public final EventHandler<Event>	getOnShowing()
public final EventHandler<Event>	getOnShown()
public final Side	getPopupSide()
public void	hide() Hides the `ContextMenu`.
public final boolean	isShowing()
public final ObjectProperty<EventHandler<Event>>	Returns: the on hidden property onHiddenProperty() Called just after the `ContextMenu` has been hidden.
public final ObjectProperty<EventHandler<Event>>	Returns: the on hiding property onHidingProperty() Called just prior to the `ContextMenu` being hidden.
public final ObjectProperty<EventHandler<Event>>	Returns: the on showing property onShowingProperty() Called just prior to the `ContextMenu` being shown.
public final ObjectProperty<EventHandler<Event>>	Returns: the on shown property onShownProperty() Called just after the `ContextMenu` is shown.
public final ObjectProperty<Side>	popupSideProperty()
public final void	setOnHidden(EventHandler<Event> value)
public final void	setOnHiding(EventHandler<Event> value)
public final void	setOnShowing(EventHandler<Event> value)
public final void	setOnShown(EventHandler<Event> value)
public final void	setPopupSide(Side value)
private void	setShowing(boolean value)
public void	show() Shows the `ContextMenu`, assuming this MenuButton is not disabled.
public final ReadOnlyBooleanProperty	showingProperty()

Inherited from javafx.scene.control.ButtonBase:: arm armedProperty disarm getOnAction isArmed onActionProperty setOnAction

Field Detail

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

items	back to summary
private final ObservableList<MenuItem> items

ON_HIDDEN	back to summary
public static final EventType<Event> ON_HIDDEN Called when the MenuButton popup has been hidden. Since JavaFX 8u60

ON_HIDDEN

back to summary

public static final EventType<Event> ON_HIDDEN

Called when the MenuButton popup has been hidden.

Since: JavaFX 8u60

ON_HIDING	back to summary
public static final EventType<Event> ON_HIDING Called when the MenuButton popup will be hidden. Since JavaFX 8u60

ON_HIDING

back to summary

public static final EventType<Event> ON_HIDING

Called when the MenuButton popup will be hidden.

Since: JavaFX 8u60

ON_SHOWING	back to summary
public static final EventType<Event> ON_SHOWING Called prior to the MenuButton showing its popup after the user has clicked or otherwise interacted with the MenuButton. Since JavaFX 8u60

ON_SHOWING

back to summary

public static final EventType<Event> ON_SHOWING

Called prior to the MenuButton showing its popup after the user has clicked or otherwise interacted with the MenuButton.

Since: JavaFX 8u60

ON_SHOWN	back to summary
public static final EventType<Event> ON_SHOWN Called after the MenuButton has shown its popup. Since JavaFX 8u60

ON_SHOWN

back to summary

public static final EventType<Event> ON_SHOWN

Called after the MenuButton has shown its popup.

Since: JavaFX 8u60

onHidden	back to summary
private ObjectProperty<EventHandler<Event>> onHidden

onHiding	back to summary
private ObjectProperty<EventHandler<Event>> onHiding

onShowing	back to summary
private ObjectProperty<EventHandler<Event>> onShowing

onShown	back to summary
private ObjectProperty<EventHandler<Event>> onShown

popupSide back to summary

popupSide	back to summary
private ObjectProperty<Side> popupSide Indicates on which side the `ContextMenu` should open in relation to the MenuButton. Menu items are generally laid out vertically in either case. For example, if the menu button were in a vertical toolbar on the left edge of the application, you might change `popupSide` to `Side.RIGHT` so that the popup will appear to the right of the MenuButton. Default Value `Side.BOTTOM`

private ObjectProperty<Side> popupSide

Indicates on which side the ContextMenu should open in relation to the MenuButton. Menu items are generally laid out vertically in either case. For example, if the menu button were in a vertical toolbar on the left edge of the application, you might change popupSide to Side.RIGHT so that the popup will appear to the right of the MenuButton.

Default Value: Side.BOTTOM

PSEUDO_CLASS_OPENVERTICALLY	back to summary
private static final PseudoClass PSEUDO_CLASS_OPENVERTICALLY

PSEUDO_CLASS_SHOWING	back to summary
private static final PseudoClass PSEUDO_CLASS_SHOWING

showing	back to summary
private ReadOnlyBooleanWrapper showing Indicates whether the `ContextMenu` is currently visible.

Constructor Detail

MenuButton	back to summary
public MenuButton() Creates a new empty menu button. Use `setText(String)`, `setGraphic(Node)` and `getItems()` to set the content.

MenuButton back to summary

MenuButton	back to summary
public MenuButton(String text) Creates a new empty menu button with the given text to display on the button. Use `setGraphic(Node)` and `getItems()` to set the content. Parameters text:String the text to display on the menu button

public MenuButton(String text)

Creates a new empty menu button with the given text to display on the button. Use setGraphic(Node) and getItems() to set the content.

Parameters

text:String: the text to display on the menu button

MenuButton back to summary

MenuButton	back to summary
public MenuButton(String text, Node graphic) Creates a new empty menu button with the given text and graphic to display on the button. Use `getItems()` to set the content. Parameters text:String the text to display on the menu button graphic:Node the graphic to display on the menu button

public MenuButton(String text, Node graphic)

Creates a new empty menu button with the given text and graphic to display on the button. Use getItems() to set the content.

Parameters

text:String: the text to display on the menu button
graphic:Node: the graphic to display on the menu button

MenuButton back to summary

MenuButton	back to summary
public MenuButton(String text, Node graphic, MenuItem... items) Creates a new menu button with the given text and graphic to display on the button, and inserts the given items into the `items` list. Parameters text:String the text to display on the menu button graphic:Node the graphic to display on the menu button items:MenuItem[] The items to display in the popup menu. Since JavaFX 8u40

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

Creates a new menu button with the given text and graphic to display on the button, and inserts the given items into the items list.

Parameters

text:String: the text to display on the menu button
graphic:Node: the graphic to display on the menu button
items:MenuItem[]: The items to display in the popup menu.

Since

JavaFX 8u40

Method Detail

createDefaultSkin back to summary

createDefaultSkin	back 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

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

executeAccessibleAction	back to summary
public void executeAccessibleAction(AccessibleAction action, Object... parameters) Overrides javafx.scene.control.ButtonBase.executeAccessibleAction. Doc from javafx.scene.control.ButtonBase.executeAccessibleAction. This method is called by the assistive technology to request the action indicated by the argument should be executed. This method is commonly overridden by subclasses to implement action that are required for a specific role. If a particular action is not handled, the superclass implementation must be called. Parameters action:AccessibleAction Doc from javafx.scene.Node.executeAccessibleAction. the action to execute parameters:Object[] Doc from javafx.scene.Node.executeAccessibleAction. optional list of parameters Annotations @Override

executeAccessibleAction

back to summary

public void executeAccessibleAction(AccessibleAction action, Object... parameters)

Overrides javafx.scene.control.ButtonBase.executeAccessibleAction.

Doc from javafx.scene.control.ButtonBase.executeAccessibleAction.

This method is called by the assistive technology to request the action indicated by the argument should be executed.

This method is commonly overridden by subclasses to implement action that are required for a specific role.
If a particular action is not handled, the superclass implementation must be called.

Parameters

action:AccessibleAction

Doc from javafx.scene.Node.executeAccessibleAction.

the action to execute

parameters:Object[]

Doc from javafx.scene.Node.executeAccessibleAction.

optional list of parameters

Annotations

@Override

fire	back to summary
public void fire() Implements abstract javafx.scene.control.ButtonBase.fire. This has no impact. Annotations @Override

fire

back to summary

public void fire()

Implements abstract javafx.scene.control.ButtonBase.fire.

This has no impact.

Annotations

@Override

getItems back to summary

getItems	back to summary
public final ObservableList<MenuItem> getItems() The items to show within this buttons menu. If this ObservableList is modified at runtime, the Menu will update as expected. Commonly used controls include including `MenuItem`, `CheckMenuItem`, `RadioMenuItem`, and of course `Menu`, which if added to a menu, will become a sub menu. `SeparatorMenuItem` is another commonly used Node in the Menu's items ObservableList. Returns:ObservableList<MenuItem> the list of menu items within this buttons menu

public final ObservableList<MenuItem> getItems()

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

Commonly used controls include including MenuItem, CheckMenuItem, RadioMenuItem, and of course Menu, which if added to a menu, will become a sub menu. SeparatorMenuItem is another commonly used Node in the Menu's items ObservableList.

Returns:ObservableList<MenuItem>: the list of menu items within this buttons menu

getOnHidden	back to summary
public final EventHandler<Event> getOnHidden()

getOnHiding	back to summary
public final EventHandler<Event> getOnHiding()

getOnShowing	back to summary
public final EventHandler<Event> getOnShowing()

getOnShown	back to summary
public final EventHandler<Event> getOnShown()

getPopupSide	back to summary
public final Side getPopupSide()

hide back to summary

hide	back to summary
public void hide() Hides the `ContextMenu`. See Also `isShowing()`

public void hide()

Hides the ContextMenu.

See Also: isShowing()

isShowing	back to summary
public final boolean isShowing()

onHiddenProperty back to summary

onHiddenProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onHiddenProperty() Called just after the `ContextMenu` has been hidden. Returns:ObjectProperty<EventHandler<Event>> the on hidden property Since 10

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

Called just after the ContextMenu has been hidden.

Returns:ObjectProperty<EventHandler<Event>>: the on hidden property
Since: 10

onHidingProperty back to summary

onHidingProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onHidingProperty() Called just prior to the `ContextMenu` being hidden. Returns:ObjectProperty<EventHandler<Event>> the on hiding property Since 10

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

Called just prior to the ContextMenu being hidden.

Returns:ObjectProperty<EventHandler<Event>>: the on hiding property
Since: 10

onShowingProperty back to summary

onShowingProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onShowingProperty() Called just prior to the `ContextMenu` being shown. Returns:ObjectProperty<EventHandler<Event>> the on showing property Since 10

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

Called just prior to the ContextMenu being shown.

Returns:ObjectProperty<EventHandler<Event>>: the on showing property
Since: 10

onShownProperty back to summary

onShownProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onShownProperty() Called just after the `ContextMenu` is shown. Returns:ObjectProperty<EventHandler<Event>> the on shown property Since 10

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

Called just after the ContextMenu is shown.

Returns:ObjectProperty<EventHandler<Event>>: the on shown property
Since: 10

popupSideProperty	back to summary
public final ObjectProperty<Side> popupSideProperty()

setOnHidden	back to summary
public final void setOnHidden(EventHandler<Event> value)

setOnHiding	back to summary
public final void setOnHiding(EventHandler<Event> value)

setOnShowing	back to summary
public final void setOnShowing(EventHandler<Event> value)

setOnShown	back to summary
public final void setOnShown(EventHandler<Event> value)

setPopupSide	back to summary
public final void setPopupSide(Side value)

setShowing	back to summary
private void setShowing(boolean value)

show back to summary

show	back to summary
public void show() Shows the `ContextMenu`, assuming this MenuButton is not disabled. See Also `isDisabled()`, `isShowing()`

public void show()

Shows the ContextMenu, assuming this MenuButton is not disabled.

See Also: isDisabled(), isShowing()

showingProperty	back to summary
public final ReadOnlyBooleanProperty showingProperty()

public Class MenuButton

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail