1 /* MenuBar.java -- An AWT menu bar class
2 Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
41 import java
.awt
.peer
.MenuBarPeer
;
42 import java
.awt
.peer
.MenuComponentPeer
;
44 import java
.io
.Serializable
;
45 import java
.util
.Enumeration
;
46 import java
.util
.Vector
;
48 import javax
.accessibility
.Accessible
;
49 import javax
.accessibility
.AccessibleContext
;
50 import javax
.accessibility
.AccessibleRole
;
53 * This class implements a menu bar in the AWT system.
55 * @author Aaron M. Renn (arenn@urbanophile.com)
56 * @author Tom Tromey (tromey@redhat.com)
57 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
59 public class MenuBar
extends MenuComponent
60 implements MenuContainer
, Serializable
, Accessible
67 // Serialization Constant
68 private static final long serialVersionUID
= -4930327919388951260L;
70 /*************************************************************************/
77 * @serial The menu used for providing help information
79 private Menu helpMenu
;
82 * @serial The menus contained in this menu bar.
84 private Vector menus
= new Vector();
87 * The accessible context for this component.
89 * @see #getAccessibleContext()
92 private transient AccessibleContext accessibleContext
;
94 /*************************************************************************/
101 * Initializes a new instance of <code>MenuBar</code>.
103 * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true.
108 if (GraphicsEnvironment
.isHeadless())
109 throw new HeadlessException ();
112 /*************************************************************************/
119 * Returns the help menu for this menu bar. This may be <code>null</code>.
121 * @return The help menu for this menu bar.
129 /*************************************************************************/
132 * Sets the help menu for this menu bar.
134 * @param menu The new help menu for this menu bar.
136 public synchronized void
137 setHelpMenu(Menu menu
)
139 if (helpMenu
!= null)
141 helpMenu
.removeNotify ();
142 helpMenu
.parent
= null;
146 if (menu
.parent
!= null)
147 menu
.parent
.remove (menu
);
150 MenuBarPeer peer
= (MenuBarPeer
) getPeer ();
154 peer
.addHelpMenu (menu
);
158 /*************************************************************************/
160 /** Add a menu to this MenuBar. If the menu has already has a
161 * parent, it is first removed from its old parent before being
164 * @param menu The menu to add.
166 * @return The menu that was added.
168 public synchronized Menu
171 if (menu
.parent
!= null)
172 menu
.parent
.remove (menu
);
175 menus
.addElement(menu
);
185 /*************************************************************************/
188 * Removes the menu at the specified index.
190 * @param index The index of the menu to remove from the menu bar.
192 public synchronized void
195 Menu m
= (Menu
) menus
.get (index
);
196 menus
.remove (index
);
202 MenuBarPeer mp
= (MenuBarPeer
) peer
;
207 /*************************************************************************/
210 * Removes the specified menu from the menu bar.
212 * @param menu The menu to remove from the menu bar.
215 remove(MenuComponent menu
)
217 int index
= menus
.indexOf(menu
);
224 /*************************************************************************/
227 * Returns the number of elements in this menu bar.
229 * @return The number of elements in the menu bar.
234 return countMenus ();
237 /*************************************************************************/
240 * Returns the number of elements in this menu bar.
242 * @return The number of elements in the menu bar.
244 * @deprecated This method is deprecated in favor of <code>getMenuCount()</code>.
249 return menus
.size () + (getHelpMenu () == null ?
0 : 1);
252 /*************************************************************************/
255 * Returns the menu at the specified index.
257 * @param index the index of the menu
259 * @return The requested menu.
261 * @exception ArrayIndexOutOfBoundsException If the index is not valid.
266 return((Menu
)menus
.elementAt(index
));
269 /*************************************************************************/
272 * Creates this object's native peer.
277 if (getPeer() == null)
278 setPeer((MenuComponentPeer
)getToolkit().createMenuBar(this));
279 Enumeration e
= menus
.elements();
280 while (e
.hasMoreElements())
282 Menu mi
= (Menu
)e
.nextElement();
285 if (helpMenu
!= null)
287 helpMenu
.addNotify();
288 ((MenuBarPeer
) peer
).addHelpMenu(helpMenu
);
292 /*************************************************************************/
295 * Destroys this object's native peer.
300 Enumeration e
= menus
.elements();
301 while (e
.hasMoreElements())
303 Menu mi
= (Menu
) e
.nextElement();
306 super.removeNotify();
309 /*************************************************************************/
312 * Returns a list of all shortcuts for the menus in this menu bar.
314 * @return A list of all shortcuts for the menus in this menu bar.
316 public synchronized Enumeration
319 Vector shortcuts
= new Vector();
320 Enumeration e
= menus
.elements();
322 while (e
.hasMoreElements())
324 Menu menu
= (Menu
)e
.nextElement();
325 if (menu
.getShortcut() != null)
326 shortcuts
.addElement(menu
.getShortcut());
329 return(shortcuts
.elements());
332 /*************************************************************************/
335 * Returns the menu item for the specified shortcut, or <code>null</code>
336 * if no such item exists.
338 * @param shortcut The shortcut to return the menu item for.
340 * @return The menu item for the specified shortcut.
343 getShortcutMenuItem(MenuShortcut shortcut
)
345 Enumeration e
= menus
.elements();
347 while (e
.hasMoreElements())
349 Menu menu
= (Menu
)e
.nextElement();
350 MenuShortcut s
= menu
.getShortcut();
351 if ((s
!= null) && (s
.equals(shortcut
)))
358 /*************************************************************************/
361 * Deletes the specified menu shortcut.
363 * @param shortcut The shortcut to delete.
366 deleteShortcut(MenuShortcut shortcut
)
369 // This is a slow implementation, but it probably doesn't matter.
370 while ((it
= getShortcutMenuItem (shortcut
)) != null)
371 it
.deleteShortcut ();
375 * Gets the AccessibleContext associated with this <code>MenuBar</code>.
376 * The context is created, if necessary.
378 * @return the associated context
380 public AccessibleContext
getAccessibleContext()
382 /* Create the context if this is the first request */
383 if (accessibleContext
== null)
384 accessibleContext
= new AccessibleAWTMenuBar();
385 return accessibleContext
;
389 * This class provides accessibility support for AWT menu bars.
391 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
393 protected class AccessibleAWTMenuBar
394 extends AccessibleAWTMenuComponent
398 * Compatible with JDK 1.4.2 revision 5
400 private static final long serialVersionUID
= -8577604491830083815L;
403 * This is the default constructor, which simply calls the default
404 * constructor of the superclass.
406 protected AccessibleAWTMenuBar()
412 * Returns the accessible role relating to the menu bar.
414 * @return <code>AccessibleRole.MENU_BAR</code>.
416 public AccessibleRole
getAccessibleRole()
418 return AccessibleRole
.MENU_BAR
;
421 } // class AccessibleAWTMenuBar