All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JPopupMenu

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.JPopupMenu

public class JPopupMenu

extends JComponent

implements Accessible, MenuElement

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JPopupMenu key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

JPopupMenu()

Create a JPopupMenu without an "invoker".

JPopupMenu(String)

Create a JPopupMenu with the specified title.

add(Action)

Append a new menuitem to the end of the menu which dispatches the specified Action object.

add(Component)

Appends the specified component to the end of this menu.

add(JMenuItem)

Appends the specified menu item to the end of this menu.

addPopupMenuListener(PopupMenuListener)

Add a PopupMenu listener param l the PopupMenuListener to add

addSeparator()

createActionChangeListener(JMenuItem)

firePopupMenuCanceled()

Notifies PopupMenuListeners that this popup menu is canceled

firePopupMenuWillBecomeInvisible()

Notifies PopupMenuListeners that this popup menu will become invisible

firePopupMenuWillBecomeVisible()

Notifies PopupMenuListeners that this popup menu will become visible

getAccessibleContext()

Get the AccessibleContext associated with this JComponent

getComponent()

getComponentAtIndex(int)

Returns the component at the specified index.

getComponentIndex(Component)

Returns the index of the specified component.

getDefaultLightWeightPopupEnabled()

Return the default value for the lightWeightPopupEnabled property.

getInvoker()

Returns the component which is the 'invoker' of this popup menu.

getLabel()

Returns the popup menu's label

getMargin()

Returns the margin between the popupmenu's border and its containees.

getSelectionModel()

Returns the model object that handles single selections.

getSubElements()

getUI()

Returns the L&F object that renders this component.

getUIClassID()

Returns the name of the L&F class that renders this component.

insert(Action, int)

Inserts a menu item for the specified Action object at a given position.

insert(Component, int)

Inserts the specified component into the menu at a given position.

isBorderPainted()

Checks whether the border should be painted.

isLightWeightPopupEnabled()

Returns true if lightweight (all-Java) popups are in use, or false if heavyweight (native peer) popups are being used.

isVisible()

Returns true if the popupmenu is visible (currently being displayed).

menuSelectionChanged(boolean)

pack()

Layout the container so that it uses the minimum space needed to display its contents.

paintBorder(Graphics)

Paint the popup menu's border if BorderPainted property is true.

processKeyEvent(KeyEvent, MenuElement[], MenuSelectionManager)

processMouseEvent(MouseEvent, MenuElement[], MenuSelectionManager)

removePopupMenuListener(PopupMenuListener)

Remove a PopupMenu listener param l the PopupMenuListener to remove

setBorderPainted(boolean)

Sets whether the border should be painted.

setDefaultLightWeightPopupEnabled(boolean)

Set the default value for the lightWeightPopupEnabled property.

setInvoker(Component)

Sets the invoker of this popupmenu -- the component in which the popupmenu menu is to be displayed.

setLabel(String)

Sets the popup menu's label.

setLightWeightPopupEnabled(boolean)

When displaying the popup, JPopupMenu choose to use a light weight popup if it fits.

setLocation(int, int)

Set the location of the upper left corner of the popup menu using x, y coordinates.

setPopupSize(Dimension)

Sets the size of the Popup window using a Dimension object.

setPopupSize(int, int)

Sets the size of the Popup window to the specified width and height.

setSelected(Component)

Sets the currently selected component, This will result in a change to the selection model.

setSelectionModel(SingleSelectionModel)

Set the model object to handle single selections.

setUI(PopupMenuUI)

Sets the L&F object that renders this component.

setVisible(boolean)

show(Component, int, int)

Display the popupmenu at the position x,y in the coordinate space of the component invoker.

updateUI()

Notification from the UIFactory that the L&F has changed.

 public JPopupMenu()

Create a JPopupMenu without an "invoker".

 public JPopupMenu(String label)

Create a JPopupMenu with the specified title.

Parameters:

label - The string that a UI may use to display as a title for the popup menu.

 public static void setDefaultLightWeightPopupEnabled(boolean aFlag)

Set the default value for the lightWeightPopupEnabled property.

 public static boolean getDefaultLightWeightPopupEnabled()

Return the default value for the lightWeightPopupEnabled property.

 public PopupMenuUI getUI()

Returns the L&F object that renders this component.

Returns:

