|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation
ro.sync.ecss.extensions.commons.table.operations.InsertColumnOperationBase
ro.sync.ecss.extensions.dita.topic.table.simpletable.InsertColumnOperation
@API(type=INTERNAL, src=PUBLIC) public class InsertColumnOperation
Operation used to insert a DITA simple table column.
Field Summary | |
---|---|
protected java.lang.String |
cellContent
The fragment that must be introduced in the table cells |
Fields inherited from class ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation |
---|
tableHelper |
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.InsertTableCellsContentConstants |
---|
CELL_FRAGMENT_ARGUMENT, CELL_FRAGMENT_ARGUMENT_IN_ARRAY, CELL_FRAGMENT_ARGUMENT_NAME |
Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation |
---|
NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR |
Constructor Summary | |
---|---|
|
InsertColumnOperation()
Constructor. |
protected |
InsertColumnOperation(AuthorTableHelper documentTypeHelper)
Constructor. |
Method Summary | |
---|---|
void |
doOperation(AuthorAccess authorAccess,
ArgumentsMap args)
Perform the actual operation. |
ArgumentDescriptor[] |
getArguments()
|
protected 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. |
protected void |
updateColumnCellsSpan(AuthorAccess authorAccess,
AuthorTableCellSpanProvider tableSupport,
AuthorElement tableElem,
int newColumnIndex,
ro.sync.ecss.extensions.api.table.operations.TableColumnSpecificationInformation columnSpecification,
java.lang.String namespace)
Increments the column span of the cells intersecting the new column. |
Methods inherited from class ro.sync.ecss.extensions.commons.table.operations.InsertColumnOperationBase |
---|
getDescription, performInsertColumn |
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 |
Field Detail |
---|
protected java.lang.String cellContent
Constructor Detail |
---|
public InsertColumnOperation()
protected InsertColumnOperation(AuthorTableHelper documentTypeHelper)
documentTypeHelper
- Document type helper, has methods specific to a document type.Method Detail |
---|
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()
.
doOperation
in interface AuthorOperation
doOperation
in class InsertColumnOperationBase
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.InsertColumnOperationBase.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)
protected java.lang.String getCellElementName(AuthorElement rowElement, int newColumnIndex)
InsertColumnOperationBase
getCellElementName
in class InsertColumnOperationBase
rowElement
- The row element where the new cell will be inserted.newColumnIndex
- The new column index. 0 based.
InsertColumnOperationBase.getCellElementName(ro.sync.ecss.extensions.api.node.AuthorElement, int)
protected java.lang.String getDefaultContentForEmptyCells()
InsertColumnOperationBase
getDefaultContentForEmptyCells
in class InsertColumnOperationBase
null
.InsertColumnOperationBase.getDefaultContentForEmptyCells()
public ArgumentDescriptor[] getArguments()
getArguments
in interface AuthorOperation
getArguments
in class InsertColumnOperationBase
ArgumentDescriptor
representing
the arguments this operation uses.InsertColumnOperationBase.getArguments()
protected void updateColumnCellsSpan(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSupport, AuthorElement tableElem, int newColumnIndex, ro.sync.ecss.extensions.api.table.operations.TableColumnSpecificationInformation columnSpecification, java.lang.String namespace) throws AuthorOperationException
InsertColumnOperationBase
updateColumnCellsSpan
in class InsertColumnOperationBase
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.InsertColumnOperationBase.updateColumnCellsSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement, int, ro.sync.ecss.extensions.api.table.operations.TableColumnSpecificationInformation, java.lang.String)
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |