Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.ComponentQuery.js
diff --git a/docs/output/Ext.ComponentQuery.js b/docs/output/Ext.ComponentQuery.js
new file mode 100644 (file)
index 0000000..328a388
--- /dev/null
@@ -0,0 +1,113 @@
+Ext.data.JsonP.Ext_ComponentQuery({
+  "tagname": "class",
+  "name": "Ext.ComponentQuery",
+  "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",
+  "extends": "Object",
+  "mixins": [
+
+  ],
+  "alternateClassNames": [
+
+  ],
+  "xtype": null,
+  "author": null,
+  "docauthor": null,
+  "singleton": true,
+  "private": false,
+  "cfg": [
+
+  ],
+  "method": [
+    {
+      "tagname": "method",
+      "name": "is",
+      "member": "Ext.ComponentQuery",
+      "doc": "<p>Tests whether the passed Component matches the selector string.</p>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "component",
+          "doc": "<p>The Component to test</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "selector",
+          "doc": "<p>The selector string to test against.</p>\n",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Boolean",
+        "doc": "<p>True if the Component matches the selector.</p>\n"
+      },
+      "private": false,
+      "static": false,
+      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
+      "linenr": 399,
+      "html_filename": "ComponentQuery.html",
+      "href": "ComponentQuery.html#Ext-ComponentQuery-method-is",
+      "shortDoc": "<p>Tests whether the passed Component matches the selector string.</p>\n"
+    },
+    {
+      "tagname": "method",
+      "name": "query",
+      "member": "Ext.ComponentQuery",
+      "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",
+      "params": [
+        {
+          "type": "Object",
+          "name": "selector",
+          "doc": "<p>The selector string to filter returned Components</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "root",
+          "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",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Array",
+        "doc": "<p>The matched Components.</p>\n"
+      },
+      "private": false,
+      "static": false,
+      "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
+      "linenr": 353,
+      "html_filename": "ComponentQuery.html",
+      "href": "ComponentQuery.html#Ext-ComponentQuery-method-query",
+      "shortDoc": "Returns an array of matched Components from within the passed root object.\n\n\nThis method filters returned Components ..."
+    }
+  ],
+  "property": [
+
+  ],
+  "event": [
+
+  ],
+  "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js",
+  "linenr": 1,
+  "html_filename": "ComponentQuery.html",
+  "href": "ComponentQuery.html#Ext-ComponentQuery",
+  "cssVar": [
+
+  ],
+  "cssMixin": [
+
+  ],
+  "component": false,
+  "superclasses": [
+
+  ],
+  "subclasses": [
+
+  ],
+  "mixedInto": [
+
+  ],
+  "allMixins": [
+
+  ]
+});
\ No newline at end of file