java.awt
Class MenuItem

java.lang.Object
  extended by java.awt.MenuComponent
      extended by java.awt.MenuItem
All Implemented Interfaces:
Serializable, Accessible
Direct Known Subclasses:
CheckboxMenuItem, Menu

public class MenuItem
extends MenuComponent
implements Serializable, Accessible

This class represents an item in a menu.

See Also:
Serialized Form

Nested Class Summary
protected  class MenuItem.AccessibleAWTMenuItem
           
 
Nested classes/interfaces inherited from class java.awt.MenuComponent
MenuComponent.AccessibleAWTMenuComponent
 
Constructor Summary
MenuItem()
          Initializes a new instance of MenuItem with no label and no shortcut.
MenuItem(String label)
          Initializes a new instance of MenuItem with the specified label and no shortcut.
MenuItem(String label, MenuShortcut shortcut)
          Initializes a new instance of MenuItem with the specified label and shortcut.
 
Method Summary
 void addActionListener(ActionListener listener)
          Adds the specified listener to the list of registered action listeners for this component.
 void addNotify()
          Creates the native peer for this object.
 void deleteShortcut()
          Deletes the shortcut for this menu item if one exists.
 void disable()
          Deprecated. This method is deprecated in favor of setEnabled().
protected  void disableEvents(long events)
          Disables the specified events.
 void enable()
          Deprecated. This method is deprecated in favor of setEnabled().
 void enable(boolean enabled)
          Deprecated. This method is deprecated in favor of setEnabled().
protected  void enableEvents(long events)
          Enables the specified events.
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this MenuItem.
 String getActionCommand()
          Returns the name of the action command in the action events generated by this menu item.
 ActionListener[] getActionListeners()
           
 String getLabel()
          Returns the label for this menu item, which may be null.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          Returns all registered EventListers of the given listenerType.
 MenuShortcut getShortcut()
          Returns the shortcut for this menu item, which may be null.
 boolean isEnabled()
          Tests whether or not this menu item is enabled.
 String paramString()
          Returns a debugging string for this object.
protected  void processActionEvent(ActionEvent event)
          Processes the specified event by dispatching it to any registered listeners.
protected  void processEvent(AWTEvent event)
          Processes the specified event by calling processActionEvent() if it is an instance of ActionEvent.
 void removeActionListener(ActionListener l)
           
 void setActionCommand(String actionCommand)
          Sets the name of the action command in the action events generated by this menu item.
 void setEnabled(boolean enabled)
          Sets the enabled status of this menu item.
 void setLabel(String label)
          This method sets the label for this menu to the specified value.
 void setShortcut(MenuShortcut shortcut)
          Sets the shortcut for this menu item to the specified value.
 
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

MenuItem

public MenuItem()
Initializes a new instance of MenuItem with no label and no shortcut.


MenuItem

public MenuItem(String label)
Initializes a new instance of MenuItem with the specified label and no shortcut.

Parameters:
label - The label for this menu item.

MenuItem

public MenuItem(String label,
                MenuShortcut shortcut)
Initializes a new instance of MenuItem with the specified label and shortcut.

Parameters:
label - The label for this menu item.
shortcut - The shortcut for this menu item.
Method Detail

getLabel

public String getLabel()
Returns the label for this menu item, which may be null.

Returns:
The label for this menu item.

setLabel

public void setLabel(String label)
This method sets the label for this menu to the specified value.

Parameters:
label - The new label for this menu item.

isEnabled

public boolean isEnabled()
Tests whether or not this menu item is enabled.

Returns:
true if this menu item is enabled, false otherwise.

setEnabled

public void setEnabled(boolean enabled)
Sets the enabled status of this menu item.

Parameters:
enabled - true to enable this menu item, false otherwise.

enable

public void enable(boolean enabled)
Deprecated. This method is deprecated in favor of setEnabled().

Sets the enabled status of this menu item.

Parameters:
enabled - true to enable this menu item, false otherwise.

enable

public void enable()
Deprecated. This method is deprecated in favor of setEnabled().

Enables this menu item.


disable

public void disable()
Deprecated. This method is deprecated in favor of setEnabled().

Disables this menu item.


getShortcut

public MenuShortcut getShortcut()
Returns the shortcut for this menu item, which may be null.

Returns:
The shortcut for this menu item.

setShortcut

public void setShortcut(MenuShortcut shortcut)
Sets the shortcut for this menu item to the specified value. This must be done before the native peer is created.

Parameters:
shortcut - The new shortcut for this menu item.

deleteShortcut

public void deleteShortcut()
Deletes the shortcut for this menu item if one exists. This must be done before the native peer is created.


getActionCommand

public String getActionCommand()
Returns the name of the action command in the action events generated by this menu item.

Returns:
The action command name

setActionCommand

public void setActionCommand(String actionCommand)
Sets the name of the action command in the action events generated by this menu item.

Parameters:
actionCommand - The new action command name.

enableEvents

protected final void enableEvents(long events)
Enables the specified events. This is done automatically when a listener is added and does not normally need to be done by application code.

Parameters:
events - The events to enable, which should be the bit masks from AWTEvent.

disableEvents

protected final void disableEvents(long events)
Disables the specified events.

Parameters:
events - The events to enable, which should be the bit masks from AWTEvent.

addNotify

public void addNotify()
Creates the native peer for this object.


addActionListener

public void addActionListener(ActionListener listener)
Adds the specified listener to the list of registered action listeners for this component.

Parameters:
listener - The listener to add.

removeActionListener

public void removeActionListener(ActionListener l)

getActionListeners

public ActionListener[] getActionListeners()

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns all registered EventListers of the given listenerType. listenerType must be a subclass of EventListener, or a ClassClassException is thrown.

Since:
1.3

processEvent

protected void processEvent(AWTEvent event)
Processes the specified event by calling processActionEvent() if it is an instance of ActionEvent.

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

processActionEvent

protected void processActionEvent(ActionEvent 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 MenuComponent
Returns:
A debugging string for this object.

getAccessibleContext

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

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