ro.sync.ecss.extensions.commons.id
Class ConfigureAutoIDElementsOperation

java.lang.Object
  ro.sync.ecss.extensions.commons.id.ConfigureAutoIDElementsOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

DITAConfigureAutoIDElementsOperation, DocbookConfigureAutoIDElementsOperation, TEIConfigureAutoIDElementsOperation

public abstract class ConfigureAutoIDElementsOperation
extends java.lang.Object
implements AuthorOperation

Operation used to configure elements for which ID generation is auto.

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

ConfigureAutoIDElementsOperation()

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() No Arguments
protected abstract GenerateIDElementsInfo	getDefaultOptions()
protected abstract java.lang.String	getListMessage()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

ConfigureAutoIDElementsOperation

public ConfigureAutoIDElementsOperation()

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.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:

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)

getDefaultOptions

protected abstract GenerateIDElementsInfo getDefaultOptions()

Returns:

The default generation options.

getListMessage

protected abstract java.lang.String getListMessage()

Returns:

The message used on the list

getArguments

public ArgumentDescriptor[] getArguments()

No Arguments

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()