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

Class SplitOperationBase

java.lang.Object

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

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

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

SplitOperation, SplitOperation, SplitOperation, SplitOperation

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

Operation for splitting the selected table cell (or the cell at caret when there is no selection), if it spans over multiple rows or columns

Field Summary

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

CHANGE_TRACKING_BEHAVIOR_ARGUMENT, 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	Description
SplitOperationBase(AuthorTableHelper tableHelper)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doOperationInternal(AuthorAccess authorAccess, ArgumentsMap args)	Split the selected table cell (or the cell at caret when there is no selection), if it spans over multiple rows or columns
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()
protected java.lang.String	getHelpPageID()	Get the ID of the help page which will be called by the end user.
protected abstract java.lang.String[]	getIgnoredAttributesForColumnSplit()
protected abstract java.lang.String[]	getIgnoredAttributesForRowSplit()
protected abstract InsertColumnOperationBase	getInsertColumnOperation()	Get the insert column operation to be used when splitting cells that have no initial span.
protected abstract InsertRowOperationBase	getInsertRowOperation()	Get the insert row operation to be used when splitting cells that have no initial span.
protected abstract JoinOperationBase	getJoinOperation()	Get the join operation to be used when splitting cells that have no initial span.

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

Constructor Detail

SplitOperationBase

public SplitOperationBase(AuthorTableHelper tableHelper)

Constructor.

Parameters:

tableHelper - Table helper with methods specific to a document type.

Method Detail

doOperationInternal

protected void doOperationInternal(AuthorAccess authorAccess,
                                   ArgumentsMap args)
                            throws AuthorOperationException

Split the selected table cell (or the cell at caret when there is no selection), if it spans over multiple rows or columns

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:

AuthorOperationException - Thrown when the operation fails.

See Also:

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

getInsertRowOperation

protected abstract InsertRowOperationBase getInsertRowOperation()

Get the insert row operation to be used when splitting cells that have no initial span.

getInsertColumnOperation

protected abstract InsertColumnOperationBase getInsertColumnOperation()

Get the insert column operation to be used when splitting cells that have no initial span.

getJoinOperation

protected abstract JoinOperationBase getJoinOperation()

Get the join operation to be used when splitting cells that have no initial span.

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getArguments

public ArgumentDescriptor[] getArguments()

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

getArguments()

getIgnoredAttributesForRowSplit

protected abstract java.lang.String[] getIgnoredAttributesForRowSplit()

Returns:

The attributes which should be skipped, when creating a copy of the split cell.

getIgnoredAttributesForColumnSplit

protected abstract java.lang.String[] getIgnoredAttributesForColumnSplit()

Returns:

The attributes which should be skipped when creating a copy of the split cell.

getHelpPageID

protected java.lang.String getHelpPageID()

Get the ID of the help page which will be called by the end user.

Returns:

the ID of the help page which will be called by the end user or null.