com.ibm.ecm.extension

Class PluginMenuType

java.lang.Object

com.ibm.ecm.extension.PluginMenuType

public abstract class PluginMenuType
extends java.lang.Object

Provides an abstract class that is extended to define a custom menu type provided by a plug-in.

Constructor Summary

Constructors

Constructor and Description
PluginMenuType()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getId() Returns the identifier that is used to describe this menu type.
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.
java.lang.String	getPluginId() Returns the identifier of the plug-in that contains this menu type.
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.
abstract boolean	isToolbar() Returns a Boolean value indicating whether the menu associated with this menu type is a toolbar.
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

public PluginMenuType()

Method Detail

getId

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

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

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

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

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

public final void setPluginId(java.lang.String pluginId)

For Internal Use Only. Sets the identifier of the plug-in that contains this action.