JPopupMenu (GNU Classpath 0.94-pre Documentation)

SelectionModel that keeps track of menu selection.

Creates a new JPopupMenu object.

Nested Class Summary
protected class	JPopupMenu.AccessibleJPopupMenu
static class	JPopupMenu.Separator This is the separator that can be used in popup menu.

Field Summary
protected SingleSelectionModel	selectionModel SelectionModel that keeps track of menu selection.

Constructor Summary
	JPopupMenu() Creates a new JPopupMenu object.
	JPopupMenu(String label) Creates a new JPopupMenu with specified label

Method Summary
JMenuItem	add(JMenuItem item) Adds given menu item to the popup menu
JMenuItem	add(String text) Constructs menu item with a specified label and adds it to popup menu
JMenuItem	add(Action action) Constructs menu item associated with the specified action and adds it to the popup menu
void	addMenuKeyListener(MenuKeyListener l) Adds a MenuKeyListener to the popup.
void	addPopupMenuListener(PopupMenuListener listener) Adds popupMenuListener to listen for PopupMenuEvents fired by the JPopupMenu
void	addSeparator() Adds separator to this popup menu
protected PropertyChangeListener	createActionChangeListener(JMenuItem item) Creates PropertyChangeListener that listens to PropertyChangeEvents occuring in the Action associated with given menu item in this popup menu.
protected JMenuItem	createActionComponent(Action action) Creates new menu item associated with a given action.
protected void	firePopupMenuCanceled() This method calls popupMenuCanceled() of popup menu's PopupMenuListeners.
protected void	firePopupMenuWillBecomeInvisible() This method calls popupMenuWillBecomeInvisible() of popup menu's PopupMenuListeners.
protected void	firePopupMenuWillBecomeVisible() This method calls popupMenuWillBecomeVisible() of popup menu's PopupMenuListeners.
AccessibleContext	getAccessibleContext() DOCUMENT ME!
Component	getComponent() Method of the MenuElement interface.
Component	getComponentAtIndex(int index) Returns component located at the specified index in the popup menu
int	getComponentIndex(Component component) Returns index of the specified component in the popup menu
static boolean	getDefaultLightWeightPopupEnabled() Returns flag indicating if newly created JPopupMenu will use heavyweight or lightweight container to display its menu items
Component	getInvoker() Returns popup menu's invoker.
String	getLabel() Returns label for this popup menu
Insets	getMargin() Returns margin for this popup menu.
MenuKeyListener[]	getMenuKeyListeners() Returns array of getMenuKeyListeners that are listening to JPopupMenu.
PopupMenuListener[]	getPopupMenuListeners() Returns array of PopupMenuListeners that are listening to JPopupMenu
SingleSelectionModel	getSelectionModel() Returns selectionModel used by this popup menu to keep track of the selection.
MenuElement[]	getSubElements() Return subcomonents of this popup menu.
PopupMenuUI	getUI() This method returns the UI used to display the JPopupMenu.
String	getUIClassID() This method returns a name to identify which look and feel class will be the UI delegate for the menuItem.
void	insert(Action action, int index) Create menu item associated with the given action and inserts it into the popup menu at the specified index
void	insert(Component component, int index) Insert given component to the popup menu at the specified index
boolean	isBorderPainted() Checks if this popup menu paints its border.
boolean	isLightWeightPopupEnabled() Returns true if this popup menu will display its menu item in a lightweight container and false otherwise.
boolean	isPopupTrigger(MouseEvent event) Checks if observing mouse event should trigger popup menu to show on the screen.
boolean	isVisible() Return visibility of the popup menu
void	menuSelectionChanged(boolean changed) Method of MenuElement Interface.
void	pack() This methods sets popup menu's size to its' preferred size.
protected String	paramString() A string that describes this JPopupMenu.
void	processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager) Process key events forwarded from MenuSelectionManager.
void	processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager) Process mouse events forwarded from MenuSelectionManager.
void	remove(int index) Revomes component at the given index from the menu.
void	removeMenuKeyListener(MenuKeyListener l) Removes a MenuKeyListener from the popup.
void	removePopupMenuListener(PopupMenuListener listener) Removes PopupMenuListener from JPopupMenu's list of listeners
void	setBorderPainted(boolean painted) Sets if the border of the popup menu should be painter or not.
static void	setDefaultLightWeightPopupEnabled(boolean enabled) Sets whether JPopupMenu should use ligthWeight container to display it menu items by default
void	setInvoker(Component component) Sets popup menu's invoker.
void	setLabel(String label) Sets label for this popup menu.
void	setLightWeightPopupEnabled(boolean enabled) DOCUMENT ME!
void	setLocation(int x, int y) Sets location of the popup menu.
void	setPopupSize(Dimension size) Sets size of the popup
void	setPopupSize(int width, int height) Sets size of the popup menu
void	setSelected(Component selected) Selects specified component in this popup menu.
void	setSelectionModel(SingleSelectionModel model) Sets selection model for this popup menu
void	setUI(PopupMenuUI ui) Set the "UI" property of the menu item, which is a look and feel class responsible for handling popupMenu's input events and painting it.
void	setVisible(boolean visible) Sets visibility property of this popup menu.
void	show(Component component, int x, int y) This method displays JPopupMenu on the screen at the specified location.
void	updateUI() This method sets this menuItem's UI to the UIManager's default for the current look and feel.

