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 Description static java.lang.String
MATH_ML
The MathML fragment representing the default equation.static java.lang.String
MATH_ML_FOR_HTML_DOC_TYPE
The MathML fragment representing the default equation for HTML documents.static java.lang.String
MATH_ML_NAMESPACE
The MathML namespace.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 Description InsertEquationOperation()
Constructor to assign arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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()
-
-
-
Field Detail
-
MATH_ML_NAMESPACE
public static final java.lang.String MATH_ML_NAMESPACE
The MathML namespace.- See Also:
- Constant Field Values
-
MATH_ML
public static final java.lang.String MATH_ML
The MathML fragment representing the default equation.
-
MATH_ML_FOR_HTML_DOC_TYPE
public static final java.lang.String MATH_ML_FOR_HTML_DOC_TYPE
The MathML fragment representing the default equation for HTML documents.
-
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.
-
-
Method Detail
-
doOperation
public void doOperation(AuthorAccess authorAccess, ArgumentsMap args) throws 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:ApplicationInformationAccess.getPlatform()
. To get to theWorkspace
you may use:AuthorAccess.getWorkspaceAccess()
.- Specified by:
doOperation
in interfaceAuthorOperation
- 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 methodAuthorOperation.getArguments()
must be present in the map of arguments.- Throws:
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 interfaceAuthorOperation
- 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 interfaceExtension
- 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.
-
-