@API(type=INTERNAL, src=PUBLIC) public abstract class InsertColumnOperationBase extends AbstractTableOperation
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
POSITION_ARGUMENT
The
insertPosition argument descriptor. |
static ArgumentDescriptor |
POSITION_ARGUMENT_DESCRIPTOR
The
position argument descriptor. |
tableHelper
NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR
Constructor and Description |
---|
InsertColumnOperationBase(AuthorTableHelper documentTypeHelper)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
doOperation(AuthorAccess authorAccess,
ArgumentsMap args)
Perform the actual operation.
|
ArgumentDescriptor[] |
getArguments() |
protected abstract java.lang.String |
getCellElementName(AuthorElement rowElement,
int newColumnIndex)
Get the name of the element that will be inserted as a cell into the table.
|
protected java.lang.String |
getDefaultContentForEmptyCells()
Get the default content that must be introduced in empty cells.
|
java.lang.String |
getDescription()
Get the description for this operation.
|
void |
performInsertColumn(AuthorAccess authorAccess,
java.lang.String namespace,
AuthorDocumentFragment[] fragments,
TableColumnSpecificationInformation columnSpecification,
boolean cellsFragments,
InsertRowOperationBase insertRowOperation,
InsertTableOperationBase insertTableOperation)
Insert column.
|
void |
performInsertColumn(AuthorAccess authorAccess,
java.lang.String namespace,
java.lang.String insertPosition,
AuthorDocumentFragment[] fragments,
TableColumnSpecificationInformation columnSpecification,
boolean cellsFragments,
InsertRowOperationBase insertRowOperation,
InsertTableOperationBase insertTableOperation)
Insert column.
|
protected void |
updateColumnCellsSpan(AuthorAccess authorAccess,
AuthorTableCellSpanProvider tableSupport,
AuthorElement tableElem,
int newColumnIndex,
TableColumnSpecificationInformation columnSpecification,
java.lang.String namespace)
Increments the column span of the cells intersecting the new column.
|
createEmptyCell, findCellInsertionOffset, getElementAncestor, isElement, isTableElement
public static final java.lang.String POSITION_ARGUMENT
insertPosition
argument descriptor.public static final ArgumentDescriptor POSITION_ARGUMENT_DESCRIPTOR
position
argument descriptor.public InsertColumnOperationBase(AuthorTableHelper documentTypeHelper)
documentTypeHelper
- Document type helper, has methods specific to a
document type.public void doOperation(AuthorAccess authorAccess, ArgumentsMap args) throws java.lang.IllegalArgumentException, AuthorOperationException
AuthorOperation
Workspace.isStandalone()
.
To get to the Workspace
you may use: AuthorAccess.getWorkspaceAccess()
.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.java.lang.IllegalArgumentException
- Thrown when one or more arguments are illegal.AuthorOperationException
- Thrown when the operation fails.AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)
public void performInsertColumn(AuthorAccess authorAccess, java.lang.String namespace, AuthorDocumentFragment[] fragments, TableColumnSpecificationInformation columnSpecification, boolean cellsFragments, InsertRowOperationBase insertRowOperation, InsertTableOperationBase insertTableOperation) throws AuthorOperationException
authorAccess
- The author access.namespace
- The cells namespace.fragments
- An array of AuthorDocumentFragments that are used as content of the inserted cells.columnSpecification
- The column specification data.cellsFragments
- If the value is true
then the fragments
where originally cells.insertRowOperation
- The insert row operation used to insert new rows when
there are fragments that cannot be inserted in the new column.insertTableOperation
- The insert table operation used to insert the column
wrapped in a new table when the insert offset is not inside a table.java.lang.IllegalArgumentException
AuthorOperationException
public void performInsertColumn(AuthorAccess authorAccess, java.lang.String namespace, java.lang.String insertPosition, AuthorDocumentFragment[] fragments, TableColumnSpecificationInformation columnSpecification, boolean cellsFragments, InsertRowOperationBase insertRowOperation, InsertTableOperationBase insertTableOperation) throws AuthorOperationException
authorAccess
- The author access.namespace
- The cells namespace.insertPosition
- The relative position where the new column will be inserted.fragments
- An array of AuthorDocumentFragments that are used as content of the inserted cells.columnSpecification
- The column specification data.cellsFragments
- If the value is true
then the fragments
where originally cells.insertRowOperation
- The insert row operation used to insert new rows when
there are fragments that cannot be inserted in the new column.insertTableOperation
- The insert table operation used to insert the column
wrapped in a new table when the insert offset is not inside a table.java.lang.IllegalArgumentException
AuthorOperationException
protected void updateColumnCellsSpan(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSupport, AuthorElement tableElem, int newColumnIndex, TableColumnSpecificationInformation columnSpecification, java.lang.String namespace) throws AuthorOperationException
authorAccess
- The author access.
Provides access to specific informations and actions for
editor, document, workspace, tables, change tracking, utility a.s.o.tableSupport
- The table cell span provider.tableElem
- The table element.newColumnIndex
- The index of the column to insert.columnSpecification
- The table column specification data.namespace
- The namespace to be used.AuthorOperationException
- When the insertion fails.public ArgumentDescriptor[] getArguments()
ArgumentDescriptor
representing
the arguments this operation uses.AuthorOperation.getArguments()
public java.lang.String getDescription()
Extension.getDescription()
protected abstract java.lang.String getCellElementName(AuthorElement rowElement, int newColumnIndex)
rowElement
- The row element where the new cell will be inserted.newColumnIndex
- The new column index. 0 based.protected java.lang.String getDefaultContentForEmptyCells()
null
.© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.