Package ro.sync.ecss.extensions.docbook

Class InsertImageDataOperation

java.lang.Object

ro.sync.ecss.extensions.docbook.InsertImageDataOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertImageDataOperation
extends java.lang.Object
implements AuthorOperation

Operation used to insert an image in Docbook 5 documents.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_IMAGE_URL	The image URL argument.

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
InsertImageDataOperation()

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()	No arguments.
java.lang.String	getDescription()
static SchemaAwareHandlerResult	insertImageRef(AuthorAccess authorAccess, ro.sync.ecss.docbook.DocBookImageInfo imageInfo, boolean isInlineMediaObjectAccepted)	Insert an image reference.

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_IMAGE_URL

public static final java.lang.String ARGUMENT_IMAGE_URL

The image URL argument. The value is imageUrl.

See Also:

Constant Field Values

Constructor Detail

InsertImageDataOperation

public InsertImageDataOperation()

Method Detail

doOperation

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

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(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

insertImageRef

public static SchemaAwareHandlerResult insertImageRef(AuthorAccess authorAccess,
                                                      ro.sync.ecss.docbook.DocBookImageInfo imageInfo,
                                                      boolean isInlineMediaObjectAccepted)
                                               throws AuthorOperationException

Insert an image reference.

Parameters:

authorAccess - Access to the Author-specific functions.

imageInfo - An object containing information about the image to be inserted.

isInlineMediaObjectAccepted - true if an inline media object is accepted according to the schema.

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()