ro.sync.ecss.extensions.docbook
Class InsertImageDataOperation

java.lang.Object
  ro.sync.ecss.extensions.docbook.InsertImageDataOperation

All Implemented Interfaces:

AuthorOperation, Extension

public class InsertImageDataOperation
extends java.lang.Object
implements AuthorOperation

Operation used to insert an image in Docbook 5 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

InsertImageDataOperation()

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() No arguments.
java.lang.String	getDescription()
static SchemaAwareHandlerResult	insertImageRef(AuthorAccess authorAccess, java.lang.String ref)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InsertImageDataOperation

public InsertImageDataOperation()

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        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:

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)

insertImageRef

public static SchemaAwareHandlerResult insertImageRef(AuthorAccess authorAccess,
                                                      java.lang.String ref)
                                               throws AuthorOperationException

Parameters:

authorAccess - Author access

ref - The image reference

Returns:

The insertion result

Throws:

AuthorOperationException

getArguments

public ArgumentDescriptor[] getArguments()

No arguments. The operation will display a dialog for choosing the image fileref.

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()