Package ro.sync.ecss.extensions.commons.operations.text

Class ConvertHexToCharOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.text.ConvertHexToCharOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class ConvertHexToCharOperation
extends Object
implements AuthorOperation

Operation for converting a hexadecimal sequence of digits from the left of the caret to the equivalent Unicode character. Note that the longest valid hexadecimal sequence will be converted and the length of that sequence is less or equal than 4, excluding the hexadecimal prefix such as '0x' or '0X' which could precede that sequence or not. It also works on selected text consisting of valid hexadecimal characters (max 6, including prefix).

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

Constructors

Constructor	Description
ConvertHexToCharOperation()

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()
String	getDescription()
protected abstract String	getErrorMessage()	Gets the error message displayed when operation fails.

Methods inherited from class java.lang.Object

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

Constructor Details

ConvertHexToCharOperation

public ConvertHexToCharOperation()

Method Details

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)

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

getErrorMessage

protected abstract String getErrorMessage()

Gets the error message displayed when operation fails.

Returns:

The error message displayed when operation fails.