Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.awt
Class CheckboxMenuItem  view CheckboxMenuItem download CheckboxMenuItem.java

java.lang.Object
  extended byjava.awt.MenuComponent
      extended byjava.awt.MenuItem
          extended byjava.awt.CheckboxMenuItem
All Implemented Interfaces:
javax.accessibility.Accessible, ItemSelectable, java.io.Serializable

public class CheckboxMenuItem
extends MenuItem
implements ItemSelectable, javax.accessibility.Accessible

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


Nested Class Summary
protected  class CheckboxMenuItem.AccessibleAWTCheckboxMenuItem
           
 
Nested classes inherited from class java.awt.MenuItem
MenuItem.AccessibleAWTMenuItem
 
Nested classes inherited from class java.awt.MenuComponent
MenuComponent.AccessibleAWTMenuComponent
 
Field Summary
private  java.awt.event.ItemListener item_listeners
           
private static long serialVersionUID
           
private  boolean state
           
 
Fields inherited from class java.awt.MenuItem
actionCommand, enabled, eventMask, label
 
Fields inherited from class java.awt.MenuComponent
accessibleContext, focusListener, parent, peer
 
Constructor Summary
CheckboxMenuItem()
          Initializes a new instance of CheckboxMenuItem with no label and an initial state of off.
CheckboxMenuItem(java.lang.String label)
          Initializes a new instance of CheckboxMenuItem with the specified label and an initial state of off.
CheckboxMenuItem(java.lang.String label, boolean state)
          Initializes a new instance of CheckboxMenuItem with the specified label and initial state.
 
Method Summary
 void addItemListener(java.awt.event.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
(package private)  void dispatchEventImpl(AWTEvent e)
          Implementation of dispatchEvent.
 javax.accessibility.AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this CheckboxMenuItem.
 java.awt.event.ItemListener[] getItemListeners()
          Returns an aray of all item listeners currently registered to this CheckBoxMenuItem.
 java.util.EventListener[] getListeners(java.lang.Class listenerType)
          Returns an array of all the objects currently registered as FooListeners upon this CheckboxMenuItem.
 java.lang.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.
 java.lang.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(java.awt.event.ItemEvent event)
          Processes the specified event by dispatching it to any registered listeners.
 void removeItemListener(java.awt.event.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, getToolkit, getTreeLock, postEvent, removeNotify, setFont, setName, setParent, setPeer, setTreeLock, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

state

private boolean state

item_listeners

private transient java.awt.event.ItemListener item_listeners
Constructor Detail

CheckboxMenuItem

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


CheckboxMenuItem

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


CheckboxMenuItem

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

Method Detail

getState

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


setState

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


getSelectedObjects

public java.lang.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

addNotify

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

Overrides:
addNotify in class MenuItem

addItemListener

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

Specified by:
addItemListener in interface ItemSelectable

removeItemListener

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

Specified by:
removeItemListener in interface ItemSelectable

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

processItemEvent

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


dispatchEventImpl

void dispatchEventImpl(AWTEvent e)
Description copied from class: MenuComponent
Implementation of dispatchEvent. Allows trusted package classes to dispatch additional events first. This implementation first translates event to an AWT 1.0 event and sends the result to MenuComponent.postEvent(java.awt.Event) 55 . The event is then passed on to MenuComponent.processEvent(java.awt.AWTEvent) 55 for local processing.

Overrides:
dispatchEventImpl in class MenuItem

paramString

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

Overrides:
paramString in class MenuItem

getListeners

public java.util.EventListener[] getListeners(java.lang.Class 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

getItemListeners

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


getAccessibleContext

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

Specified by:
getAccessibleContext in interface javax.accessibility.Accessible
Overrides:
getAccessibleContext in class MenuItem