com.ibm.ecm.extension

Class PluginMenuType

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

Constructor Summary

Constructor and Description
PluginMenuType()

Method Summary

Modifier and Type Method and Description
  1. abstract
  2. java.lang.String
 getId()
Returns the identifier that is used to describe this menu type.
  1. abstract
  2. java.lang.String
 getName(java.util.Locale locale)
Returns a descriptive label for this menu type 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 menu type.
  1. abstract
  2. java.lang.String
 getTooltip(java.util.Locale locale)
Returns a descriptive tooltip for this menu type that is displayed in the IBM Content Navigator administration tool.
  1. abstract
  2. boolean
 isToolbar()
Returns a Boolean value indicating whether the menu associated with this menu type is a toolbar.
  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

PluginMenuType

  1. public PluginMenuType()

Method Detail

getId

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

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 type.

getName

  1. public abstract java.lang.String getName( java.util.Locale locale)
Returns a descriptive label for this menu type that is displayed in the IBM Content Navigator administration tool.
Returns:
A String that provides a short description of the menu.

getTooltip

  1. public abstract java.lang.String getTooltip( java.util.Locale locale)
Returns a descriptive tooltip for this menu type that is displayed in the IBM Content Navigator administration tool.
Returns:
A String that provides the tooltip for the menu type.

isToolbar

  1. public abstract boolean isToolbar( )
Returns a Boolean value indicating whether the menu associated with this menu type is a toolbar. If the menu is not a toolbar, then it is a context menu.
Returns:
A value of true if the menu is a toolbar. This method returns a value of false if the menu is a context menu.

getPluginId

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

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.