ro.sync.ecss.extensions.commons.operations

Class ToggleSurroundWithElementOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.ToggleSurroundWithElementOperation

All Implemented Interfaces:

AuthorOperation, Extension

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

Toggle "surround with element" operation. Case 1: If there is no selection in the document: - if the caret is inside a word then the word is wrapped in the given element (or unwrapped if it is already included in the element) - else the element is inserted at caret position. Case 2: If there is a selection, it is wrapped in the given element (or unwrapped if it is already included in the element)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARGUMENT_ELEMENT The element 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 and Description
ToggleSurroundWithElementOperation()

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()
static AuthorElement[]	getElementsPath(AuthorDocumentFragment fragment) Given a document fragment it returns the path of elements until the first leaf.
static java.util.List<int[]>	getEquiIntervalFromMarker(AuthorAccess authorAccess, int[] interval) If the given interval is not balanced (balanced = starts and ends in the same element) it will be split into multiple balanced intervals.

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_ELEMENT

public static final java.lang.String ARGUMENT_ELEMENT

The element argument.

See Also:

Constant Field Values

Constructor Detail

ToggleSurroundWithElementOperation

public ToggleSurroundWithElementOperation()

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: Workspace.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(AuthorAccess, 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 java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getElementsPath

public static AuthorElement[] getElementsPath(AuthorDocumentFragment fragment)

Given a document fragment it returns the path of elements until the first leaf.

Parameters:

fragment - The document fragment to check.

Returns:

The path of elements to first leaf.

getEquiIntervalFromMarker

public static java.util.List<int[]> getEquiIntervalFromMarker(AuthorAccess authorAccess,
                                                              int[] interval)
                                                       throws javax.swing.text.BadLocationException

If the given interval is not balanced (balanced = starts and ends in the same element) it will be split into multiple balanced intervals.

Parameters:

authorAccess - Author access.

interval - The interval to split..

Returns:

The list of intervals.

Throws:

javax.swing.text.BadLocationException