RecordsetSort Class
Plugin that adds default and custom sorting functionality to the Recordset utility
Item Index
Methods
Attributes
Methods
_defSortFn
    
        ()
    
    
    
    
        private
    
    
    
    
    
    Method that all sort calls go through. Sets up the lastSortProperties object with the details of the sort, and passes in parameters to the "defaultSorter" or a custom specified sort function.
flip
    
        ()
    
    
    
    
        public
    
    
    
    
    
    Sorts the recordset based on the last-used sort parameters, but flips the order. (ie: Descending becomes ascending, and vice versa).
initializer
    
        ()
    
    
    
    
        protected
    
    
    
    
    
    Sets up the default function to use when the "sort" event is fired.
resort
    
        ()
    
    
    
    
        public
    
    
    
    
    
    Resorts the recordset based on the last-used sort parameters (stored in 'lastSortProperties' ATTR)
reverse
    
        ()
    
    
    
    
        public
    
    
    
    
    
    Reverses the recordset calling the standard array.reverse() method.
Attributes
defaultSorter
    Function
    
    
        public
    
    
    
    
    Default sort function to use if none is specified by the user. Takes two records, the key to sort by, and whether sorting direction is descending or not (boolean). If two records have the same value for a given key, the ID is used as the tie-breaker.
Fires event defaultSorterChange
            
            Fires when the value for the configuration attribute defaultSorter is
            changed. You can listen for the event using the on method if you
            wish to be notified before the attribute's value has changed, or
            using the after method if you wish to be notified after the
            attribute's value has changed.
            
Parameters:
- 
                        eEventFacadeAn Event Facade object with the following attribute-specific properties added:
defaultSorter
    Function
    
    
        public
    
    
    
    
    A boolean telling if the recordset is in a sorted state.
Fires event defaultSorterChange
            
            Fires when the value for the configuration attribute defaultSorter is
            changed. You can listen for the event using the on method if you
            wish to be notified before the attribute's value has changed, or
            using the after method if you wish to be notified after the
            attribute's value has changed.
            
Parameters:
- 
                        eEventFacadeAn Event Facade object with the following attribute-specific properties added:
lastSortProperties
    Object
    
    
        public
    
    
    
    
    The last properties used to sort. Consists of an object literal with the keys "field", "desc", and "sorter"
Fires event lastSortPropertiesChange
            
            Fires when the value for the configuration attribute lastSortProperties is
            changed. You can listen for the event using the on method if you
            wish to be notified before the attribute's value has changed, or
            using the after method if you wish to be notified after the
            attribute's value has changed.
            
Parameters:
- 
                        eEventFacadeAn Event Facade object with the following attribute-specific properties added:
