ro.sync.ecss.extensions.dita.topic.table

Class InsertTableOperation

java.lang.Object

ro.sync.ecss.extensions.dita.topic.table.InsertTableOperation

All Implemented Interfaces:

AuthorOperation, Extension, InsertTableCellsContentConstants, InsertTableOperationBase

@API(type=INTERNAL,
     src=PUBLIC)
public class InsertTableOperation
extends java.lang.Object
implements AuthorOperation, InsertTableOperationBase, InsertTableCellsContentConstants

Operation used to insert a DITA table.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cellContent The fragment that must be introduced in the table cells
static ArgumentDescriptor	DEFAULT_TABLE_MODEL_ARGUMENT Argument descriptor for the default (actually preferred) table model.

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.InsertTableCellsContentConstants

CELL_FRAGMENT_ARGUMENT, CELL_FRAGMENT_ARGUMENT_IN_ARRAY, CELL_FRAGMENT_ARGUMENT_NAME

Constructor Summary

Constructors

Constructor and Description
InsertTableOperation()

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() No arguments.
java.lang.String	getDescription()
void	insertTable(AuthorDocumentFragment[] fragments, boolean cellsFragments, AuthorAccess authorAccess, java.lang.String namespace, AuthorTableHelper tableHelper, TableInfo tableInfo) If the fragments array is not null, this method converts the given fragments array into a table.
void	insertTable(AuthorDocumentFragment[] fragments, java.util.List<java.util.Map<java.lang.String,java.lang.String>> rowAttributes, boolean cellsFragments, AuthorAccess authorAccess, java.lang.String namespace, AuthorTableHelper tableHelper, TableInfo tableInfo) If the fragments array is not null, this method converts the given fragments array into a table.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TABLE_MODEL_ARGUMENT

public static final ArgumentDescriptor DEFAULT_TABLE_MODEL_ARGUMENT

Argument descriptor for the default (actually preferred) table model.

cellContent

protected java.lang.String cellContent

The fragment that must be introduced in the table cells

Constructor Detail

InsertTableOperation

public InsertTableOperation()

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.getPlatform(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:

doOperation in interface AuthorOperation

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

No arguments. The operation will display a dialog for choosing the table attributes.

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

insertTable

public void insertTable(AuthorDocumentFragment[] fragments,
                        boolean cellsFragments,
                        AuthorAccess authorAccess,
                        java.lang.String namespace,
                        AuthorTableHelper tableHelper,
                        TableInfo tableInfo)
                 throws AuthorOperationException

Description copied from interface: InsertTableOperationBase

If the fragments array is not null, this method converts the given fragments array into a table. Each fragments will correspond to a cell. The resulting table will have one column and as many rows as fragments length. If no fragment is provided an empty table is inserted (a dialog is shown to choose all the table properties)

Specified by:

insertTable in interface InsertTableOperationBase

Parameters:

fragments - An array of AuthorDocumentFragments that are used as content of the inserted cells.

cellsFragments - If the value is true then the fragments where originally cells.

authorAccess - The author access.

namespace - The namespace.

tableHelper - The table helper.

tableInfo - The details about table creation. If null, a dialog is presented to let the user choose the details.

Throws:

AuthorOperationException

See Also:

InsertTableOperationBase.insertTable(ro.sync.ecss.extensions.api.node.AuthorDocumentFragment[], boolean, ro.sync.ecss.extensions.api.AuthorAccess, java.lang.String, ro.sync.ecss.extensions.commons.table.operations.AuthorTableHelper, ro.sync.ecss.extensions.commons.table.operations.TableInfo)

insertTable

public void insertTable(AuthorDocumentFragment[] fragments,
                        java.util.List<java.util.Map<java.lang.String,java.lang.String>> rowAttributes,
                        boolean cellsFragments,
                        AuthorAccess authorAccess,
                        java.lang.String namespace,
                        AuthorTableHelper tableHelper,
                        TableInfo tableInfo)
                 throws AuthorOperationException

If the fragments array is not null, this method converts the given fragments array into a table. Each fragments will correspond to a cell. The resulting table will have one column and as many rows as fragments length. If no fragment is provided an empty table is inserted (a dialog is shown to choose all the table properties)

Parameters:

fragments - An array of AuthorDocumentFragments that are used as content of the inserted cells.

rowAttributes - For each fragment this list can contain a list of corresponding attributes that can be set on the row element.

cellsFragments - If the value is true then the fragments where originally cells.

authorAccess - The author access.

namespace - The namespace.

tableHelper - The table helper.

tableInfo - The details about table creation. If null, a dialog is presented to let the user choose the details.

Throws:

AuthorOperationException