JavaFX 24 · javafx.scene.control.ToggleButton · APIdia, the JavaDoc alternative

A ToggleButton is a specialized control which has the ability to be selected. Typically a ToggleButton is rendered similarly to a Button. However, they are two different types of Controls. A Button is a "command" button which invokes a function when clicked. A ToggleButton on the other hand is simply a control with a Boolean indicating whether it has been selected.

ToggleButton can also be placed in groups. By default, a ToggleButton is not in a group. When in groups, only one ToggleButton at a time within that group can be selected. To put two ToggleButtons in the same group, simply assign them both the same value for ToggleGroup.

Unlike RadioButtons, ToggleButtons in a ToggleGroup do not attempt to force at least one selected ToggleButton in the group. That is, if a ToggleButton is selected, clicking on it will cause it to become unselected. With RadioButton, clicking on the selected button in the group will have no effect.

Example:

 ToggleButton tb1 = new ToggleButton("toggle button 1");
ToggleButton tb2 = new ToggleButton("toggle button 2");
ToggleButton tb3 = new ToggleButton("toggle button 3");
ToggleGroup group = new ToggleGroup();
tb1.setToggleGroup(group);
tb2.setToggleGroup(group);
tb3.setToggleGroup(group);

MnemonicParsing is enabled by default for ToggleButton.

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_STYLE_CLASS
private static final PseudoClass	PSEUDO_CLASS_SELECTED
private BooleanProperty	selected Indicates whether this toggle button is selected.
private ObjectProperty<ToggleGroup>	toggleGroup The `ToggleGroup` to which this `ToggleButton` belongs.

Constructor Summary

Access	Constructor and Description
public	ToggleButton() Creates a toggle button with an empty string for its label.
public	ToggleButton(String A text string for its label. text) Creates a toggle button with the specified text as its label.
public	ToggleButton(String A text string for its label. text, Node the icon for its label. graphic) Creates a toggle button with the specified text and icon for its label.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public void	fire() Implements abstract javafx.scene.control.ButtonBase.fire. Invoked when a user gesture indicates that an event for this `ButtonBase` should occur.
protected Pos	getInitialAlignment() Overrides javafx.scene.control.Labeled.getInitialAlignment. Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
public final ToggleGroup	getToggleGroup() Implements javafx.scene.control.Toggle.getToggleGroup. Returns The `ToggleGroup` to which this `Toggle` belongs.
private void	initialize()
public final boolean	isSelected() Implements javafx.scene.control.Toggle.isSelected. Indicates whether this `Toggle` is selected.
public Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final BooleanProperty	selectedProperty() Implements javafx.scene.control.Toggle.selectedProperty. The selected state for this `Toggle`.
public final void	setSelected(boolean `true` to make this `Toggle` selected. value) Implements javafx.scene.control.Toggle.setSelected. Sets this `Toggle` as selected or unselected.
public final void	setToggleGroup(ToggleGroup The new `ToggleGroup`. value) Implements javafx.scene.control.Toggle.setToggleGroup. Sets the `ToggleGroup` to which this `Toggle` belongs.
public final ObjectProperty<ToggleGroup>	toggleGroupProperty() Implements javafx.scene.control.Toggle.toggleGroupProperty. The `ToggleGroup` to which this `Toggle` belongs.

Inherited from javafx.scene.control.ButtonBase:: arm armedProperty disarm executeAccessibleAction getOnAction isArmed onActionProperty setOnAction

Field Detail

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

PSEUDO_CLASS_SELECTED	back to summary
private static final PseudoClass PSEUDO_CLASS_SELECTED

selected	back to summary
private BooleanProperty selected Indicates whether this toggle button is selected. This can be manipulated programmatically.

toggleGroup	back to summary
private ObjectProperty<ToggleGroup> toggleGroup The `ToggleGroup` to which this `ToggleButton` belongs. A `ToggleButton` can only be in one group at any one time. If the group is changed, then the button is removed from the old group prior to being added to the new group.

Constructor Detail

ToggleButton	back to summary
public ToggleButton() Creates a toggle button with an empty string for its label.

ToggleButton	back to summary
public ToggleButton(String text) Creates a toggle button with the specified text as its label. Parameters text:String A text string for its label.

ToggleButton

back to summary

public ToggleButton(String text)

Creates a toggle button with the specified text as its label.

Parameters

text:String: A text string for its label.

ToggleButton	back to summary
public ToggleButton(String text, Node graphic) Creates a toggle button with the specified text and icon for its label. Parameters text:String A text string for its label. graphic:Node the icon for its label.

ToggleButton

back to summary

public ToggleButton(String text, Node graphic)

Creates a toggle button with the specified text and icon for its label.

Parameters

text:String: A text string for its label.
graphic:Node: the icon for its label.

Method Detail

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

fire back to summary

fire	back to summary
public void fire() Implements abstract javafx.scene.control.ButtonBase.fire. Doc from javafx.scene.control.ButtonBase.fire. Invoked when a user gesture indicates that an event for this `ButtonBase` should occur. If invoked, this method will be executed regardless of the status of `arm`. Annotations @Override

public void fire()

Implements abstract javafx.scene.control.ButtonBase.fire.

Doc from javafx.scene.control.ButtonBase.fire.

Invoked when a user gesture indicates that an event for this ButtonBase should occur.

If invoked, this method will be executed regardless of the status of arm.

Annotations

@Override

getInitialAlignment	back to summary
protected Pos getInitialAlignment() Overrides javafx.scene.control.Labeled.getInitialAlignment. Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden to use Pos.CENTER initially. Returns:Pos Doc from javafx.scene.control.Labeled.getInitialAlignment. the initial alignment state of this control Annotations @Override Since 9

