Class CheckMenuItem
- All Implemented Interfaces:
-
Styleable,EventTarget
public class CheckMenuItem extends MenuItem
A MenuItem that can be toggled between selected and unselected states. It is intended that CheckMenuItem be used in conjunction with the Menu or ContextMenu controls.
Creating and inserting a CheckMenuItem into a Menu is shown below.
CheckMenuItem subsystem1 = new CheckMenuItem("Enabled");
subsystem1.setOnAction(e -> System.out.println("subsystem1 #1 Enabled!"));
Menu menu = new Menu("Subsystems");
menu.getItems().add(subsystem1);
MenuBar menuBar = new MenuBar(menu); Of course, the approach shown above separates out the definition of the CheckMenuItem from the Menu, but this needn't be so.
To ascertain the current state of the CheckMenuItem, you should refer to the selected boolean. An example use case may be the following example:
final checkMenuItem = new CheckMenuItem("Show Widget");
subsystem1.setOnAction(e -> System.out.println("Show the widget!"));
private final BooleanProperty widgetShowing();
public final boolean isWidgetShowing() { return widgetShowing.get(); )
public final void setWidgetShowing(boolean value) {
widgetShowingProperty().set(value);
}
public final BooleanProperty widgetShowingProperty() {
if (widgetShowing == null) {
widgetShowing = new SimpleBooleanProperty(this, "widgetShowing", true);
}
return widgetShowing;
}
widgetShowing.bind(checkMenuItem.selected); Typically a CheckMenuItem will be rendered such that, when selected, it shows a check (or tick) mark in the area normally reserved for the MenuItem graphic. Of course, this will vary depending on the skin and styling specified.
- Since:
- JavaFX 2.0
- See Also:
Property Summary
| Type | Property | Description |
|---|---|---|
final BooleanProperty |
selected |
Represents the current state of this CheckMenuItem. |
Properties declared in class javafx.scene.control.MenuItem
accelerator, disable, graphic, id, mnemonicParsing, onAction, onMenuValidation, parentMenu, parentPopup, style, text, visible
Field Summary
Fields declared in class javafx.scene.control.MenuItem
MENU_VALIDATION_EVENT
Constructor Summary
| Constructor | Description |
|---|---|
CheckMenuItem() |
Creates an empty CheckMenuItem. |
CheckMenuItem |
Constructs a CheckMenuItem and sets the display text with the specified text. |
CheckMenuItem |
Constructs a CheckMenuItem and sets the display text with the specified text and sets the graphic Node to the given node. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
final boolean |
isSelected() |
Gets the value of the selected property. |
final BooleanProperty |
selectedProperty() |
Represents the current state of this CheckMenuItem. |
final void |
setSelected |
Sets the value of the selected property. |
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
selected
public final BooleanProperty selectedProperty
- Default value:
- false
- See Also:
Constructor Details
CheckMenuItem
public CheckMenuItem()
CheckMenuItem.CheckMenuItem
public CheckMenuItem(String text)
- Parameters:
-
text- the display text
CheckMenuItem
public CheckMenuItem(String text, Node graphic)
Node to the given node.- Parameters:
-
text- the display text -
graphic- the graphic Node
Method Details
setSelected
public final void setSelected(boolean value)
selected property.- Property description:
- Represents the current state of this CheckMenuItem. Bind to this to be informed whenever the user interacts with the CheckMenuItem (and causes the selected state to be toggled).
- Default value:
- false
- Parameters:
-
value- the value for theselectedproperty - See Also:
isSelected
public final boolean isSelected()
selected property.- Property description:
- Represents the current state of this CheckMenuItem. Bind to this to be informed whenever the user interacts with the CheckMenuItem (and causes the selected state to be toggled).
- Default value:
- false
- Returns:
- the value of the
selectedproperty - See Also:
selectedProperty
public final BooleanProperty selectedProperty()
- Default value:
- false
- Returns:
- the
selectedproperty - See Also:
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.