com.ibm.ecm.extension

Class PluginAction

java.lang.Object

com.ibm.ecm.extension.PluginAction

public abstract class PluginAction
extends java.lang.Object

Provides an abstract class that is extended to define a client-side action that is provided by a plug-in. The actions that are defined by subclasses of this class appear on the IBM Content Navigator toolbar and on the context menus within the content list.

Constructor Summary

Constructors

Constructor and Description
PluginAction()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getActionFunction() Provides the name of the JavaScript function that is invoked for this action.
java.lang.String	getActionModelClass() Provides the name of the ecm.model.Action subclass to use when this plug-in action is invoked.
com.ibm.json.java.JSONObject	getAdditionalConfiguration(java.util.Locale locale) Returns additional JSON that will appear on the ecm.model.Action JavaScript object for this action.
abstract java.lang.String	getIcon() Deprecated. Since 2.0.3. Plugins should provide an icon cascading style sheet class and override getIconClass to specify images for buttons and menu items.
java.lang.String	getIconClass() Returns the name of the icon style class applied to the toolbar button or menu item for this action.
abstract java.lang.String	getId() Returns an alphanumeric identifier that is used to describe this action.
java.lang.String[]	getMenuTypes() Returns the menu types that this action is appropriate for.
abstract java.lang.String	getName(java.util.Locale locale) Returns a descriptive label for this action that is displayed on pop-up menus and as hover help for the icon on the toolbar.
java.lang.String	getPluginId() Returns the identifier of the plug-in that contains this action.
abstract java.lang.String	getPrivilege() Returns a String that contains the list of privilege names that the user must have on the selected documents for this action to be enabled.
abstract java.lang.String	getServerTypes() Returns the server types that this action is valid on.
boolean	isDynamic() Returns a Boolean value that indicates whether this action is dynamic.
boolean	isGlobal() Returns a Boolean value that indicates whether this action is global.
abstract boolean	isMultiDoc() Returns a Boolean value that indicates whether this action is enabled when multiple documents are selected.
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

PluginAction

public PluginAction()

Method Detail

getPluginId

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 is not to 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 value of the identifier of the plug-in that contains this action.

getId

public abstract java.lang.String getId()

Returns an alphanumeric identifier that is used to describe this action.

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

Returns:

An alphanumeric String that is used to identify the action.

getName

public abstract java.lang.String getName(java.util.Locale locale)

Returns a descriptive label for this action that is displayed on pop-up menus and as hover help for the icon on the toolbar.

Parameters:

locale - The current locale for the user.

Returns:

A short description of the action.

getIcon

public abstract java.lang.String getIcon()

Deprecated. Since 2.0.3. Plugins should provide an icon cascading style sheet class and override getIconClass to specify images for buttons and menu items.

Returns the name of the icon that is displayed on the toolbar for this action.

An icon file is a 23x23 pixel transparent image, for example, a transparent GIF image or PNG image. The icon file must be included in the pluginPackage/WebContent subdirectory of the JAR file for the plug-in that contains this action.

Returns:

The name of the icon file.

getPrivilege

public abstract java.lang.String getPrivilege()

Returns a String that contains the list of privilege names that the user must have on the selected documents for this action to be enabled.

Returns:

A list of one or more comma-separated privilege names. An empty string indicates that no privileges are required for this action to be enabled.

isMultiDoc

public abstract boolean isMultiDoc()

Returns a Boolean value that indicates whether this action is enabled when multiple documents are selected.

Returns:

A value of true if the action is enabled when multiple documents are selected.

isGlobal

public boolean isGlobal()

Returns a Boolean value that indicates whether this action is global. Global actions appear on the toolbar at the top of the application interface and do not require that documents are selected. This method can be overridden by subclasses.

Returns:

A value of true if the action should be global. By default, this function returns false.

isDynamic

public boolean isDynamic()

Returns a Boolean value that indicates whether this action is dynamic. Dynamic actions are actions containing sub actions dynamically generated at runtime. This method can be overridden by subclasses.

Returns:

A value of true if the action should be dynamic. By default, this function returns false.

getActionFunction

public abstract java.lang.String getActionFunction()

Provides the name of the JavaScript function that is invoked for this action.

This parameters to this function include:

Parameter	Description
repository	An instance of ecm.model.Respository.
items	An array of ecm.model.Item objects.
callback	A function to be invoked by the action when the action completes.
teamspace	An instance of ecm.model.Teamspace if the action is related to a particular teamspace.
resultSet	An instance of ecm.model.ResultSet if the action is related to a particular result set.
parameterMap	Other parameters to the action.

Returns:

The name of a JavaScript function that is contained in one of the script files with the plug-in.

getServerTypes

public abstract java.lang.String getServerTypes()

Returns the server types that this action is valid on.

Returns:

A String that contains one or more of the following values separated by commas:

Server Type	Description
p8	IBM FileNet P8
cm	IBM Content Manager
od	IBM Content Manager OnDemand
cmis	OASIS Content Management Interoperability Services

getMenuTypes

public java.lang.String[] getMenuTypes()

Returns the menu types that this action is appropriate for.

Returns:

An array of menu type identifiers, either built-in menu types or plug-in defined. If the action is appropriate for all menu types, a zero length array can be returned. The default implementation returns a zero length array.

Since:

2.0.2

getAdditionalConfiguration

public com.ibm.json.java.JSONObject getAdditionalConfiguration(java.util.Locale locale)

Returns additional JSON that will appear on the ecm.model.Action JavaScript object for this action. This can be used to provide custom configuration information for the action as needed by plug-in provided JavaScript for the action.

Returns:

An instance of JSONObject containing properties that will be mixed into the ecm.model.Action object. The default implementation returns an empty JSONObject.

Since:

2.0.2

getActionModelClass

public java.lang.String getActionModelClass()

Provides the name of the ecm.model.Action subclass to use when this plug-in action is invoked. The ecm.model.Action subclass provides custom code for enabling or disabling the action. If an ecm.model.Action subclass is not specified, then the default ecm.model.Action class is used.

Returns:

The name of an instance of ecm.model.Action to use for this action.

getIconClass

public java.lang.String getIconClass()

Returns the name of the icon style class applied to the toolbar button or menu item for this action.

Returns:

The name of the icon style class.