java.awt
Class CheckboxMenuItem

java.lang.Object
  |
  +--java.awt.MenuComponent
        |
        +--java.awt.MenuItem
              |
              +--java.awt.CheckboxMenuItem
All Implemented Interfaces:
Accessible, ItemSelectable, Serializable
public class CheckboxMenuItem
extends MenuItem
implements ItemSelectable, Accessible

check box that can be included in a menu. Selecting the check box in the menu changes its state from "on" to "off" or from "off" to "on."

The following picture depicts a menu which contains an instance of CheckBoxMenuItem:

The item labeled Check shows a check box menu item in its "off" state.

When a check box menu item is selected, AWT sends an item event to the item. Since the event is an instance of ItemEvent, the processEvent method examines the event and passes it along to processItemEvent. The latter method redirects the event to any ItemListener objects that have registered an interest in item events generated by this menu item.

Since:
JDK1.0
See Also:
ItemEvent, ItemListener, Serialized Form

 

Nested Class Summary

protected  class CheckboxMenuItem.AccessibleAWTCheckboxMenuItem
    Inner class of CheckboxMenuItem used to provide default support for accessibility.
 
Nested classes inherited from class java.awt.MenuItem
 
Nested classes inherited from class java.awt.MenuComponent
 

 

Constructor Summary

CheckboxMenuItem()
    Create a check box menu item with an empty label.
CheckboxMenuItem(String label)
    Create a check box menu item with the specified label.
CheckboxMenuItem(String label, boolean state)
    Create a check box menu item with the specified label and state.
 

 

Method Summary

 void addItemListener(ItemListener l)
    Adds the specified item listener to receive item events from this check box menu item.
 void addNotify()
    Creates the peer of the checkbox item.
 AccessibleContext getAccessibleContext()
    Gets the AccessibleContext associated with this CheckboxMenuItem.
 ItemListener[] getItemListeners()
    Returns an array of all the item listeners registered on this checkbox menuitem.
 EventListener[] getListeners(Class listenerType)
    Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem.
 Object[] getSelectedObjects()
    Returns the an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
 boolean getState()
    Determines whether the state of this check box menu item is "on" or "off."
 String paramString()
    Returns a string representing the state of this CheckBoxMenuItem.
protected  void processEvent(AWTEvent e)
    Processes events on this check box menu item.
protected  void processItemEvent(ItemEvent e)
    Processes item events occurring on this check box menu item by dispatching them to any registered ItemListener objects.
 void removeItemListener(ItemListener l)
    Removes the specified item listener so that it no longer receives item events from this check box menu item.
 void setState(boolean b)
    Sets this check box menu item to the specifed state.
 
Methods inherited from class java.awt.MenuItem
addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, processAc