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

Class SelectedTextOperation

java.lang.Object

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

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

ToLowerCaseOperation, ToUpperCaseOperation

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

Provides upper case and lower case operations over a selected text.

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 and Description
SelectedTextOperation()

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap arguments) Process the selected text and make it lower case or upper case.
ArgumentDescriptor[]	getArguments()
protected abstract java.lang.String	processText(java.lang.String text) Process text.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

SelectedTextOperation

public SelectedTextOperation()

Method Detail

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

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap arguments)
                 throws java.lang.IllegalArgumentException,
                        AuthorOperationException

Process the selected text and make it lower case or upper case.

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.

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

processText

protected abstract java.lang.String processText(java.lang.String text)

Process text.

Parameters:

text - The text to be processed.

Returns:

The text after process.