Class CustomMenuItem

java.lang.Object

javafx.scene.control.MenuItem

javafx.scene.control.CustomMenuItem

All Implemented Interfaces:

Styleable, EventTarget

Direct Known Subclasses:

SeparatorMenuItem

public class CustomMenuItem
extends MenuItem

A MenuItem that allows for arbitrary nodes to be embedded within it, by assigning a Node to the content property. CustomMenuItem attempts to make arbitrary nodes appear more natural in the Menu. For example, you automatically get hover highlighting when the user hovers their mouse over the node (or navigates to it using keyboard or other alternate means).

A useful property of this class is hideOnClick. This boolean specifies whether the CustomMenuItem will be automatically hidden should the user click within the bounds of the CustomMenuItem. This is of particular use when the node inside this CustomMenuItem is a control that requires user interaction, as by setting the hideOnClick property to false means the user can interact with it without the menu hiding. Note that by default hideOnClick is true.

An example of how to use CustomMenuItem is shown below.

 CustomMenuItem customMenuItem = new CustomMenuItem(new Slider());
customMenuItem.setHideOnClick(false);

Menu menu = new Menu("Brightness");
menu.getItems().add(customMenuItem);
MenuBar menuBar = new MenuBar(menu);

The slider is horizontally centered when the menu is visible, and interacting with the slider will not result in the menu disappearing.

Since:

JavaFX 2.0

See Also:

• MenuItem
• Menu

Property Summary

Properties

Type	Property	Description
final ObjectProperty<Node>	content	The node to display within this CustomMenuItem.
final BooleanProperty	hideOnClick	If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.

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 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
CustomMenuItem()	Creates a default CustomMenuItem instance.
CustomMenuItem(Node node)	Constructs a CustomMenuItem and initializes its content with the node specified.
CustomMenuItem(Node node, boolean hideOnClick)	Constructs a CustomMenuItem and sets the content to the node specified.

Method Summary

Modifier and Type	Method	Description
final ObjectProperty<Node>	contentProperty()	The node to display within this CustomMenuItem.
final Node	getContent()	Gets the value of the content property.
final BooleanProperty	hideOnClickProperty()	If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.
final boolean	isHideOnClick()	Gets the value of the hideOnClick property.
final void	setContent(Node value)	Sets the value of the content property.
final void	setHideOnClick(boolean value)	Sets the value of the hideOnClick property.

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

content

public final ObjectProperty<Node> contentProperty

The node to display within this CustomMenuItem.

See Also:

• getContent()
• setContent(Node)
• contentProperty()

hideOnClick

public final BooleanProperty hideOnClickProperty

If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.

Default value:

true

See Also:

• isHideOnClick()
• setHideOnClick(boolean)
• hideOnClickProperty()

Constructor Details

CustomMenuItem

public CustomMenuItem()

Creates a default CustomMenuItem instance.

CustomMenuItem

public CustomMenuItem(Node node)

Constructs a CustomMenuItem and initializes its content with the node specified.

Parameters:

node - to be embedded inside this CustomMenuItem

CustomMenuItem

public CustomMenuItem(Node node,
 boolean hideOnClick)

Constructs a CustomMenuItem and sets the content to the node specified.

Parameters:

node - to be embedded inside this CustomMenuItem

hideOnClick - if false the menu will not hide when the user interacts with the node.

Method Details

setContent

public final void setContent(Node value)

Sets the value of the content property.

Property description:

The node to display within this CustomMenuItem.

Parameters:

value - the value for the content property

See Also:

• getContent()
• contentProperty()

getContent

public final Node getContent()

Gets the value of the content property.

Property description:

The node to display within this CustomMenuItem.

Returns:

the value of the content property

See Also:

• setContent(Node)
• contentProperty()

contentProperty

public final ObjectProperty<Node> contentProperty()

The node to display within this CustomMenuItem.

Returns:

the content property

See Also:

• getContent()
• setContent(Node)

setHideOnClick

public final void setHideOnClick(boolean value)

Sets the value of the hideOnClick property.

Property description:

If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.

Default value:

true

Parameters:

value - the value for the hideOnClick property

See Also:

• isHideOnClick()
• hideOnClickProperty()

isHideOnClick

public final boolean isHideOnClick()

Gets the value of the hideOnClick property.

Property description:

If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.

Default value:

true

Returns:

the value of the hideOnClick property

See Also:

• setHideOnClick(boolean)
• hideOnClickProperty()

hideOnClickProperty

public final BooleanProperty hideOnClickProperty()

If true, this menu item, and all visible menus, will be hidden when this menu item is clicked on.

Default value:

true

Returns:

the hideOnClick property

See Also:

• isHideOnClick()
• setHideOnClick(boolean)