Package ro.sync.ecss.extensions.xhtml

Class InsertMediaOperation

java.lang.Object

ro.sync.ecss.extensions.xhtml.InsertMediaOperation

All Implemented Interfaces:

AuthorOperation, Extension

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

Operation used to insert a XHTML media.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_MEDIA_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
InsertMediaOperation()

Method Summary

Modifier and Type	Method	Description
static java.lang.StringBuilder	createMediaContentToInsert(java.lang.String ref)	Provide the HTML fragment that contains the media object.
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()	No arguments.
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_MEDIA_URL

public static final java.lang.String ARGUMENT_MEDIA_URL

The image URL argument. The value is mediaUrl.

See Also:

Constant Field Values

Constructor Detail

InsertMediaOperation

public InsertMediaOperation()

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)

createMediaContentToInsert

public static java.lang.StringBuilder createMediaContentToInsert(java.lang.String ref)

Provide the HTML fragment that contains the media object.

Parameters:

ref - Relative reference of the media file.

Returns:

HTML code of the inserted media.

getArguments

public ArgumentDescriptor[] getArguments()

No arguments. The operation will display a dialog for choosing the media file.

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