java.awt
Class Menu

java.lang.Object
  |
  +--java.awt.MenuComponent
        |
        +--java.awt.MenuItem
              |
              +--java.awt.Menu

All Implemented Interfaces:

Accessible, MenuContainer, Serializable

Direct Known Subclasses:

PopupMenu

public class Menu

extends MenuItem

implements MenuContainer, Accessible

A Menu object is a pull-down menu component that is deployed from a menu bar.

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).

Since:

JDK1.0

See Also:

MenuItem, CheckboxMenuItem, Serialized Form

Inner Class Summary

protected class

Menu.AccessibleAWTMenu Menu.AccessibleAWTMenu Inner class of Menu 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 Menu class. It provides an implementation of the Java Accessibility API appropriate to menu user-interface elements.

Inner classes inherited from class java.awt.MenuItem

MenuItem.AccessibleAWTMenuItem

Inner classes inherited from class java.awt.MenuComponent

MenuComponent.AccessibleAWTMenuComponent

Constructor Summary

Menu
copy-> new Menu()
copy-> <Menu var> = new Menu();

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

Since:

JDK1.1

Menu
copy-> new Menu( )
copy-> <Menu var> = new 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.

Menu
copy-> new Menu(, )
copy-> <Menu var> = new 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.

Since:

JDK1.0.

Method Summary

MenuItem	add(MenuItem mi) copy-> .add( ) copy-> <MenuItem var>=<Menu>.add(<MenuItem mi>); Adds the specified menu item to this menu. If the menu item has been part of another menu, remove it from that menu. Parameters: mi - the menu item to be added. Returns: the menu item added. See Also: insert(java.lang.String, int), insert(java.awt.MenuItem, int)
void	add(String label) copy-> .add( ) copy-> <Menu>.add(<String label>); Adds an item with the specified label to this menu. Parameters: label - the text on the item. See Also: insert(java.lang.String, int), insert(java.awt.MenuItem, int)
void	addNotify() copy-> .addNotify() copy-> <Menu>.addNotify(); Creates the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality. Overrides: addNotify in class MenuItem
void	addSeparator() copy-> .addSeparator() copy-> <Menu>.addSeparator(); Adds a separator line, or a hypen, to the menu at the current position. See Also: insertSeparator(int)
int	countItems() copy-> .countItems() copy-> <int var>=<Menu>.countItems(); Deprecated. As of JDK version 1.1, replaced by getItemCount().
AccessibleContext	getAccessibleContext() copy-> .getAccessibleContext() copy-> <AccessibleContext var>=<Menu>.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. Specified by: getAccessibleContext in interface Accessible Overrides: getAccessibleContext in class MenuItem Returns: an AccessibleAWTMenu that serves as the AccessibleContext of this Menu
MenuItem	getItem(int index) copy-> .getItem( ) copy-> <MenuItem var>=<Menu>.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.
int	getItemCount() copy-> .getItemCount() copy-> <int var>=<Menu>.getItemCount(); Get the number of items in this menu. Returns: the number of items in this menu. Since: JDK1.1
void	insert(MenuItem menuitem, int index) copy-> .insert(, ) copy-> <Menu>.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. Since: JDK1.1 See Also: add(java.lang.String), add(java.awt.MenuItem)
void	insert(String label, int index) copy-> .insert(, ) copy-> <Menu>.insert(<String label>, <int index>); Inserts a menu item with the specified label into this menu at the specified position. Parameters: label - the text on the item. index - the position at which the menu item should be inserted. Since: JDK1.1 See Also: add(java.lang.String), add(java.awt.MenuItem)
void	insertSeparator(int index) copy-> .insertSeparator( ) copy-> <Menu>.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. Since: JDK1.1 See Also: addSeparator()
boolean	isTearOff() copy-> .isTearOff() copy-> <boolean var>=<Menu>.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.
String	paramString() copy-> .paramString() copy-> <String var>=<Menu>.paramString(); Gets the parameter string representing the state of this menu. This string is useful for debugging. Overrides: paramString in class MenuItem Since: JDK1.0nu.
void	remove(int index) copy-> .remove( ) copy-> <Menu>.remove(<int index>); Removes the menu item at the specified index from this menu. Parameters: index - the position of the item to be removed.
void	remove(MenuComponent item) copy-> .remove( ) copy-> <Menu>.remove(<MenuComponent item>); Removes the specified menu item from this menu. Specified by: remove in interface MenuContainer Parameters: item - the item to be removed from the menu. If item is null or is not in this menu, this method does nothing.
void	removeAll() copy-> .removeAll() copy-> <Menu>.removeAll(); Removes all items from this menu. Since: JDK1.0.
void	removeNotify() copy-> .removeNotify() copy-> <Menu>.removeNotify(); Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality. Overrides: removeNotify in class MenuComponent

Methods inherited from class java.awt.MenuItem

addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getLabel, getListeners, getShortcut, isEnabled, processActionEvent, processEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

Methods inherited from class java.awt.MenuComponent

dispatchEvent, getFont, getName, getParent, getPeer, getTreeLock, postEvent, setFont, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent