An implementation of a two-state button. The JRadioButton and JCheckBox classes are subclasses of this class. For information on using them see How to Use Buttons, Check Boxes, and Radio Buttons, a section in The Java Tutorial.

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions, a section in The Java Tutorial.

Warning

Swing is not thread safe. For more information see Swing's Threading Policy.

Warning

Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	JToggleButton.AccessibleJToggleButton This class implements accessibility support for the `JToggleButton` class.
public static class	JToggleButton.ToggleButtonModel The ToggleButton model Warning Serialized objects of this class will not be compatible with future Swing releases.

Field Summary

Modifier and Type	Field and Description
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.

Constructor Summary

Access	Constructor and Description
public	JToggleButton() Creates an initially unselected toggle button without setting the text or image.
public	JToggleButton(Icon the image that the button should display icon) Creates an initially unselected toggle button with the specified image but no text.
public	JToggleButton(Icon the image that the button should display icon, boolean if true, the button is initially selected; otherwise, the button is initially unselected selected) Creates a toggle button with the specified image and selection state, but no text.
public	JToggleButton(String the string displayed on the toggle button text) Creates an unselected toggle button with the specified text.
public	JToggleButton(String the string displayed on the toggle button text, boolean if true, the button is initially selected; otherwise, the button is initially unselected selected) Creates a toggle button with the specified text and selection state.
public	JToggleButton(Action an instance of an `Action` a) Creates a toggle button where properties are taken from the Action supplied.
public	JToggleButton(String the string displayed on the button text, Icon the image that the button should display icon) Creates a toggle button that has the specified text and image, and that is initially unselected.
public	JToggleButton(String the text of the toggle button text, Icon the image that the button should display icon, boolean if true, the button is initially selected; otherwise, the button is initially unselected selected) Creates a toggle button with the specified text, image, and selection state.

Method Summary

Modifier and Type	Method and Description
public AccessibleContext	Returns: an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JToggleButton.
private JToggleButton	getGroupSelection(FocusEvent.Cause cause)
public String	Returns: the string "ToggleButtonUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns a string that specifies the name of the l&f class that renders this component.
protected String	Returns: a string representation of this JToggleButton. paramString() Overrides javax.swing.AbstractButton.paramString. Returns a string representation of this JToggleButton.
public void	requestFocus(FocusEvent.Cause the cause why the focus is requested cause) Overrides java.awt.Component.requestFocus. If this toggle button is a member of the `ButtonGroup` which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling `Component#requestFocus(FocusEvent.Cause)` on the toggle button selected in the group.
public boolean	requestFocusInWindow(FocusEvent.Cause the cause why the focus is requested cause) Overrides java.awt.Component.requestFocusInWindow. If this toggle button is a member of the `ButtonGroup` which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling `Component#requestFocusInWindow(FocusEvent.Cause)` on the toggle button selected in the group.
private boolean	requestFocusInWindowUnconditionally(FocusEvent.Cause cause)
private void	requestFocusUnconditionally(FocusEvent.Cause cause)
pack-priv boolean	shouldUpdateSelectedStateFromAction() Overrides javax.swing.AbstractButton.shouldUpdateSelectedStateFromAction. Overridden to return true, JToggleButton supports the selected state.
public void	updateUI() Overrides javax.swing.AbstractButton.updateUI. Resets the UI property to a value from the current look and feel.
private void	writeObject(ObjectOutputStream the `ObjectOutputStream` in which to write s) Hides javax.swing.JComponent.writeObject. See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Inherited from javax.swing.AbstractButton:: actionPropertyChanged addActionListener addChangeListener addImpl addItemListener checkHorizontalKey checkVerticalKey clientPropertyChanged configurePropertiesFromAction createActionListener createActionPropertyChangeListener createActionPropertyChangeListener0 createChangeListener createItemListener doClick doClick fireActionPerformed fireItemStateChanged fireStateChanged getAction getActionCommand getActionListeners getChangeListeners getDisabledIcon getDisabledSelectedIcon getDisplayedMnemonicIndex getHideActionText getHorizontalAlignment getHorizontalTextPosition getIcon getIconTextGap getItemListeners getLabel getMargin getMnemonic getModel getMultiClickThreshhold getPressedIcon getRolloverIcon getRolloverSelectedIcon getSelectedIcon getSelectedObjects getText getUI getVerticalAlignment getVerticalTextPosition imageUpdate init isBorderPainted isContentAreaFilled isFocusPainted isRolloverEnabled isSelected largeIconChanged paintBorder removeActionListener removeChangeListener removeItemListener removeNotify setAction setActionCommand setBorderPainted setContentAreaFilled setDisabledIcon setDisabledSelectedIcon setDisplayedMnemonicIndex setEnabled setFocusPainted setHideActionText setHorizontalAlignment setHorizontalTextPosition setIcon setIconFromAction setIconTextGap setLabel setLayout setMargin setMnemonic setMnemonic setModel setMultiClickThreshhold setPressedIcon setRolloverEnabled setRolloverIcon setRolloverSelectedIcon setSelected setSelectedIcon setText setUI setUIProperty setVerticalAlignment setVerticalTextPosition smallIconChanged

