Oxygen XML Editor 11.2 Author API

ro.sync.ecss.extensions.commons.operations
Class SurroundWithFragmentOperation

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.operations.SurroundWithFragmentOperation
All Implemented Interfaces:
AuthorOperation, Extension

public class SurroundWithFragmentOperation
extends Object
implements AuthorOperation

Surround with fragment operation. If selection exists the selected fragment is surrounded in a given fragment. If no selection exists, the given fragment is simply inserted at the given position. In this case the insertion can be schema aware.


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
SurroundWithFragmentOperation()
           
 
Method Summary
 void doOperation(AuthorAccess authorAccess, ArgumentsMap args)
          Perform the actual operation.
 ArgumentDescriptor[] getArguments()
           
 String getDescription()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SurroundWithFragmentOperation

public SurroundWithFragmentOperation()
Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws 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:
AuthorOperationException - Thrown when the operation fails.
See Also:
AuthorOperation.doOperation(AuthorAccess, ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()
Specified by:
getArguments in interface AuthorOperation
Returns:
An array of ArgumentDescriptor representing the arguments this operation uses.
See Also:
AuthorOperation.getArguments()

getDescription

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

Oxygen XML Editor 11.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.