docs/source/Sorter.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-util.Sorter'>/**
   2 </span> * @class Ext.util.Sorter
   3  * @extends Object
   4  * Represents a single sorter that can be applied to a Store
   5  */
   6 Ext.define('Ext.util.Sorter', {
   7
   8 <span id='Ext-util.Sorter-cfg-property'>    /**
   9 </span>     * @cfg {String} property The property to sort by. Required unless {@link #sorter} is provided
  10      */
  11
  12 <span id='Ext-util.Sorter-cfg-sorterFn'>    /**
  13 </span>     * @cfg {Function} sorterFn A specific sorter function to execute. Can be passed instead of {@link #property}
  14      */
  15
  16 <span id='Ext-util.Sorter-cfg-root'>    /**
  17 </span>     * @cfg {String} root Optional root property. This is mostly useful when sorting a Store, in which case we set the
  18      * root to 'data' to make the filter pull the {@link #property} out of the data object of each item
  19      */
  20
  21 <span id='Ext-util.Sorter-cfg-transform'>    /**
  22 </span>     * @cfg {Function} transform A function that will be run on each value before
  23      * it is compared in the sorter. The function will receive a single argument,
  24      * the value.
  25      */
  26
  27 <span id='Ext-util.Sorter-cfg-direction'>    /**
  28 </span>     * @cfg {String} direction The direction to sort by. Defaults to ASC
  29      */
  30     direction: &quot;ASC&quot;,
  31
  32     constructor: function(config) {
  33         var me = this;
  34
  35         Ext.apply(me, config);
  36
  37         //&lt;debug&gt;
  38         if (me.property == undefined &amp;&amp; me.sorterFn == undefined) {
  39             Ext.Error.raise(&quot;A Sorter requires either a property or a sorter function&quot;);
  40         }
  41         //&lt;/debug&gt;
  42
  43         me.updateSortFunction();
  44     },
  45
  46 <span id='Ext-util.Sorter-method-createSortFunction'>    /**
  47 </span>     * @private
  48      * Creates and returns a function which sorts an array by the given property and direction
  49      * @return {Function} A function which sorts by the property/direction combination provided
  50      */
  51     createSortFunction: function(sorterFn) {
  52         var me        = this,
  53             property  = me.property,
  54             direction = me.direction || &quot;ASC&quot;,
  55             modifier  = direction.toUpperCase() == &quot;DESC&quot; ? -1 : 1;
  56
  57         //create a comparison function. Takes 2 objects, returns 1 if object 1 is greater,
  58         //-1 if object 2 is greater or 0 if they are equal
  59         return function(o1, o2) {
  60             return modifier * sorterFn.call(me, o1, o2);
  61         };
  62     },
  63
  64 <span id='Ext-util.Sorter-method-defaultSorterFn'>    /**
  65 </span>     * @private
  66      * Basic default sorter function that just compares the defined property of each object
  67      */
  68     defaultSorterFn: function(o1, o2) {
  69         var me = this,
  70             transform = me.transform,
  71             v1 = me.getRoot(o1)[me.property],
  72             v2 = me.getRoot(o2)[me.property];
  73
  74         if (transform) {
  75             v1 = transform(v1);
  76             v2 = transform(v2);
  77         }
  78
  79         return v1 &gt; v2 ? 1 : (v1 &lt; v2 ? -1 : 0);
  80     },
  81
  82 <span id='Ext-util.Sorter-method-getRoot'>    /**
  83 </span>     * @private
  84      * Returns the root property of the given item, based on the configured {@link #root} property
  85      * @param {Object} item The item
  86      * @return {Object} The root property of the object
  87      */
  88     getRoot: function(item) {
  89         return this.root == undefined ? item : item[this.root];
  90     },
  91
  92     // @TODO: Add docs for these three methods
  93     setDirection: function(direction) {
  94         var me = this;
  95         me.direction = direction;
  96         me.updateSortFunction();
  97     },
  98
  99     toggle: function() {
 100         var me = this;
 101         me.direction = Ext.String.toggle(me.direction, &quot;ASC&quot;, &quot;DESC&quot;);
 102         me.updateSortFunction();
 103     },
 104
 105     updateSortFunction: function() {
 106         var me = this;
 107         me.sort = me.createSortFunction(me.sorterFn || me.defaultSorterFn);
 108     }
 109 });</pre></pre></body></html>