javafx.scene.control

Class ToggleButton

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.ButtonBase

javafx.scene.control.ToggleButton

All Implemented Interfaces:

Skinnable, Toggle

Direct Known Subclasses:

RadioButton

public class ToggleButton
extends ButtonBase
implements Toggle

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.

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
BooleanProperty	selected Indicates whether this toggle button is selected.
<any>	toggleGroup The ToggleGroup to which this ToggleButton belongs.

Properties inherited from class javafx.scene.control.ButtonBase

armedProperty, onActionProperty

Properties inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, graphicProperty, graphicTextGapProperty, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_STYLE_CLASS * Stylesheet Handling * *
private static PseudoClass	PSEUDO_CLASS_SELECTED
private BooleanProperty	selected Indicates whether this toggle button is selected.
private <any>	toggleGroup The ToggleGroup to which this ToggleButton belongs.

Constructor Summary

Constructors

Constructor and Description
ToggleButton() Creates a toggle button with an empty string for its label.
ToggleButton(java.lang.String text) Creates a toggle button with the specified text as its label.
ToggleButton(java.lang.String text, Node 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() Create a new instance of the default skin for this control.
void	fire() Invoked when a user gesture indicates that an event for this ButtonBase should occur.
protected Pos	getInitialAlignment() Returns the initial alignment state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
ToggleGroup	getToggleGroup() Gets the value of the property toggleGroup.
private void	initialize()
boolean	isSelected() Gets the value of the property selected.
java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
BooleanProperty	selectedProperty() Indicates whether this toggle button is selected.
void	setSelected(boolean value) Sets the value of the property selected.
void	setToggleGroup(ToggleGroup value) Sets the value of the property toggleGroup.
<any>	toggleGroupProperty() The ToggleGroup to which this ToggleButton belongs.

Methods inherited from class javafx.scene.control.ButtonBase

arm, armedProperty, disarm, executeAccessibleAction, getOnAction, isArmed, onActionProperty, setOnAction

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.scene.control.Toggle

getProperties, getUserData, setUserData

Property Detail

selected

public final BooleanProperty selectedProperty

Indicates whether this toggle button is selected. This can be manipulated programmatically.

Specified by:

selectedProperty in interface Toggle

See Also:

isSelected(), setSelected(boolean)

toggleGroup

public final <any> toggleGroupProperty

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.

Specified by:

toggleGroupProperty in interface Toggle

See Also:

getToggleGroup(), setToggleGroup(ToggleGroup)

Field Detail

selected

private BooleanProperty selected

Indicates whether this toggle button is selected. This can be manipulated programmatically.

toggleGroup

private <any> 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.

DEFAULT_STYLE_CLASS

private static final java.lang.String DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

See Also:

Constant Field Values

PSEUDO_CLASS_SELECTED

private static final PseudoClass PSEUDO_CLASS_SELECTED

Constructor Detail

ToggleButton

public ToggleButton()

Creates a toggle button with an empty string for its label.

ToggleButton

public ToggleButton(java.lang.String text)

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

Parameters:

text - A text string for its label.

ToggleButton

public ToggleButton(java.lang.String text,
                    Node graphic)

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

Parameters:

text - A text string for its label.

graphic - the icon for its label.

Method Detail

initialize

private void initialize()

setSelected

public final void setSelected(boolean value)

Sets the value of the property selected.

Specified by:

setSelected in interface Toggle

Parameters:

value - true to make this Toggle selected.

isSelected

public final boolean isSelected()

Gets the value of the property selected.

Specified by:

isSelected in interface Toggle

Returns:

true if this Toggle is selected.

selectedProperty

public final BooleanProperty selectedProperty()

Indicates whether this toggle button is selected. This can be manipulated programmatically.

Specified by:

selectedProperty in interface Toggle

See Also:

isSelected(), setSelected(boolean)

setToggleGroup

public final void setToggleGroup(ToggleGroup value)

Sets the value of the property toggleGroup.

Specified by:

setToggleGroup in interface Toggle

Parameters:

value - The new ToggleGroup.

getToggleGroup

public final ToggleGroup getToggleGroup()

Gets the value of the property toggleGroup.

Specified by:

getToggleGroup in interface Toggle

Returns:

The ToggleGroup to which this Toggle belongs.

toggleGroupProperty

public final <any> toggleGroupProperty()

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.

Specified by:

toggleGroupProperty in interface Toggle

See Also:

getToggleGroup(), setToggleGroup(ToggleGroup)

fire

public void 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 ButtonBase.arm().

Specified by:

fire in class ButtonBase

createDefaultSkin

protected Skin<?> 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(...).

Overrides:

createDefaultSkin in class Control

Returns:

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

getInitialAlignment

protected Pos 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.

Overrides:

getInitialAlignment in class Labeled

Returns:

the initial alignment state of this control

Since:

9

queryAccessibleAttribute

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

Overrides:

queryAccessibleAttribute in class Control