java.awt

Class MenuBar

Implemented Interfaces:
Accessible, MenuContainer, Serializable

public class MenuBar
extends MenuComponent
implements MenuContainer, Serializable, Accessible

This class implements a menu bar in the AWT system.
See Also:
Serialized Form

Nested Class Summary

protected class
MenuBar.AccessibleAWTMenuBar
This class provides accessibility support for AWT menu bars.

Nested classes/interfaces inherited from class java.awt.MenuComponent

MenuComponent.AccessibleAWTMenuComponent

Constructor Summary

MenuBar()
Initializes a new instance of MenuBar.

Method Summary

Menu
add(Menu menu)
Add a menu to this MenuBar.
void
addNotify()
Creates this object's native peer.
int
countMenus()
Deprecated. This method is deprecated in favor of getMenuCount().
void
deleteShortcut(MenuShortcut shortcut)
Deletes the specified menu shortcut.
AccessibleContext
getAccessibleContext()
Gets the AccessibleContext associated with this MenuBar.
Menu
getHelpMenu()
Returns the help menu for this menu bar.
Menu
getMenu(int index)
Returns the menu at the specified index.
int
getMenuCount()
Returns the number of elements in this menu bar.
MenuItem
getShortcutMenuItem(MenuShortcut shortcut)
Returns the menu item for the specified shortcut, or null if no such item exists.
void
remove(int index)
Removes the menu at the specified index.
void
remove(MenuComponent menu)
Removes the specified menu from the menu bar.
void
removeNotify()
Destroys this object's native peer.
void
setHelpMenu(Menu menu)
Sets the help menu for this menu bar.
Enumeration
shortcuts()
Returns a list of all shortcuts for the menus in this menu bar.

Methods inherited from class java.awt.MenuComponent

dispatchEvent, getAccessibleContext, getFont, getName, getParent, getPeer, getTreeLock, paramString, postEvent, processEvent, removeNotify, setFont, setName, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MenuBar

public MenuBar()
Initializes a new instance of MenuBar.
Throws:
HeadlessException - if GraphicsEnvironment.isHeadless() is true

Method Details

add

public Menu add(Menu menu)
Add a menu to this MenuBar. If the menu has already has a parent, it is first removed from its old parent before being added.
Parameters:
menu - the menu to add
Returns:
the menu that was added

addNotify

public void addNotify()
Creates this object's native peer.

countMenus

public int countMenus()

Deprecated. This method is deprecated in favor of getMenuCount().

Returns the number of elements in this menu bar.
Returns:
the number of elements in the menu bar

deleteShortcut

public void deleteShortcut(MenuShortcut shortcut)
Deletes the specified menu shortcut.
Parameters:
shortcut - the shortcut to delete

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this MenuBar. The context is created, if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface MenuComponent
Returns:
the associated context

getHelpMenu

public Menu getHelpMenu()
Returns the help menu for this menu bar. This may be null.
Returns:
the help menu for this menu bar

getMenu

public Menu getMenu(int index)
Returns the menu at the specified index.
Parameters:
index - the index of the menu
Returns:
the requested menu
Throws:
ArrayIndexOutOfBoundsException - if the index is not valid

getMenuCount

public int getMenuCount()
Returns the number of elements in this menu bar.
Returns:
the number of elements in the menu bar

getShortcutMenuItem

public MenuItem getShortcutMenuItem(MenuShortcut shortcut)
Returns the menu item for the specified shortcut, or null if no such item exists.
Parameters:
shortcut - the shortcut to return the menu item for
Returns:
the menu item for the specified shortcut

remove

public void remove(int index)
Removes the menu at the specified index.
Parameters:
index - the index of the menu to remove from the menu bar

remove

public void remove(MenuComponent menu)
Removes the specified menu from the menu bar.
Specified by:
remove in interface MenuContainer
Parameters:
menu - the menu to remove from the menu bar

removeNotify

public void removeNotify()
Destroys this object's native peer.
Overrides:
removeNotify in interface MenuComponent

setHelpMenu

public void setHelpMenu(Menu menu)
Sets the help menu for this menu bar.
Parameters:
menu - the new help menu for this menu bar

shortcuts

public Enumeration shortcuts()
Returns a list of all shortcuts for the menus in this menu bar.
Returns:
a list of all shortcuts for the menus in this menu bar

MenuBar.java -- An AWT menu bar class Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.