com.ibm.ecm.extension

Class PluginMenuItem

java.lang.Object

com.ibm.ecm.extension.PluginMenuItem

public class PluginMenuItem
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
PluginMenuItem(java.lang.String actionId) Creates a simple menu item.
PluginMenuItem(java.lang.String actionId, java.lang.String actionLabel) Creates a simple menu item.
PluginMenuItem(java.lang.String actionIdsLabel, java.lang.String[] actionIds) Constructs a menu item as a list of items.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionId() Returns an identifier for an action that is performed by this menu item.
java.lang.String[]	getActionIds() Returns an array of identifiers for actions that are performed by this menu item.
java.lang.String	getActionIdsLabel(java.util.Locale locale) Returns a label for the action identifier.
java.lang.String	getActionLabel() Returns custom label for an action that is performed by this menu item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginMenuItem

public PluginMenuItem(java.lang.String actionId)

Creates a simple menu item. Provides the identifier of the action for that menu item.

Parameters:

actionId - The action identifier for the action associated with the menu item.

PluginMenuItem

public PluginMenuItem(java.lang.String actionId,
                      java.lang.String actionLabel)

Creates a simple menu item. Provides the identifier of the action and custom label for that menu item.

Parameters:

actionId - The action identifier for the action associated with the menu item.

actionId - The custom label for the action associated with the menu item.

PluginMenuItem

public PluginMenuItem(java.lang.String actionIdsLabel,
                      java.lang.String[] actionIds)

Constructs a menu item as a list of items. This constructor is used to provide a cascading menu.

Parameters:

actionIdsLabel - A label that is used to identify the menu item.

actionIds - An array of identifiers for the actions on the menu.

Method Detail

getActionId

public java.lang.String getActionId()

Returns an identifier for an action that is performed by this menu item.

Returns:

An alphanumeric String that is used to identify an action.

getActionIdsLabel

public java.lang.String getActionIdsLabel(java.util.Locale locale)

Returns a label for the action identifier. This method is used to provide a label for cascading menus. For example, if an item in the top-level menu has a cascading menu, you use this method to provide the label for that top-level menu item that opens the cascade of submenu actions.

Returns:

An alphanumeric String that is used to identify the list of actions.

getActionIds

public java.lang.String[] getActionIds()

Returns an array of identifiers for actions that are performed by this menu item. This method is used to create a cascading menu item.

Returns:

An array of alphanumeric Strings that is used to identify the list of actions.

getActionLabel

public java.lang.String getActionLabel()

Returns custom label for an action that is performed by this menu item.

Returns:

An alphanumeric String that is used to identify an action.