APIdia Launch Partner
Top Description Methods
javafx.scene.control

public Interface Toggle

Known Direct Implementers
javafx.scene.control.ToggleButton, javafx.scene.control.RadioMenuItem
Imports
javafx.beans.property.BooleanProperty, .ObjectProperty, javafx.collections.ObservableMap
Represents a control that can be toggled between selected and non-selected states. In addition, a Toggle can be assigned a ToggleGroup, which manages all assigned Toggles such that only a single Toggle within the ToggleGroup may be selected at any one time.
Since
JavaFX 2.0

Method Summary

Modifier and TypeMethod and Description
public ObservableMap<Object, Object>

Returns:

An observable map of properties on this toggle for use primarily by application developers
getProperties()

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

public ToggleGroup

Returns:

The ToggleGroup to which this Toggle belongs.
getToggleGroup()

Returns The ToggleGroup to which this Toggle belongs.

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 Node.setUserData(java.lang.Object) method.

public boolean

Returns:

true if this Toggle is selected.
isSelected()

Indicates whether this Toggle is selected.

public BooleanProperty

Returns:

the selected property
selectedProperty()

The selected state for this Toggle.

public void
setSelected(boolean
true to make this Toggle selected.
selected)

Sets this Toggle as selected or unselected.

public void
setToggleGroup(ToggleGroup
The new ToggleGroup.
toggleGroup)

Sets the ToggleGroup to which this Toggle belongs.

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

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

public ObjectProperty<ToggleGroup>

Returns:

the toggle group property
toggleGroupProperty()

The ToggleGroup to which this Toggle belongs.

Method Detail

getPropertiesback to summary
public ObservableMap<Object, Object> getProperties()

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

Returns:ObservableMap<Object, Object>

An observable map of properties on this toggle for use primarily by application developers

getToggleGroupback to summary
public ToggleGroup getToggleGroup()

Returns The ToggleGroup to which this Toggle belongs.

Returns:ToggleGroup

The ToggleGroup to which this Toggle belongs.

getUserDataback to summary
public Object getUserData()

Returns a previously set Object property, or null if no such property has been set using the Node.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.

isSelectedback to summary
public boolean isSelected()

Indicates whether this Toggle is selected.

Returns:boolean

true if this Toggle is selected.

selectedPropertyback to summary
public BooleanProperty selectedProperty()

The selected state for this Toggle.

Returns:BooleanProperty

the selected property

setSelectedback to summary
public void setSelected(boolean selected)

Sets this Toggle as selected or unselected.

Parameters
selected:boolean

true to make this Toggle selected.

setToggleGroupback to summary
public void setToggleGroup(ToggleGroup toggleGroup)

Sets the ToggleGroup to which this Toggle belongs.

Parameters
toggleGroup:ToggleGroup

The new ToggleGroup.

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 Node.getUserData().

Parameters
value:Object

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

toggleGroupPropertyback to summary
public ObjectProperty<ToggleGroup> toggleGroupProperty()

The ToggleGroup to which this Toggle belongs.

Returns:ObjectProperty<ToggleGroup>

the toggle group property