javafx.scene.control

Class ToggleGroup

java.lang.Object

javafx.scene.control.ToggleGroup

public class ToggleGroup
extends Object

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

Property Summary

Type	Property and Description
ReadOnlyObjectProperty<Toggle>	selectedToggle The selected toggle.

Constructor Summary

Constructors

Constructor and Description
ToggleGroup() Creates a default ToggleGroup instance.

Method Summary

Modifier and Type	Method and Description
Toggle	getSelectedToggle() Gets the selected Toggle.
ObservableList<Toggle>	getToggles() The list of toggles within the ToggleGroup.
ReadOnlyObjectProperty<Toggle>	selectedToggleProperty() The selected toggle.
void	selectToggle(Toggle value) Selects the toggle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

selectedToggle

public final ReadOnlyObjectProperty<Toggle> selectedToggleProperty

The selected toggle.

See Also:

getSelectedToggle()

Constructor Detail

ToggleGroup

public ToggleGroup()

Creates a default ToggleGroup instance.

Method Detail

getToggles

public final ObservableList<Toggle> getToggles()

The list of toggles within the ToggleGroup.

selectToggle

public final void selectToggle(Toggle value)

Selects the toggle.

Parameters:

value - The Toggle that is to be selected.

getSelectedToggle

public final Toggle getSelectedToggle()

Gets the selected Toggle.

Returns:

Toggle The selected toggle.

selectedToggleProperty

public final ReadOnlyObjectProperty<Toggle> selectedToggleProperty()

The selected toggle.

See Also:

getSelectedToggle()