ro.sync.ecss.extensions.commons.operations

Class InsertEquationOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.InsertEquationOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

InsertEquationOperation, InsertEquationOperation

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

Operation used to insert an MathML Equation in any documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger Logger for logging.
static java.lang.String	MATH_ML The MathML fragment representing the default equation.
static java.lang.String	WEBAPP_MATH_ML The MathML fragment representing the default equation for webapp.

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
InsertEquationOperation() Constructor to assign arguments.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createDefaultFragmentToEdit(AuthorAccess authorAccess, AuthorSchemaManager asm) Return default fragment.
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() The MathML XML fragment can be customized by the developer.
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Logger for logging.

MATH_ML

public static final java.lang.String MATH_ML

The MathML fragment representing the default equation.

See Also:

Constant Field Values

WEBAPP_MATH_ML

public static final java.lang.String WEBAPP_MATH_ML

The MathML fragment representing the default equation for webapp. We need some initial equation so that we can render a equation for the user to click on.

See Also:

Constant Field Values

Constructor Detail

InsertEquationOperation

public InsertEquationOperation()

Constructor to assign arguments.

Method Detail

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()

The MathML XML fragment can be customized by the developer.

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

createDefaultFragmentToEdit

protected java.lang.String createDefaultFragmentToEdit(AuthorAccess authorAccess,
                                                       AuthorSchemaManager asm)

Return default fragment.

Parameters:

authorAccess - Author access.

asm - The author schema manager.

Returns:

The default fragment.