ro.sync.ecss.extensions.commons.table.operations
Class JoinCellAboveBelowOperationBase

java.lang.Object
  ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation
      ro.sync.ecss.extensions.commons.table.operations.JoinCellAboveBelowOperationBase

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation, JoinCellAboveBelowOperation

public abstract class JoinCellAboveBelowOperationBase
extends AbstractTableOperation

Operation for joining the content of two cells in the same column, from adjacent rows. The operation is possible only for cells that span over the same number of columns.

Field Summary

static String	JOIN_ABOVE Possible value of Join direction argument.
static String	JOIN_BELOW Possible value of Join direction argument.

Fields inherited from class ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation

tableHelper

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

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

JoinCellAboveBelowOperationBase(AuthorTableHelper tableHelper)
Constructor.

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()
String	getDescription()

Methods inherited from class ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation

createEmptyCell, findCellInsertionOffset, getElementAncestor, isElement, isTableElement

Methods inherited from class java.lang.Object

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

Field Detail

JOIN_ABOVE

public static final String JOIN_ABOVE

Possible value of Join direction argument.

See Also:

Constant Field Values

JOIN_BELOW

public static final String JOIN_BELOW

Possible value of Join direction argument.

See Also:

Constant Field Values

Constructor Detail

JoinCellAboveBelowOperationBase

public JoinCellAboveBelowOperationBase(AuthorTableHelper tableHelper)

Constructor.

Parameters:

tableHelper - The document type specific table helper.

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws IllegalArgumentException,
                        AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. This method is typically called from an ActionListener.actionPerformed(java.awt.event.ActionEvent) if used from Oxygen stand-alone distribution or org.eclipse.jface.action.Action#run() if used from the Oxygen Eclipse plugin.

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:

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)

getArguments

public ArgumentDescriptor[] getArguments()

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()