Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

A menu can optionally be a tear-off menu. A tear-off menu can be opened and dragged away from its parent menu bar or menu. It remains on the screen after the mouse button has been released. The mechanism for tearing off a menu is platform dependent, since the look and feel of the tear-off menu is determined by its peer. On platforms that do not support tear-off menus, the tear-off property is ignored.

Each item in a menu must belong to the MenuItem class. It can be an instance of MenuItem, a submenu (an instance of Menu), or a check box (an instance of CheckboxMenuItem).

Summary

Nested Classes
class	Menu.AccessibleAWTMenu	Inner class of Menu used to provide default support for accessibility.

Public Constructors
	Menu() Constructs a new menu with an empty label.
	Menu(String label) Constructs a new menu with the specified label.
	Menu(String label, boolean tearOff) Constructs a new menu with the specified label, indicating whether the menu can be torn off.

Public Methods
MenuItem	add(MenuItem mi) Adds the specified menu item to this menu.
void	add(String label) Adds an item with the specified label to this menu.
void	addNotify() Creates the menu's peer.
void	addSeparator() Adds a separator line, or a hypen, to the menu at the current position.
int	countItems() This method is deprecated. As of JDK version 1.1, replaced by `getItemCount()`.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this Menu.
MenuItem	getItem(int index) Gets the item located at the specified index of this menu.
int	getItemCount() Get the number of items in this menu.
void	insert(MenuItem menuitem, int index) Inserts a menu item into this menu at the specified position.
void	insert(String label, int index) Inserts a menu item with the specified label into this menu at the specified position.
void	insertSeparator(int index) Inserts a separator at the specified position.
boolean	isTearOff() Indicates whether this menu is a tear-off menu.
String	paramString() Returns a string representing the state of this `Menu`.
void	remove(int index) Removes the menu item at the specified index from this menu.
void	remove(MenuComponent item) Removes the specified menu item from this menu.
void	removeAll() Removes all items from this menu.
void	removeNotify() Removes the menu's peer.

[Expand]

Inherited Methods

From class java.awt.MenuItem

synchronized void	addActionListener(ActionListener l) Adds the specified action listener to receive action events from this menu item.
void	addNotify() Creates the menu item's peer.
void	deleteShortcut() Delete any `MenuShortcut` object associated with this menu item.
synchronized void	disable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	disableEvents(long eventsToDisable) Disables event delivery to this menu item for events defined by the specified event mask parameter.
synchronized void	enable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
void	enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
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.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this MenuItem.
String	getActionCommand() Gets the command name of the action event that is fired by this menu item.
synchronized ActionListener[]	getActionListeners() Returns an array of all the action listeners registered on this menu item.
String	getLabel() Gets the label for this menu item.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `MenuItem`.
MenuShortcut	getShortcut() Get the `MenuShortcut` object associated with this menu item,
boolean	isEnabled() Checks whether this menu item is enabled.
String	paramString() Returns a string representing the state of this `MenuItem`.
void	processActionEvent(ActionEvent e) Processes action events occurring on this menu item, by dispatching them to any registered `ActionListener` objects.
void	processEvent(AWTEvent e) Processes events on this menu item.
synchronized void	removeActionListener(ActionListener l) Removes the specified action listener so it no longer receives action events from this menu item.
void	setActionCommand(String command) Sets the command name of the action event that is fired by this menu item.
synchronized void	setEnabled(boolean b) Sets whether or not this menu item can be chosen.
synchronized void	setLabel(String label) Sets the label for this menu item to the specified label.
void	setShortcut(MenuShortcut s) Set the `MenuShortcut` object associated with this menu item.

From class java.awt.MenuComponent

