IlvPopupMenuManager (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.swing.IlvPopupMenuManager

All Implemented Interfaces:

SwingConstants
```
public class IlvPopupMenuManager
extends Object
implements SwingConstants
```
This class enables Swing pop-up menus on graphic objects in a manager view.
Each graphic object contained in the manager associated with the view can have its own pop-up menu. There are three ways to implement Swing pop-up menus on graphic objects.
- The pop-up menu is set on the graphic object using the method IlvGraphic.setPopupMenu(javax.swing.JPopupMenu).
- The pop-up menu is registered at this pop-up menu manager with a name by registerMenu(String, javax.swing.JPopupMenu) and the name of the pop-up menu is set on the graphic object using the method IlvGraphic.setPopupMenuName(java.lang.String).
- The pop-up menu is allocated on the fly by overriding the method IlvGraphic.getPopupMenu(IlvPoint, IlvTransformer, IlvManagerView, IlvPopupMenuManager) in a graphic object subclass.
If a pop-up menu is triggered in a manager view to a position where a graphic object is located, the pop-up menu of the graphic object is displayed if available. If no graphic object is located at that position, the pop-up menu of the manager of the view is displayed if available.
To enable Swing pop-up menus in a view, call the static method registerView(ilog.views.IlvManagerView). To disable tooltips in a view, call unregisterView(ilog.views.IlvManagerView).
The pop-up menu manager can also be used to enable pop-up menus on arbitrary Swing component, via setPopupMenu(JComponent, JPopupMenu).
Since:

JViews 7.5

See Also:

IlvGraphic, IlvManagerView

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JCOMPONENT_POPUP_MENU_CONTEXT_KEY` The key of the client property of a `JPopupMenu` used to store the pop-up menu context via `JComponent.setClientProperty`.
`static String`	`JCOMPONENT_POPUP_MENU_KEY` The key of the client property of Swing components used to store a Swing pop-up menu or its name via `JComponent.setClientProperty`.

Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`doPopup(IlvManagerView view, IlvGraphic g)` Shows a pop-up menu for the input graphic object on the input view.
`static JPopupMenu`	`getPopupMenu(JComponent component)` Returns a Swing pop-up menu of a Swing component.
`static IlvPopupMenuContext`	`getPopupMenuContext(MenuElement element)` Returns the pop-up menu context of a pop-up menu element (for instance, the pop-up menu itself or a menu item or a submenu).
`static JPopupMenu`	`getRegisteredMenu(String name)` Returns the Swing pop-up menu registered for a given name.
`static void`	`registerMenu(String name, JPopupMenu popupMenu)` Registers a Swing pop-up menu with a given name.
`static void`	`registerView(IlvManagerView view)` Enables the Swing pop-up menus of graphic objects in a manager view.
`static void`	`setPopupMenu(JComponent component, JPopupMenu popupMenu)` Stores a Swing pop-up menu of a Swing component.
`static void`	`setPopupMenuContext(MenuElement element, IlvPopupMenuContext context)` Stores the pop-up menu context of a pop-up menu element (for instance, the pop-up menu itself or a menu item or a submenu).
`static void`	`setPopupMenuName(JComponent component, String popupMenuName)` Stores the name of a Swing pop-up menu of a Swing component.
`static void`	`unregisterMenu(String name)` Removes the name of a Swing pop-up menu from the register.
`static void`	`unregisterView(IlvManagerView view)` Disables the Swing pop-up menus of graphic objects in a manager view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JCOMPONENT_POPUP_MENU_KEY
```
public static final String JCOMPONENT_POPUP_MENU_KEY
```
    The key of the client property of Swing components used to store a Swing pop-up menu or its name via JComponent.setClientProperty.
    
    See Also:
    
    setPopupMenu(javax.swing.JComponent, javax.swing.JPopupMenu)
  - JCOMPONENT_POPUP_MENU_CONTEXT_KEY
```
public static final String JCOMPONENT_POPUP_MENU_CONTEXT_KEY
```
    The key of the client property of a JPopupMenu used to store the pop-up menu context via JComponent.setClientProperty.
    
    See Also:
    
    setPopupMenuContext(javax.swing.MenuElement, ilog.views.swing.IlvPopupMenuContext)
- Method Detail
  - registerView
```
public static void registerView(IlvManagerView view)
```
    Enables the Swing pop-up menus of graphic objects in a manager view.
    
    Parameters:
    
    view - The manager view.
    
    See Also:
    
    IlvGraphic.setPopupMenu(javax.swing.JPopupMenu), unregisterView(ilog.views.IlvManagerView)
  - unregisterView
```
public static void unregisterView(IlvManagerView view)
```
    Disables the Swing pop-up menus of graphic objects in a manager view.
    
    Parameters:
    
    view - The manager view.
    
    See Also:
    
    registerView(ilog.views.IlvManagerView)
  - registerMenu
```
public static void registerMenu(String name,
                                JPopupMenu popupMenu)
```
    Registers a Swing pop-up menu with a given name. This allows you to specify Swing pop-up menus for graphic objects by name using IlvGraphic.setPopupMenuName(java.lang.String).
    
    Parameters:
    
    name - The name of the pop-up menu.
    
    popupMenu - The pop-up menu.
    
    See Also:
    
    IlvGraphic.setPopupMenuName(java.lang.String)., unregisterMenu(java.lang.String)
  - unregisterMenu
```
public static void unregisterMenu(String name)
```
    Removes the name of a Swing pop-up menu from the register. A graphic object that uses this name to identify the Swing pop-up menus will not anymore have any pop-up menu enabled.
    
    Parameters:
    
    name - The name of the pop-up menu.
    
    See Also:
    
    IlvGraphic.setPopupMenuName(java.lang.String)., registerMenu(java.lang.String, javax.swing.JPopupMenu)
  - getRegisteredMenu
```
public static JPopupMenu getRegisteredMenu(String name)
```
    Returns the Swing pop-up menu registered for a given name.
    
    See Also:
    
    registerMenu(java.lang.String, javax.swing.JPopupMenu)
  - setPopupMenu
```
public static void setPopupMenu(JComponent component,
                                JPopupMenu popupMenu)
```
    Stores a Swing pop-up menu of a Swing component. This can be used to enable pop-up menus in Swing components that don't contain a manager view.
    
    Parameters:
    
    component - The Swing component.
    
    popupMenu - The pop-up menu. If null, the pop-up menu will be removed from the component.
    
    See Also:
    
    getPopupMenu(javax.swing.JComponent)
  - setPopupMenuName
```
public static void setPopupMenuName(JComponent component,
                                    String popupMenuName)
```
    Stores the name of a Swing pop-up menu of a Swing component. This is an alternative way to set the pop-up menu of this object. You need to register a Swing pop-up menu for the name via registerMenu(String name, javax.swing.JPopupMenu) and use the name to specify the pop-up menu of the input component. This can be used to enable pop-up menus in Swing components that don't contain a manager view.
    
    Parameters:
    
    component - The Swing component.
    
    popupMenuName - The name of the registered Swing pop-up menu to be used for the input component. If popupName is null, the pop-up menu will be removed from the component.
    
    See Also:
    
    getPopupMenu(javax.swing.JComponent)
  - getPopupMenu
```
public static JPopupMenu getPopupMenu(JComponent component)
```
    Returns a Swing pop-up menu of a Swing component.
    
    See Also:
    
    setPopupMenu(javax.swing.JComponent, javax.swing.JPopupMenu)
  - setPopupMenuContext
```
public static void setPopupMenuContext(MenuElement element,
                                       IlvPopupMenuContext context)
```
    Stores the pop-up menu context of a pop-up menu element (for instance, the pop-up menu itself or a menu item or a submenu). This is called when the display of the pop-up menu is triggered. The context can be used inside the action listener of the pop-up menu to decide how the action must be performed.
    
    See Also:
    
    getPopupMenuContext(javax.swing.MenuElement)
  - getPopupMenuContext
```
public static IlvPopupMenuContext getPopupMenuContext(MenuElement element)
```
    Returns the pop-up menu context of a pop-up menu element (for instance, the pop-up menu itself or a menu item or a submenu). The action listener of a menu element can retrieve the context of the pop-up menu in order to decide how the action must be performed.
    
    See Also:
    
    setPopupMenuContext(javax.swing.MenuElement, ilog.views.swing.IlvPopupMenuContext)
  - doPopup
```
public static void doPopup(IlvManagerView view,
                           IlvGraphic g)
```
    Shows a pop-up menu for the input graphic object on the input view. The graphic object must belong to a manager contained in the view.
    
    Since:
    
    JViews 8.8

Class IlvPopupMenuManager

Field Summary

Fields inherited from interface javax.swing.SwingConstants

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JCOMPONENT_POPUP_MENU_KEY

JCOMPONENT_POPUP_MENU_CONTEXT_KEY

Method Detail

registerView

unregisterView

registerMenu

unregisterMenu

getRegisteredMenu

setPopupMenu

setPopupMenuName

getPopupMenu

setPopupMenuContext

getPopupMenuContext

doPopup