Class ViewerSorter

Object
   |
   +--ViewerSorter

class ViewerSorter

Defined in viewer_sorter.js

Constructor Detail

ViewerSorter

function ViewerSorter(comparator)

getIndexOf

int getIndexOf(<Object> newChild, <ArrayList> existingChildren)

Calculates the insertion point of a new object given a list of existing objects.

Parameters:
newChild - an object that is to be inserted into the list
existingChildren - a list of objects that already exist in the viewer

Returns:
the index in existingChildren at which newChild should be inserted to maintain the ordering imposed by this sorter

invert

void invert()

Inverts the current sort order.

isInverted

boolean isInverted()

Returns true if the current sort order is the same as when the sorter was constructed, and false if the current sort order is inverted as compared to construct-time sort order.

Returns:
true or false

setInverted

void setInverted(<boolean> inverted)

Sets the inverted state to inverted. After this call completes, this.isInverted() == inverted is true.

Parameters:
inverted - the desired inverted state

Returns:
true if something changed and false otherwise

sort

void sort(<ArrayList> children)

Sorts the given list of objects in place.

Parameters:
children - a list of objects to be sorted

NUM_COMP

<static> function NUM_COMP(<number> numA, <number> numB)

A comparator for numbers (either ints or floats), suitable for passing to a ViewerSorter.

Parameters:
numA - a number
numB - a number

Returns:
the value of numA - numB

STR_COMP

<static> int STR_COMP(<string> strA, <string> strB)

A comparator for strings, suitable for passing to a ViewerSorter.

Parameters:
strA - a string
strB - a string

Returns:
-1 if strA is less than strB, 0 if they are equal, and 1 if strA is greater than strB.

getChainedComparator

<static> Function getChainedComparator()

Returns a comparator suitable for passing to a ViewerSorter that compares two values based on a sequence of prioritized keys.

Returns:
a comparator

getCompositeComparator

<static> Function getCompositeComparator(<string> path, <boolean> ignoreCase)

Returns a comparator suitable for passing to a ViewerSorter that will do a string comparison on two Composites at the given path.

Parameters:
path - the path at which to compare the Composites passed into the resulting function
ignoreCase - (Optional) - a flag indicating whether or not the returned comparator should perform case-insensitive string comparisons. Defaults to false, which means case-sensitive comparisons.

Returns:
a function that compares Composites at the given path