X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.ComponentQuery.js?ds=sidebyside diff --git a/docs/output/Ext.ComponentQuery.js b/docs/output/Ext.ComponentQuery.js index 328a3887..824fccc0 100644 --- a/docs/output/Ext.ComponentQuery.js +++ b/docs/output/Ext.ComponentQuery.js @@ -1,113 +1 @@ -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\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()}\");\n
\n\n\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');\n
\n\n\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": [ - - ], - "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\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 - }, - { - "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": [ - - ], - "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 +Ext.data.JsonP.Ext_ComponentQuery({"tagname":"class","html":"Hierarchy
Ext.BaseExt.ComponentQueryUses
Files
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 .component
gridpanel
or .gridpanel
An itemId or id must be prefixed with a #
\n\n#myContainer
Attributes 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()}\");\n
\n\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}\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');\n
\n\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.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nTests whether the passed Component matches the selector string.
\nThe Component to test
\nThe selector string to test against.
\nTrue if the Component matches the selector.
\nReturns 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.
\nThe selector string to filter returned Components
\nThe 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.
\nThe matched Components.
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\n