public class

JToggleButton

extends AbstractButton
implements Accessible
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.AbstractButton
           ↳ javax.swing.JToggleButton
Known Direct Subclasses

Class Overview

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class JToggleButton.AccessibleJToggleButton This class implements accessibility support for the JToggleButton class. 
class JToggleButton.ToggleButtonModel The ToggleButton model

Warning: Serialized objects of this class will not be compatible with future Swing releases. 

[Expand]
Inherited Constants
From class javax.swing.AbstractButton
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.SwingConstants
[Expand]
Inherited Fields
From class javax.swing.AbstractButton
From class javax.swing.JComponent
Public Constructors
JToggleButton()
Creates an initially unselected toggle button without setting the text or image.
JToggleButton(Icon icon)
Creates an initially unselected toggle button with the specified image but no text.
JToggleButton(Icon icon, boolean selected)
Creates a toggle button with the specified image and selection state, but no text.
JToggleButton(String text)
Creates an unselected toggle button with the specified text.
JToggleButton(String text, boolean selected)
Creates a toggle button with the specified text and selection state.
JToggleButton(Action a)
Creates a toggle button where properties are taken from the Action supplied.
JToggleButton(String text, Icon icon)
Creates a toggle button that has the specified text and image, and that is initially unselected.
JToggleButton(String text, Icon icon, boolean selected)
Creates a toggle button with the specified text, image, and selection state.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JToggleButton.
String getUIClassID()
Returns a string that specifies the name of the l&f class that renders this component.
void updateUI()
Resets the UI property to a value from the current look and feel.
Protected Methods
String paramString()
Returns a string representation of this JToggleButton.
[Expand]
Inherited Methods
From class javax.swing.AbstractButton
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.ItemSelectable
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible

Public Constructors

public JToggleButton ()

Creates an initially unselected toggle button without setting the text or image.

public JToggleButton (Icon icon)

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

Parameters
icon the image that the button should display

public JToggleButton (Icon icon, boolean selected)

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

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

public JToggleButton (String text)

Creates an unselected toggle button with the specified text.

Parameters
text the string displayed on the toggle button

public JToggleButton (String text, boolean selected)

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

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

public JToggleButton (Action a)

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

public JToggleButton (String text, Icon icon)

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

Parameters
text the string displayed on the button
icon the image that the button should display

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

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

Parameters
text the text of the toggle button
icon the image that the button should display
selected if true, the button is initially selected; otherwise, the button is initially unselected

Public Methods

public AccessibleContext 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
  • an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton

public String getUIClassID ()

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

Returns
  • String "ToggleButtonUI"

public void updateUI ()

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

See Also

Protected Methods

protected String 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
  • a string representation of this JToggleButton.