ro.sync.ecss.extensions.dita.reuse

Class CreateReusableComponentOperation

java.lang.Object

ro.sync.ecss.extensions.dita.reuse.CreateReusableComponentOperation

All Implemented Interfaces:

AuthorOperation, ro.sync.ecss.extensions.api.DITAUniqueIDAssigner, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class CreateReusableComponentOperation
extends java.lang.Object
implements AuthorOperation, ro.sync.ecss.extensions.api.DITAUniqueIDAssigner

Operation used to create a reusable component 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
CreateReusableComponentOperation()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateReusableComponentOperation

public CreateReusableComponentOperation()

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

getArguments

public ArgumentDescriptor[] getArguments()

No arguments. The reuse content operation will display a dialog for choosing the file to save to.

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

generateID

public java.lang.String generateID(AuthorAccess authorAccess,
                                   java.lang.String seed)

Specified by:

generateID in interface ro.sync.ecss.extensions.api.DITAUniqueIDAssigner

See Also:

DITAUniqueIDAssigner.generateID(ro.sync.ecss.extensions.api.AuthorAccess, java.lang.String)