Module java.desktop
Package javax.swing

Class JCheckBox

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.AbstractButton
javax.swing.JToggleButton
javax.swing.JCheckBox
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
@JavaBean(description="A component which can be selected or deselected.")
public class JCheckBox
extends JToggleButton
implements Accessible
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 JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
See Also:
JRadioButton

  • Field Details

  • Constructor Details

    • JCheckBox

      public JCheckBox()
      Creates an initially unselected check box button with no text, no icon.

    • JCheckBox

      public JCheckBox​(Icon icon)
      Creates an initially unselected check box with an icon.
      Parameters:
      icon - the Icon image to display

    • JCheckBox

      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

    • JCheckBox

      public JCheckBox​(String text)
      Creates an initially unselected check box with text.
      Parameters:
      text - the text of the check box.

    • JCheckBox

      public JCheckBox​(Action a)
      Creates a check box where properties are taken from the Action supplied.
      Parameters:
      a - the Action used to specify the new check box
      Since:
      1.3

    • JCheckBox

      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

    • JCheckBox

      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

    • JCheckBox

      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

  • Method Details

    • setBorderPaintedFlat

      @BeanProperty(visualUpdate=true, description="Whether the border is painted flat.") 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
      Since:
      1.3
      See Also:
      isBorderPaintedFlat()

    • isBorderPaintedFlat

      public boolean isBorderPaintedFlat()
      Gets the value of the borderPaintedFlat property.
      Returns:
      the value of the borderPaintedFlat property
      Since:
      1.3
      See Also:
      setBorderPaintedFlat(boolean)

    • updateUI

      public void updateUI()
      Resets the UI property to a value from the current look and feel.
      Overrides:
      updateUI in class JToggleButton
      See Also:
      JComponent.updateUI()

    • getUIClassID

      @BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class") public String getUIClassID()
      Returns a string that specifies the name of the L&F class that renders this component.
      Overrides:
      getUIClassID in class JToggleButton
      Returns:
      the string "CheckBoxUI"
      See Also:
      JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

    • paramString

      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.
      Overrides:
      paramString in class JToggleButton
      Returns:
      a string representation of this JCheckBox.

    • getAccessibleContext

      @BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this CheckBox.") 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.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class JToggleButton
      Returns:
      an AccessibleJCheckBox that serves as the AccessibleContext of this JCheckBox