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

Class InsertRowOperation

java.lang.Object

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

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

ro.sync.ecss.extensions.commons.table.operations.cals.InsertRowOperation

All Implemented Interfaces:

AuthorOperation, Extension, CALSConstants, InsertTableCellsContentConstants

Direct Known Subclasses:

InsertRowOperation, InsertSingleRowOperation

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertRowOperation
extends InsertRowOperationBase
implements CALSConstants, InsertTableCellsContentConstants

Operation used to insert a table row for DocBook v.4 or v.5 and for DITA CALS tables..

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cellContent	The fragment that must be introduced in the table cells

Fields inherited from class ro.sync.ecss.extensions.commons.table.operations.InsertRowOperationBase

CUSTOM_INSERTION_ARGUMENT_DESCRIPTOR

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

Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.cals.CALSConstants

ATTRIBUTE_NAME_ALIGN, ATTRIBUTE_NAME_COLNAME, ATTRIBUTE_NAME_COLNUM, ATTRIBUTE_NAME_COLS, ATTRIBUTE_NAME_COLSEP, ATTRIBUTE_NAME_COLWIDTH, ATTRIBUTE_NAME_ID, ATTRIBUTE_NAME_MOREROWS, ATTRIBUTE_NAME_NAMEEND, ATTRIBUTE_NAME_NAMEST, ATTRIBUTE_NAME_ROWSEP, ATTRIBUTE_NAME_SPANNAME, ATTRIBUTE_NAME_TABLE_WIDTH, ATTRIBUTE_NAME_XML_ID, ELEMENT_NAME_COLSPEC, ELEMENT_NAME_ENTRY, ELEMENT_NAME_INFORMALTABLE, ELEMENT_NAME_ROW, ELEMENT_NAME_SPANSPEC, ELEMENT_NAME_TABLE, ELEMENT_NAME_TGROUP

Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.InsertTableCellsContentConstants

CELL_FRAGMENT_ARGUMENT, CELL_FRAGMENT_ARGUMENT_IN_ARRAY, CELL_FRAGMENT_ARGUMENT_NAME

Constructor Summary

Constructors

Constructor	Description
InsertRowOperation()	Constructor.
InsertRowOperation(AuthorTableHelper helper)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doOperationInternal(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
protected String	getCellElementName(AuthorElement tableElement, int columnIndex)	Get the name of the element that represents a cell.
protected String	getDefaultContentForEmptyCells()	Get the default content that must be introduced in empty cells.
protected ArgumentDescriptor[]	getOperationArguments()	Get the array of arguments used for this operation.
protected String	getRowElementName(AuthorElement tableElement)	Get the name of the element that represents a row.
protected boolean	useCurrentRowTemplateOnInsert()

Methods inherited from class ro.sync.ecss.extensions.commons.table.operations.InsertRowOperationBase

createCellXMLFragment, getArguments, getDescription, getRowXMLFragment, insertRows, removeCustomInsertionDescriptor

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

Field Details

cellContent

protected String cellContent

The fragment that must be introduced in the table cells

Constructor Details

InsertRowOperation

public InsertRowOperation()

Constructor.

InsertRowOperation

public InsertRowOperation(AuthorTableHelper helper)

Constructor.

Parameters:

helper - Table helper

Method Details

doOperationInternal

protected void doOperationInternal(AuthorAccess authorAccess,
 ArgumentsMap args)
                            throws AuthorOperationException

Description copied from class: AbstractTableOperation

Perform the actual operation.

Overrides:

doOperationInternal in class InsertRowOperationBase

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)

getCellElementName

protected String getCellElementName(AuthorElement tableElement,
 int columnIndex)

Description copied from class: InsertRowOperationBase

Get the name of the element that represents a cell.

Specified by:

getCellElementName in class InsertRowOperationBase

Parameters:

tableElement - The table element

columnIndex - The column index.

Returns:

The name of the element that represent a cell in the table.

See Also:

• InsertRowOperationBase.getCellElementName(AuthorElement, int)

getRowElementName

protected String getRowElementName(AuthorElement tableElement)

Description copied from class: InsertRowOperationBase

Get the name of the element that represents a row.

Specified by:

getRowElementName in class InsertRowOperationBase

Parameters:

tableElement - The table parent element.

Returns:

The name of the element that represent a row in the table.

See Also:

• InsertRowOperationBase.getRowElementName(AuthorElement)

useCurrentRowTemplateOnInsert

protected boolean useCurrentRowTemplateOnInsert()

Overrides:

useCurrentRowTemplateOnInsert in class InsertRowOperationBase

Returns:

true if the current row template should be used to create the new row that must be inserted. Default: false

See Also:

• InsertRowOperationBase.useCurrentRowTemplateOnInsert()

getOperationArguments

protected ArgumentDescriptor[] getOperationArguments()

Description copied from class: InsertRowOperationBase

Get the array of arguments used for this operation. The first argument defines the location where the operation will be executed as an xpath expression, the second one defines the relative position to the node obtained from the XPath location, the third is the namespace argument descriptor and the forth specifies if the user desires the insertion of multiple rows or not. For the second argument included in the returned arguments descriptor array, the allowed values are: AuthorConstants.POSITION_BEFORE, AuthorConstants.POSITION_AFTER, AuthorConstants.POSITION_INSIDE_FIRST AuthorConstants.POSITION_INSIDE_LAST

Overrides:

getOperationArguments in class InsertRowOperationBase

Returns:

The array with the arguments of the operation.

See Also:

• InsertRowOperationBase.getOperationArguments()

getDefaultContentForEmptyCells

protected String getDefaultContentForEmptyCells()

Description copied from class: InsertRowOperationBase

Get the default content that must be introduced in empty cells.

Overrides:

getDefaultContentForEmptyCells in class InsertRowOperationBase

Returns:

The default content that must be introduced in empty cells. Default: null.

See Also:

• InsertRowOperationBase.getDefaultContentForEmptyCells()