Package ro.sync.ecss.extensions.commons.operations

Class InsertOrReplaceFragmentOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.InsertFragmentOperation

ro.sync.ecss.extensions.commons.operations.InsertOrReplaceFragmentOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertOrReplaceFragmentOperation
extends InsertFragmentOperation

Identical with InsertFragmentOperation with the difference that the selection will be removed.

Field Summary

Fields inherited from class ro.sync.ecss.extensions.commons.operations.InsertFragmentOperation

ARGUMENT_DESCR_INSERT_FRAG_EVEN_IF_INVALID, ARGUMENT_DESCRIPTOR_FRAGMENT, ARGUMENT_DESCRIPTOR_GO_TO_NEXT_EDITABLE_POSITION, ARGUMENT_DESCRIPTOR_XPATH_LOCATION, ARGUMENT_FRAGMENT, ARGUMENT_GO_TO_NEXT_EDITABLE_POSITION, ARGUMENT_INSERT_FRAG_EVEN_IF_INVALID, ARGUMENT_RELATIVE_LOCATION, ARGUMENT_XPATH_LOCATION

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

Method Summary

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

Methods inherited from class ro.sync.ecss.extensions.commons.operations.InsertFragmentOperation

doOperationInternal, doOperationInternal

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertOrReplaceFragmentOperation

public InsertOrReplaceFragmentOperation()

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 the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:

doOperation in interface AuthorOperation

Overrides:

doOperation in class InsertFragmentOperation

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:

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(AuthorAccess, ArgumentsMap)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Overrides:

getDescription in class InsertFragmentOperation

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Overrides:

getArguments in class InsertFragmentOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

InsertFragmentOperation.getArguments()