JavaTM 2 Platform
Std. Ed. v1.3.1

Class PopupMenu

All Implemented Interfaces:
Accessible, MenuContainer, Serializable

public class PopupMenu
extends Menu

A class that implements a menu which can be dynamically popped up at a specified position within a component.

As the inheritance hierarchy implies, a PopupMenu can be used anywhere a Menu can be used. However, if you use a PopupMenu like a Menu (e.g., you add it to a MenuBar), then you cannot call show on that PopupMenu.

See Also:
Serialized Form

Inner Class Summary
protected  class PopupMenu.AccessibleAWTPopupMenu
          Inner class of PopupMenu used to provide default support for accessibility.
Inner classes inherited from class java.awt.Menu
Inner classes inherited from class java.awt.MenuItem
Inner classes inherited from class java.awt.MenuComponent
Constructor Summary
          Creates a new popup menu.
PopupMenu(String label)
          Creates a new popup menu with the specified name.
Method Summary
 void addNotify()
          Creates the popup menu's peer.
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this PopupMenu.
 void show(Component origin, int x, int y)
          Shows the popup menu at the x, y position relative to an origin component.
Methods inherited from class java.awt.Menu
add, add, addSeparator, countItems, getItem, getItemCount, insert, insert, insertSeparator, isTearOff, paramString, remove, remove, removeAll, removeNotify
Methods inherited from class java.awt.MenuItem
addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getLabel, getListeners, getShortcut, isEnabled, processActionEvent, processEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut
Methods inherited from class java.awt.MenuComponent
dispatchEvent, getFont, getName, getParent, getPeer, getTreeLock, postEvent, setFont, setName, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

Constructor Detail


public PopupMenu()
Creates a new popup menu.


public PopupMenu(String label)
Creates a new popup menu with the specified name.
label - a non-null string specifying the popup menu's label
Method Detail


public void addNotify()
Creates the popup menu's peer. The peer allows us to change the appearance of the popup menu without changing any of the popup menu's functionality.
addNotify in class Menu


public void show(Component origin,
                 int x,
                 int y)
Shows the popup menu at the x, y position relative to an origin component. The origin component must be contained within the component hierarchy of the popup menu's parent. Both the origin and the parent must be showing on the screen for this method to be valid.

If this PopupMenu is being used as a Menu (i.e., it has a non-Component parent), then you cannot call this method on the PopupMenu.

origin - the component which defines the coordinate space
x - the x coordinate position to popup the menu
y - the y coordinate position to popup the menu
IllegalArgumentException - if this PopupMenu has a non- Component parent


public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this PopupMenu. For popup menus, the AccessibleContext takes the form of an AccessibleAWTPopupMenu. A new AccessibleAWTPopupMenu instance is created if necessary.
getAccessibleContext in class Menu
an AccessibleAWTPopupMenu that serves as the AccessibleContext of this PopupMenu

JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Oracle and/or its affiliates, in the US and other countries.
Copyright © 1995, 2010 Oracle and/or its affiliates. All rights reserved.