Package ro.sync.ecss.extensions.dita.conref

Class InsertConrefOperation

java.lang.Object

ro.sync.ecss.extensions.dita.conref.InsertConrefOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertConrefOperation
extends Object
implements AuthorOperation

Operation used to insert a conref in DITA documents.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_ELEMENT_CLASS	The reference class key to retrieve the value from the arguments map sent from client-side.
static final String	ARGUMENT_REFERENCE_VALUE	The the reference value - used only when called from JS code.

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

ARGUMENT_REFERENCE_VALUE

public static final String ARGUMENT_REFERENCE_VALUE

The the reference value - used only when called from JS code.

See Also:

• Constant Field Values

ARGUMENT_ELEMENT_CLASS

public static final String ARGUMENT_ELEMENT_CLASS

The reference class key to retrieve the value from the arguments map sent from client-side.

See Also:

• Constant Field Values

Constructor Details

InsertConrefOperation

public InsertConrefOperation()

Method Details

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

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(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

No arguments. The insert conref operation will display a dialog for choosing the conref 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 String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

• Extension.getDescription()