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

Class SplitCellAboveBelowOperationBase

java.lang.Object

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

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

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

SplitCellAboveBelowOperation, SplitCellAboveBelowOperation, SplitCellAboveBelowOperation, SplitCellAboveBelowOperation

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

Base operation for splitting a table cell. The new cell resulting from the split operation will be positioned above or below the original cell.

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
SplitCellAboveBelowOperationBase(AuthorTableHelper tableHelper)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doOperationInternal(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()
protected abstract java.lang.String[]	getIgnoredAttributes()
void	splitCell(AuthorElement cell, AuthorAccess authorAccess, boolean above)	Split the cell.

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

SplitCellAboveBelowOperationBase

public SplitCellAboveBelowOperationBase(AuthorTableHelper tableHelper)

Constructor.

Parameters:

tableHelper - Document type specific table information helper.

Method Detail

doOperationInternal

protected void doOperationInternal(AuthorAccess authorAccess,
                                   ArgumentsMap args)
                            throws 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:

AuthorOperationException - Thrown when the operation fails.

See Also:

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

splitCell

public void splitCell(AuthorElement cell,
                      AuthorAccess authorAccess,
                      boolean above)
               throws AuthorOperationException,
                      javax.swing.text.BadLocationException

Split the cell.

Parameters:

cell - The table cell to split.

authorAccess - Access to author functionality.

above - If true the cell will be split above.

Throws:

AuthorOperationException

javax.swing.text.BadLocationException

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

getIgnoredAttributes

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

Returns:

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