ListGroupSortedclasslister.t[1975]

Sorted group list. This is a list that simply displays its members in a specific sorting order.

class ListGroupSorted :   ListGroup

Superclass Tree   (in declaration order)

ListGroupSorted
       
ListGroup
                object

Subclass Tree  

ListGroupSorted
       
ListGroupParen
        ListGroupPrefixSuffix
                SuggestionListGroup

Global Objects  

(none)

Summary of Properties  

Inherited from ListGroup :
groupDisplaysSublist  minGroupSize 

Summary of Methods  

compareGroupItems  showGroupList  sortListGroup 

Inherited from ListGroup :
createGroupSublister  groupCardinality  groupNounPhraseCount  showGroupItem  showGroupItemCounted 

Properties  

(none)

Methods  

// compareGroupItems (a, b)Interface description onlylister.t[2019]

Compare a pair of items from the group to determine their sorting order. Returns 0 if the two items are at the same sorting order, 1 if the first item sorts after the second item, -1 if the first item sorts before the second item.

We do not provide a default implementation of this method, so that sortListGroup will know not to bother sorting the list at all if the subclass doesn't provide a definition for this method.

showGroupList (pov, lister, lst, options, indent, infoTab)OVERRIDDENlister.t[1979]
Show the group list

sortListGroup (lst)lister.t[1997]
Sort the group list. By default, if we have a compareGroupItems() method defined, we'll sort the list using that method; otherwise, we'll just return the list unchanged.

TADS 3 Library Manual
Generated on 9/15/2006 from TADS version 3.0.12