java.lang.Object
- java.awt.MenuComponent
- - java.awt.MenuBar

All Implemented Interfaces:

MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MenuBar extends MenuComponent implements MenuContainer, javax.accessibility.Accessible

The MenuBar class encapsulates the platform's concept of a menu bar bound to a frame. In order to associate the menu bar with a Frame object, call the frame's setMenuBar method.
This is what a menu bar might look like:

A menu bar handles keyboard shortcuts for menu items, passing them along to its child menus. (Keyboard shortcuts, which are optional, provide the user with an alternative to the mouse for invoking a menu item and the action that is associated with it.) Each menu item can maintain an instance of MenuShortcut. The MenuBar class defines several methods, shortcuts() and getShortcutMenuItem(java.awt.MenuShortcut) that retrieve information about the shortcuts a given menu bar is managing.

Since:

JDK1.0

See Also:
Frame, Frame.setMenuBar(java.awt.MenuBar), Menu, MenuItem, MenuShortcut, Serialized Form

Nested Classes
	Modifier and Type	Class and Description
	AccessibleAWTMenuBar	`protected class` AccessibleAWTMenuBar Inner class of MenuBar used to provide default support for accessibility. `protected class` AccessibleAWTMenuBar Inner class of MenuBar 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 `MenuBar` class. It provides an implementation of the Java Accessibility API appropriate to menu bar user-interface elements. Since: 1.3 See Also: Serialized Form
	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

Constructors
	Constructor and Description
	MenuBar	MenuBar() Creates a new menu bar. public MenuBar() throws HeadlessException Creates a new menu bar. Throws: `HeadlessException` - if GraphicsEnvironment.isHeadless() returns true. See Also: `GraphicsEnvironment.isHeadless()`

Methods
	Modifier and Type	Method and Description
	add	`Menu` add(Menu m) Adds the specified menu to the menu bar. public Menu add(Menu m) Adds the specified menu to the menu bar. If the menu has been part of another menu bar, removes it from that menu bar. Parameters: `m` - the menu to be added Returns: the menu added See Also: `remove(int)`, `remove(java.awt.MenuComponent)`
	addNotify	`void` addNotify() Creates the menu bar's peer. public void addNotify() Creates the menu bar's peer. The peer allows us to change the appearance of the menu bar without changing any of the menu bar's functionality.
	countMenus	`int` countMenus() Deprecated. As of JDK version 1.1, replaced by `getMenuCount()`. @Deprecated public int countMenus() Deprecated. As of JDK version 1.1, replaced by `getMenuCount()`.
	deleteShortcut	`void` deleteShortcut(MenuShortcut s) Deletes the specified menu shortcut. public void deleteShortcut(MenuShortcut s) Deletes the specified menu shortcut. Parameters: `s` - the menu shortcut to delete. Since: JDK1.1
	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
	getAccessibleContext	`javax.accessibility.AccessibleContext` getAccessibleContext() Gets the AccessibleContext associated with this MenuBar. public javax.accessibility.AccessibleContext getAccessibleContext() Gets the AccessibleContext associated with this MenuBar. For menu bars, the AccessibleContext takes the form of an AccessibleAWTMenuBar. A new AccessibleAWTMenuBar instance is created if necessary. Specified by: `getAccessibleContext` in interface `javax.accessibility.Accessible` Overrides: `getAccessibleContext` in class `MenuComponent` Returns: an AccessibleAWTMenuBar that serves as the AccessibleContext of this MenuBar Since: 1.3
	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)`
	getHelpMenu	`Menu` getHelpMenu() Gets the help menu on the menu bar. public Menu getHelpMenu() Gets the help menu on the menu bar. Returns: the help menu on this menu bar.
	getMenu	`Menu` getMenu(int i) Gets the specified menu. public Menu getMenu(int i) Gets the specified menu. Parameters: `i` - the index position of the menu to be returned. Returns: the menu at the specified index of this menu bar.
	getMenuCount	`int` getMenuCount() Gets the number of menus on the menu bar. public int getMenuCount() Gets the number of menus on the menu bar. Returns: the number of menus on the menu bar. Since: JDK1.1
	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.
	getShortcutMenuItem	`MenuItem` getShortcutMenuItem(MenuShortcut s) Gets the instance of `MenuItem` associated with the specified `MenuShortcut` object, or `null` if none of the menu items being managed by this menu bar is associated with the specified menu shortcut. public MenuItem getShortcutMenuItem(MenuShortcut s) Gets the instance of `MenuItem` associated with the specified `MenuShortcut` object, or `null` if none of the menu items being managed by this menu bar is associated with the specified menu shortcut. Parameters: `s` - the specified menu shortcut. Since: JDK1.1 See Also: `MenuItem`, `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
	paramString	`protected java.lang.String` paramString() Returns a string representing the state of this `MenuComponent`. protected java.lang.String paramString() Description copied from class: `MenuComponent` Returns a string representing the state of this `MenuComponent`. 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 component
	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
	processEvent	`protected void` processEvent(AWTEvent e) Processes events occurring on this menu component. protected void processEvent(AWTEvent e) Description copied from class: `MenuComponent` Processes events occurring on this menu component. Note that if the event parameter is `null` the behavior is unspecified and may result in an exception. Parameters: `e` - the event Since: JDK1.1
	remove	`void` remove(int index) Removes the menu located at the specified index from this menu bar. public void remove(int index) Removes the menu located at the specified index from this menu bar. Parameters: `index` - the position of the menu to be removed. See Also: `add(java.awt.Menu)`
	remove	`void` remove(MenuComponent m) Removes the specified menu component from this menu bar. public void remove(MenuComponent m) Removes the specified menu component from this menu bar. Specified by: `remove` in interface `MenuContainer` Parameters: `m` - the menu component to be removed. See Also: `add(java.awt.Menu)`
	removeNotify	`void` removeNotify() Removes the menu bar's peer. public void removeNotify() Removes the menu bar's peer. The peer allows us to change the appearance of the menu bar without changing any of the menu bar's functionality. Overrides: `removeNotify` in class `MenuComponent`
	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`
	setHelpMenu	`void` setHelpMenu(Menu m) Sets the specified menu to be this menu bar's help menu. public void setHelpMenu(Menu m) Sets the specified menu to be this menu bar's help menu. If this menu bar has an existing help menu, the old help menu is removed from the menu bar, and replaced with the specified menu. Parameters: `m` - the menu to be set as the help menu
	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()`
	shortcuts	`java.util.Enumeration<MenuShortcut>` shortcuts() Gets an enumeration of all menu shortcuts this menu bar is managing. public java.util.Enumeration<MenuShortcut> shortcuts() Gets an enumeration of all menu shortcuts this menu bar is managing. Returns: an enumeration of menu shortcuts that this menu bar is managing. Since: JDK1.1 See Also: `MenuShortcut`
	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 MenuBar

Methods inherited from class java.lang.Object