public class ToggleGroup
extends java.lang.Object
Toggles
whose
selected
variables should be managed such that only a single
Toggle
within the ToggleGroup
may be selected at
any one time.
Generally ToggleGroups
are managed automatically simply by specifying
the name of a ToggleGroup
on the
, but in
some situations it is desirable to explicitly manage which
Toggle
ToggleGroup
is used by
.
Toggles
Type | Property and Description |
---|---|
<any> |
selectedToggle
The selected toggle.
|
Modifier and Type | Field and Description |
---|---|
private <any> |
properties |
private <any> |
selectedToggle |
private <any> |
toggles |
private static java.lang.Object |
USER_DATA_KEY
*
*
*
|
Constructor and Description |
---|
ToggleGroup()
Creates a default ToggleGroup instance.
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
clearSelectedToggle() |
<any> |
getProperties()
Returns an observable map of properties on this node for use primarily
by application developers.
|
Toggle |
getSelectedToggle()
Gets the selected
Toggle . |
<any> |
getToggles()
The list of toggles within the ToggleGroup.
|
java.lang.Object |
getUserData()
Returns a previously set Object property, or null if no such property
has been set using the
setUserData(java.lang.Object) method. |
boolean |
hasProperties()
Tests if ToggleGroup has properties.
|
<any> |
selectedToggleProperty()
The selected toggle.
|
void |
selectToggle(Toggle value)
Selects the toggle.
|
private boolean |
setSelected(Toggle toggle,
boolean selected) |
void |
setUserData(java.lang.Object value)
Convenience method for setting a single Object property that can be
retrieved at a later date.
|
public final <any> selectedToggleProperty
getSelectedToggle()
private final <any> toggles
private final <any> selectedToggle
private static final java.lang.Object USER_DATA_KEY
private <any> properties
public final <any> getToggles()
public final void selectToggle(Toggle value)
value
- The Toggle
that is to be selected.public final Toggle getSelectedToggle()
Toggle
.public final <any> selectedToggleProperty()
getSelectedToggle()
private boolean setSelected(Toggle toggle, boolean selected)
final void clearSelectedToggle()
public final <any> getProperties()
public boolean hasProperties()
public void setUserData(java.lang.Object value)
getUserData()
.value
- The value to be stored - this can later be retrieved by calling
getUserData()
.public java.lang.Object getUserData()
setUserData(java.lang.Object)
method.