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

@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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	doOperation(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, 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

doOperation

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

Description copied from interface: AuthorOperation

Perform the actual operation. You can check if the operation was invoked from the oXygen standalone application or from the oXygen plugin for Eclipse by using the method: Workspace.isStandalone(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

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)

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.