docs/output/Ext.ComponentQuery.js

   1 Ext.data.JsonP.Ext_ComponentQuery({
   2   "tagname": "class",
   3   "name": "Ext.ComponentQuery",
   4   "doc": "<p>Provides searching of Components within <a href=\"#/api/Ext.ComponentManager\" rel=\"Ext.ComponentManager\" class=\"docClass\">Ext.ComponentManager</a> (globally) or a specific\n<a href=\"#/api/Ext.container.Container\" rel=\"Ext.container.Container\" class=\"docClass\">Ext.container.Container</a> on the document with a similar syntax to a CSS selector.</p>\n\n<p>Components can be retrieved by using their <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">xtype</a> with an optional . prefix</p>\n\n<ul>\n    <li>component or .component</li>\n    <li>gridpanel or .gridpanel</li>\n</ul>\n\n\n<p>An itemId or id must be prefixed with a #</p>\n\n<ul>\n    <li>#myContainer</li>\n</ul>\n\n\n<p>Attributes must be wrapped in brackets</p>\n\n<ul>\n    <li>component[autoScroll]</li>\n    <li>panel[title=\"Test\"]</li>\n</ul>\n\n\n<p>Member expressions from candidate Components may be tested. If the expression returns a <i>truthy</i> value,\nthe candidate Component will be included in the query:</p>\n\n<pre><code>var disabledFields = myFormPanel.query(\"{isDisabled()}\");\n</code></pre>\n\n\n<p>Pseudo classes may be used to filter results in the same way as in <a href=\"#/api/Ext.DomQuery\" rel=\"Ext.DomQuery\" class=\"docClass\">DomQuery</a>:<code></p>\n\n<pre>// Function receives array and returns a filtered array.\nExt.ComponentQuery.pseudos.invalid = function(items) {\n    var i = 0, l = items.length, c, result = [];\n    for (; i < l; i++) {\n        if (!(c = items[i]).isValid()) {\n            result.push(c);\n        }\n    }\n    return result;\n};\n\nvar invalidFields = myFormPanel.query('field:invalid');\nif (invalidFields.length) {\n    invalidFields[0].getEl().scrollIntoView(myFormPanel.body);\n    for (var i = 0, l = invalidFields.length; i < l; i++) {\n        invalidFields[i].getEl().frame(\"red\");\n    }\n}\n</pre>\n\n\n<p></code></p>\n\n<p>\nDefault pseudos include:<br />\n- not\n</p>\n\n\n<p>Queries return an array of components.\nHere are some example queries.</p>\n\n<pre><code>    // retrieve all Ext.Panels in the document by xtype\n    var panelsArray = Ext.ComponentQuery.query('panel');\n\n    // retrieve all Ext.Panels within the container with an id myCt\n    var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');\n\n    // retrieve all direct children which are Ext.Panels within myCt\n    var directChildPanel = Ext.ComponentQuery.query('#myCt > panel');\n\n    // retrieve all gridpanels and listviews\n    var gridsAndLists = Ext.ComponentQuery.query('gridpanel, listview');\n</code></pre>\n\n\n<p>For easy access to queries based from a particular Container see the <a href=\"#/api/Ext.container.Container-method-query\" rel=\"Ext.container.Container-method-query\" class=\"docClass\">Ext.container.Container.query</a>,\n<a href=\"#/api/Ext.container.Container-method-down\" rel=\"Ext.container.Container-method-down\" class=\"docClass\">Ext.container.Container.down</a> and <a href=\"#/api/Ext.container.Container-method-child\" rel=\"Ext.container.Container-method-child\" class=\"docClass\">Ext.container.Container.child</a> methods. Also see\n<a href=\"#/api/Ext.Component-method-up\" rel=\"Ext.Component-method-up\" class=\"docClass\">Ext.Component.up</a>.</p>\n",
   5   "extends": "Object",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "is",
  24       "member": "Ext.ComponentQuery",
  25       "doc": "<p>Tests whether the passed Component matches the selector string.</p>\n",
  26       "params": [
  27         {
  28           "type": "Object",
  29           "name": "component",
  30           "doc": "<p>The Component to test</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "Object",
  35           "name": "selector",
  36           "doc": "<p>The selector string to test against.</p>\n",
  37           "optional": false
  38         }
  39       ],
  40       "return": {
  41         "type": "Boolean",
  42         "doc": "<p>True if the Component matches the selector.</p>\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
  47       "linenr": 399,
  48       "html_filename": "ComponentQuery.html",
  49       "href": "ComponentQuery.html#Ext-ComponentQuery-method-is",
  50       "shortDoc": "<p>Tests whether the passed Component matches the selector string.</p>\n"
  51     },
  52     {
  53       "tagname": "method",
  54       "name": "query",
  55       "member": "Ext.ComponentQuery",
  56       "doc": "<p>Returns an array of matched Components from within the passed root object.</p>\n\n\n<p>This method filters returned Components in a similar way to how CSS selector based DOM\nqueries work using a textual selector string.</p>\n\n\n<p>See class summary for details.</p>\n\n",
  57       "params": [
  58         {
  59           "type": "Object",
  60           "name": "selector",
  61           "doc": "<p>The selector string to filter returned Components</p>\n",
  62           "optional": false
  63         },
  64         {
  65           "type": "Object",
  66           "name": "root",
  67           "doc": "<p>The Container within which to perform the query. If omitted, all Components\nwithin the document are included in the search.</p>\n\n\n<p>This parameter may also be an array of Components to filter according to the selector.</p>\n\n",
  68           "optional": false
  69         }
  70       ],
  71       "return": {
  72         "type": "Array",
  73         "doc": "<p>The matched Components.</p>\n"
  74       },
  75       "private": false,
  76       "static": false,
  77       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
  78       "linenr": 353,
  79       "html_filename": "ComponentQuery.html",
  80       "href": "ComponentQuery.html#Ext-ComponentQuery-method-query",
  81       "shortDoc": "Returns an array of matched Components from within the passed root object.\n\n\nThis method filters returned Components ..."
  82     }
  83   ],
  84   "property": [
  85
  86   ],
  87   "event": [
  88
  89   ],
  90   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
  91   "linenr": 1,
  92   "html_filename": "ComponentQuery.html",
  93   "href": "ComponentQuery.html#Ext-ComponentQuery",
  94   "cssVar": [
  95
  96   ],
  97   "cssMixin": [
  98
  99   ],
 100   "component": false,
 101   "superclasses": [
 102
 103   ],
 104   "subclasses": [
 105
 106   ],
 107   "mixedInto": [
 108
 109   ],
 110   "allMixins": [
 111
 112   ]
 113 });