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.Filter-method-constructor'><span id='Ext-util.Filter'>/**
2 </span></span> * @class Ext.util.Filter
4 * <p>Represents a filter that can be applied to a {@link Ext.util.MixedCollection MixedCollection}. Can either simply
5 * filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context
6 * of MixedCollections, though {@link Ext.data.Store Store}s frequently create them when filtering and searching on their
7 * records. Example usage:</p>
8 <pre><code>
9 //set up a fictional MixedCollection containing a few people to filter on
10 var allNames = new Ext.util.MixedCollection();
12 {id: 1, name: 'Ed', age: 25},
13 {id: 2, name: 'Jamie', age: 37},
14 {id: 3, name: 'Abe', age: 32},
15 {id: 4, name: 'Aaron', age: 26},
16 {id: 5, name: 'David', age: 32}
19 var ageFilter = new Ext.util.Filter({
24 var longNameFilter = new Ext.util.Filter({
25 filterFn: function(item) {
26 return item.name.length > 4;
30 //a new MixedCollection with the 3 names longer than 4 characters
31 var longNames = allNames.filter(longNameFilter);
33 //a new MixedCollection with the 2 people of age 24:
34 var youngFolk = allNames.filter(ageFilter);
35 </code></pre>
37 * @param {Object} config Config object
39 Ext.define('Ext.util.Filter', {
41 /* Begin Definitions */
44 <span id='Ext-util.Filter-cfg-property'> /**
45 </span> * @cfg {String} property The property to filter on. Required unless a {@link #filter} is passed
48 <span id='Ext-util.Filter-cfg-filterFn'> /**
49 </span> * @cfg {Function} filterFn A custom filter function which is passed each item in the {@link Ext.util.MixedCollection}
50 * in turn. Should return true to accept each item or false to reject it
53 <span id='Ext-util.Filter-cfg-anyMatch'> /**
54 </span> * @cfg {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false
58 <span id='Ext-util.Filter-cfg-exactMatch'> /**
59 </span> * @cfg {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false.
60 * Ignored if anyMatch is true.
64 <span id='Ext-util.Filter-cfg-caseSensitive'> /**
65 </span> * @cfg {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.
69 <span id='Ext-util.Filter-cfg-root'> /**
70 </span> * @cfg {String} root Optional root property. This is mostly useful when filtering a Store, in which case we set the
71 * root to 'data' to make the filter pull the {@link #property} out of the data object of each item
74 constructor: function(config) {
75 Ext.apply(this, config);
77 //we're aliasing filter to filterFn mostly for API cleanliness reasons, despite the fact it dirties the code here.
78 //Ext.util.Sorter takes a sorterFn property but allows .sort to be called - we do the same here
79 this.filter = this.filter || this.filterFn;
81 if (this.filter == undefined) {
82 if (this.property == undefined || this.value == undefined) {
83 // Commented this out temporarily because it stops us using string ids in models. TODO: Remove this once
84 // Model has been updated to allow string ids
86 // Ext.Error.raise("A Filter requires either a property or a filterFn to be set");
88 this.filter = this.createFilterFn();
91 this.filterFn = this.filter;
95 <span id='Ext-util.Filter-method-createFilterFn'> /**
97 * Creates a filter function for the configured property/value/anyMatch/caseSensitive options for this Filter
99 createFilterFn: function() {
101 matcher = me.createValueMatcher(),
102 property = me.property;
104 return function(item) {
105 return matcher.test(me.getRoot.call(me, item)[property]);
109 <span id='Ext-util.Filter-method-getRoot'> /**
111 * Returns the root property of the given item, based on the configured {@link #root} property
112 * @param {Object} item The item
113 * @return {Object} The root property of the object
115 getRoot: function(item) {
116 return this.root == undefined ? item : item[this.root];
119 <span id='Ext-util.Filter-method-createValueMatcher'> /**
121 * Returns a regular expression based on the given value and matching options
123 createValueMatcher : function() {
126 anyMatch = me.anyMatch,
127 exactMatch = me.exactMatch,
128 caseSensitive = me.caseSensitive,
129 escapeRe = Ext.String.escapeRegex;
131 if (!value.exec) { // not a regex
132 value = String(value);
134 if (anyMatch === true) {
135 value = escapeRe(value);
137 value = '^' + escapeRe(value);
138 if (exactMatch === true) {
142 value = new RegExp(value, caseSensitive ? '' : 'i');
147 });</pre></pre></body></html>