java.lang.Object
- java.awt.MenuComponent
- - java.awt.MenuItem

All Implemented Interfaces:

java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

CheckboxMenuItem, Menu

public class MenuItem extends MenuComponent implements javax.accessibility.Accessible

All items in a menu must belong to the class MenuItem, or one of its subclasses.
The default MenuItem object embodies a simple labeled menu item.
This picture of a menu bar shows five menu items:
The first two items are simple menu items, labeled "Basic" and "Simple". Following these two items is a separator, which is itself a menu item, created with the label "-". Next is an instance of CheckboxMenuItem labeled "Check". The final menu item is a submenu labeled "More Examples", and this submenu is an instance of Menu.
When a menu item is selected, AWT sends an action event to the menu item. Since the event is an instance of ActionEvent, the processEvent method examines the event and passes it along to processActionEvent. The latter method redirects the event to any ActionListener objects that have registered an interest in action events generated by this menu item.
Note that the subclass Menu overrides this behavior and does not send any event to the frame until one of its subitems is selected.

See Also:
Serialized Form

Nested Classes
	Modifier and Type	Class and Description
	AccessibleAWTMenuComponent	`protected class` AccessibleAWTMenuComponent Inner class of `MenuComponent` used to provide default support for accessibility. `protected class` AccessibleAWTMenuComponent Inner class of `MenuComponent` used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by menu component developers. The class used to obtain the accessible role for this object. Since: 1.3 See Also: Serialized Form
	AccessibleAWTMenuItem	`protected class` AccessibleAWTMenuItem Inner class of MenuItem used to provide default support for accessibility. `protected class` AccessibleAWTMenuItem Inner class of MenuItem used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by menu component developers. This class implements accessibility support for the `MenuItem` class. It provides an implementation of the Java Accessibility API appropriate to menu item user-interface elements. Since: 1.3 See Also: Serialized Form

Constructors
	Constructor and Description
	MenuItem	MenuItem() Constructs a new MenuItem with an empty label and no keyboard shortcut. public MenuItem() throws HeadlessException Constructs a new MenuItem with an empty label and no keyboard shortcut. Throws: `HeadlessException` - if GraphicsEnvironment.isHeadless() returns true. Since: JDK1.1 See Also: `GraphicsEnvironment.isHeadless()`
	MenuItem	MenuItem(java.lang.String label) Constructs a new MenuItem with the specified label and no keyboard shortcut. public MenuItem(java.lang.String label) throws HeadlessException Constructs a new MenuItem with the specified label and no keyboard shortcut. Note that use of "-" in a label is reserved to indicate a separator between menu items. By default, all menu items except for separators are enabled. Parameters: `label` - the label for this menu item. Throws: `HeadlessException` - if GraphicsEnvironment.isHeadless() returns true. Since: JDK1.0 See Also: `GraphicsEnvironment.isHeadless()`
	MenuItem	MenuItem(java.lang.String label, MenuShortcut s) Create a menu item with an associated keyboard shortcut. public MenuItem(java.lang.String label, MenuShortcut s) throws HeadlessException Create a menu item with an associated keyboard shortcut. Note that use of "-" in a label is reserved to indicate a separator between menu items. By default, all menu items except for separators are enabled. Parameters: `label` - the label for this menu item. `s` - the instance of `MenuShortcut` associated with this menu item. Throws: `HeadlessException` - if GraphicsEnvironment.isHeadless() returns true. Since: JDK1.1 See Also: `GraphicsEnvironment.isHeadless()`

