Class Menu
- All Implemented Interfaces:
- MenuContainer,- Serializable,- Accessible
- Direct Known Subclasses:
- PopupMenu
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:
- 1.0
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classInner class of Menu used to provide default support for accessibility.Nested classes/interfaces declared in class java.awt.MenuItemMenuItem.AccessibleAWTMenuItemNested classes/interfaces declared in class java.awt.MenuComponentMenuComponent.AccessibleAWTMenuComponent
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionAdds the specified menu item to this menu.voidAdds an item with the specified label to this menu.voidCreates the menu's peer.voidAdds a separator line, or a hyphen, to the menu at the current position.intDeprecated.Gets the AccessibleContext associated with this Menu.getItem(int index) Gets the item located at the specified index of this menu.intGet the number of items in this menu.voidInserts a menu item into this menu at the specified position.voidInserts a menu item with the specified label into this menu at the specified position.voidinsertSeparator(int index) Inserts a separator at the specified position.booleanIndicates whether this menu is a tear-off menu.Returns a string representing the state of thisMenu.voidremove(int index) Removes the menu item at the specified index from this menu.voidremove(MenuComponent item) Removes the specified menu item from this menu.voidRemoves all items from this menu.voidRemoves the menu's peer.Methods declared in class java.awt.MenuItemaddActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getListeners, getShortcut, isEnabled, processActionEvent, processEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcutMethods declared in class java.awt.MenuComponentdispatchEvent, getFont, getName, getParent, getTreeLock, postEvent, setFont, setName, toStringMethods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface java.awt.MenuContainergetFont, postEvent
- 
Constructor Details- 
MenuConstructs a new menu with an empty label. This menu is not a tear-off menu.- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true.
- Since:
- 1.1
- See Also:
 
- 
MenuConstructs 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.
- See Also:
 
- 
MenuConstructs 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.
- See Also:
 
 
- 
- 
Method Details- 
addNotify
- 
removeNotifypublic void removeNotify()Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.- Overrides:
- removeNotifyin class- MenuComponent
 
- 
isTearOffpublic 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:
- trueif this is a tear-off menu;- falseotherwise.
 
- 
getItemCountpublic int getItemCount()Get the number of items in this menu.- Returns:
- the number of items in this menu
- Since:
- 1.1
 
- 
countItemsDeprecated.As of JDK version 1.1, replaced bygetItemCount().Returns the number of items in this menu.- Returns:
- the number of items in this menu
 
- 
getItemGets 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.
 
- 
add
- 
addAdds an item with the specified label to this menu.- Parameters:
- label- the text on the item
- See Also:
 
- 
insertInserts 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- indexis less than zero
- Since:
- 1.1
- See Also:
 
- 
insertInserts a menu item with the specified label into this menu at the specified position. This is a convenience method forinsert(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- indexis less than zero
- Since:
- 1.1
- See Also:
 
- 
addSeparatorpublic void addSeparator()Adds a separator line, or a hyphen, to the menu at the current position.- See Also:
 
- 
insertSeparatorpublic 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- indexis less than 0.
- Since:
- 1.1
- See Also:
 
- 
removepublic 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.
 
- 
removeRemoves the specified menu item from this menu.- Specified by:
- removein interface- MenuContainer
- Parameters:
- item- the item to be removed from the menu. If- itemis- nullor is not in this menu, this method does nothing.
 
- 
removeAllpublic void removeAll()Removes all items from this menu.- Since:
- 1.1
 
- 
paramStringReturns a string representing the state of thisMenu. 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 benull.- Overrides:
- paramStringin class- MenuItem
- Returns:
- the parameter string of this menu
 
- 
getAccessibleContextGets 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:
- getAccessibleContextin interface- Accessible
- Overrides:
- getAccessibleContextin class- MenuItem
- Returns:
- an AccessibleAWTMenu that serves as the AccessibleContext of this Menu
- Since:
- 1.3
 
 
- 
getItemCount().