Field Detail

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID, readObject

Constructor Detail

JToggleButton	back to summary
public JToggleButton() Creates an initially unselected toggle button without setting the text or image.

JToggleButton	back to summary
public JToggleButton(Icon icon) Creates an initially unselected toggle button with the specified image but no text. Parameters icon:Icon the image that the button should display

JToggleButton

back to summary

public JToggleButton(Icon icon)

Creates an initially unselected toggle button with the specified image but no text.

Parameters

icon:Icon: the image that the button should display

JToggleButton	back to summary
public JToggleButton(Icon icon, boolean selected) Creates a toggle button with the specified image and selection state, but no text. Parameters icon:Icon the image that the button should display selected:boolean if true, the button is initially selected; otherwise, the button is initially unselected

JToggleButton

back to summary

public JToggleButton(Icon icon, boolean selected)

Creates a toggle button with the specified image and selection state, but no text.

Parameters

icon:Icon: the image that the button should display
selected:boolean: if true, the button is initially selected; otherwise, the button is initially unselected

JToggleButton	back to summary
public JToggleButton(String text) Creates an unselected toggle button with the specified text. Parameters text:String the string displayed on the toggle button

JToggleButton

back to summary

public JToggleButton(String text)

Creates an unselected toggle button with the specified text.

Parameters

text:String: the string displayed on the toggle button

JToggleButton	back to summary
public JToggleButton(String text, boolean selected) Creates a toggle button with the specified text and selection state. Parameters text:String the string displayed on the toggle button selected:boolean if true, the button is initially selected; otherwise, the button is initially unselected

JToggleButton

back to summary

public JToggleButton(String text, boolean selected)

Creates a toggle button with the specified text and selection state.

Parameters

text:String: the string displayed on the toggle button
selected:boolean: if true, the button is initially selected; otherwise, the button is initially unselected

JToggleButton back to summary

JToggleButton	back to summary
public JToggleButton(Action a) Creates a toggle button where properties are taken from the Action supplied. Parameters a:Action an instance of an `Action` Since 1.3

public JToggleButton(Action a)

Creates a toggle button where properties are taken from the Action supplied.

Parameters

a:Action: an instance of an Action

Since

1.3

JToggleButton	back to summary
public JToggleButton(String text, Icon icon) Creates a toggle button that has the specified text and image, and that is initially unselected. Parameters text:String the string displayed on the button icon:Icon the image that the button should display

JToggleButton

back to summary

public JToggleButton(String text, Icon icon)

Creates a toggle button that has the specified text and image, and that is initially unselected.

Parameters

text:String: the string displayed on the button
icon:Icon: the image that the button should display

JToggleButton	back to summary
public JToggleButton(String text, Icon icon, boolean selected) Creates a toggle button with the specified text, image, and selection state. Parameters text:String the text of the toggle button icon:Icon the image that the button should display selected:boolean if true, the button is initially selected; otherwise, the button is initially unselected

JToggleButton

back to summary

public JToggleButton(String text, Icon icon, boolean selected)

Creates a toggle button with the specified text, image, and selection state.

Parameters

text:String: the text of the toggle button
icon:Icon: the image that the button should display
selected:boolean: if true, the button is initially selected; otherwise, the button is initially unselected

Method Detail

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JToggleButton. For toggle buttons, the AccessibleContext takes the form of an AccessibleJToggleButton. A new AccessibleJToggleButton instance is created if necessary. Returns:AccessibleContext an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton Annotations @BeanProperty bound:false expert:true description:The AccessibleContext associated with this ToggleButton.

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this JToggleButton. For toggle buttons, the AccessibleContext takes the form of an AccessibleJToggleButton. A new AccessibleJToggleButton instance is created if necessary.

Returns:AccessibleContext

an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton

Annotations

@BeanProperty
bound:false
expert:true
description:The AccessibleContext associated with this ToggleButton.

getGroupSelection	back to summary
private JToggleButton getGroupSelection(FocusEvent.Cause cause)

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns a string that specifies the name of the l&f class that renders this component. Returns:String the string "ToggleButtonUI" Annotations @BeanProperty bound:false description:A string that specifies the name of the L&F class See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Returns a string that specifies the name of the l&f class that renders this component.

Returns:String

the string "ToggleButtonUI"

Annotations

@BeanProperty
bound:false
description:A string that specifies the name of the L&F class

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.AbstractButton.paramString. Returns a string representation of this JToggleButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`. Returns:String a string representation of this JToggleButton.

protected String paramString()

Overrides javax.swing.AbstractButton.paramString.

Returns a string representation of this JToggleButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns:String: a string representation of this JToggleButton.

requestFocus back to summary

requestFocus	back to summary
public void requestFocus(FocusEvent.Cause cause) Overrides java.awt.Component.requestFocus. If this toggle button is a member of the `ButtonGroup` which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling `Component#requestFocus(FocusEvent.Cause)` on the toggle button selected in the group. In all other cases the result of the method is the same as calling `Component#requestFocus(FocusEvent.Cause)` on this toggle button. Parameters cause:FocusEvent.Cause the cause why the focus is requested Annotations @Override Since 9 See Also `ButtonGroup`, `Component#requestFocus(FocusEvent.Cause)`, `FocusEvent.Cause`

public void requestFocus(FocusEvent.Cause cause)

Overrides java.awt.Component.requestFocus.

If this toggle button is a member of the ButtonGroup which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling Component#requestFocus(FocusEvent.Cause) on the toggle button selected in the group. In all other cases the result of the method is the same as calling Component#requestFocus(FocusEvent.Cause) on this toggle button.

Parameters

cause:FocusEvent.Cause: the cause why the focus is requested

Annotations

@Override

Since

requestFocusInWindow back to summary

requestFocusInWindow	back to summary
public boolean requestFocusInWindow(FocusEvent.Cause cause) Overrides java.awt.Component.requestFocusInWindow. If this toggle button is a member of the `ButtonGroup` which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling `Component#requestFocusInWindow(FocusEvent.Cause)` on the toggle button selected in the group. In all other cases the result of the method is the same as calling `Component#requestFocusInWindow(FocusEvent.Cause)` on this toggle button. Parameters cause:FocusEvent.Cause the cause why the focus is requested Returns:boolean Doc from java.awt.Component.requestFocusInWindow. `false` if the focus change request is guaranteed to fail; `true` if it is likely to succeed Since 9 See Also `ButtonGroup`, `Component#requestFocusInWindow(FocusEvent.Cause)`, `FocusEvent.Cause`

public boolean requestFocusInWindow(FocusEvent.Cause cause)

Overrides java.awt.Component.requestFocusInWindow.

If this toggle button is a member of the ButtonGroup which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling Component#requestFocusInWindow(FocusEvent.Cause) on the toggle button selected in the group. In all other cases the result of the method is the same as calling Component#requestFocusInWindow(FocusEvent.Cause) on this toggle button.

Parameters

cause:FocusEvent.Cause: the cause why the focus is requested

Returns:boolean

Doc from java.awt.Component.requestFocusInWindow.

false if the focus change request is guaranteed to fail; true if it is likely to succeed

Since

requestFocusInWindowUnconditionally	back to summary
private boolean requestFocusInWindowUnconditionally(FocusEvent.Cause cause)

requestFocusUnconditionally	back to summary
private void requestFocusUnconditionally(FocusEvent.Cause cause)

shouldUpdateSelectedStateFromAction	back to summary
pack-priv boolean shouldUpdateSelectedStateFromAction() Overrides javax.swing.AbstractButton.shouldUpdateSelectedStateFromAction. Overridden to return true, JToggleButton supports the selected state.

shouldUpdateSelectedStateFromAction

back to summary

pack-priv boolean shouldUpdateSelectedStateFromAction()

Overrides javax.swing.AbstractButton.shouldUpdateSelectedStateFromAction.

Overridden to return true, JToggleButton supports the selected state.

updateUI back to summary

updateUI	back to summary
public void updateUI() Overrides javax.swing.AbstractButton.updateUI. Resets the UI property to a value from the current look and feel. See Also `JComponent#updateUI`

public void updateUI()

Overrides javax.swing.AbstractButton.updateUI.

Resets the UI property to a value from the current look and feel.

See Also: JComponent#updateUI

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Hides javax.swing.JComponent.writeObject. See readObject() and writeObject() in JComponent for more information about serialization in Swing. Parameters s:ObjectOutputStream Doc from javax.swing.JComponent.writeObject. the `ObjectOutputStream` in which to write Annotations @Serial Exceptions IOException: Doc from java.awt.Container.writeObject. if an I/O error occurs

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Parameters

s:ObjectOutputStream

Doc from javax.swing.JComponent.writeObject.

the ObjectOutputStream in which to write

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

javax.swing back to summary

protected Class JToggleButton.AccessibleJToggleButton

Class Inheritance

extends AccessibleAbstractButton
implements ItemListener

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.AbstractButton.AccessibleAbstractButton
javax.swing.JToggleButton.AccessibleJToggleButton

