@API(type=INTERNAL, src=PUBLIC) public abstract class SimpleTableSortOperation extends TableSortOperation
authorAccess, COLUMN
NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR
Constructor and Description |
---|
SimpleTableSortOperation() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
forceSortAll() |
protected 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.
|
java.util.List<CriterionInformation> |
getSortCriteria(AuthorElement parent)
Obtain the sort criterion.
|
java.lang.String[] |
getSortKeysValues(AuthorNode node,
SortCriteriaInformation sortInfo)
Obtain the values of the keys that can be used for sorting.
|
AuthorElement |
getSortParent(int offset,
AuthorAccess authorAccess)
Get the table element whose rows will be sorted.
|
boolean |
isCaretInColumn(AuthorAccess authorAccess,
int columnNumber)
Checks if the caret is in a cell which is in the given column.
|
abstract boolean |
isHeadElement(AuthorElement node)
Returns
true if the given node is the table header element. |
boolean |
isIgnored(AuthorNode node)
Checks if a given node is ignored when sorting.
|
abstract boolean |
isRowElement(AuthorElement node)
Returns
true if the given node is a table row. |
abstract boolean |
isTableElement(AuthorElement node)
Return
true if the given node is the table element. |
canBeSorted
doOperation, getArguments, getDescription, getNonIgnoredChildren, getSelectedNonIgnoredChildrenInterval, getTextContentToSort
public AuthorElement getSortParent(int offset, AuthorAccess authorAccess) throws AuthorOperationException
getSortParent
in class SortOperation
offset
- The offset where the operation was invoked.authorAccess
- The AuthorAccess
.AuthorOperationException
SortOperation.getSortParent(int, ro.sync.ecss.extensions.api.AuthorAccess)
public boolean isIgnored(AuthorNode node)
SortOperation
isIgnored
in class SortOperation
node
- The node to be checked.true
if the given node is ignored when sorting.SortOperation.isIgnored(ro.sync.ecss.extensions.api.node.AuthorNode)
public java.lang.String[] getSortKeysValues(AuthorNode node, SortCriteriaInformation sortInfo) throws AuthorOperationException
SortOperation
getSortKeysValues
in class SortOperation
node
- The element which will be sorted.sortInfo
- The sort information corresponding to the user choice.AuthorOperationException
- If the text content cannot be obtained.SortOperation.getSortKeysValues(AuthorNode, SortCriteriaInformation)
public java.util.List<CriterionInformation> getSortCriteria(AuthorElement parent) throws AuthorOperationException
SortOperation
getSortCriteria
in class SortOperation
parent
- The parent node of the nodes which will be sorted.SortCriteriaInformation
containing the CriterionInformation
objects.AuthorOperationException
SortOperation.getSortCriteria(ro.sync.ecss.extensions.api.node.AuthorElement)
protected boolean forceSortAll()
forceSortAll
in class SortOperation
true
if the sort operation should not use the selected
element and should always sort all elements.SortOperation.forceSortAll()
public boolean isCaretInColumn(AuthorAccess authorAccess, int columnNumber)
authorAccess
- The author access.columnNumber
- The number of the column in which to check.true
if the given column has a cell which contains the caret.protected int getRowIndexForTableBody(AuthorNode table)
TableSortOperation
getRowIndexForTableBody
in class TableSortOperation
TableSortOperation.getRowIndexForTableBody(ro.sync.ecss.extensions.api.node.AuthorNode)
public abstract boolean isTableElement(AuthorElement node)
true
if the given node is the table element.node
- The node to be checked.true
if the given node is the table element.public abstract boolean isHeadElement(AuthorElement node)
true
if the given node is the table header element.node
- The node to be checked.true
if the given node is the table header.public abstract boolean isRowElement(AuthorElement node)
true
if the given node is a table row.node
- The node to be checked.true
when the given node is a table row element.© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.