Package ro.sync.ecss.extensions.api
Interface AuthorOperation
- All Superinterfaces:
Extension
- All Known Subinterfaces:
ExecuteMultipleActionsWithExtraAskValuesOperation
- All Known Implementing Classes:
AbstractTableOperation,AddEditConrefOperation,CALSAndHTMLShowTablePropertiesBase,CALSAndHTMLTableSortOperation,CALSShowTableProperties,CapitalizeSentencesOperation,CapitalizeWordsOperation,ChangeAttributeOperation,ChangeAttributesOperation,ChangePseudoClassesOperation,ChoiceTableShowPropertiesOperation,ConfigureAutoIDElementsOperation,ConvertHexToCharOperation,CountWordsOperation,CreateAndInsertTopicRef,CreateNewTopicFromSelectionOperation,CreateReusableComponentOperation,DB4InsertListOperation,DB5InsertListOperation,DeleteColumnOperation,DeleteColumnOperation,DeleteColumnOperation,DeleteColumnOperation,DeleteColumnOperation,DeleteColumnOperation,DeleteColumnOperationBase,DeleteElementOperation,DeleteElementsOperation,DeleteRowOperation,DeleteRowOperation,DeleteRowOperation,DeleteRowOperation,DeleteRowOperation,DeleteRowOperation,DeleteRowOperationBase,DemoteTopicrefOperation,DITACALSShowTablePropertiesOperation,DITACALSTableSortOperation,DITAConfigureAutoIDElementsOperation,DITAInsertListOperation,DITAListSortOperation,DITASimpleTableSortOperation,DITAUpdateImageMapOperation,Docbook4CALSShowTablePropertiesOperation,Docbook4HTMLShowTablePropertiesOperation,Docbook4InsertMediaDataOperation,Docbook4PasteAsLinkOperation,Docbook4PasteAsXIncludeOperation,Docbook4PasteAsXrefOperation,Docbook5CALSShowTablePropertiesOperation,Docbook5ConfigureAutoIDElementsOperation,Docbook5HTMLShowTablePropertiesOperation,Docbook5InsertMediaDataOperation,Docbook5PasteAsLinkOperation,Docbook5PasteAsXIncludeOperation,Docbook5PasteAsXrefOperation,DocbookCALSTableSortOperation,DocbookConfigureAutoIDElementsOperation,DocbookHTMLShowTablePropertiesOperationBase,DocbookInsertListOperation,DocbookListSortOperation,EditImageMapOperation,EditImageMapOperation,EditImageMapOperation,EditImageMapOperation,EditImageMapOperation,EditOLinkOperation,EditPropertiesOperation,ExecuteCommandLineOperation,ExecuteCustomizableTransformationScenarioOperation,ExecuteMultipleActionsOperation,ExecuteMultipleWebappCompatibleActionsOperation,ExecuteTransformationScenariosOperation,ExecuteValidationScenariosOperation,FindSimilarTopicsOperation,FormSelectedTextOperation,GenerateIDsDB4Operation,GenerateIDsDB5Operation,GenerateIDsDITAOperation,GenerateIDsOperation,GenerateIDsTEIP5Operation,InsertColumnOperation,InsertColumnOperation,InsertColumnOperation,InsertColumnOperation,InsertColumnOperation,InsertColumnOperation,InsertColumnOperationBase,InsertConrefOperation,InsertContentKeyrefOperation,InsertEquationOperation,InsertEquationOperation,InsertEquationOperation,InsertExternalLinkOperation,InsertFragmentOperation,InsertGraphicOperation,InsertGUIButtonOperation,InsertImageDataOperation,InsertImageOperation,InsertImageOperationP4,InsertImageOperationP5,InsertImgOperation,InsertKeydefWithKeywordOperation,InsertKeyrefOperation,InsertLinkOperation,InsertListOperation,InsertLocalLinkOperation,InsertMediaDataOperationBase,InsertMediaOperation,InsertMediaOperation,InsertNewTopicOperation,InsertOLinkOperation,InsertOrReplaceFragmentOperation,InsertOrReplaceTextOperation,InsertReusableComponentOperation,InsertRowOperation,InsertRowOperation,InsertRowOperation,InsertRowOperation,InsertRowOperation,InsertRowOperation,InsertRowOperationBase,InsertScreenshotOperation,InsertSingleColumnOperation,InsertSingleColumnOperation,InsertSingleColumnOperation,InsertSingleColumnOperation,InsertSingleColumnOperation,InsertSingleColumnOperation,InsertSingleRowOperation,InsertSingleRowOperation,InsertSingleRowOperation,InsertSingleRowOperation,InsertSingleRowOperation,InsertSingleRowOperation,InsertTableOperation,InsertTableOperation,InsertTableOperation,InsertTableOperation,InsertTableOperation,InsertTopicgroupOperation,InsertTopicheadOperation,InsertTopicrefOperation,InsertULink,InsertXIncludeOperation,InsertXrefOperation,InsertXrefOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperation,JoinCellAboveBelowOperationBase,JoinOperation,JoinOperation,JoinOperation,JoinOperation,JoinOperationBase,JoinRowCellsOperation,JoinRowCellsOperation,JoinRowCellsOperation,JoinRowCellsOperation,JoinRowCellsOperation,JoinRowCellsOperation,JoinRowCellsOperationBase,JSOperation,MoveBlockAuthorOperation,MoveCaretOperation,MoveElementOperation,OpenInSystemAppOperation,PasteAsContentKeyReferenceOperation,PasteAsContentReferenceOperation,PasteAsLinkKeyReferenceOperation,PasteAsReferenceOperation,PromoteDemoteItemOperation,PromoteDemoteSectionOperation,PromoteTopicrefOperation,PseudoClassOperation,PushElementOperation,ReloadContentOperation,RelTableShowPropertiesOperation,RemoveConrefOperation,RemovePseudoClassOperation,RenameElementOperation,ReplaceAllKeyrefsAndConrefsOperation,ReplaceConrefOperation,ReplaceContentOperation,ReplaceElementContentOperation,SearchReferencesDITAOperation,SelectedTextOperation,SetPseudoClassOperation,SetReadOnlyStatusOperation,ShowDITAElementDocumentationOperation,ShowElementDocumentationOperation,ShowKeyDefinitionOperation,ShowKeysAndReusableComponentsOperation,ShowTablePropertiesBaseOperation,SimpleTableShowPropertiesOperation,SimpleTableShowPropertiesOperationBase,SimpleTableSortOperation,SortOperation,SplitCellAboveBelowOperation,SplitCellAboveBelowOperation,SplitCellAboveBelowOperation,SplitCellAboveBelowOperation,SplitCellAboveBelowOperationBase,SplitLeftRightOperation,SplitLeftRightOperation,SplitLeftRightOperation,SplitLeftRightOperation,SplitLeftRightOperationBase,SplitOperation,SplitOperation,SplitOperation,SplitOperation,SplitOperationBase,StopCurrentTransformationScenarioOperation,SurroundWithFragmentOperation,SurroundWithTextOperation,TableSortOperation,TEIConfigureAutoIDElementsOperation,TEIInsertListOperation,TEIListSortOperation,TEIP5ConfigureAutoIDElementsOperation,TEITableSortOperation,ToggleCommentOperation,TogglePseudoClassOperation,ToggleSurroundWithElementOperation,ToLowerCaseOperation,TopicContentViewModeOperation,TopicReferencesViewModeOperation,TopicTitlesViewModeOperation,ToUpperCaseOperation,TransformOperation,UnwrapTagsOperation,UpdateImageMapOperationBase,WebappMarkAsSavedOperation,XHTMLInsertListOperation,XHTMLListSortOperation,XHTMLTableSortOperation,XHTMLUpdateImageMapOperation,XQueryOperation,XQueryUpdateOperation,XSLTOperation
Interface defining an author extension operation.
The operations are executed by the Author actions.
All edits performed inside an AuthorOperation are part of a single compound edit
(
AuthorDocumentController.beginCompoundEdit(). If this behavior is not desirable,
one can implement the AuthorOperationWithCustomUndoBehavior interface.
More information on various subclasses can be found in the
user manual.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringRepresents the namespace argument.static final ArgumentDescriptorThenamespaceargument descriptor.static final StringControls if the operation is schema aware.static final ArgumentDescriptorTheschema awareargument descriptor. -
Method Summary
Modifier and TypeMethodDescriptionvoiddoOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.Methods inherited from interface ro.sync.ecss.extensions.api.Extension
getDescription
-
Field Details
-
NAMESPACE_ARGUMENT
Represents the namespace argument. The value is'namespace'.- See Also:
-
NAMESPACE_ARGUMENT_DESCRIPTOR
Thenamespaceargument descriptor. -
SCHEMA_AWARE_ARGUMENT
Controls if the operation is schema aware. -
SCHEMA_AWARE_ARGUMENT_DESCRIPTOR
Theschema awareargument descriptor.
-
-
Method Details
-
doOperation
void doOperation(AuthorAccess authorAccess, ArgumentsMap args) throws IllegalArgumentException, AuthorOperationException 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 theWorkspaceyou may use:AuthorAccess.getWorkspaceAccess().- 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 methodgetArguments()must be present in the map of arguments.- Throws:
IllegalArgumentException- Thrown when one or more arguments are illegal.AuthorOperationException- Thrown when the operation fails.
-
getArguments
ArgumentDescriptor[] getArguments()- Returns:
- An array of
ArgumentDescriptorrepresenting the arguments this operation uses.
-