All Implemented Interfaces

java.awt.event.ItemListener, java.util.EventListener

Known Direct Subclasses

javax.swing.JCheckBox.AccessibleJCheckBox, javax.swing.JRadioButton.AccessibleJRadioButton

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the JToggleButton class. It provides an implementation of the Java Accessibility API appropriate to toggle button user-interface elements.

Warning

Constructor Summary

Access	Constructor and Description
public	AccessibleJToggleButton() Constructs `AccessibleJToggleButton`

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object.
public void	itemStateChanged(ItemEvent the event to be processed e) Implements java.awt.event.ItemListener.itemStateChanged. Fire accessible property change events when the state of the toggle button changes.

Constructor Detail

AccessibleJToggleButton	back to summary
public AccessibleJToggleButton() Constructs `AccessibleJToggleButton`

Method Detail

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

itemStateChanged	back to summary
public void itemStateChanged(ItemEvent e) Implements java.awt.event.ItemListener.itemStateChanged. Fire accessible property change events when the state of the toggle button changes. Parameters e:ItemEvent Doc from java.awt.event.ItemListener.itemStateChanged. the event to be processed

itemStateChanged

back to summary

public void itemStateChanged(ItemEvent e)

Implements java.awt.event.ItemListener.itemStateChanged.

Fire accessible property change events when the state of the toggle button changes.

Parameters

e:ItemEvent

Doc from java.awt.event.ItemListener.itemStateChanged.

the event to be processed

javax.swing back to summary

public Class JToggleButton.ToggleButtonModel

Class Inheritance

extends DefaultButtonModel

java.lang.Object
javax.swing.DefaultButtonModel
javax.swing.JToggleButton.ToggleButtonModel

Annotations

@SuppressWarnings:serial

The ToggleButton model

Warning

Field Summary

Inherited from javax.swing.DefaultButtonModel:: actionCommand ARMED changeEvent ENABLED group listenerList mnemonic PRESSED ROLLOVER SELECTED stateMask

Constructor Summary

Access	Constructor and Description
public	ToggleButtonModel() Creates a new ToggleButton Model

Method Summary

Modifier and Type	Method and Description
public boolean	isSelected() Overrides javax.swing.DefaultButtonModel.isSelected. Implements javax.swing.ButtonModel.isSelected. Checks if the button is selected.
public void	setPressed(boolean whether or not the button should be pressed b) Overrides javax.swing.DefaultButtonModel.setPressed. Implements javax.swing.ButtonModel.setPressed. Sets the pressed state of the toggle button.
public void	setSelected(boolean true selects the toggle button, false deselects the toggle button. b) Overrides javax.swing.DefaultButtonModel.setSelected. Implements javax.swing.ButtonModel.setSelected. Sets the selected state of the button.

Constructor Detail

ToggleButtonModel	back to summary
public ToggleButtonModel() Creates a new ToggleButton Model

Method Detail

isSelected back to summary

isSelected	back to summary
public boolean isSelected() Overrides javax.swing.DefaultButtonModel.isSelected. Implements javax.swing.ButtonModel.isSelected. Checks if the button is selected. Returns:boolean Doc from javax.swing.ButtonModel.isSelected. `true` if the button is selected

public boolean isSelected()

Overrides javax.swing.DefaultButtonModel.isSelected.

Implements javax.swing.ButtonModel.isSelected.

Checks if the button is selected.

Returns:boolean

Doc from javax.swing.ButtonModel.isSelected.

true if the button is selected

setPressed	back to summary
public void setPressed(boolean b) Overrides javax.swing.DefaultButtonModel.setPressed. Implements javax.swing.ButtonModel.setPressed. Sets the pressed state of the toggle button. Parameters b:boolean Doc from javax.swing.ButtonModel.setPressed. whether or not the button should be pressed Annotations @SuppressWarnings:deprecation

setPressed

back to summary

public void setPressed(boolean b)

Overrides javax.swing.DefaultButtonModel.setPressed.

Implements javax.swing.ButtonModel.setPressed.

Sets the pressed state of the toggle button.

Parameters

b:boolean

Doc from javax.swing.ButtonModel.setPressed.

whether or not the button should be pressed

Annotations

@SuppressWarnings:deprecation

setSelected	back to summary
public void setSelected(boolean b) Overrides javax.swing.DefaultButtonModel.setSelected. Implements javax.swing.ButtonModel.setSelected. Sets the selected state of the button. Parameters b:boolean true selects the toggle button, false deselects the toggle button.

setSelected

back to summary

public void setSelected(boolean b)

Overrides javax.swing.DefaultButtonModel.setSelected.

Implements javax.swing.ButtonModel.setSelected.

Sets the selected state of the button.

Parameters

b:boolean: true selects the toggle button, false deselects the toggle button.