Oxygen XML Editor 16.1 Author API

ro.sync.ecss.extensions.dita.topic.table.simpletable
Class InsertRowOperation

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation
      extended by ro.sync.ecss.extensions.commons.table.operations.InsertRowOperationBase
          extended by ro.sync.ecss.extensions.dita.topic.table.simpletable.InsertRowOperation
All Implemented Interfaces:
AuthorOperation, Extension, InsertTableCellsContentConstants, SimpleTableConstants

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

Operation used to insert a simple table row for DITA.


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.dita.topic.table.simpletable.SimpleTableConstants
ATTRIBUTE_NAME_ID, ELEMENT_NAME_CHDESC_CHOICETABLE, ELEMENT_NAME_CHDESCHD_CHOICETABLE, ELEMENT_NAME_CHOICETABLE, ELEMENT_NAME_CHOPTION_CHOICETABLE, ELEMENT_NAME_CHOPTIONHD_CHOICETABLE, ELEMENT_NAME_ENTRY_SIMPLETABLE, ELEMENT_NAME_HEADER_CHOICETABLE, ELEMENT_NAME_HEADER_PROPERTIES, ELEMENT_NAME_HEADER_SIMPLETABLE, ELEMENT_NAME_PROPDESC_PROPERTIES, ELEMENT_NAME_PROPDESCHD_PROPERTIES, ELEMENT_NAME_PROPERTIES, ELEMENT_NAME_PROPTYPE_PROPERTIES, ELEMENT_NAME_PROPTYPEHD_PROPERTIES, ELEMENT_NAME_PROPVALUE_PROPERTIES, ELEMENT_NAME_PROPVALUEHD_PROPERTIES, ELEMENT_NAME_ROW_CHOICETABLE, ELEMENT_NAME_ROW_PROPERTIES, ELEMENT_NAME_ROW_SIMPLETABLE, ELEMENT_NAME_SIMPLETABLE
 
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
InsertRowOperation()
          Constructor.
 
Method Summary
 void doOperation(AuthorAccess authorAccess, ArgumentsMap args)
          Perform the actual operation.
protected  java.lang.String getCellElementName(AuthorElement tableElement, int columnIndex)
          Get the name of the element that represents a cell.
protected  java.lang.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  java.lang.String getRowElementName(AuthorElement tableElement)
          Get the name of the element that represents a row.
 
Methods inherited from class ro.sync.ecss.extensions.commons.table.operations.InsertRowOperationBase
createCellXMLFragment, getArguments, getDescription, getRowXMLFragment, getRowXMLFragment, useCurrentRowTemplateOnInsert
 
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

cellContent

protected java.lang.String cellContent
The fragment that must be introduced in the table cells

Constructor Detail

InsertRowOperation

public InsertRowOperation()
Constructor.

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().

Specified by:
doOperation in interface AuthorOperation
Overrides:
doOperation 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:
java.lang.IllegalArgumentException - Thrown when one or more arguments are illegal.
AuthorOperationException - Thrown when the operation fails.
See Also:
InsertRowOperationBase.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getCellElementName

protected java.lang.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 java.lang.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)

getDefaultContentForEmptyCells

protected java.lang.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()

getOperationArguments

protected ArgumentDescriptor[] getOperationArguments()
Description copied from class: InsertRowOperationBase
Get the array of arguments used for this operation. The first argument define the location where the operation will be executed as an xpath expression, the second one define the relative position to the node obtained from the XPath location and the third is the namespace argument descriptor. 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()

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.