docs/output/Ext.util.Filter.js

   1 Ext.data.JsonP.Ext_util_Filter({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "Boolean",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "Filter.html#Ext-util-Filter-cfg-anyMatch",
  16         "shortDoc": "True to allow any match - no regex start/end line anchors will be added. ...",
  17         "static": false,
  18         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
  19         "private": false,
  20         "name": "anyMatch",
  21         "owner": "Ext.util.Filter",
  22         "doc": "<p>True to allow any match - no regex start/end line anchors will be added. Defaults to false</p>\n",
  23         "linenr": 51,
  24         "html_filename": "Filter.html"
  25       },
  26       {
  27         "type": "Boolean",
  28         "deprecated": null,
  29         "alias": null,
  30         "protected": false,
  31         "tagname": "cfg",
  32         "href": "Filter.html#Ext-util-Filter-cfg-caseSensitive",
  33         "shortDoc": "True to make the regex case sensitive (adds 'i' switch to regex). ...",
  34         "static": false,
  35         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
  36         "private": false,
  37         "name": "caseSensitive",
  38         "owner": "Ext.util.Filter",
  39         "doc": "<p>True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.</p>\n",
  40         "linenr": 62,
  41         "html_filename": "Filter.html"
  42       },
  43       {
  44         "type": "Boolean",
  45         "deprecated": null,
  46         "alias": null,
  47         "protected": false,
  48         "tagname": "cfg",
  49         "href": "Filter.html#Ext-util-Filter-cfg-exactMatch",
  50         "shortDoc": "True to force exact match (^ and $ characters added to the regex). ...",
  51         "static": false,
  52         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
  53         "private": false,
  54         "name": "exactMatch",
  55         "owner": "Ext.util.Filter",
  56         "doc": "<p>True to force exact match (^ and $ characters added to the regex). Defaults to false.\nIgnored if anyMatch is true.</p>\n",
  57         "linenr": 56,
  58         "html_filename": "Filter.html"
  59       },
  60       {
  61         "type": "Function",
  62         "deprecated": null,
  63         "alias": null,
  64         "protected": false,
  65         "tagname": "cfg",
  66         "href": "Filter.html#Ext-util-Filter-cfg-filterFn",
  67         "shortDoc": "A custom filter function which is passed each item in the Ext.util.MixedCollection\nin turn. ...",
  68         "static": false,
  69         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
  70         "private": false,
  71         "name": "filterFn",
  72         "owner": "Ext.util.Filter",
  73         "doc": "<p>A custom filter function which is passed each item in the <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">Ext.util.MixedCollection</a>\nin turn. Should return true to accept each item or false to reject it</p>\n",
  74         "linenr": 46,
  75         "html_filename": "Filter.html"
  76       },
  77       {
  78         "type": "String",
  79         "deprecated": null,
  80         "alias": null,
  81         "protected": false,
  82         "tagname": "cfg",
  83         "href": "Filter.html#Ext-util-Filter-cfg-property",
  84         "shortDoc": "The property to filter on. ...",
  85         "static": false,
  86         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
  87         "private": false,
  88         "name": "property",
  89         "owner": "Ext.util.Filter",
  90         "doc": "<p>The property to filter on. Required unless a <a href=\"#/api/Ext.util.Filter-cfg-filterFn\" rel=\"Ext.util.Filter-cfg-filterFn\" class=\"docClass\">filterFn</a> is passed</p>\n",
  91         "linenr": 42,
  92         "html_filename": "Filter.html"
  93       },
  94       {
  95         "type": "String",
  96         "deprecated": null,
  97         "alias": null,
  98         "protected": false,
  99         "tagname": "cfg",
 100         "href": "Filter.html#Ext-util-Filter-cfg-root",
 101         "shortDoc": "Optional root property. ...",
 102         "static": false,
 103         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
 104         "private": false,
 105         "name": "root",
 106         "owner": "Ext.util.Filter",
 107         "doc": "<p>Optional root property. This is mostly useful when filtering a Store, in which case we set the\nroot to 'data' to make the filter pull the <a href=\"#/api/Ext.util.Filter-cfg-property\" rel=\"Ext.util.Filter-cfg-property\" class=\"docClass\">property</a> out of the data object of each item</p>\n",
 108         "linenr": 67,
 109         "html_filename": "Filter.html"
 110       }
 111     ],
 112     "method": [
 113       {
 114         "deprecated": null,
 115         "alias": null,
 116         "href": "Filter.html#Ext-util-Filter-method-constructor",
 117         "tagname": "method",
 118         "protected": false,
 119         "shortDoc": "Creates new Filter. ...",
 120         "static": false,
 121         "params": [
 122           {
 123             "type": "Object",
 124             "optional": true,
 125             "doc": "<p>(optional) Config object</p>\n",
 126             "name": "config"
 127           }
 128         ],
 129         "private": false,
 130         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
 131         "doc": "<p>Creates new Filter.</p>\n",
 132         "owner": "Ext.util.Filter",
 133         "name": "Filter",
 134         "html_filename": "Filter.html",
 135         "return": {
 136           "type": "Object",
 137           "doc": "\n"
 138         },
 139         "linenr": 72
 140       }
 141     ],
 142     "property": [
 143
 144     ],
 145     "cssVar": [
 146
 147     ],
 148     "cssMixin": [
 149
 150     ],
 151     "event": [
 152
 153     ]
 154   },
 155   "singleton": false,
 156   "alias": null,
 157   "superclasses": [
 158
 159   ],
 160   "protected": false,
 161   "tagname": "class",
 162   "mixins": [
 163
 164   ],
 165   "href": "Filter.html#Ext-util-Filter",
 166   "subclasses": [
 167
 168   ],
 169   "static": false,
 170   "author": null,
 171   "component": false,
 172   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Filter.js",
 173   "private": false,
 174   "alternateClassNames": [
 175
 176   ],
 177   "name": "Ext.util.Filter",
 178   "doc": "<p>Represents a filter that can be applied to a <a href=\"#/api/Ext.util.MixedCollection\" rel=\"Ext.util.MixedCollection\" class=\"docClass\">MixedCollection</a>. Can either simply\nfilter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context\nof MixedCollections, though <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Store</a>s frequently create them when filtering and searching on their\nrecords. Example usage:</p>\n\n\n<pre><code>//set up a fictional MixedCollection containing a few people to filter on\nvar allNames = new Ext.util.MixedCollection();\nallNames.addAll([\n    {id: 1, name: 'Ed',    age: 25},\n    {id: 2, name: 'Jamie', age: 37},\n    {id: 3, name: 'Abe',   age: 32},\n    {id: 4, name: 'Aaron', age: 26},\n    {id: 5, name: 'David', age: 32}\n]);\n\nvar ageFilter = new Ext.util.Filter({\n    property: 'age',\n    value   : 32\n});\n\nvar longNameFilter = new Ext.util.Filter({\n    filterFn: function(item) {\n        return item.name.length > 4;\n    }\n});\n\n//a new MixedCollection with the 3 names longer than 4 characters\nvar longNames = allNames.filter(longNameFilter);\n\n//a new MixedCollection with the 2 people of age 24:\nvar youngFolk = allNames.filter(ageFilter);\n</code></pre>\n\n",
 179   "mixedInto": [
 180
 181   ],
 182   "linenr": 1,
 183   "xtypes": [
 184
 185   ],
 186   "html_filename": "Filter.html",
 187   "extends": "Object"
 188 });