APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.control

public Class ToggleGroup

extends Object
Class Inheritance
Imports
java.util.HashMap, .List, javafx.beans.property.ReadOnlyObjectProperty, .ReadOnlyObjectWrapper, javafx.collections.ListChangeListener.Change, .FXCollections, .ObservableList, .ObservableMap, com.sun.javafx.collections.VetoableListDecorator, .TrackableObservableList
A class which contains a reference to all 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 Toggle, but in some situations it is desirable to explicitly manage which ToggleGroup is used by Toggles.

Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
private ObservableMap<Object, Object>
properties

private final ReadOnlyObjectWrapper<Toggle>
selectedToggle

private final ObservableList<Toggle>
toggles

private static final Object
USER_DATA_KEY

Constructor Summary

AccessConstructor and Description
public
ToggleGroup()

Creates a default ToggleGroup instance.

Method Summary

Modifier and TypeMethod and Description
pack-priv final void
clearSelectedToggle()

public final ObservableMap<Object, Object>

Returns:

an observable map of properties on this node for use primarily by application developers
getProperties()

Returns an observable map of properties on this node for use primarily by application developers.

public final Toggle

Returns:

Toggle The selected toggle.
getSelectedToggle()

Gets the selected Toggle.

public final ObservableList<Toggle>

Returns:

the list of toggles within the ToggleGroup
getToggles()

The list of toggles within the ToggleGroup.

public Object

Returns:

The Object that was previously set, or null if no property has been set or if null was set.
getUserData()

Returns a previously set Object property, or null if no such property has been set using the ToggleGroup#setUserData(java.lang.Object) method.

public boolean

Returns:

true if node has properties.
hasProperties()

Tests if ToggleGroup has properties.

public final ReadOnlyObjectProperty<Toggle>

Returns:

the selected toggle
selectedToggleProperty()

The selected toggle.

public final void
selectToggle(Toggle
The Toggle that is to be selected.
value)

Selects the toggle.

private boolean
setSelected(Toggle toggle, boolean selected)

public void
setUserData(Object
The value to be stored - this can later be retrieved by calling ToggleGroup#getUserData().
value)

Convenience method for setting a single Object property that can be retrieved at a later date.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

propertiesback to summary
private ObservableMap<Object, Object> properties
selectedToggleback to summary
private final ReadOnlyObjectWrapper<Toggle> selectedToggle
togglesback to summary
private final ObservableList<Toggle> toggles
USER_DATA_KEYback to summary
private static final Object USER_DATA_KEY

Constructor Detail

ToggleGroupback to summary
public ToggleGroup()

Creates a default ToggleGroup instance.

Method Detail

clearSelectedToggleback to summary
pack-priv final void clearSelectedToggle()
getPropertiesback to summary
public final ObservableMap<Object, Object> getProperties()

Returns an observable map of properties on this node for use primarily by application developers.

Returns:ObservableMap<Object, Object>

an observable map of properties on this node for use primarily by application developers

Since
JavaFX 8u40
getSelectedToggleback to summary
public final Toggle getSelectedToggle()

Gets the selected Toggle.

Returns:Toggle

Toggle The selected toggle.

getTogglesback to summary
public final ObservableList<Toggle> getToggles()

The list of toggles within the ToggleGroup.

Returns:ObservableList<Toggle>

the list of toggles within the ToggleGroup

getUserDataback to summary
public Object getUserData()

Returns a previously set Object property, or null if no such property has been set using the ToggleGroup#setUserData(java.lang.Object) method.

Returns:Object

The Object that was previously set, or null if no property has been set or if null was set.

Since
JavaFX 8u40
hasPropertiesback to summary
public boolean hasProperties()

Tests if ToggleGroup has properties.

Returns:boolean

true if node has properties.

Since
JavaFX 8u40
selectedTogglePropertyback to summary
public final ReadOnlyObjectProperty<Toggle> selectedToggleProperty()

The selected toggle.

Returns:ReadOnlyObjectProperty<Toggle>

the selected toggle

selectToggleback to summary
public final void selectToggle(Toggle value)

Selects the toggle.

Parameters
value:Toggle

The Toggle that is to be selected.

setSelectedback to summary
private boolean setSelected(Toggle toggle, boolean selected)
setUserDataback to summary
public void setUserData(Object value)

Convenience method for setting a single Object property that can be retrieved at a later date. This is functionally equivalent to calling the getProperties().put(Object key, Object value) method. This can later be retrieved by calling ToggleGroup#getUserData().

Parameters
value:Object

The value to be stored - this can later be retrieved by calling ToggleGroup#getUserData().

Since
JavaFX 8u40