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

java.lang.Object
  ro.sync.ecss.extensions.commons.table.operations.AbstractTableOperation
      ro.sync.ecss.extensions.commons.table.operations.InsertRowOperationBase

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

InsertRowOperation, InsertRowOperation, InsertRowOperation, InsertRowOperation, InsertRowOperation

public abstract class InsertRowOperationBase
extends AbstractTableOperation

Abstract class for operation used to insert a table row.

Field Summary

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

tableHelper

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

InsertRowOperationBase(AuthorTableHelper documentTypeHelper)
Constructor.

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() The operation will display a dialog for choose table attributes.
protected abstract java.lang.String	getCellElementName(AuthorElement tableElement, int columnIndex) Get the name of the element that represents a cell.
java.lang.String	getDescription()
protected java.lang.String[]	getIgnoredAttributes() Gets the attributes which should be skipped when using the current row as temaplate for insert operation.
protected ArgumentDescriptor[]	getOperationArguments() Get the array of arguments used for this operation.
protected abstract java.lang.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.AbstractTableOperation

createEmptyCell, findCellInsertionOffset, getElementAncestor, isElement, isTableElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InsertRowOperationBase

public InsertRowOperationBase(AuthorTableHelper documentTypeHelper)

Constructor.

Parameters:

documentTypeHelper - Author Document type helper, has methods specific to a document type.

Method Detail

getOperationArguments

protected ArgumentDescriptor[] getOperationArguments()

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

Returns:

The array with the arguments of the operation.

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. This method is typically called from an ActionListener.actionPerformed(java.awt.event.ActionEvent) if used from Oxygen stand-alone distribution or org.eclipse.jface.action.Action#run() if used from the Oxygen Eclipse plugin.

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:

AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

The operation will display a dialog for choose table attributes.

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getCellElementName

protected abstract java.lang.String getCellElementName(AuthorElement tableElement,
                                                       int columnIndex)

Get the name of the element that represents a cell.

Parameters:

tableElement - The table element

columnIndex - The column index.

Returns:

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

getRowElementName

protected abstract java.lang.String getRowElementName(AuthorElement tableElement)

Get the name of the element that represents a row.

Parameters:

tableElement - The table parent element.

Returns:

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

getIgnoredAttributes

protected java.lang.String[] getIgnoredAttributes()

Gets the attributes which should be skipped when using the current row as temaplate for insert operation.

Returns:

The attributes which should be skipped when using the current row as template for insert operation. By default, there is no such attribute and returned value is null.

useCurrentRowTemplateOnInsert

protected boolean useCurrentRowTemplateOnInsert()

Returns:

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