java.awt

Class MenuItem

public class MenuItem extends MenuComponent implements Serializable, Accessible

This class represents an item in a menu.
Nested Class Summary
protected classMenuItem.AccessibleAWTMenuItem
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
voidaddActionListener(ActionListener listener)
Adds the specified listener to the list of registered action listeners for this component.
voidaddNotify()
Creates the native peer for this object.
voiddeleteShortcut()
Deletes the shortcut for this menu item if one exists.
voiddisable()
Disables this menu item.
protected voiddisableEvents(long events)
Disables the specified events.
voidenable(boolean enabled)
Sets the enabled status of this menu item.
voidenable()
Enables this menu item.
protected voidenableEvents(long events)
Enables the specified events.
AccessibleContextgetAccessibleContext()
Gets the AccessibleContext associated with this MenuItem.
StringgetActionCommand()
Returns the name of the action command in the action events generated by this menu item.
ActionListener[]getActionListeners()
StringgetLabel()
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. listenerType must be a subclass of EventListener, or a ClassClassException is thrown.
MenuShortcutgetShortcut()
Returns the shortcut for this menu item, which may be null.
booleanisEnabled()
Tests whether or not this menu item is enabled.
StringparamString()
Returns a debugging string for this object.
protected voidprocessActionEvent(ActionEvent event)
Processes the specified event by dispatching it to any registered listeners.
protected voidprocessEvent(AWTEvent event)
Processes the specified event by calling processActionEvent() if it is an instance of ActionEvent.
voidremoveActionListener(ActionListener l)
voidsetActionCommand(String actionCommand)
Sets the name of the action command in the action events generated by this menu item.
voidsetEnabled(boolean enabled)
Sets the enabled status of this menu item.
voidsetLabel(String label)
This method sets the label for this menu to the specified value.
voidsetShortcut(MenuShortcut shortcut)
Sets the shortcut for this menu item to the specified value.

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

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.

addNotify

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

deleteShortcut

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

disable

public void disable()

Deprecated: This method is deprecated in favor of setEnabled().

Disables this menu item.

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.

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.

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.

getAccessibleContext

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

Returns: the associated context

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

getActionListeners

public ActionListener[] getActionListeners()

getLabel

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

Returns: The label for this menu item.

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

getShortcut

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

Returns: The shortcut 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.

paramString

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

Returns: A debugging string for this object.

processActionEvent

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

Parameters: event The event to process.

processEvent

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

Parameters: event The event to process.

removeActionListener

public void removeActionListener(ActionListener l)

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.

setEnabled

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

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

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.

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.