001/* PopupMenu.java -- An AWT popup menu
002   Copyright (C) 1999, 2000, 2001, 2002, 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.awt.peer.PopupMenuPeer;
042
043import javax.accessibility.AccessibleContext;
044import javax.accessibility.AccessibleRole;
045
046/**
047  * This class implement an AWT popup menu widget
048  *
049  * @author Aaron M. Renn (arenn@urbanophile.com)
050  */
051public class PopupMenu extends Menu
052{
053
054/*
055 * Static Variables
056 */
057
058  /**
059   * The number used to generate the name returned by getName.
060   */
061  private static transient long next_popup_number;
062
063  // Serialization Constant
064  private static final long serialVersionUID = - 4620452533522760060L;
065
066/*************************************************************************/
067
068/*
069 * Constructors
070 */
071
072/**
073  * Initializes a new instance of <code>PopupMenu</code>.
074  *
075  * @exception HeadlessException If GraphicsEnvironment.isHeadless()
076  * returns true.
077  */
078public
079PopupMenu()
080{
081}
082
083/*************************************************************************/
084
085/**
086  * Initializes a new instance of <code>PopupMenu</code> with the specified
087  * label.
088  *
089  * @param label The label for this popup menu.
090  *
091  * @exception HeadlessException If GraphicsEnvironment.isHeadless()
092  * returns true.
093  */
094public
095PopupMenu(String label)
096{
097  super(label);
098
099  if (GraphicsEnvironment.isHeadless())
100    throw new HeadlessException ();
101}
102
103/*************************************************************************/
104
105/*
106 * Instance Methods
107 */
108
109/**
110  * Creates this object's native peer.
111  */
112public void
113addNotify()
114{
115  if (peer == null)
116    peer = getToolkit ().createPopupMenu (this);
117  super.addNotify ();
118}
119
120/*************************************************************************/
121
122/**
123  * Displays this popup menu at the specified coordinates relative to
124  * the specified component.
125  *
126  * @param component The component to which the display coordinates are relative.
127  * @param x The X coordinate of the menu.
128  * @param y The Y coordinate of the menu.
129  */
130public void
131show(Component component, int x, int y)
132{
133  if (getPeer() == null)
134    this.addNotify();
135  PopupMenuPeer pmp = (PopupMenuPeer)getPeer();
136  if (pmp != null)
137    {
138      /* XXX
139      Event e = new Event (component, Event.ACTION_EVENT, component);
140      e.x = x;
141      e.y = y;*/
142      pmp.show (component, x, y);
143    }
144}
145
146  protected class AccessibleAWTPopupMenu extends AccessibleAWTMenu
147  {
148    private static final long serialVersionUID = -4282044795947239955L;
149
150    protected AccessibleAWTPopupMenu()
151    {
152    }
153
154    public AccessibleRole getAccessibleRole()
155    {
156      return AccessibleRole.POPUP_MENU;
157    }
158
159  }
160
161  /**
162   * Gets the AccessibleContext associated with this <code>PopupMenu</code>.
163   * The context is created, if necessary.
164   *
165   * @return the associated context
166   */
167  public AccessibleContext getAccessibleContext()
168  {
169    /* Create the context if this is the first request */
170    if (accessibleContext == null)
171      accessibleContext = new AccessibleAWTPopupMenu();
172    return accessibleContext;
173  }
174
175  /**
176   * Generate a unique name for this <code>PopupMenu</code>.
177   *
178   * @return A unique name for this <code>PopupMenu</code>.
179   */
180  String generateName()
181  {
182    return "popup" + getUniqueLong();
183  }
184
185  private static synchronized long getUniqueLong()
186  {
187    return next_popup_number++;
188  }
189
190} // class PopupMenu