public abstract class PluginMenu
extends java.lang.Object
| Constructor and Description |
|---|
PluginMenu() |
| Modifier and Type | Method and Description |
|---|---|
abstract java.lang.String |
getDescription(java.util.Locale locale)
Returns a description for this menu that is displayed in the IBM Content Navigator administration tool.
|
abstract java.lang.String |
getId()
Returns an identifier that is used to describe this menu.
|
PluginMenuItem[] |
getMenuItems()
Returns an array of
PluginMenuItem objects for all the actions in this menu. |
PluginMenuItem[] |
getMenuItems(java.util.Locale locale)
Returns an array of
PluginMenuItem objects for all the actions in this menu. |
abstract java.lang.String |
getMenuType()
Returns the identifier for the menu type that is used for this menu.
|
abstract java.lang.String |
getName(java.util.Locale locale)
Returns a descriptive label for this menu that is displayed in the IBM Content Navigator administration tool.
|
java.lang.String |
getPluginId()
Returns the identifier of the plug-in that contains this action.
|
void |
setPluginId(java.lang.String pluginId)
For Internal Use Only.
|
public abstract java.lang.String getId()
Important: This identifier is used in URLs so it must contain only alphanumeric characters.
String that is used to identify the menu.public abstract java.lang.String getName(java.util.Locale locale)
String containing the short description of the menu.public abstract java.lang.String getDescription(java.util.Locale locale)
String that provides a short description of the menu.public abstract java.lang.String getMenuType()
String containing the identifier of the menu type.public PluginMenuItem[] getMenuItems()
PluginMenuItem objects for all the actions in this menu. Supports one level of a
cascading menu, which means that a menu item in a top-level menu can have one submenu.PluginMenuItem objects.public PluginMenuItem[] getMenuItems(java.util.Locale locale)
PluginMenuItem objects for all the actions in this menu. Supports one level of a
cascading menu, which means that a menu item in a top-level menu can have one submenu.locale - The client locale used to localize sub-menu labels.PluginMenuItem objects.public final java.lang.String getPluginId()
Important: This method is implemented by IBM Content Navigator and must not be overridden.
Plugin class for the plug-in.public final void setPluginId(java.lang.String pluginId)