@API(type=INTERNAL, src=PUBLIC) public class DITAListSortOperation extends SortOperation
authorAccess, COLUMN
NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR
Constructor and Description |
---|
DITAListSortOperation()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
canBeSorted(AuthorElement parent,
int[] selectedNonIgnoredChildrenInterval)
Check if the parent element selected children can be sorted.
|
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)
Obtain the parent node of all the nodes which will be sorted.
|
boolean |
isIgnored(AuthorNode node)
Checks if a given node is ignored when sorting.
|
doOperation, forceSortAll, getArguments, getDescription, getNonIgnoredChildren, getSelectedNonIgnoredChildrenInterval, getTextContentToSort
public AuthorElement getSortParent(int offset, AuthorAccess authorAccess) throws AuthorOperationException
SortOperation
getSortParent
in class SortOperation
offset
- The offset where the operation was invoked.authorAccess
- The AuthorAccess
.AuthorOperationException
- When the offset is negative or greater than the content length.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 void canBeSorted(AuthorElement parent, int[] selectedNonIgnoredChildrenInterval) throws AuthorOperationException
SortOperation
canBeSorted
in class SortOperation
parent
- The parent of the elements which will be sorted.selectedNonIgnoredChildrenInterval
- The interval of selected children indices.AuthorOperationException
- When the given node is not sortable.
For example a table row containing a cell with multiple rowspan stops the operation.SortOperation.canBeSorted(ro.sync.ecss.extensions.api.node.AuthorElement, int[])
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(ro.sync.ecss.extensions.api.node.AuthorNode, ro.sync.ecss.extensions.commons.sort.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)
© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.