Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

PopupMenu

extends Menu

java.lang.Object
↳	java.awt.MenuComponent
	↳	java.awt.MenuItem
		↳	java.awt.Menu
			↳	java.awt.PopupMenu

Class Overview

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.

Summary

Nested Classes
class	PopupMenu.AccessibleAWTPopupMenu	Inner class of PopupMenu used to provide default support for accessibility.

Public Constructors
	PopupMenu() Creates a new popup menu with an empty name.
	PopupMenu(String label) Creates a new popup menu with the specified name.

Public Methods
void	addNotify() Creates the popup menu's peer.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `PopupMenu`.
MenuContainer	getParent() Returns the parent container for this menu component.
void	show(Component origin, int x, int y) Shows the popup menu at the x, y position relative to an origin component.

[Expand]

Inherited Methods

From class java.awt.Menu

MenuItem	add(MenuItem mi) Adds the specified menu item to this menu.
void	add(String label) Adds an item with the specified label to this menu.
void	addNotify() Creates the menu's peer.
void	addSeparator() Adds a separator line, or a hypen, to the menu at the current position.
int	countItems() This method is deprecated. As of JDK version 1.1, replaced by `getItemCount()`.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this Menu.
MenuItem	getItem(int index) Gets the item located at the specified index of this menu.
int	getItemCount() Get the number of items in this menu.
void	insert(MenuItem menuitem, int index) Inserts a menu item into this menu at the specified position.
void	insert(String label, int index) Inserts a menu item with the specified label into this menu at the specified position.
void	insertSeparator(int index) Inserts a separator at the specified position.
boolean	isTearOff() Indicates whether this menu is a tear-off menu.
String	paramString() Returns a string representing the state of this `Menu`.
void	remove(int index) Removes the menu item at the specified index from this menu.
void	remove(MenuComponent item) Removes the specified menu item from this menu.
void	removeAll() Removes all items from this menu.
void	removeNotify() Removes the menu's peer.

From class java.awt.MenuItem

synchronized void	addActionListener(ActionListener l) Adds the specified action listener to receive action events from this menu item.
void	addNotify() Creates the menu item's peer.
void	deleteShortcut() Delete any `MenuShortcut` object associated with this menu item.
synchronized void	disable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	disableEvents(long eventsToDisable) Disables event delivery to this menu item for events defined by the specified event mask parameter.
synchronized void	enable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
void	enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	enableEvents(long eventsToEnable) Enables event delivery to this menu item for events to be defined by the specified event mask parameter Since event types are automatically enabled when a listener for that type is added to the menu item, this method only needs to be invoked by subclasses of `MenuItem` which desire to have the specified event types delivered to `processEvent` regardless of whether a listener is registered.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this MenuItem.
String	getActionCommand() Gets the command name of the action event that is fired by this menu item.
synchronized ActionListener[]	getActionListeners() Returns an array of all the action listeners registered on this menu item.
String	getLabel() Gets the label for this menu item.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `MenuItem`.
MenuShortcut	getShortcut() Get the `MenuShortcut` object associated with this menu item,
boolean	isEnabled() Checks whether this menu item is enabled.
String	paramString() Returns a string representing the state of this `MenuItem`.
void	processActionEvent(ActionEvent e) Processes action events occurring on this menu item, by dispatching them to any registered `ActionListener` objects.
void	processEvent(AWTEvent e) Processes events on this menu item.
synchronized void	removeActionListener(ActionListener l) Removes the specified action listener so it no longer receives action events from this menu item.
void	setActionCommand(String command) Sets the command name of the action event that is fired by this menu item.
synchronized void	setEnabled(boolean b) Sets whether or not this menu item can be chosen.
synchronized void	setLabel(String label) Sets the label for this menu item to the specified label.
void	setShortcut(MenuShortcut s) Set the `MenuShortcut` object associated with this menu item.

From class java.awt.MenuComponent

final void	dispatchEvent(AWTEvent e) Delivers an event to this component or one of its sub components.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `MenuComponent`.
Font	getFont() Gets the font used for this menu component.
String	getName() Gets the name of the menu component.
MenuContainer	getParent() Returns the parent container for this menu component.
MenuComponentPeer	getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers.
final Object	getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
String	paramString() Returns a string representing the state of this `MenuComponent`.
boolean	postEvent(Event evt) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent`.
void	processEvent(AWTEvent e) Processes events occurring on this menu component.
void	removeNotify() Removes the menu component's peer.
void	setFont(Font f) Sets the font to be used for this menu component to the specified font.
void	setName(String name) Sets the name of the component to the specified string.
String	toString() Returns a representation of this menu component as a string.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.MenuContainer

From interface javax.accessibility.Accessible

Public Constructors

public PopupMenu ()

Creates a new popup menu with an empty name.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public PopupMenu (String label)

Creates a new popup menu with the specified name.

Parameters

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

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

Public Methods

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.

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this PopupMenu.

Returns

the AccessibleContext of this PopupMenu

public MenuContainer getParent ()

Returns the parent container for this menu component.

Returns

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

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	if the parent is `null`
IllegalArgumentException	if this `PopupMenu` has a non-`Component` parent
IllegalArgumentException	if the origin is not in the parent's heirarchy
RuntimeException	if the parent is not showing on screen

Interfaces

Classes

Enums

Exceptions

Errors

PopupMenu

Class Overview

Summary

Public Constructors

public PopupMenu ()

Throws

See Also

public PopupMenu (String label)

Parameters

Throws

See Also

Public Methods

public void addNotify ()

public AccessibleContext getAccessibleContext ()

Returns

public MenuContainer getParent ()

Returns

public void show (Component origin, int x, int y)

Parameters

Throws