libjava/java/awt/Menu.java

   1 /* Menu.java -- A Java AWT Menu
   2    Copyright (C) 1999, 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   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)
   9 any later version.
  10
  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.
  15
  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
  19 02111-1307 USA.
  20
  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
  24 combination.
  25
  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. */
  37
  38
  39 package java.awt;
  40
  41 import java.awt.peer.MenuPeer;
  42 import java.awt.peer.MenuItemPeer;
  43 import java.awt.peer.MenuComponentPeer;
  44 import java.io.Serializable;
  45 import java.util.Vector;
  46 import java.util.Enumeration;
  47
  48 /**
  49   * This class represents a pull down or tear off menu in Java's AWT.
  50   *
  51   * @author Aaron M. Renn (arenn@urbanophile.com)
  52   */
  53 public class Menu extends MenuItem implements MenuContainer, Serializable
  54 {
  55
  56 /*
  57  * Static Variables
  58  */
  59
  60 // Serialization Constant
  61 private static final long serialVersionUID = -8809584163345499784L;
  62
  63 /*************************************************************************/
  64
  65 /*
  66  * Instance Variables
  67  */
  68
  69 /**
  70   * @serial The actual items in the menu
  71   */
  72 private Vector items = new Vector();
  73
  74 /**
  75   * @serial Flag indicating whether or not this menu is a tear off
  76   */
  77 private boolean isTearOff;
  78
  79 /**
  80   * @serial Indicates whether or not this is a help menu.
  81   */
  82 private boolean isHelpMenu;
  83
  84 // From the serialization spec.  FIXME: what should it be?
  85 private int menuSerializedDataVersion;
  86
  87 static final MenuItem separator = new MenuItem("-");
  88
  89 /*************************************************************************/
  90
  91 /*
  92  * Constructors
  93  */
  94
  95 /**
  96   * Initializes a new instance of <code>Menu</code> with no label and that
  97   * is not a tearoff;
  98   */
  99 public
 100 Menu()
 101 {
 102 }
 103
 104 /*************************************************************************/
 105
 106 /**
 107   * Initializes a new instance of <code>Menu</code> that is not a tearoff and
 108   * that has the specified label.
 109   *
 110   * @param label The menu label.
 111   */
 112 public
 113 Menu(String label)
 114 {
 115   this(label, false);
 116 }
 117
 118 /*************************************************************************/
 119
 120 /**
 121   * Initializes a new instance of <code>Menu</code> with the specified
 122   * label and tearoff status.
 123   *
 124   * @param label The label for this menu
 125   * @param isTearOff <code>true</code> if this menu is a tear off menu,
 126   * <code>false</code> otherwise.
 127   */
 128 public
 129 Menu(String label, boolean isTearOff)
 130 {
 131   super(label);
 132
 133   this.isTearOff = isTearOff;
 134
 135   if (label.equals("Help"))
 136     isHelpMenu = true;
 137 }
 138
 139 /*************************************************************************/
 140
 141 /*
 142  * Instance Methods
 143  */
 144
 145 /**
 146   * Tests whether or not this menu is a tearoff.
 147   *
 148   * @return <code>true</code> if this menu is a tearoff, <code>false</code>
 149   * otherwise.
 150   */
 151 public boolean
 152 isTearOff()
 153 {
 154   return(isTearOff);
 155 }
 156
 157 /*************************************************************************/
 158
 159 /**
 160   * Returns the number of items in this menu.
 161   *
 162   * @return The number of items in this menu.
 163   */
 164 public int
 165 getItemCount()
 166 {
 167   return(items.size());
 168 }
 169
 170 /*************************************************************************/
 171
 172 /**
 173   * Returns the number of items in this menu.
 174   *
 175   * @return The number of items in this menu.
 176   *
 177   * @deprecated This method is deprecated in favor of <code>getItemCount()</code>.
 178   */
 179 public int
 180 count()
 181 {
 182   return(items.size());
 183 }
 184
 185 /*************************************************************************/
 186
 187 /**
 188   * Returns the item at the specified index.
 189   *
 190   * @return The item at the specified index.
 191   *
 192   * @exception ArrayIndexOutOfBoundsException If the index value is not valid.
 193   */
 194 public MenuItem
 195 getItem(int index)
 196 {
 197   return((MenuItem)items.elementAt(index));
 198 }
 199
 200 /*************************************************************************/
 201
 202 /**
 203   * Adds the specified item to this menu.  If it was previously part of
 204   * another menu, it is first removed from that menu.
 205   *
 206   * @param item The new item to add.
 207   *
 208   * @return The item that was added.
 209   */
 210 public MenuItem
 211 add(MenuItem item)
 212 {
 213   items.addElement(item);
 214   if (item.parent != null)
 215     {
 216       item.parent.remove(item);
 217     }
 218   item.parent = this;
 219
 220   if (peer != null)
 221     {
 222       MenuPeer mp = (MenuPeer) peer;
 223       mp.addItem(item);
 224     }
 225
 226   return item;
 227 }
 228
 229 /*************************************************************************/
 230
 231 /**
 232   * Add an item with the specified label to this menu.
 233   *
 234   * @param label The label of the menu item to add.
 235   */
 236 public void
 237 add(String label)
 238 {
 239   add(new MenuItem(label));
 240 }
 241
 242 /*************************************************************************/
 243
 244 /**
 245   * Inserts the specified menu item into this menu at the specified index.
 246   *
 247   * @param item The menu item to add.
 248   * @param index The index of the menu item.
 249   *
 250   * XXX: FIXME
 251   *
 252   * @exception IllegalArgumentException If the index is less than zero.
 253   * @exception ArrayIndexOutOfBoundsException If the index is otherwise invalid.
 254   */
 255 public void
 256 insert(MenuItem item, int index)
 257 {
 258   if (index < 0)
 259     throw new IllegalArgumentException("Index is less than zero");
 260
 261   items.insertElementAt(item, index);
 262
 263   MenuPeer mp = (MenuPeer)getPeer();
 264   // FIXME: Need to add a peer method here.
 265 //    if (mp != null)
 266 //      mp.insertItem(item, index);
 267 }
 268
 269 /*************************************************************************/
 270
 271 /**
 272   * Inserts an item with the specified label into this menu at the specified index.
 273   *
 274   * @param label The label of the item to add.
 275   * @param index The index of the menu item.
 276   *
 277   * @exception IllegalArgumentException If the index is less than zero.
 278   * @exception ArrayIndexOutOfBoundsException If the index is otherwise invalid.
 279   */
 280 public void
 281 insert(String label, int index)
 282 {
 283   insert(new MenuItem(label), index);
 284 }
 285
 286 /*************************************************************************/
 287
 288 /**
 289   * Adds a separator bar at the current menu location.
 290   */
 291 public void
 292 addSeparator()
 293 {
 294   add(separator);
 295 }
 296
 297 /*************************************************************************/
 298
 299 /**
 300   * Inserts a separator bar at the specified index value.
 301   *
 302   * @param index The index at which to insert a separator bar.
 303   *
 304   * XXX: FIXME
 305   *
 306   * @exception IllegalArgumentException If the index is less than zero.
 307   * @exception ArrayIndexOutOfBoundsException If the index is otherwise invalid.
 308   */
 309 public void
 310 insertSeparator(int index)
 311 {
 312   insert(separator, index);
 313 }
 314
 315 /*************************************************************************/
 316
 317 /**
 318   * Deletes the item at the specified index from this menu.
 319   *
 320   * @param index The index of the item to remove.
 321   *
 322   * @exception ArrayIndexOutOfBoundsException If the index is otherwise invalid.
 323   */
 324 public synchronized void
 325 remove(int index)
 326 {
 327   items.removeElementAt(index);
 328
 329   MenuPeer mp = (MenuPeer)getPeer();
 330   if (mp != null)
 331     mp.delItem(index);
 332 }
 333
 334 /*************************************************************************/
 335
 336 /**
 337   * Removes the specifed item from the menu.  If the specified component
 338   * does not exist, this method does nothing. // FIXME: Right?
 339   *
 340   * @param item The component to remove.
 341   */
 342 public void
 343 remove(MenuComponent item)
 344 {
 345   int index = items.indexOf(item);
 346   if (index == -1)
 347     return;
 348
 349   remove(index);
 350 }
 351
 352 /*************************************************************************/
 353
 354 /**
 355   * Removes all the elements from this menu.
 356   */
 357 public synchronized void
 358 removeAll()
 359 {
 360   int count = getItemCount();
 361   for(int i = 0; i < count; i++)
 362     {
 363       // We must always remove item 0.
 364       remove(0);
 365     }
 366 }
 367
 368 /*************************************************************************/
 369
 370 /**
 371   * Creates the native peer for this object.
 372   */
 373 public void
 374 addNotify()
 375 {
 376   if (peer != null)
 377     peer = getToolkit().createMenu(this);
 378   super.addNotify ();
 379 }
 380
 381 /*************************************************************************/
 382
 383 /**
 384   * Destroys the native peer for this object.
 385   */
 386 public void
 387 removeNotify()
 388 {
 389   super.removeNotify();
 390 }
 391
 392 /*************************************************************************/
 393
 394 /**
 395   * Returns a debugging string for this menu.
 396   *
 397   * @return A debugging string for this menu.
 398   */
 399 public String
 400 paramString()
 401 {
 402   return (",isTearOff=" + isTearOff + ",isHelpMenu=" + isHelpMenu
 403           + super.paramString());
 404 }
 405
 406 // Accessibility API not yet implemented.
 407 // public AccessibleContext getAccessibleContext()
 408
 409 } // class Menu