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

java.lang.Object
  ro.sync.ecss.extensions.dita.reuse.CreateReusableComponentOperation

All Implemented Interfaces:

AuthorOperation, DITAUniqueIDAssigner, Extension

public class CreateReusableComponentOperation
extends Object
implements AuthorOperation, 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

CreateReusableComponentOperation()

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
String	generateID(AuthorAccess authorAccess, String seed) Generate an unique ID from an element local name
ArgumentDescriptor[]	getArguments() No arguments.
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 IllegalArgumentException,
                        AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. This method is typically called from an ActionListener.actionPerformed(java.awt.event.ActionEvent) if used from Oxygen stand-alone distribution or org.eclipse.jface.action.Action#run() if used from the Oxygen Eclipse plugin.

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:

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

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

generateID

public String generateID(AuthorAccess authorAccess,
                         String seed)

Description copied from interface: DITAUniqueIDAssigner

Generate an unique ID from an element local name

Specified by:

generateID in interface DITAUniqueIDAssigner

Parameters:

authorAccess - The author access

seed - The element local name

Returns:

The unique ID

See Also:

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