public class

JCheckBox

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

Class Overview

An implementation of a check box -- an item that can be selected or deselected, and which displays its state to the user. By convention, any number of check boxes in a group can be selected. See How to Use Buttons, Check Boxes, and Radio Buttons in The Java Tutorial for examples and information on using check boxes.

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.

See Also

Summary

Nested Classes
class JCheckBox.AccessibleJCheckBox This class implements accessibility support for the JCheckBox class. 
Constants
String BORDER_PAINTED_FLAT_CHANGED_PROPERTY Identifies a change to the flat property.
[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
JCheckBox()
Creates an initially unselected check box button with no text, no icon.
JCheckBox(Icon icon)
Creates an initially unselected check box with an icon.
JCheckBox(Icon icon, boolean selected)
Creates a check box with an icon and specifies whether or not it is initially selected.
JCheckBox(String text)
Creates an initially unselected check box with text.
JCheckBox(Action a)
Creates a check box where properties are taken from the Action supplied.
JCheckBox(String text, boolean selected)
Creates a check box with text and specifies whether or not it is initially selected.
JCheckBox(String text, Icon icon)
Creates an initially unselected check box with the specified text and icon.
JCheckBox(String text, Icon icon, boolean selected)
Creates a check box with text and icon, and specifies whether or not it is initially selected.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JCheckBox.
String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.
boolean isBorderPaintedFlat()
Gets the value of the borderPaintedFlat property.
void setBorderPaintedFlat(boolean b)
Sets the borderPaintedFlat property, which gives a hint to the look and feel as to the appearance of the check box border.
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 JCheckBox.
[Expand]
Inherited Methods
From class javax.swing.JToggleButton
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

Constants

public static final String BORDER_PAINTED_FLAT_CHANGED_PROPERTY

Identifies a change to the flat property.

Constant Value: "borderPaintedFlat"

Public Constructors

public JCheckBox ()

Creates an initially unselected check box button with no text, no icon.

public JCheckBox (Icon icon)

Creates an initially unselected check box with an icon.

Parameters
icon the Icon image to display

public JCheckBox (Icon icon, boolean selected)

Creates a check box with an icon and specifies whether or not it is initially selected.

Parameters
icon the Icon image to display
selected a boolean value indicating the initial selection state. If true the check box is selected

public JCheckBox (String text)

Creates an initially unselected check box with text.

Parameters
text the text of the check box.

public JCheckBox (Action a)

Creates a check box where properties are taken from the Action supplied.

public JCheckBox (String text, boolean selected)

Creates a check box with text and specifies whether or not it is initially selected.

Parameters
text the text of the check box.
selected a boolean value indicating the initial selection state. If true the check box is selected

public JCheckBox (String text, Icon icon)

Creates an initially unselected check box with the specified text and icon.

Parameters
text the text of the check box.
icon the Icon image to display

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

Creates a check box with text and icon, and specifies whether or not it is initially selected.

Parameters
text the text of the check box.
icon the Icon image to display
selected a boolean value indicating the initial selection state. If true the check box is selected

Public Methods

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this JCheckBox. For JCheckBoxes, the AccessibleContext takes the form of an AccessibleJCheckBox. A new AccessibleJCheckBox instance is created if necessary.

Returns
  • an AccessibleJCheckBox that serves as the AccessibleContext of this JCheckBox

public String getUIClassID ()

Returns a string that specifies the name of the L&F class that renders this component.

Returns
  • the string "CheckBoxUI"

public boolean isBorderPaintedFlat ()

Gets the value of the borderPaintedFlat property.

Returns
  • the value of the borderPaintedFlat property

public void setBorderPaintedFlat (boolean b)

Sets the borderPaintedFlat property, which gives a hint to the look and feel as to the appearance of the check box border. This is usually set to true when a JCheckBox instance is used as a renderer in a component such as a JTable or JTree. The default value for the borderPaintedFlat property is false. This method fires a property changed event. Some look and feels might not implement flat borders; they will ignore this property.

Parameters
b true requests that the border be painted flat; false requests normal borders

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 JCheckBox. 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. specific new aspects of the JFC components.

Returns
  • a string representation of this JCheckBox.