Creates a new JPopupMenu with specified label

Parameters: label Label for popup menu.

Adds given menu item to the popup menu

Parameters: item menu item to add to the popup menu

Returns: menu item that was added to the popup menu

Constructs menu item with a specified label and adds it to popup menu

Parameters: text label for the menu item to be added

Returns: constructed menu item that was added to the popup menu

Constructs menu item associated with the specified action and adds it to the popup menu

Parameters: action Action for the new menu item

Returns: menu item that was added to the menu

Adds a MenuKeyListener to the popup.

Parameters: l - the listener to add.

Adds popupMenuListener to listen for PopupMenuEvents fired by the JPopupMenu

Parameters: listener PopupMenuListener to add to JPopupMenu

Adds separator to this popup menu

Creates PropertyChangeListener that listens to PropertyChangeEvents occuring in the Action associated with given menu item in this popup menu.

Parameters: item MenuItem

Returns: The PropertyChangeListener

Creates new menu item associated with a given action.

Parameters: action Action used to create new menu item

Returns: new created menu item associated with a given action.

This method calls popupMenuCanceled() of popup menu's PopupMenuListeners. This method is invoked just before popup menu is cancelled. This happens when popup menu is closed without selecting any of its menu items. This usually happens when the top-level window is resized or moved.

This method calls popupMenuWillBecomeInvisible() of popup menu's PopupMenuListeners. This method is invoked just before popup menu will disappear from the screen

This method calls popupMenuWillBecomeVisible() of popup menu's PopupMenuListeners. This method is invoked just before popup menu will appear on the screen.

DOCUMENT ME!

Returns: DOCUMENT ME!

Method of the MenuElement interface. Returns reference to itself.

Returns: Returns reference to itself

Deprecated: Replaced by getComponent(int)

Returns component located at the specified index in the popup menu

Parameters: index index of the component to return

Returns: component located at the specified index in the popup menu

Returns index of the specified component in the popup menu

Parameters: component Component to look for

Returns: index of the specified component in the popup menu

Returns flag indicating if newly created JPopupMenu will use heavyweight or lightweight container to display its menu items

Returns: true if JPopupMenu will use lightweight container to display menu items by default, and false otherwise.

Returns popup menu's invoker.

Returns: popup menu's invoker

Returns label for this popup menu

Returns: label for this popup menu

Returns margin for this popup menu.

Returns: margin for this popup menu.

Returns array of getMenuKeyListeners that are listening to JPopupMenu.

Returns: array of getMenuKeyListeners that are listening to JPopupMenu

Returns array of PopupMenuListeners that are listening to JPopupMenu

Returns: Array of PopupMenuListeners that are listening to JPopupMenu

Returns selectionModel used by this popup menu to keep track of the selection.

Returns: popup menu's selection model

