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

Class DeleteRowOperationBase

java.lang.Object

ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation

ro.sync.ecss.extensions.commons.table.operations.DeleteRowOperationBase

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation, DeleteRowOperation

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class DeleteRowOperationBase
extends AbstractTableOperation

Operation used to delete a table row.

Field Summary

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
DeleteRowOperationBase(AuthorTableHelper documentTypeHelper) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract SplitCellAboveBelowOperationBase	createSplitCellOperation() Create the split cell operation.
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Delete the table row at the caret position.
ArgumentDescriptor[]	getArguments() No arguments for this operation.
java.lang.String	getDescription()
boolean	performDeleteRows(AuthorAccess authorAccess, int startRowOffset, int endRowOffset) Delete table row.

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

Constructor Detail

DeleteRowOperationBase

public DeleteRowOperationBase(AuthorTableHelper documentTypeHelper)

Constructor.

Parameters:

documentTypeHelper - The table helper specific to a document type. An implementation of AuthorTableHelper.

Method Detail

performDeleteRows

public boolean performDeleteRows(AuthorAccess authorAccess,
                                 int startRowOffset,
                                 int endRowOffset)
                          throws AuthorOperationException

Delete table row. The row that must be deleted is determined in the following order:

• by startRowOffset and endRowOffset if both are bigger than 0
• selected row, if any
• the row at caret offset

Parameters:

authorAccess - The access to Author operations.

startRowOffset - The start row offset.

endRowOffset - The end row offset.

Returns:

true if a row is deleted

Throws:

java.lang.IllegalArgumentException

AuthorOperationException

doOperation

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

Delete the table row at the caret position. For this operation the caret must be inside a table cell.

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:

AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

No arguments for this operation.

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

createSplitCellOperation

protected abstract SplitCellAboveBelowOperationBase createSplitCellOperation()

Create the split cell operation. The operation is needed to split the cells that span over multiple rows and start on the row to be deleted.

Returns:

The split cell operation.