Module java.desktop
Package javax.swing

Class JToggleButton

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.AbstractButton
javax.swing.JToggleButton
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
JCheckBox, JRadioButton
@JavaBean(defaultProperty="UIClassID",
          description="An implementation of a two-state button.")
public class JToggleButton
extends AbstractButton
implements Accessible
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 XMLEncoder.

Since:
1.2
See Also:
JRadioButton, JCheckBox

  • Constructor Details

    • JToggleButton

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

    • JToggleButton

      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

    • JToggleButton

      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

    • JToggleButton

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

    • JToggleButton

      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

    • JToggleButton

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

    • JToggleButton

      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

    • JToggleButton

      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

  • Method Details