public class RadioMenuItem extends MenuItem implements Toggle
A RadioMenuItem is a MenuItem that can be toggled (it uses
the Toggle mixin). This means that
RadioMenuItem has an API very similar in nature to other controls that use
Toggle, such as
RadioButton and
ToggleButton. RadioMenuItem is
specifically designed for use within a Menu, so refer to that class
API documentation for more information on how to add a RadioMenuItem into it.
To create a simple, ungrouped RadioMenuItem, do the following:
RadioMenuItem radioItem = new RadioMenuItem("radio text");
radioItem.setSelected(false);
radioItem.setOnAction(new EventHandler<ActionEvent>() {
@Override public void handle(ActionEvent e) {
System.out.println("radio toggled");
}
});
The problem with the example above is that this offers no benefit over using
a normal MenuItem. As already mentioned, the purpose of a
RadioMenuItem is to offer
multiple choices to the user, and only allow for one of these choices to be
selected at any one time (i.e. the selection should be mutually exclusive).
To achieve this, you can place zero or more RadioMenuItem's into groups. When
in groups, only one RadioMenuItem at a time within that group can be selected.
To put two RadioMenuItem instances into the same group, simply assign them
both the same value for toggleGroup. For example:
ToggleGroup toggleGroup = new ToggleGroup();
RadioMenuItem radioItem1 = new RadioMenuItem("Option 1");
radioItem.setOnAction(new EventHandler<ActionEvent>() {
@Override public void handle(ActionEvent e) {
System.out.println("radio toggled");
}
});
radioItem1.setToggleGroup(toggleGroup);
RadioMenuItem radioItem2 = new RadioMenuItem("Option 2");
radioItem.setOnAction(new EventHandler<ActionEvent>() {
@Override public void handle(ActionEvent e) {
System.out.println("radio toggled");
}
});
radioItem2.setToggleGroup(toggleGroup);
ToggleGroup, only one item may be
selected at any one time, and should
the selection change, the ToggleGroup will take care of deselecting the
previous item.
| Modifier and Type | Field and Description |
|---|---|
private static java.lang.String |
DEFAULT_STYLE_CLASS
*
Stylesheet Handling *
*
|
private BooleanProperty |
selected |
private static java.lang.String |
STYLE_CLASS_SELECTED |
private ObjectProperty<ToggleGroup> |
toggleGroup
Represents the
ToggleGroup that this RadioMenuItem belongs to. |
eventHandlerManager, MENU_VALIDATION_EVENT| Constructor and Description |
|---|
RadioMenuItem()
Constructs a RadioMenuItem with no display text.
|
RadioMenuItem(java.lang.String text)
Constructs a RadioMenuItem and sets the display text with the specified text.
|
RadioMenuItem(java.lang.String text,
Node graphic)
Constructs a RadioMenuItem and sets the display text with the specified text
and sets the graphic
Node to the given node. |
| Modifier and Type | Method and Description |
|---|---|
ToggleGroup |
getToggleGroup()
Returns The
ToggleGroup to which this Toggle belongs. |
boolean |
isSelected()
Indicates whether this
Toggle is selected. |
BooleanProperty |
selectedProperty()
The selected state for this
Toggle. |
void |
setSelected(boolean value)
Sets this
Toggle as selected or unselected. |
void |
setToggleGroup(ToggleGroup value)
Sets the
ToggleGroup to which this Toggle belongs. |
ObjectProperty<ToggleGroup> |
toggleGroupProperty()
The
ToggleGroup to which this Toggle belongs. |
acceleratorProperty, addEventHandler, buildEventDispatchChain, disableProperty, fire, getAccelerator, getCssMetaData, getGraphic, getId, getOnAction, getOnMenuValidation, getParentMenu, getParentPopup, getProperties, getPseudoClassStates, getStyle, getStyleableParent, getStyleClass, getText, getTypeSelector, getUserData, graphicProperty, idProperty, impl_styleableGetNode, isDisable, isMnemonicParsing, isVisible, mnemonicParsingProperty, onActionProperty, onMenuValidationProperty, parentMenuProperty, parentPopupProperty, removeEventHandler, setAccelerator, setDisable, setGraphic, setId, setMnemonicParsing, setOnAction, setOnMenuValidation, setParentMenu, setParentPopup, setStyle, setText, setUserData, setVisible, styleProperty, textProperty, toString, visiblePropertyclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetProperties, getUserData, setUserDataprivate ObjectProperty<ToggleGroup> toggleGroup
ToggleGroup that this RadioMenuItem belongs to.private BooleanProperty selected
private static final java.lang.String DEFAULT_STYLE_CLASS
private static final java.lang.String STYLE_CLASS_SELECTED
public RadioMenuItem()
public RadioMenuItem(java.lang.String text)
public final void setToggleGroup(ToggleGroup value)
ToggleToggleGroup to which this Toggle belongs.setToggleGroup in interface Togglevalue - The new ToggleGroup.public final ToggleGroup getToggleGroup()
ToggleToggleGroup to which this Toggle belongs.getToggleGroup in interface ToggleToggleGroup to which this Toggle belongs.public final ObjectProperty<ToggleGroup> toggleGroupProperty()
ToggleToggleGroup to which this Toggle belongs.toggleGroupProperty in interface Togglepublic final void setSelected(boolean value)
ToggleToggle as selected or unselected.setSelected in interface Togglevalue - true to make this Toggle selected.public final boolean isSelected()
ToggleToggle is selected.isSelected in interface Toggletrue if this Toggle is selected.public final BooleanProperty selectedProperty()
ToggleToggle.selectedProperty in interface Toggle