ro.sync.ecss.extensions.commons.table.operations.xhtml
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.xhtml.InsertRowOperation
- All Implemented Interfaces:
- AuthorOperation, Extension, XHTMLConstants
@API(type=INTERNAL,
src=PUBLIC)
public class InsertRowOperation
- extends InsertRowOperationBase
- implements XHTMLConstants
Operation used to insert a table row for XHTML documents.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
InsertRowOperation
public InsertRowOperation()
- Constructor.
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()
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 elementcolumnIndex
- 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)
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()
© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.