X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.ComponentQuery.js diff --git a/docs/output/Ext.ComponentQuery.js b/docs/output/Ext.ComponentQuery.js index 90a7d114..824fccc0 100644 --- a/docs/output/Ext.ComponentQuery.js +++ b/docs/output/Ext.ComponentQuery.js @@ -1,127 +1 @@ -Ext.data.JsonP.Ext_ComponentQuery({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "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" - }, - "html_filename": "ComponentQuery.html" - }, - { - "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\n

This 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\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

See class summary for details.

\n", - "linenr": 348, - "return": { - "type": "[Ext.Component]", - "doc": "

The matched Components.

\n" - }, - "html_filename": "ComponentQuery.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "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\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

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

Default pseudos include:

\n\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\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\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", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "ComponentQuery.html", - "extends": "Object" -}); \ No newline at end of file +Ext.data.JsonP.Ext_ComponentQuery({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.ComponentQuery

Uses

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\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

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

Default pseudos include:

\n\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\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\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
Defined By

Properties

Get the reference to the current class from which this object was instantiated. ...

Get 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

\n\n
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
\n
Defined By

Methods

( Array/Arguments args ) : Objectprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
Ext.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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result from the superclass' method

    \n
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.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
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Tests whether the passed Component matches the selector string. ...

Tests whether the passed Component matches the selector string.

\n

Parameters

  • component : Ext.Component

    The Component to test

    \n
  • selector : String

    The selector string to test against.

    \n

Returns

  • Boolean

    True if the Component matches the selector.

    \n
Returns an array of matched Components from within the passed root object. ...

Returns an array of matched Components from within the passed root object.

\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

See class summary for details.

\n

Parameters

  • selector : String

    The selector string to filter returned Components

    \n
  • root : Ext.container.Container

    The Container within which to perform the query.\nIf omitted, all Components within the document are included in the search.

    \n\n

    This parameter may also be an array of Components to filter according to the selector.

    \n

Returns

Get the reference to the class from which this object was instantiated. ...

Get 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

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

Returns

","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.ComponentQuery"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":["Ext.ComponentManager"],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.ComponentQuery","template":false,"required":null,"protected":false,"name":"is","id":"method-is"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.ComponentQuery","template":false,"required":null,"protected":false,"name":"query","id":"method-query"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[]},"private":false,"component":false,"name":"Ext.ComponentQuery","alternateClassNames":[],"id":"class-Ext.ComponentQuery","mixedInto":[],"xtypes":{},"files":[{"href":"ComponentQuery.html#Ext-ComponentQuery","filename":"ComponentQuery.js"}]}); \ No newline at end of file