ro.sync.ecss.extensions.api
Interface AuthorOperation

All Superinterfaces:

Extension

All Known Implementing Classes:

AbstractTableOperation, AddEditConrefOperation, CapitalizeSentencesOperation, CapitalizeWordsOperation, ChangeAttributeOperation, ConfigureAutoIDElementsOperation, CountWordsOperation, CreateReusableComponentOperation, DeleteColumnOperation, DeleteColumnOperation, DeleteColumnOperation, DeleteColumnOperation, DeleteColumnOperation, DeleteColumnOperationBase, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperationBase, DITAConfigureAutoIDElementsOperation, DocbookConfigureAutoIDElementsOperation, EditOLinkOperation, FormSelectedTextOperation, GenerateIDsDB4Operation, GenerateIDsDB5Operation, GenerateIDsDITAOperation, GenerateIDsOperation, GenerateIDsTEIP4Operation, GenerateIDsTEIP5Operation, InsertColumnOperation, InsertColumnOperation, InsertColumnOperation, InsertColumnOperation, InsertColumnOperation, InsertColumnOperationBase, InsertConrefOperation, InsertContentKeyrefOperation, InsertEquationOperation, InsertEquationOperation, InsertEquationOperation, InsertEquationOperation, InsertFragmentOperation, InsertGraphicOperation, InsertGUIButtonOperation, InsertImageDataOperation, InsertImageOperation, InsertImageOperationP4, InsertImageOperationP5, InsertImgOperation, InsertKeyrefOperation, InsertLinkOperation, InsertOLinkOperation, InsertOrReplaceFragmentOperation, InsertOrReplaceTextOperation, InsertReusableComponentOperation, InsertRowOperation, InsertRowOperation, InsertRowOperation, InsertRowOperation, InsertRowOperation, InsertRowOperationBase, InsertScreenshotOperation, InsertTableOperation, InsertTableOperation, InsertTableOperation, InsertTableOperation, InsertTableOperation, InsertTopicgroupOperation, InsertTopicheadOperation, InsertTopicrefOperation, InsertXIncludeOperation, InsertXrefOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperationBase, JoinRowCellsOperation, JoinRowCellsOperation, JoinRowCellsOperation, JoinRowCellsOperation, JoinRowCellsOperation, JoinRowCellsOperationBase, PasteAsContentReferenceOperation, PasteAsReferenceOperation, RemoveConrefOperation, ReplaceConrefOperation, SearchReferencesDITAOperation, SelectedTextOperation, ShowElementDocumentationOperation, SplitCellAboveBelowOperation, SplitCellAboveBelowOperation, SplitCellAboveBelowOperation, SplitCellAboveBelowOperationBase, SplitLeftRightOperation, SplitLeftRightOperation, SplitLeftRightOperation, SplitLeftRightOperationBase, SurroundWithFragmentOperation, SurroundWithTextOperation, TEIConfigureAutoIDElementsOperation, ToggleSurroundWithElementOperation, ToLowerCaseOperation, ToUpperCaseOperation, UnwrapTagsOperation

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface AuthorOperation
extends Extension

Interface defining an author extension operation. The operations are executed by the Author actions.

Field Summary

static java.lang.String	NAMESPACE_ARGUMENT Represents the namespace argument.
static ArgumentDescriptor	NAMESPACE_ARGUMENT_DESCRIPTOR The namespace argument descriptor.
static java.lang.String	SCHEMA_AWARE_ARGUMENT Controls if the operation is schema aware.
static ArgumentDescriptor	SCHEMA_AWARE_ARGUMENT_DESCRIPTOR The schema aware argument descriptor.

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()

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

getDescription

Field Detail

NAMESPACE_ARGUMENT

static final java.lang.String NAMESPACE_ARGUMENT

Represents the namespace argument. The value is 'namespace'.

See Also:

Constant Field Values

NAMESPACE_ARGUMENT_DESCRIPTOR

static final ArgumentDescriptor NAMESPACE_ARGUMENT_DESCRIPTOR

The namespace argument descriptor.

SCHEMA_AWARE_ARGUMENT

static final java.lang.String SCHEMA_AWARE_ARGUMENT

Controls if the operation is schema aware.

See Also:

SCHEMA_AWARE_ARGUMENT_DESCRIPTOR, Constant Field Values

SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

static final ArgumentDescriptor SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

The schema aware argument descriptor.

Method Detail

doOperation

void doOperation(AuthorAccess authorAccess,
                 ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        AuthorOperationException

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.

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

getArguments

ArgumentDescriptor[] getArguments()

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.