ro.sync.ecss.extensions.api.webapp

Interface WebappActionsManager

All Superinterfaces:

AuthorExtensionActionProvider

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WebappActionsManager
extends AuthorExtensionActionProvider

Helper object that provides access to extension actions, and provides support for invoking operations.

Since:

17

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getExtensionActionsConfiguration() Returns a representation of the extension actions configuration including the actions list and the toolbar configuration.
void	invokeOperation(java.lang.String operationClassName, java.util.Map<java.lang.String,java.lang.Object> args, int imposedOffset) Invokes an operation.

Methods inherited from interface ro.sync.ecss.extensions.api.AuthorExtensionActionProvider

getExtensionAction, getExtensionAction

Method Detail

invokeOperation

void invokeOperation(java.lang.String operationClassName,
                     java.util.Map<java.lang.String,java.lang.Object> args,
                     int imposedOffset)
              throws java.lang.IllegalArgumentException,
                     AuthorOperationException

Invokes an operation.

Parameters:

operationClassName - The name of the class that implements the operation.

args - The arguments in a representation that mimics JSON: JSON string maps to Java String, and JSON object maps to Java Map.

imposedOffset - The offset where the action is to be executed. -1 if the action is to be executed for the current selection.

Throws:

AuthorOperationException - If the action invocation throws.

java.lang.IllegalArgumentException - If the action invocation throws.

getExtensionActionsConfiguration

java.util.Map<java.lang.String,java.lang.Object> getExtensionActionsConfiguration()

Returns a representation of the extension actions configuration including the actions list and the toolbar configuration.

Returns:

The actions configuration.