final void	dispatchEvent(AWTEvent e) Delivers an event to this component or one of its sub components.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `MenuComponent`.
Font	getFont() Gets the font used for this menu component.
String	getName() Gets the name of the menu component.
MenuContainer	getParent() Returns the parent container for this menu component.
MenuComponentPeer	getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers.
final Object	getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
String	paramString() Returns a string representing the state of this `MenuComponent`.
boolean	postEvent(Event evt) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent`.
void	processEvent(AWTEvent e) Processes events occurring on this menu component.
void	removeNotify() Removes the menu component's peer.
void	setFont(Font f) Sets the font to be used for this menu component to the specified font.
void	setName(String name) Sets the name of the component to the specified string.
String	toString() Returns a representation of this menu component as a string.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.MenuContainer

From interface javax.accessibility.Accessible

Public Constructors

public Menu ()

Constructs a new menu with an empty label. This menu is not a tear-off menu.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public Menu (String label)

Constructs a new menu with the specified label. This menu is not a tear-off menu.

Parameters

label	the menu's label in the menu bar, or in another menu of which this menu is a submenu.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public Menu (String label, boolean tearOff)

Constructs a new menu with the specified label, indicating whether the menu can be torn off.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored.

Parameters

label	the menu's label in the menu bar, or in another menu of which this menu is a submenu.
tearOff	if `true`, the menu is a tear-off menu.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

Public Methods

public MenuItem add (MenuItem mi)

Adds the specified menu item to this menu. If the menu item has been part of another menu, removes it from that menu.

Parameters

mi	the menu item to be added

Returns

the menu item added

public void add (String label)

Adds an item with the specified label to this menu.

Parameters

label	the text on the item

public void addNotify ()

Creates the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

public void addSeparator ()

Adds a separator line, or a hypen, to the menu at the current position.

public int countItems ()

This method is deprecated.
As of JDK version 1.1, replaced by getItemCount().

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this Menu. For menus, the AccessibleContext takes the form of an AccessibleAWTMenu. A new AccessibleAWTMenu instance is created if necessary.

Returns

an AccessibleAWTMenu that serves as the AccessibleContext of this Menu

public MenuItem getItem (int index)

Gets the item located at the specified index of this menu.

Parameters

index	the position of the item to be returned.

Returns

the item located at the specified index.

public int getItemCount ()

Get the number of items in this menu.

Returns

the number of items in this menu.

public void insert (MenuItem menuitem, int index)

Inserts a menu item into this menu at the specified position.

Parameters

menuitem	the menu item to be inserted.
index	the position at which the menu item should be inserted.

Throws

IllegalArgumentException	if the value of `index` is less than zero

public void insert (String label, int index)

Inserts a menu item with the specified label into this menu at the specified position. This is a convenience method for insert(menuItem, index).

Parameters

label	the text on the item
index	the position at which the menu item should be inserted

Throws

IllegalArgumentException	if the value of `index` is less than zero

public void insertSeparator (int index)

Inserts a separator at the specified position.

Parameters

index	the position at which the menu separator should be inserted.

Throws

IllegalArgumentException	if the value of `index` is less than 0.

public boolean isTearOff ()

Indicates whether this menu is a tear-off menu.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored.

Returns

true if this is a tear-off menu; false otherwise.

public String paramString ()

Returns a string representing the state of this Menu. 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.

Returns

the parameter string of this menu

public void remove (int index)

Removes the menu item at the specified index from this menu.

Parameters

index	the position of the item to be removed.

public void remove (MenuComponent item)

Removes the specified menu item from this menu.

Parameters

item	the item to be removed from the menu. If `item` is `null` or is not in this menu, this method does nothing.

public void removeAll ()

Removes all items from this menu.

public void removeNotify ()

Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

java.lang.Object
↳	java.awt.MenuComponent
	↳	java.awt.MenuItem
		↳	java.awt.Menu

Interfaces

Classes

Enums

Exceptions

Errors

Menu

Class Overview

See Also

Summary

Public Constructors

public Menu ()

Throws

See Also

public Menu (String label)

Parameters

Throws

See Also

public Menu (String label, boolean tearOff)

Parameters

Throws

See Also

Public Methods

public MenuItem add (MenuItem mi)

Parameters

Returns

See Also

public void add (String label)

Parameters

See Also

public void addNotify ()

public void addSeparator ()

See Also

public int countItems ()

public AccessibleContext getAccessibleContext ()

Returns

public MenuItem getItem (int index)

Parameters

Returns

public int getItemCount ()

Returns

public void insert (MenuItem menuitem, int index)

Parameters

Throws

See Also

public void insert (String label, int index)

Parameters

Throws

See Also

public void insertSeparator (int index)

Parameters

Throws

See Also

public boolean isTearOff ()

Returns

public String paramString ()

Returns

public void remove (int index)

Parameters

public void remove (MenuComponent item)

Parameters

public void removeAll ()

public void removeNotify ()