Provides searching of Components within Ext.ComponentManager (globally) or a specific\nExt.container.Container on the document with a similar syntax to a CSS selector.
\n\nComponents can be retrieved by using their xtype with an optional . prefix
\n\nAn itemId or id must be prefixed with a #
\n\nAttributes must be wrapped in brackets
\n\nMember expressions from candidate Components may be tested. If the expression returns a truthy value,\nthe candidate Component will be included in the query:
\n\nvar disabledFields = myFormPanel.query(\"{isDisabled()}\");\nPseudo classes may be used to filter results in the same way as in DomQuery:
// 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\n\n\n\n\n\nDefault pseudos include:
\n- not\n
Queries return an array of components.\nHere are some example queries.
\n\n // 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');\nFor easy access to queries based from a particular Container see the Ext.container.Container.query,\nExt.container.Container.down and Ext.container.Container.child methods. Also see\nExt.Component.up.
\n", - "extends": "Object", - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ + "members": { + "cfg": [ - ], - "method": [ - { - "tagname": "method", - "name": "is", - "member": "Ext.ComponentQuery", - "doc": "Tests whether the passed Component matches the selector string.
\n", - "params": [ - { - "type": "Object", - "name": "component", - "doc": "The Component to test
\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ComponentQuery.html#Ext-ComponentQuery-method-is", + "shortDoc": "Tests whether the passed Component matches the selector string. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentQuery.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "The Component to test
\n", + "name": "component" + }, + { + "type": "String", + "optional": false, + "doc": "The selector string to test against.
\n", + "name": "selector" + } + ], + "name": "is", + "owner": "Ext.ComponentQuery", + "doc": "Tests whether the passed Component matches the selector string.
\n", + "linenr": 399, + "return": { + "type": "Boolean", + "doc": "True if the Component matches the selector.
\n" }, - { - "type": "Object", - "name": "selector", - "doc": "The selector string to test against.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the Component matches the selector.
\n" + "html_filename": "ComponentQuery.html" }, - "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": "Tests whether the passed Component matches the selector string.
\n" - }, - { - "tagname": "method", - "name": "query", - "member": "Ext.ComponentQuery", - "doc": "Returns an array of matched Components from within the passed root object.
\n\n\nThis method filters returned Components in a similar way to how CSS selector based DOM\nqueries work using a textual selector string.
\n\n\nSee class summary for details.
\n\n", - "params": [ - { - "type": "Object", - "name": "selector", - "doc": "The selector string to filter returned Components
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ComponentQuery.html#Ext-ComponentQuery-method-query", + "shortDoc": "Returns an array of matched Components from within the passed root object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector string to filter returned Components
\n", + "name": "selector" + }, + { + "type": "Ext.container.Container", + "optional": false, + "doc": "The Container within which to perform the query.\nIf omitted, all Components within the document are included in the search.
\n\nThis parameter may also be an array of Components to filter according to the selector.
\n", + "name": "root" + } + ], + "name": "query", + "owner": "Ext.ComponentQuery", + "doc": "Returns an array of matched Components from within the passed root object.
\n\nThis method filters returned Components in a similar way to how CSS selector based DOM\nqueries work using a textual selector string.
\n\nSee class summary for details.
\n", + "linenr": 348, + "return": { + "type": "[Ext.Component]", + "doc": "The matched Components.
\n" }, - { - "type": "Object", - "name": "root", - "doc": "The Container within which to perform the query. If omitted, all Components\nwithin the document are included in the search.
\n\n\nThis parameter may also be an array of Components to filter according to the selector.
\n\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "The matched Components.
\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": [ + "html_filename": "ComponentQuery.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentQuery.js", - "linenr": 1, - "html_filename": "ComponentQuery.html", - "href": "ComponentQuery.html#Ext-ComponentQuery", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": true, + "alias": null, "superclasses": [ ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "ComponentQuery.html#Ext-ComponentQuery", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentQuery.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.ComponentQuery", + "doc": "Provides searching of Components within Ext.ComponentManager (globally) or a specific\nExt.container.Container on the document with a similar syntax to a CSS selector.
\n\nComponents can be retrieved by using their xtype with an optional . prefix
\n\ncomponent or .componentgridpanel or .gridpanelAn itemId or id must be prefixed with a #
\n\n#myContainerAttributes must be wrapped in brackets
\n\ncomponent[autoScroll]panel[title=\"Test\"]Member expressions from candidate Components may be tested. If the expression returns a truthy value,\nthe candidate Component will be included in the query:
\n\nvar disabledFields = myFormPanel.query(\"{isDisabled()}\");\nPseudo classes may be used to filter results in the same way as in DomQuery:
\n\n// 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}\nDefault pseudos include:
\n\nQueries return an array of components.\nHere are some example queries.
\n\n// retrieve all Ext.Panels in the document by xtype\nvar panelsArray = Ext.ComponentQuery.query('panel');\n\n// retrieve all Ext.Panels within the container with an id myCt\nvar panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');\n\n// retrieve all direct children which are Ext.Panels within myCt\nvar directChildPanel = Ext.ComponentQuery.query('#myCt > panel');\n\n// retrieve all grids and trees\nvar gridsAndTrees = Ext.ComponentQuery.query('gridpanel, treepanel');\nFor easy access to queries based from a particular Container see the Ext.container.Container.query,\nExt.container.Container.down and Ext.container.Container.child methods. Also see\nExt.Component.up.
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "ComponentQuery.html", + "extends": "Object" }); \ No newline at end of file