getInitialAlignment

back to summary

protected Pos getInitialAlignment()

Overrides javafx.scene.control.Labeled.getInitialAlignment.

Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden to use Pos.CENTER initially.

Returns:Pos

Doc from javafx.scene.control.Labeled.getInitialAlignment.

the initial alignment state of this control

Annotations

@Override

Since

getToggleGroup back to summary

getToggleGroup	back to summary
public final ToggleGroup getToggleGroup() Implements javafx.scene.control.Toggle.getToggleGroup. Doc from javafx.scene.control.Toggle.getToggleGroup. Returns The `ToggleGroup` to which this `Toggle` belongs. Returns:ToggleGroup The `ToggleGroup` to which this `Toggle` belongs. Annotations @Override

public final ToggleGroup getToggleGroup()

Implements javafx.scene.control.Toggle.getToggleGroup.

Doc from javafx.scene.control.Toggle.getToggleGroup.

Returns The ToggleGroup to which this Toggle belongs.

Returns:ToggleGroup

The ToggleGroup to which this Toggle belongs.

Annotations

@Override

initialize	back to summary
private void initialize()

isSelected back to summary

isSelected	back to summary
public final boolean isSelected() Implements javafx.scene.control.Toggle.isSelected. Doc from javafx.scene.control.Toggle.isSelected. Indicates whether this `Toggle` is selected. Returns:boolean `true` if this `Toggle` is selected. Annotations @Override

public final boolean isSelected()

Implements javafx.scene.control.Toggle.isSelected.

Doc from javafx.scene.control.Toggle.isSelected.

Indicates whether this Toggle is selected.

Returns:boolean

true if this Toggle is selected.

Annotations

@Override

queryAccessibleAttribute	back to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. Doc from javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute. This method is commonly overridden by subclasses to implement attributes that are required for a specific role. If a particular attribute is not handled, the superclass implementation must be called. Parameters attribute:AccessibleAttribute Doc from javafx.scene.Node.queryAccessibleAttribute. the requested attribute parameters:Object[] Doc from javafx.scene.Node.queryAccessibleAttribute. optional list of parameters Returns:Object Doc from javafx.scene.Node.queryAccessibleAttribute. the value for the requested attribute Annotations @Override

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.Control.queryAccessibleAttribute.

Doc from javafx.scene.control.Control.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Parameters

attribute:AccessibleAttribute

Doc from javafx.scene.Node.queryAccessibleAttribute.

the requested attribute

parameters:Object[]

Doc from javafx.scene.Node.queryAccessibleAttribute.

optional list of parameters

Returns:Object

Doc from javafx.scene.Node.queryAccessibleAttribute.

the value for the requested attribute

Annotations

@Override

selectedProperty back to summary

selectedProperty	back to summary
public final BooleanProperty selectedProperty() Implements javafx.scene.control.Toggle.selectedProperty. Doc from javafx.scene.control.Toggle.selectedProperty. The selected state for this `Toggle`. Returns:BooleanProperty the selected property Annotations @Override

public final BooleanProperty selectedProperty()

Implements javafx.scene.control.Toggle.selectedProperty.

Doc from javafx.scene.control.Toggle.selectedProperty.

The selected state for this Toggle.

Returns:BooleanProperty

the selected property

Annotations

@Override

setSelected back to summary

setSelected	back to summary
public final void setSelected(boolean value) Implements javafx.scene.control.Toggle.setSelected. Doc from javafx.scene.control.Toggle.setSelected. Sets this `Toggle` as selected or unselected. Parameters value:boolean `true` to make this `Toggle` selected. Annotations @Override

public final void setSelected(boolean value)

Implements javafx.scene.control.Toggle.setSelected.

Doc from javafx.scene.control.Toggle.setSelected.

Sets this Toggle as selected or unselected.

Parameters

value:boolean: true to make this Toggle selected.

Annotations

@Override

setToggleGroup back to summary

setToggleGroup	back to summary
public final void setToggleGroup(ToggleGroup value) Implements javafx.scene.control.Toggle.setToggleGroup. Doc from javafx.scene.control.Toggle.setToggleGroup. Sets the `ToggleGroup` to which this `Toggle` belongs. Parameters value:ToggleGroup The new `ToggleGroup`. Annotations @Override

public final void setToggleGroup(ToggleGroup value)

Implements javafx.scene.control.Toggle.setToggleGroup.

Doc from javafx.scene.control.Toggle.setToggleGroup.

Sets the ToggleGroup to which this Toggle belongs.

Parameters

value:ToggleGroup: The new ToggleGroup.

Annotations

@Override

toggleGroupProperty back to summary

toggleGroupProperty	back to summary
public final ObjectProperty<ToggleGroup> toggleGroupProperty() Implements javafx.scene.control.Toggle.toggleGroupProperty. Doc from javafx.scene.control.Toggle.toggleGroupProperty. The `ToggleGroup` to which this `Toggle` belongs. Returns:ObjectProperty<ToggleGroup> the toggle group property Annotations @Override

public final ObjectProperty<ToggleGroup> toggleGroupProperty()

Implements javafx.scene.control.Toggle.toggleGroupProperty.

Doc from javafx.scene.control.Toggle.toggleGroupProperty.

The ToggleGroup to which this Toggle belongs.

Returns:ObjectProperty<ToggleGroup>

the toggle group property

Annotations

@Override

public Class ToggleButton

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail