ro.sync.ecss.extensions.commons.operations

Class JSOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.JSOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class JSOperation
extends java.lang.Object
implements AuthorOperation

An implementation of an operation that allows you to call the Java API from custom JavaScript content. This operation has the following parameters:

• script: the JavaScript content to execute.

  It must have a function called doOperation(), which can use the predefined authorAccess variable. The authorAccess variable has access to the AuthorAccess instance. The following example is a script that can be used to move the caret location after the current element:

      function doOperation(){ 
        caretOffset = authorAccess.getEditorAccess().getCaretOffset(); 
        currentNode = authorAccess.getDocumentController().getNodeAtOffset(caretOffset); 
        //Move caret after current node 
        authorAccess.getEditorAccess().setCaretPosition(currentNode.getEndOffset() + 1); 
      }
    

Note: If you have a script called commons.js in the framework directory, you can call functions defined inside it from your custom script content so that you can use that external script file as a library of functions.

Field Summary

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor and Description
JSOperation()

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Constructor Detail

JSOperation

public JSOperation()

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. You can check if the operation was invoked from the oXygen standalone application or from the oXygen plugin for Eclipse by using the method: Workspace.getPlatform(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:

doOperation in interface AuthorOperation

Parameters:

authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.

args - The map of arguments. All the arguments defined by method AuthorOperation.getArguments() must be present in the map of arguments.

Throws:

java.lang.IllegalArgumentException - Thrown when one or more arguments are illegal.

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()