Methods
	Modifier and Type	Method and Description
	addActionListener	`void` addActionListener(ActionListener l) Adds the specified action listener to receive action events from this menu item. public void addActionListener(ActionListener l) Adds the specified action listener to receive action events from this menu item. If l is null, no exception is thrown and no action is performed. Refer to AWT Threading Issues for details on AWT's threading model. Parameters: `l` - the action listener. Since: JDK1.1 See Also: `removeActionListener(java.awt.event.ActionListener)`, `getActionListeners()`, `ActionEvent`, `ActionListener`
	addNotify	`void` addNotify() Creates the menu item's peer. public void addNotify() Creates the menu item's peer. The peer allows us to modify the appearance of the menu item without changing its functionality.
	deleteShortcut	`void` deleteShortcut() Delete any `MenuShortcut` object associated with this menu item. public void deleteShortcut() Delete any `MenuShortcut` object associated with this menu item. Since: JDK1.1
	disable	`void` disable() Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`. @Deprecated public void disable() Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
	disableEvents	`protected void` disableEvents(long eventsToDisable) Disables event delivery to this menu item for events defined by the specified event mask parameter. protected final void disableEvents(long eventsToDisable) Disables event delivery to this menu item for events defined by the specified event mask parameter. Parameters: `eventsToDisable` - the event mask defining the event types Since: JDK1.1 See Also: `processEvent(java.awt.AWTEvent)`, `enableEvents(long)`, `Component.disableEvents(long)`
	dispatchEvent	`void` dispatchEvent(AWTEvent e) Delivers an event to this component or one of its sub components. public final void dispatchEvent(AWTEvent e) Description copied from class: `MenuComponent` Delivers an event to this component or one of its sub components. Parameters: `e` - the event
	enable	`void` enable() Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`. @Deprecated public void enable() Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
	enable	`void` enable(boolean b) Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`. @Deprecated public void enable(boolean b) Deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
	enableEvents	`protected void` enableEvents(long eventsToEnable) Enables event delivery to this menu item for events to be defined by the specified event mask parameter protected final void enableEvents(long eventsToEnable) Enables event delivery to this menu item for events to be defined by the specified event mask parameter Since event types are automatically enabled when a listener for that type is added to the menu item, this method only needs to be invoked by subclasses of `MenuItem` which desire to have the specified event types delivered to `processEvent` regardless of whether a listener is registered. Parameters: `eventsToEnable` - the event mask defining the event types Since: JDK1.1 See Also: `processEvent(java.awt.AWTEvent)`, `disableEvents(long)`, `Component.enableEvents(long)`
	getAccessibleContext	`javax.accessibility.AccessibleContext` getAccessibleContext() Gets the AccessibleContext associated with this MenuItem. public javax.accessibility.AccessibleContext getAccessibleContext() Gets the AccessibleContext associated with this MenuItem. For menu items, the AccessibleContext takes the form of an AccessibleAWTMenuItem. A new AccessibleAWTMenuItem instance is created if necessary. Specified by: `getAccessibleContext` in interface `javax.accessibility.Accessible` Overrides: `getAccessibleContext` in class `MenuComponent` Returns: an AccessibleAWTMenuItem that serves as the AccessibleContext of this MenuItem Since: 1.3
	getActionCommand	`java.lang.String` getActionCommand() Gets the command name of the action event that is fired by this menu item. public java.lang.String getActionCommand() Gets the command name of the action event that is fired by this menu item. Since: JDK1.1 See Also: `setActionCommand(java.lang.String)`
	getActionListeners	`ActionListener[]` getActionListeners() Returns an array of all the action listeners registered on this menu item. public ActionListener[] getActionListeners() Returns an array of all the action listeners registered on this menu item. Returns: all of this menu item's `ActionListener`s or an empty array if no action listeners are currently registered Since: 1.4 See Also: `addActionListener(java.awt.event.ActionListener)`, `removeActionListener(java.awt.event.ActionListener)`, `ActionEvent`, `ActionListener`
	getFont	`Font` getFont() Gets the font used for this menu component. public Font getFont() Description copied from class: `MenuComponent` Gets the font used for this menu component. Returns: the font used in this menu component, if there is one; `null` otherwise See Also: `MenuComponent.setFont(java.awt.Font)`
	getLabel	`java.lang.String` getLabel() Gets the label for this menu item. public java.lang.String getLabel() Gets the label for this menu item. Returns: the label of this menu item, or `null` if this menu item has no label. Since: JDK1.0 See Also: `setLabel(java.lang.String)`
	getListeners	`<T extends java.util.EventListener> T[]` getListeners(java.lang.Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `MenuItem`. public <T extends java.util.EventListener> T[] getListeners(java.lang.Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `MenuItem`. `FooListener`s are registered using the `addFooListener` method. You can specify the `listenerType` argument with a class literal, such as `FooListener.class`. For example, you can query a `MenuItem` `m` for its action listeners with the following code: ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class)); If no such listeners exist, this method returns an empty array. Parameters: `listenerType` - the type of listeners requested; this parameter should specify an interface that descends from `java.util.EventListener` Returns: an array of all objects registered as `FooListener`s on this menu item, or an empty array if no such listeners have been added Throws: `java.lang.ClassCastException` - if `listenerType` doesn't specify a class or interface that implements `java.util.EventListener` Since: 1.3 See Also: `getActionListeners()`
	getName	`java.lang.String` getName() Gets the name of the menu component. public java.lang.String getName() Description copied from class: `MenuComponent` Gets the name of the menu component. Returns: the name of the menu component Since: JDK1.1 See Also: `MenuComponent.setName(java.lang.String)`
	getParent	`MenuContainer` getParent() Returns the parent container for this menu component. public MenuContainer getParent() Description copied from class: `MenuComponent` Returns the parent container for this menu component. Returns: the menu component containing this menu component, or `null` if this menu component is the outermost component, the menu bar itself
	getPeer	`java.awt.peer.MenuComponentPeer` getPeer() Deprecated. As of JDK version 1.1, programs should not directly manipulate peers. @Deprecated public java.awt.peer.MenuComponentPeer getPeer() Deprecated. As of JDK version 1.1, programs should not directly manipulate peers.
	getShortcut	`MenuShortcut` getShortcut() Get the `MenuShortcut` object associated with this menu item, public MenuShortcut getShortcut() Get the `MenuShortcut` object associated with this menu item, Returns: the menu shortcut associated with this menu item, or `null` if none has been specified. Since: JDK1.1 See Also: `setShortcut(java.awt.MenuShortcut)`
	getTreeLock	`protected java.lang.Object` getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations. protected final java.lang.Object getTreeLock() Description copied from class: `MenuComponent` Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations. Returns: this component's locking object
	isEnabled	`boolean` isEnabled() Checks whether this menu item is enabled. public boolean isEnabled() Checks whether this menu item is enabled. Since: JDK1.0 See Also: `setEnabled(boolean)`
	paramString	`java.lang.String` paramString() Returns a string representing the state of this `MenuItem`. public java.lang.String paramString() Returns a string representing the state of this `MenuItem`. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`. Overrides: `paramString` in class `MenuComponent` Returns: the parameter string of this menu item
	postEvent	`boolean` postEvent(Event evt) Deprecated. As of JDK version 1.1, replaced by `dispatchEvent`. @Deprecated public boolean postEvent(Event evt) Deprecated. As of JDK version 1.1, replaced by `dispatchEvent`. Description copied from class: `MenuComponent` Posts the specified event to the menu. This method is part of the Java 1.0 event system and it is maintained only for backwards compatibility. Its use is discouraged, and it may not be supported in the future. Parameters: `evt` - the event which is to take place
	processActionEvent	`protected void` processActionEvent(ActionEvent e) Processes action events occurring on this menu item, by dispatching them to any registered `ActionListener` objects. protected void processActionEvent(ActionEvent e) Processes action events occurring on this menu item, by dispatching them to any registered `ActionListener` objects. This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs: An `ActionListener` object is registered via `addActionListener`. Action events are enabled via `enableEvents`. Note that if the event parameter is `null` the behavior is unspecified and may result in an exception. Parameters: `e` - the action event Since: JDK1.1 See Also: `ActionEvent`, `ActionListener`, `enableEvents(long)`
	processEvent	`protected void` processEvent(AWTEvent e) Processes events on this menu item. protected void processEvent(AWTEvent e) Processes events on this menu item. If the event is an instance of `ActionEvent`, it invokes `processActionEvent`, another method defined by `MenuItem`. Currently, menu items only support action events. Note that if the event parameter is `null` the behavior is unspecified and may result in an exception. Overrides: `processEvent` in class `MenuComponent` Parameters: `e` - the event Since: JDK1.1 See Also: `processActionEvent(java.awt.event.ActionEvent)`
	removeActionListener	`void` removeActionListener(ActionListener l) Removes the specified action listener so it no longer receives action events from this menu item. public void removeActionListener(ActionListener l) Removes the specified action listener so it no longer receives action events from this menu item. If l is null, no exception is thrown and no action is performed. Refer to AWT Threading Issues for details on AWT's threading model. Parameters: `l` - the action listener. Since: JDK1.1 See Also: `addActionListener(java.awt.event.ActionListener)`, `getActionListeners()`, `ActionEvent`, `ActionListener`
	removeNotify	`void` removeNotify() Removes the menu component's peer. public void removeNotify() Description copied from class: `MenuComponent` Removes the menu component's peer. The peer allows us to modify the appearance of the menu component without changing the functionality of the menu component.
	setActionCommand	`void` setActionCommand(java.lang.String command) Sets the command name of the action event that is fired by this menu item. public void setActionCommand(java.lang.String command) Sets the command name of the action event that is fired by this menu item. By default, the action command is set to the label of the menu item. Parameters: `command` - the action command to be set for this menu item. Since: JDK1.1 See Also: `getActionCommand()`
	setEnabled	`void` setEnabled(boolean b) Sets whether or not this menu item can be chosen. public void setEnabled(boolean b) Sets whether or not this menu item can be chosen. Parameters: `b` - if `true`, enables this menu item; if `false`, disables it. Since: JDK1.1 See Also: `isEnabled()`
	setFont	`void` setFont(Font f) Sets the font to be used for this menu component to the specified font. public void setFont(Font f) Description copied from class: `MenuComponent` Sets the font to be used for this menu component to the specified font. This font is also used by all subcomponents of this menu component, unless those subcomponents specify a different font. Some platforms may not support setting of all font attributes of a menu component; in such cases, calling `setFont` will have no effect on the unsupported font attributes of this menu component. Unless subcomponents of this menu component specify a different font, this font will be used by those subcomponents if supported by the underlying platform. Parameters: `f` - the font to be set See Also: `MenuComponent.getFont()`, `Font.getAttributes()`, `TextAttribute`
	setLabel	`void` setLabel(java.lang.String label) Sets the label for this menu item to the specified label. public void setLabel(java.lang.String label) Sets the label for this menu item to the specified label. Parameters: `label` - the new label, or `null` for no label. Since: JDK1.0 See Also: `getLabel()`
	setName	`void` setName(java.lang.String name) Sets the name of the component to the specified string. public void setName(java.lang.String name) Description copied from class: `MenuComponent` Sets the name of the component to the specified string. Parameters: `name` - the name of the menu component Since: JDK1.1 See Also: `MenuComponent.getName()`
	setShortcut	`void` setShortcut(MenuShortcut s) Set the `MenuShortcut` object associated with this menu item. public void setShortcut(MenuShortcut s) Set the `MenuShortcut` object associated with this menu item. If a menu shortcut is already associated with this menu item, it is replaced. Parameters: `s` - the menu shortcut to associate with this menu item. Since: JDK1.1 See Also: `getShortcut()`
	toString	`java.lang.String` toString() Returns a representation of this menu component as a string. public java.lang.String toString() Description copied from class: `MenuComponent` Returns a representation of this menu component as a string. Overrides: `toString` in class `java.lang.Object` Returns: a string representation of this menu component

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

SourceForge

Class MenuItem

Methods inherited from class java.lang.Object