public class

JCheckBoxMenuItem

extends JMenuItem
implements Accessible SwingConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.AbstractButton
           ↳ javax.swing.JMenuItem
             ↳ javax.swing.JCheckBoxMenuItem

Class Overview

A menu item that can be selected or deselected. If selected, the menu item typically appears with a checkmark next to it. If unselected or deselected, the menu item appears without a checkmark. Like a regular menu item, a check box menu item can have either text or a graphic icon associated with it, or both.

Either isSelected/setSelected or getState/setState can be used to determine/specify the menu item's selection state. The preferred methods are isSelected and setSelected, which work for all menus and buttons. The getState and setState methods exist for compatibility with other component sets.

Menu items can be configured, and to some degree controlled, by Actions. Using an Action with a menu item has many benefits beyond directly configuring a menu item. 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.

For further information and examples of using check box menu items, see How to Use Menus, 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 JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem This class implements accessibility support for the JCheckBoxMenuItem class. 
[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
JCheckBoxMenuItem()
Creates an initially unselected check box menu item with no set text or icon.
JCheckBoxMenuItem(Icon icon)
Creates an initially unselected check box menu item with an icon.
JCheckBoxMenuItem(String text)
Creates an initially unselected check box menu item with text.
JCheckBoxMenuItem(Action a)
Creates a menu item whose properties are taken from the Action supplied.
JCheckBoxMenuItem(String text, Icon icon)
Creates an initially unselected check box menu item with the specified text and icon.
JCheckBoxMenuItem(String text, boolean b)
Creates a check box menu item with the specified text and selection state.
JCheckBoxMenuItem(String text, Icon icon, boolean b)
Creates a check box menu item with the specified text, icon, and selection state.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JCheckBoxMenuItem.
Object[] getSelectedObjects()
Returns an array (length 1) containing the check box menu item label or null if the check box is not selected.
boolean getState()
Returns the selected-state of the item.
String getUIClassID()
Returns the name of the L&F class that renders this component.
synchronized void setState(boolean b)
Sets the selected-state of the item.
Protected Methods
String paramString()
Returns a string representation of this JCheckBoxMenuItem.
[Expand]
Inherited Methods
From class javax.swing.JMenuItem
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
From interface javax.swing.MenuElement

Public Constructors

public JCheckBoxMenuItem ()

Creates an initially unselected check box menu item with no set text or icon.

public JCheckBoxMenuItem (Icon icon)

Creates an initially unselected check box menu item with an icon.

Parameters
icon the icon of the CheckBoxMenuItem.

public JCheckBoxMenuItem (String text)

Creates an initially unselected check box menu item with text.

Parameters
text the text of the CheckBoxMenuItem

public JCheckBoxMenuItem (Action a)

Creates a menu item whose properties are taken from the Action supplied.

public JCheckBoxMenuItem (String text, Icon icon)

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

Parameters
text the text of the CheckBoxMenuItem
icon the icon of the CheckBoxMenuItem

public JCheckBoxMenuItem (String text, boolean b)

Creates a check box menu item with the specified text and selection state.

Parameters
text the text of the check box menu item.
b the selected state of the check box menu item

public JCheckBoxMenuItem (String text, Icon icon, boolean b)

Creates a check box menu item with the specified text, icon, and selection state.

Parameters
text the text of the check box menu item
icon the icon of the check box menu item
b the selected state of the check box menu item

Public Methods

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this JCheckBoxMenuItem. For JCheckBoxMenuItems, the AccessibleContext takes the form of an AccessibleJCheckBoxMenuItem. A new AccessibleJCheckBoxMenuItem instance is created if necessary.

Returns
  • an AccessibleJCheckBoxMenuItem that serves as the AccessibleContext of this AccessibleJCheckBoxMenuItem

public Object[] getSelectedObjects ()

Returns an array (length 1) containing the check box menu item label or null if the check box is not selected.

Returns
  • an array containing one Object -- the text of the menu item -- if the item is selected; otherwise null

public boolean getState ()

Returns the selected-state of the item. This method exists for AWT compatibility only. New code should use isSelected() instead.

Returns
  • true if the item is selected

public String getUIClassID ()

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

Returns
  • "CheckBoxMenuItemUI"

public synchronized void setState (boolean b)

Sets the selected-state of the item. This method exists for AWT compatibility only. New code should use setSelected() instead.

Parameters
b a boolean value indicating the item's selected-state, where true=selected

Protected Methods

protected String paramString ()

Returns a string representation of this JCheckBoxMenuItem. 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 JCheckBoxMenuItem.