ro.sync.ecss.extensions.api.table.operations
Class AuthorTableInsertColumnArguments

java.lang.Object
  ro.sync.ecss.extensions.api.table.operations.AuthorTableInsertColumnArguments

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class AuthorTableInsertColumnArguments
extends java.lang.Object

Holds the arguments for AuthorTableOperationsHandler.handleInsertColumn(AuthorTableInsertColumnArguments) method.

Since:

14

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Constructor Summary

AuthorTableInsertColumnArguments(int insertOffset, AuthorDocumentFragment[] columnFragments, boolean fragmentsWrappedInCells, AuthorAccess authorAccess, TableColumnSpecificationInformation columnSpecification)
Constructor.

Method Summary

boolean	areFragmentsWrappedInCells()
AuthorAccess	getAuthorAccess()
AuthorDocumentFragment[]	getColumnFragments()
TableColumnSpecificationInformation	getColumnSpecificationInformation() Returns the column specification information of a table column.
int	getInsertOffset()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorTableInsertColumnArguments

public AuthorTableInsertColumnArguments(int insertOffset,
                                        AuthorDocumentFragment[] columnFragments,
                                        boolean fragmentsWrappedInCells,
                                        AuthorAccess authorAccess,
                                        TableColumnSpecificationInformation columnSpecification)

Constructor.

Parameters:

insertOffset - The offset where the column is inserted.

columnFragments - The array containing the cells nodes that compose an Author table column.

fragmentsWrappedInCells - true if the given column fragments represents the cells nodes or only the content of the cells nodes.

authorAccess - The Author access.

columnSpecification - Table column specification information that is requested when a column is copied or dragged, from AuthorTableOperationsHandler.getColumnSpecification(AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int) method. It can be null if no information is specified for table column.

Method Detail

getAuthorAccess

public AuthorAccess getAuthorAccess()

Returns:

Returns the access to Author operation.

getColumnFragments

public AuthorDocumentFragment[] getColumnFragments()

Returns:

Returns the array containing the cells nodes that compose an Author table column.

getInsertOffset

public int getInsertOffset()

Returns:

Returns the offset where the column is inserted.

areFragmentsWrappedInCells

public boolean areFragmentsWrappedInCells()

Returns:

Returns true if the given column fragments represents the cells nodes or only the content of the cells nodes.

getColumnSpecificationInformation

public TableColumnSpecificationInformation getColumnSpecificationInformation()

Returns the column specification information of a table column. This information is requested when a column is copied or dragged, from AuthorTableOperationsHandler.getColumnSpecification(AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int) method.

Returns:

Returns information about column specification (like column specified width). It can be null if no information is specified for table column.