docs/source/Sorter.html

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