User Guide

208 Chapter 6: Components Dictionary
Parameters
compareFunc
A reference to a function that compares two items to determine their sort order.
For details, see
Array.sort() in Flash ActionScript Language Reference. This parameter
is optional.
optionsFlag Lets you perform multiple sorts of different types on a single array without
having to replicate the entire array or re-sort it repeatedly. This parameter is optional.
The following are possible values for
optionsFlag:
Array.DESCENDING, which sorts highest to lowest.
Array.CASEINSENSITIVE, which sorts without regard to case.
Array.NUMERIC, which sorts numerically if the two elements being compared are numbers. If
they arent numbers, use a string comparison (which can be case-insensitive if that flag is
specified).
Array.UNIQUESORT, which returns an error code (0) instead of a sorted array if two objects in
the array are identical or have identical sort fields.
Array.RETURNINDEXEDARRAY, which returns an integer index array that is the result of the
sort. For example, the following array would return the second line of code and the array
would remain unchanged:
["a", "d", "c", "b"]
[0, 3, 2, 1]
You can combine these options into one value. For example, the following code combines options
3 and 1:
array.sort (Array.NUMERIC | Array.DESCENDING)
Returns
Nothing.
Description
Method; sorts the items in the combo box according to the specified compare function or
according to the specified sort options.
Example
This example sorts according to uppercase labels. The items a and b are passed to the function
and contain
label and data fields:
myComboBox.sortItems(upperCaseFunc);
function upperCaseFunc(a,b){
return a.label.toUpperCase() > b.label.toUpperCase();
}
The following example uses the upperCaseFunc() function defined above, along with the
optionsFlag parameter to sort the elements of a ComboBox instance named myComboBox:
myComboBox.addItem("Mercury");
myComboBox.addItem("Venus");
myComboBox.addItem("Earth");
myComboBox.addItem("planet");