docs/source/Filter.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-Filter-method-constructor'><span id='Ext-util-Filter'>/**
  19 </span></span> * @class Ext.util.Filter
  20  * @extends Object
  21  * &lt;p&gt;Represents a filter that can be applied to a {@link Ext.util.MixedCollection MixedCollection}. Can either simply
  22  * filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context
  23  * of MixedCollections, though {@link Ext.data.Store Store}s frequently create them when filtering and searching on their
  24  * records. Example usage:&lt;/p&gt;
  25 &lt;pre&gt;&lt;code&gt;
  26 //set up a fictional MixedCollection containing a few people to filter on
  27 var allNames = new Ext.util.MixedCollection();
  28 allNames.addAll([
  29     {id: 1, name: 'Ed',    age: 25},
  30     {id: 2, name: 'Jamie', age: 37},
  31     {id: 3, name: 'Abe',   age: 32},
  32     {id: 4, name: 'Aaron', age: 26},
  33     {id: 5, name: 'David', age: 32}
  34 ]);
  35
  36 var ageFilter = new Ext.util.Filter({
  37     property: 'age',
  38     value   : 32
  39 });
  40
  41 var longNameFilter = new Ext.util.Filter({
  42     filterFn: function(item) {
  43         return item.name.length &gt; 4;
  44     }
  45 });
  46
  47 //a new MixedCollection with the 3 names longer than 4 characters
  48 var longNames = allNames.filter(longNameFilter);
  49
  50 //a new MixedCollection with the 2 people of age 24:
  51 var youngFolk = allNames.filter(ageFilter);
  52 &lt;/code&gt;&lt;/pre&gt;
  53  * @constructor
  54  * @param {Object} config Config object
  55  */
  56 Ext.define('Ext.util.Filter', {
  57
  58     /* Begin Definitions */
  59
  60     /* End Definitions */
  61 <span id='Ext-util-Filter-cfg-property'>    /**
  62 </span>     * @cfg {String} property The property to filter on. Required unless a {@link #filter} is passed
  63      */
  64
  65 <span id='Ext-util-Filter-cfg-filterFn'>    /**
  66 </span>     * @cfg {Function} filterFn A custom filter function which is passed each item in the {@link Ext.util.MixedCollection}
  67      * in turn. Should return true to accept each item or false to reject it
  68      */
  69
  70 <span id='Ext-util-Filter-cfg-anyMatch'>    /**
  71 </span>     * @cfg {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false
  72      */
  73     anyMatch: false,
  74
  75 <span id='Ext-util-Filter-cfg-exactMatch'>    /**
  76 </span>     * @cfg {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false.
  77      * Ignored if anyMatch is true.
  78      */
  79     exactMatch: false,
  80
  81 <span id='Ext-util-Filter-cfg-caseSensitive'>    /**
  82 </span>     * @cfg {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.
  83      */
  84     caseSensitive: false,
  85
  86 <span id='Ext-util-Filter-cfg-root'>    /**
  87 </span>     * @cfg {String} root Optional root property. This is mostly useful when filtering a Store, in which case we set the
  88      * root to 'data' to make the filter pull the {@link #property} out of the data object of each item
  89      */
  90
  91     constructor: function(config) {
  92         Ext.apply(this, config);
  93
  94         //we're aliasing filter to filterFn mostly for API cleanliness reasons, despite the fact it dirties the code here.
  95         //Ext.util.Sorter takes a sorterFn property but allows .sort to be called - we do the same here
  96         this.filter = this.filter || this.filterFn;
  97
  98         if (this.filter == undefined) {
  99             if (this.property == undefined || this.value == undefined) {
 100                 // Commented this out temporarily because it stops us using string ids in models. TODO: Remove this once
 101                 // Model has been updated to allow string ids
 102
 103                 // Ext.Error.raise(&quot;A Filter requires either a property or a filterFn to be set&quot;);
 104             } else {
 105                 this.filter = this.createFilterFn();
 106             }
 107
 108             this.filterFn = this.filter;
 109         }
 110     },
 111
 112 <span id='Ext-util-Filter-method-createFilterFn'>    /**
 113 </span>     * @private
 114      * Creates a filter function for the configured property/value/anyMatch/caseSensitive options for this Filter
 115      */
 116     createFilterFn: function() {
 117         var me       = this,
 118             matcher  = me.createValueMatcher(),
 119             property = me.property;
 120
 121         return function(item) {
 122             return matcher.test(me.getRoot.call(me, item)[property]);
 123         };
 124     },
 125
 126 <span id='Ext-util-Filter-method-getRoot'>    /**
 127 </span>     * @private
 128      * Returns the root property of the given item, based on the configured {@link #root} property
 129      * @param {Object} item The item
 130      * @return {Object} The root property of the object
 131      */
 132     getRoot: function(item) {
 133         return this.root == undefined ? item : item[this.root];
 134     },
 135
 136 <span id='Ext-util-Filter-method-createValueMatcher'>    /**
 137 </span>     * @private
 138      * Returns a regular expression based on the given value and matching options
 139      */
 140     createValueMatcher : function() {
 141         var me            = this,
 142             value         = me.value,
 143             anyMatch      = me.anyMatch,
 144             exactMatch    = me.exactMatch,
 145             caseSensitive = me.caseSensitive,
 146             escapeRe      = Ext.String.escapeRegex;
 147
 148         if (!value.exec) { // not a regex
 149             value = String(value);
 150
 151             if (anyMatch === true) {
 152                 value = escapeRe(value);
 153             } else {
 154                 value = '^' + escapeRe(value);
 155                 if (exactMatch === true) {
 156                     value += '$';
 157                 }
 158             }
 159             value = new RegExp(value, caseSensitive ? '' : 'i');
 160          }
 161
 162          return value;
 163     }
 164 });</pre>
 165 </body>
 166 </html>