ro.sync.ecss.extensions.commons.operations

Class EditImageMapOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.EditImageMapOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

EditImageMapOperation, EditImageMapOperation, EditImageMapOperation, EditImageMapOperation

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

Operation used to edit an ImageMap in some documents.

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
EditImageMapOperation(EditImageMapCore imageMapCore) Operation's constructor.

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()
protected void	processArgumentsMap(ArgumentsMap args) Process the arguments map.

Methods inherited from class java.lang.Object

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

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

getDescription

Constructor Detail

EditImageMapOperation

public EditImageMapOperation(EditImageMapCore imageMapCore)

Operation's constructor.

Parameters:

imageMapCore - The image map core utilities.

Method Detail

doOperation

public final 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)

processArgumentsMap

protected void processArgumentsMap(ArgumentsMap args)

Process the arguments map.

Parameters:

args - The map with arguments for this operation.

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