X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.ComponentQuery.js?ds=sidebyside diff --git a/docs/output/Ext.ComponentQuery.js b/docs/output/Ext.ComponentQuery.js new file mode 100644 index 00000000..328a3887 --- /dev/null +++ b/docs/output/Ext.ComponentQuery.js @@ -0,0 +1,113 @@ +Ext.data.JsonP.Ext_ComponentQuery({ + "tagname": "class", + "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\n

Components can be retrieved by using their xtype with an optional . prefix

\n\n\n\n\n

An itemId or id must be prefixed with a #

\n\n\n\n\n

Attributes must be wrapped in brackets

\n\n\n\n\n

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\n
var disabledFields = myFormPanel.query(\"{isDisabled()}\");\n
\n\n\n

Pseudo 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}\n
\n\n\n

\n\n

\nDefault pseudos include:
\n- not\n

\n\n\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');\n
\n\n\n

For 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": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": true, + "private": false, + "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 + }, + { + "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" + }, + "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\n

This method filters returned Components in a similar way to how CSS selector based DOM\nqueries work using a textual selector string.

\n\n\n

See class summary for details.

\n\n", + "params": [ + { + "type": "Object", + "name": "selector", + "doc": "

The selector string to filter returned Components

\n", + "optional": false + }, + { + "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\n

This 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": [ + + ], + "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