public abstract class PluginAction
extends java.lang.Object
| Constructor and Description |
|---|
PluginAction() |
| 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.
|
public final java.lang.String getPluginId()
Plugin class for the plug-in.public final void setPluginId(java.lang.String pluginId)
public abstract java.lang.String getId()
Important: This identifier is used in URLs so it must contain only alphanumeric characters.
String that is used to identify the action.public abstract java.lang.String getName(java.util.Locale locale)
locale - The current locale for the user.public abstract java.lang.String getIcon()
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.
public abstract java.lang.String getPrivilege()
String that contains the list of privilege names that the user must have on the selected
documents for this action to be enabled.public abstract boolean isMultiDoc()
true if the action is enabled when multiple documents are selected.public boolean isGlobal()
true if the action should be global. By default, this function returns
false.public boolean isDynamic()
true if the action should be dynamic. By default, this function returns
false.public abstract java.lang.String getActionFunction()
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. |
public abstract java.lang.String getServerTypes()
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 |
public java.lang.String[] getMenuTypes()
public com.ibm.json.java.JSONObject getAdditionalConfiguration(java.util.Locale locale)
public java.lang.String getActionModelClass()
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.ecm.model.Action to use for this action.public java.lang.String getIconClass()