Package ro.sync.ecss.extensions.commons.sort

Class TableSortOperation

java.lang.Object

ro.sync.ecss.extensions.commons.sort.SortOperation

ro.sync.ecss.extensions.commons.sort.TableSortOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

CALSAndHTMLTableSortOperation, SimpleTableSortOperation

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class TableSortOperation
extends SortOperation

Base table sort operation.

Field Summary

Fields inherited from class ro.sync.ecss.extensions.commons.sort.SortOperation

authorAccess, COLUMN

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

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
TableSortOperation()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	canBeSorted(AuthorElement parent, int[] selectedNonIgnoredChildrenInterval)	Check if the parent element selected children can be sorted.
protected java.lang.String	getHelpPageID()	Get the ID of the help page which will be called by the end user.
protected abstract int	getRowIndexForTableBody(AuthorNode table)	Returns the visual row index of the actual table body if the table has separate head, foot element and table group elements.

Methods inherited from class ro.sync.ecss.extensions.commons.sort.SortOperation

doOperation, forceSortAll, getArguments, getDescription, getNonIgnoredChildren, getSelectedNonIgnoredChildrenInterval, getSortCriteria, getSortKeysValues, getSortParent, getTextContentToSort, isIgnored

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSortOperation

public TableSortOperation()

Constructor.

Method Detail

canBeSorted

public void canBeSorted(AuthorElement parent,
                        int[] selectedNonIgnoredChildrenInterval)
                 throws AuthorOperationException

Description copied from class: SortOperation

Check if the parent element selected children can be sorted. For example a table row containing a cell with rowspan cannot be sorted and stops the operation.

Specified by:

canBeSorted in class SortOperation

Parameters:

parent - The parent of the elements which will be sorted.

selectedNonIgnoredChildrenInterval - The interval of selected children indices.

Throws:

AuthorOperationException - When the given node is not sortable. For example a table row containing a cell with multiple rowspan stops the operation.

See Also:

SortOperation.canBeSorted(ro.sync.ecss.extensions.api.node.AuthorElement, int[])

getRowIndexForTableBody

protected abstract int getRowIndexForTableBody(AuthorNode table)

Returns the visual row index of the actual table body if the table has separate head, foot element and table group elements.

getHelpPageID

protected java.lang.String getHelpPageID()

Description copied from class: SortOperation

Get the ID of the help page which will be called by the end user.

Overrides:

getHelpPageID in class SortOperation

Returns:

the ID of the help page which will be called by the end user or null.

See Also:

SortOperation.getHelpPageID()