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, JoinCellAboveBelowOperation

@API(type=INTERNAL,
     src=PUBLIC)
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

Fields

Modifier and Type	Field and Description
static java.lang.String	JOIN_ABOVE Possible value of Join direction argument.
static java.lang.String	JOIN_BELOW Possible value of Join direction argument.

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

TABLE_INFO_ARGUMENT_DESCRIPTOR, TABLE_INFO_ARGUMENT_NAME, 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

Constructors

Constructor and Description
JoinCellAboveBelowOperationBase(AuthorTableHelper tableHelper) Constructor.

Method Summary

Modifier and Type	Method and Description
protected DeleteRowOperationBase	createDeleteRowOperation() Create a delete row operation necessary to delete the row which will now be empty.
protected void	doOperationInternal(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()

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

createEmptyCell, doOperation, 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 java.lang.String JOIN_ABOVE

Possible value of Join direction argument.

See Also:

Constant Field Values

JOIN_BELOW

public static final java.lang.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

doOperationInternal

protected void doOperationInternal(AuthorAccess authorAccess,
                                   ArgumentsMap args)
                            throws java.lang.IllegalArgumentException,
                                   AuthorOperationException

Description copied from class: AbstractTableOperation

Perform the actual operation.

Specified by:

doOperationInternal in class AbstractTableOperation

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:

java.lang.IllegalArgumentException - Thrown when one or more arguments are illegal.

AuthorOperationException - Thrown when the operation fails.

See Also:

AbstractTableOperation.doOperationInternal(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

createDeleteRowOperation

protected DeleteRowOperationBase createDeleteRowOperation()

Create a delete row operation necessary to delete the row which will now be empty. Can be overwritten by custom code.

Returns:

a delete row operation necessary to delete the row which will now be empty.

getArguments

public ArgumentDescriptor[] getArguments()

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()