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
@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 |
static java.lang.String |
JOIN_ABOVE
Possible value of Join direction argument. |
static java.lang.String |
JOIN_BELOW
Possible value of Join direction argument. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
JoinCellAboveBelowOperationBase
public JoinCellAboveBelowOperationBase(AuthorTableHelper tableHelper)
- Constructor.
- Parameters:
tableHelper
- The document type specific table helper.
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)
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()
© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.