Return subcomonents of this popup menu. This method returns only components that implement the MenuElement interface.

Returns: array of menu items belonging to this popup menu

This method returns the UI used to display the JPopupMenu.

Returns: The UI used to display the JPopupMenu.

This method returns a name to identify which look and feel class will be the UI delegate for the menuItem.

Returns: The Look and Feel classID. "PopupMenuUI"

Create menu item associated with the given action and inserts it into the popup menu at the specified index

Parameters: action Action for the new menu item index index in the popup menu at which to insert new menu item.

Insert given component to the popup menu at the specified index

Parameters: component Component to insert index Index at which to insert given component

Checks if this popup menu paints its border.

Returns: true if this popup menu paints its border and false otherwise.

Returns true if this popup menu will display its menu item in a lightweight container and false otherwise.

Returns: true if this popup menu will display its menu items in a lightweight container and false otherwise.

Checks if observing mouse event should trigger popup menu to show on the screen.

Parameters: event MouseEvent to check

Returns: true if the observing mouse event is popup trigger and false otherwise

Return visibility of the popup menu

Returns: true if popup menu is visible on the screen and false otherwise.

Method of MenuElement Interface. It is invoked when popupMenu's selection has changed

Parameters: changed true if this popupMenu is part of current menu hierarchy and false otherwise.

This methods sets popup menu's size to its' preferred size. If the popup menu's size is previously set it will be ignored.

A string that describes this JPopupMenu. Normally only used for debugging.

Returns: A string describing this JMenuItem

Process key events forwarded from MenuSelectionManager. This method doesn't do anything. It is here to conform to the MenuElement interface.

Parameters: event event forwarded from MenuSelectionManager path path to the menu element from which event was generated manager MenuSelectionManager for the current menu hierarchy

Process mouse events forwarded from MenuSelectionManager. This method doesn't do anything. It is here to conform to the MenuElement interface.

Parameters: event event forwarded from MenuSelectionManager path path to the menu element from which event was generated manager MenuSelectionManager for the current menu hierarchy

Revomes component at the given index from the menu.

Parameters: index index of the component that will be removed in the menu

Removes a MenuKeyListener from the popup.

Parameters: l - the listener to remove.

Removes PopupMenuListener from JPopupMenu's list of listeners

Parameters: listener PopupMenuListener which needs to be removed

Sets if the border of the popup menu should be painter or not.

Parameters: painted true if the border should be painted and false otherwise

Sets whether JPopupMenu should use ligthWeight container to display it menu items by default

Parameters: enabled true if JPopupMenu should use lightweight container for displaying its menu items, and false otherwise.

Sets popup menu's invoker.

Parameters: component The new invoker of this popup menu

Sets label for this popup menu. This method fires PropertyChangeEvent when the label property is changed. Please note that most of the Look & Feel will ignore this property.

Parameters: label label for this popup menu

DOCUMENT ME!

Parameters: enabled DOCUMENT ME!

Sets location of the popup menu.

Parameters: x X coordinate of the popup menu's location y Y coordinate of the popup menu's location

Sets size of the popup

Parameters: size Dimensions representing new size of the popup menu

Sets size of the popup menu

Parameters: width width for the new size height height for the new size

Selects specified component in this popup menu.

Parameters: selected component to select

Sets selection model for this popup menu

Parameters: model new selection model of this popup menu

Set the "UI" property of the menu item, which is a look and feel class responsible for handling popupMenu's input events and painting it.

Parameters: ui The new "UI" property

Sets visibility property of this popup menu. If the property is set to true then popup menu will be dispayed and popup menu will hide itself if visible property is set to false.

Parameters: visible true if popup menu will become visible and false otherwise.

This method displays JPopupMenu on the screen at the specified location. Note that x and y coordinates given to this method should be expressed in terms of the popup menus' invoker.

Parameters: component Invoker for this popup menu x x-coordinate of the popup menu relative to the specified invoker y y-coordiate of the popup menu relative to the specified invoker

This method sets this menuItem's UI to the UIManager's default for the current look and feel.

Class JPopupMenu