PopupMenu (Java Platform SE 6) (original) (raw)

java.awt

Class PopupMenu

java.lang.Object extended by java.awt.MenuComponent java.awt.MenuItem java.awt.Menu java.awt.PopupMenu

All Implemented Interfaces:

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

Nested Class Summary
protected class	PopupMenu.AccessibleAWTPopupMenu Inner class of PopupMenu used to provide default support for accessibility.

Nested classes/interfaces inherited from class java.awt.Menu
Menu.AccessibleAWTMenu

Nested classes/interfaces inherited from class java.awt.MenuItem
MenuItem.AccessibleAWTMenuItem

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

Constructor Summary
PopupMenu() Creates a new popup menu with an empty name.
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 thisPopupMenu.
MenuContainer	getParent() Returns the parent container for this menu component.
void	[show](../../java/awt/PopupMenu.html#show%28java.awt.Component, int, int%29)(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](../../java/awt/Menu.html#insert%28java.awt.MenuItem, int%29), [insert](../../java/awt/Menu.html#insert%28java.lang.String, int%29), insertSeparator, isTearOff, paramString, remove, remove, removeAll, removeNotify

Methods inherited from class java.awt.MenuItem
addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getListeners, getShortcut, isEnabled, processActionEvent, processEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

Methods inherited from class java.awt.MenuComponent
dispatchEvent, getFont, getName, getPeer, getTreeLock, postEvent, setFont, setName, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

Constructor Detail

PopupMenu

public PopupMenu() throws HeadlessException

Creates a new popup menu with an empty name.

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

PopupMenu

public PopupMenu(String label) throws HeadlessException

Creates a new popup menu with the specified name.

Parameters:

label - a non-null string specifying the popup menu's label

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

Method Detail

getParent

public MenuContainer getParent()

Returns the parent container for this menu component.

Overrides:

[getParent](../../java/awt/MenuComponent.html#getParent%28%29) in class [MenuComponent](../../java/awt/MenuComponent.html "class in java.awt")

Returns:

the menu component containing this menu component, or null if this menu component is the outermost component, the menu bar itself

addNotify

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.

Overrides:

[addNotify](../../java/awt/Menu.html#addNotify%28%29) in class [Menu](../../java/awt/Menu.html "class in java.awt")

show

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.

Parameters:

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

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the parent is null

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if this PopupMenu has a non-Component parent

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the origin is not in the parent's heirarchy

[RuntimeException](../../java/lang/RuntimeException.html "class in java.lang") - if the parent is not showing on screen

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with thisPopupMenu.

Specified by:

[getAccessibleContext](../../javax/accessibility/Accessible.html#getAccessibleContext%28%29) in interface [Accessible](../../javax/accessibility/Accessible.html "interface in javax.accessibility")

Overrides:

[getAccessibleContext](../../java/awt/Menu.html#getAccessibleContext%28%29) in class [Menu](../../java/awt/Menu.html "class in java.awt")

Returns:

the AccessibleContext of thisPopupMenu

Since:

1.3

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

Scripting on this page tracks web page traffic, but does not change the content in any way.