Oxygen XML Editor 14.2 Author API

ro.sync.ecss.extensions.dita.link
Class InsertLinkOperation

java.lang.Object
  extended by ro.sync.ecss.extensions.dita.link.InsertXrefOperation
      extended by ro.sync.ecss.extensions.dita.link.InsertLinkOperation
All Implemented Interfaces:
AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertLinkOperation
extends InsertXrefOperation

Operation used to insert a Link 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
InsertLinkOperation()
           
 
Method Summary
 void doOperation(AuthorAccess authorAccess, ArgumentsMap args)
          Perform the actual operation.
 java.lang.String getDescription()
           
 
Methods inherited from class ro.sync.ecss.extensions.dita.link.InsertXrefOperation
doOperationInternal, getArguments
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InsertLinkOperation

public InsertLinkOperation()
Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        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: Workspace.isStandalone(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:
doOperation in interface AuthorOperation
Overrides:
doOperation in class InsertXrefOperation
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)

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface Extension
Overrides:
getDescription in class InsertXrefOperation
Returns:
The description of the extension.
See Also:
Extension.getDescription()

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.