ro.sync.ecss.extensions.dita.link

Class InsertXrefOperation

java.lang.Object

ro.sync.ecss.extensions.dita.link.InsertXrefOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

InsertLinkOperation

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

Operation used to insert an XRef in DITA 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
InsertXrefOperation() Constructor for the XRef operation.

Method Summary

Methods

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
protected void	doOperationInternal(AuthorAccess authorAccess, ArgumentsMap args, boolean isXref) Perform the operation.
ArgumentDescriptor[]	getArguments() The operation has 3 arguments: format, type and scope.
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertXrefOperation

public InsertXrefOperation()

Constructor for the XRef operation.

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

doOperationInternal

protected void doOperationInternal(AuthorAccess authorAccess,
                       ArgumentsMap args,
                       boolean isXref)
                            throws AuthorOperationException

Perform the operation.

Parameters:

authorAccess - The author access.

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

isXref - true if we need to insert a XRef element, false for link element.

Throws:

AuthorOperationException - Thrown when the operation fails.

getArguments

public ArgumentDescriptor[] getArguments()

The operation has 3 arguments: format, type and scope. The operation will display a dialog for choosing the XRef source and target.

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