X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/Filter.html diff --git a/docs/source/Filter.html b/docs/source/Filter.html index 13345bc7..a10c3a2d 100644 --- a/docs/source/Filter.html +++ b/docs/source/Filter.html @@ -1,5 +1,22 @@ -
+ +/** - * @class Ext.util.Filter + + + + +\ No newline at end of file +});The source code + + + + + + +/** + * @class Ext.util.Filter * @extends Object * <p>Represents a filter that can be applied to a {@link Ext.util.MixedCollection MixedCollection}. Can either simply * filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context @@ -33,44 +50,46 @@ var longNames = allNames.filter(longNameFilter); //a new MixedCollection with the 2 people of age 24: var youngFolk = allNames.filter(ageFilter); </code></pre> - * @constructor - * @param {Object} config Config object */ Ext.define('Ext.util.Filter', { /* Begin Definitions */ /* End Definitions */ - /** - * @cfg {String} property The property to filter on. Required unless a {@link #filter} is passed + /** + * @cfg {String} property The property to filter on. Required unless a {@link #filterFn} is passed */ - /** + /** * @cfg {Function} filterFn A custom filter function which is passed each item in the {@link Ext.util.MixedCollection} * in turn. Should return true to accept each item or false to reject it */ - /** + /** * @cfg {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false */ anyMatch: false, - /** + /** * @cfg {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. * Ignored if anyMatch is true. */ exactMatch: false, - /** + /** * @cfg {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false. */ caseSensitive: false, - /** + /** * @cfg {String} root Optional root property. This is mostly useful when filtering a Store, in which case we set the * root to 'data' to make the filter pull the {@link #property} out of the data object of each item */ - + + /** + * Creates new Filter. + * @param {Object} config (optional) Config object + */ constructor: function(config) { Ext.apply(this, config); @@ -92,7 +111,7 @@ Ext.define('Ext.util.Filter', { } }, - /** + /** * @private * Creates a filter function for the configured property/value/anyMatch/caseSensitive options for this Filter */ @@ -106,7 +125,7 @@ Ext.define('Ext.util.Filter', { }; }, - /** + /** * @private * Returns the root property of the given item, based on the configured {@link #root} property * @param {Object} item The item @@ -116,7 +135,7 @@ Ext.define('Ext.util.Filter', { return this.root == undefined ? item : item[this.root]; }, - /** + /** * @private * Returns a regular expression based on the given value and matching options */ @@ -144,4 +163,6 @@ Ext.define('Ext.util.Filter', { return value; } -});