com.ibm.ecm.extension

Class PluginMenu

  1. java.lang.Object
  2. extended bycom.ibm.ecm.extension.PluginMenu
  1. public abstract class PluginMenu
  2. extends java.lang.Object
Provides an abstract class that is extended to define a menu in a plug-in.

Constructor Summary

Constructor and Description
PluginMenu()

Method Summary

Modifier and Type Method and Description
  1. abstract
  2. java.lang.String
 getDescription(java.util.Locale locale)
Returns a description for this menu that is displayed in the IBM Content Navigator administration tool.
  1. abstract
  2. java.lang.String
 getId()
Returns an identifier that is used to describe this menu.
  1. PluginMenuItem[]
 getMenuItems()
Returns an array of PluginMenuItem objects for all the actions in this menu.
  1. PluginMenuItem[]
 getMenuItems(java.util.Locale locale)
Returns an array of PluginMenuItem objects for all the actions in this menu.
  1. abstract
  2. java.lang.String
 getMenuType()
Returns the identifier for the menu type that is used for this menu.
  1. abstract
  2. 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.
  1. java.lang.String
 getPluginId()
Returns the identifier of the plug-in that contains this action.
  1. void
 setPluginId(java.lang.String pluginId)
For Internal Use Only.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginMenu

  1. public PluginMenu()

Method Detail

getId

  1. public abstract java.lang.String getId( )
Returns an identifier that is used to describe this menu.

Important: This identifier is used in URLs so it must contain only alphanumeric characters.

Returns:
An alphanumeric String that is used to identify the menu.

getName

  1. public 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.
Returns:
A String containing the short description of the menu.

getDescription

  1. public 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.
Returns:
A String that provides a short description of the menu.

getMenuType

  1. public abstract java.lang.String getMenuType( )
Returns the identifier for the menu type that is used for this menu.
Returns:
A String containing the identifier of the menu type.

getMenuItems

  1. public PluginMenuItem[] getMenuItems( )
Returns an array of 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.
Returns:
An array of PluginMenuItem objects.

getMenuItems

  1. public PluginMenuItem[] getMenuItems( java.util.Locale locale)
Returns an array of 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.
Parameters:
locale - The client locale used to localize sub-menu labels.
Returns:
An array of PluginMenuItem objects.

getPluginId

  1. public final java.lang.String getPluginId( )
Returns the identifier of the plug-in that contains this action.

Important: This method is implemented by IBM Content Navigator and must not be overridden.

Returns:
An instance of the Plugin class for the plug-in.

setPluginId

  1. public final void setPluginId(java.lang.String pluginId)
For Internal Use Only. Sets the identifier of the plug-in that contains this action.