java.awt
Class CheckboxMenuItem

java.lang.Object
  extended by java.awt.MenuComponent
      extended by java.awt.MenuItem
          extended by java.awt.CheckboxMenuItem
All Implemented Interfaces:
ItemSelectable, Serializable, Accessible

public class CheckboxMenuItem
extends MenuItem
implements ItemSelectable, Accessible

This class implements a menu item that has a checkbox on it indicating the selected state of some option.

See Also:
Serialized Form

Nested Class Summary
protected  class CheckboxMenuItem.AccessibleAWTCheckboxMenuItem
           
 
Nested classes/interfaces inherited from class java.awt.MenuItem
MenuItem.AccessibleAWTMenuItem
 
Nested classes/interfaces inherited from class java.awt.MenuComponent
MenuComponent.AccessibleAWTMenuComponent
 
Constructor Summary
CheckboxMenuItem()
          Initializes a new instance of CheckboxMenuItem with no label and an initial state of off.
CheckboxMenuItem(String label)
          Initializes a new instance of CheckboxMenuItem with the specified label and an initial state of off.
CheckboxMenuItem(String label, boolean state)
          Initializes a new instance of CheckboxMenuItem with the specified label and initial state.
 
Method Summary
 void addItemListener(ItemListener listener)
          Adds the specified listener to the list of registered item listeners for this object.
 void addNotify()
          Create's this object's native peer
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this CheckboxMenuItem.
 ItemListener[] getItemListeners()
          Returns an aray of all item listeners currently registered to this CheckBoxMenuItem.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem.
 Object[] getSelectedObjects()
          Returns an array of length 1 with the menu item label for this object if the state is on.
 boolean getState()
          Returns the state of this menu item.
 String paramString()
          Returns a debugging string for this object.
protected  void processEvent(AWTEvent event)
          Processes the specified event by calling processItemEvent() if it is an instance of ItemEvent or calling the superclass method otherwise.
protected  void processItemEvent(ItemEvent event)
          Processes the specified event by dispatching it to any registered listeners.
 void removeItemListener(ItemListener listener)
          Removes the specified listener from the list of registered item listeners for this object.
 void setState(boolean state)
          Sets the state of this menu item.
 
Methods inherited from class java.awt.MenuItem
addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, processActionEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut
 
Methods inherited from class java.awt.MenuComponent
dispatchEvent, getFont, getName, getParent, getPeer, getTreeLock, postEvent, removeNotify, setFont, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckboxMenuItem

public CheckboxMenuItem()
Initializes a new instance of CheckboxMenuItem with no label and an initial state of off.

Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

CheckboxMenuItem

public CheckboxMenuItem(String label)
Initializes a new instance of CheckboxMenuItem with the specified label and an initial state of off.

Parameters:
label - The label of the menu item.
Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

CheckboxMenuItem

public CheckboxMenuItem(String label,
                        boolean state)
Initializes a new instance of CheckboxMenuItem with the specified label and initial state.

Parameters:
label - The label of the menu item.
state - The initial state of the menu item, where true is on, and false is off.
Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() returns true.
Method Detail

getState

public boolean getState()
Returns the state of this menu item.

Returns:
The state of this menu item.

setState

public void setState(boolean state)
Sets the state of this menu item.

Parameters:
state - The initial state of the menu item, where true is on, and false is off.

getSelectedObjects

public Object[] getSelectedObjects()
Returns an array of length 1 with the menu item label for this object if the state is on. Otherwise null is returned.

Specified by:
getSelectedObjects in interface ItemSelectable
Returns:
An array with this menu item's label if it has a state of on, or null otherwise.

addNotify

public void addNotify()
Create's this object's native peer

Overrides:
addNotify in class MenuItem

addItemListener

public void addItemListener(ItemListener listener)
Adds the specified listener to the list of registered item listeners for this object.

Specified by:
addItemListener in interface ItemSelectable
Parameters:
listener - The listener to add.

removeItemListener

public void removeItemListener(ItemListener listener)
Removes the specified listener from the list of registered item listeners for this object.

Specified by:
removeItemListener in interface ItemSelectable
Parameters:
listener - The listener to remove.

processEvent

protected void processEvent(AWTEvent event)
Processes the specified event by calling processItemEvent() if it is an instance of ItemEvent or calling the superclass method otherwise.

Overrides:
processEvent in class MenuItem
Parameters:
event - The event to process.

processItemEvent

protected void processItemEvent(ItemEvent event)
Processes the specified event by dispatching it to any registered listeners.

Parameters:
event - The event to process.

paramString

public String paramString()
Returns a debugging string for this object.

Overrides:
paramString in class MenuItem
Returns:
A debugging string for this object.

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem. FooListeners are registered using the addFooListener method.

Overrides:
getListeners in class MenuItem
Throws:
ClassCastException - If listenerType doesn't specify a class or interface that implements java.util.EventListener.

getItemListeners

public ItemListener[] getItemListeners()
Returns an aray of all item listeners currently registered to this CheckBoxMenuItem.


getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this CheckboxMenuItem. The context is created, if necessary.

Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class MenuItem
Returns:
the associated context