the PopupMenuUI object that renders this component

 public void setUI(PopupMenuUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the new PopupMenuUI L&F object

See Also:

getUI

 public void updateUI()

Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.

Overrides:

updateUI in class JComponent

See Also:

updateUI

 public String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"PopupMenuUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

 public SingleSelectionModel getSelectionModel()

Returns the model object that handles single selections.

Returns:

the SingleSelectionModel in use

See Also:

SingleSelectionModel

 public void setSelectionModel(SingleSelectionModel model)

Set the model object to handle single selections.

Parameters:

model - the SingleSelectionModel to use

See Also:

SingleSelectionModel

 public JMenuItem add(JMenuItem menuItem)

Appends the specified menu item to the end of this menu.

Parameters:

c - the JMenuItem to add

Returns:

the JMenuItem added.

 public Component add(Component c)

Appends the specified component to the end of this menu.

Parameters:

c - the Component to add

Returns:

the Component added.

Overrides:

add in class Container

 public JMenuItem add(Action a)

Append a new menuitem to the end of the menu which dispatches the specified Action object.

Parameters:

a - the Action to add to the menu

See Also:

Action

 protected PropertyChangeListener createActionChangeListener(JMenuItem b)

 public void setLightWeightPopupEnabled(boolean aFlag)

When displaying the popup, JPopupMenu choose to use a light weight popup if it fits. This method allows you to disable this feature. You have to do disable it if your application mixes light weight and heavy weights components.

 public boolean isLightWeightPopupEnabled()

Returns true if lightweight (all-Java) popups are in use, or false if heavyweight (native peer) popups are being used.

Returns:

true if lightweight popups are in use

 public String getLabel()

Returns the popup menu's label

See Also:

setLabel

 public void setLabel(String label)

Sets the popup menu's label. Different Look and Feels may choose to display or not display this.

Parameters:

label - the label for the popup menu

See Also:

getText

 public void addSeparator()

 public void insert(Action a,
                    int index)

Inserts a menu item for the specified Action object at a given position.

Parameters:

component - the Action object to insert

index - an int specifying the position at which to insert the Action, where 0 is the first

See Also:

Action

 public void insert(Component component,
                    int index)

Inserts the specified component into the menu at a given position.

Parameters:

component - the Component to insert

index - an int specifying the position at which to insert the component, where 0 is the first

 public void addPopupMenuListener(PopupMenuListener l)

Add a PopupMenu listener param l the PopupMenuListener to add

 public void removePopupMenuListener(PopupMenuListener l)

Remove a PopupMenu listener param l the PopupMenuListener to remove

 protected void firePopupMenuWillBecomeVisible()

Notifies PopupMenuListeners that this popup menu will become visible

 protected void firePopupMenuWillBecomeInvisible()

Notifies PopupMenuListeners that this popup menu will become invisible

 protected void firePopupMenuCanceled()

Notifies PopupMenuListeners that this popup menu is canceled

 public void pack()

Layout the container so that it uses the minimum space needed to display its contents.

 public void setVisible(boolean b)

Overrides:

setVisible in class JComponent

 public boolean isVisible()

Returns true if the popupmenu is visible (currently being displayed).

Overrides:

isVisible in class Component

 public void setLocation(int x,
                         int y)

Set the location of the upper left corner of the popup menu using x, y coordinates.

Parameters:

x - the x coordinate of the popup's new position

y - the y coordinate of the popup's new position

Overrides:

setLocation in class Component

 public Component getInvoker()

Returns the component which is the 'invoker' of this popup menu.

Returns:

the Component in which the popup menu is displayed

 public void setInvoker(Component invoker)

Sets the invoker of this popupmenu -- the component in which the popupmenu menu is to be displayed.

Parameters:

invoker - the Component in which the popup menu is displayed

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

Display the popupmenu at the position x,y in the coordinate space of the component invoker.

Parameters:

invoker - The component in whose space the popupmenu is to appear

x - the x coordinate in invoker's coordinate space at which the popup menu is to be displayed

y - the y coordinate in invoker's coordinate space at which the popup menu is to be displayed

 public int getComponentIndex(Component c)

Returns the index of the specified component.

Parameters:

the - Component to find

Returns:

the index of the component, where 0 is the first, or -1 if the component is not found

 public Component getComponentAtIndex(int i)

Returns the component at the specified index.

Parameters:

i - the index of the component, where 0 is the first

Returns:

the Component at that index

 public void setPopupSize(Dimension d)

Sets the size of the Popup window using a Dimension object.

Parameters:

d - The dimension specifying the new size of this component.

 public void setPopupSize(int width,
                          int height)

Sets the size of the Popup window to the specified width and height.

Parameters:

width - The new width of the Popup in pixels.

height - The new height of the Popup in pixels.

 public void setSelected(Component sel)

Sets the currently selected component, This will result in a change to the selection model.

Parameters:

sel - the Component to select

 public boolean isBorderPainted()

Checks whether the border should be painted.

Returns:

true if the border is painted

See Also:

setBorderPainted

 public void setBorderPainted(boolean b)

Sets whether the border should be painted.

Parameters:

b - if true, the border is painted.

See Also:

isBorderPainted

 protected void paintBorder(Graphics g)

Paint the popup menu's border if BorderPainted property is true.

Overrides:

paintBorder in class JComponent

See Also:

paint, setBorder

 public Insets getMargin()

Returns the margin between the popupmenu's border and its containees. return an Insets object containing the margin values.

 public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JComponent

 public void processMouseEvent(MouseEvent event,
                               MenuElement path[],
                               MenuSelectionManager manager)

 public void processKeyEvent(KeyEvent e,
                             MenuElement path[],
                             MenuSelectionManager manager)

 public void menuSelectionChanged(boolean isIncluded)

 public MenuElement[] getSubElements()

 public Component getComponent()

All Packages  Class Hierarchy  This Package  Previous  Next  Index