Package 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

@API(type=INTERNAL,
     src=PUBLIC)
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

Constructors

Constructor	Description
ConfigureAutoIDElementsOperation()

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()	No Arguments
protected GenerateIDElementsInfo	getDefaultOptions(AuthorAccess authorAccess)	Get the default generation options
protected java.lang.String	getDefaultOptionsXMLResourceName()	Get the name of the XML resource from which to load the default options.
protected java.lang.String	getHelpPageID()	Get the ID of the help page which will be called by the end user.
protected abstract java.lang.String	getListMessage()
protected boolean	isDocBook()	Check if DocBook.

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

getDefaultOptions

protected GenerateIDElementsInfo getDefaultOptions(AuthorAccess authorAccess)

Get the default generation options

Returns:

The default generation options.

getDefaultOptionsXMLResourceName

protected java.lang.String getDefaultOptionsXMLResourceName()

Get the name of the XML resource from which to load the default options.

Returns:

the name of the XML resource from which to load the default options.

getListMessage

protected abstract java.lang.String getListMessage()

Returns:

The message used on the list

isDocBook

protected boolean isDocBook()

Check if DocBook.

Returns:

true if we are in DocBook.

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

getHelpPageID

protected java.lang.String getHelpPageID()

Get the ID of the help page which will be called by the end user.

Returns:

the ID of the help page which will be called by the end user or null.