X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.ComponentManager.js diff --git a/docs/output/Ext.ComponentManager.js b/docs/output/Ext.ComponentManager.js index e09da619..4044559d 100644 --- a/docs/output/Ext.ComponentManager.js +++ b/docs/output/Ext.ComponentManager.js @@ -1,351 +1 @@ -Ext.data.JsonP.Ext_ComponentManager({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "ComponentManager.html#Ext-ComponentManager-method-create", - "shortDoc": "Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to in...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

A configuration object for the Component you wish to create.

\n", - "name": "config" - }, - { - "type": "Constructor", - "optional": false, - "doc": "

The constructor to provide the default Component type if\nthe config object does not contain a xtype. (Optional if the config contains a xtype).

\n", - "name": "defaultType" - } - ], - "name": "create", - "owner": "Ext.ComponentManager", - "doc": "

Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.

\n", - "linenr": 25, - "return": { - "type": "Ext.Component", - "doc": "

The newly instantiated Component.

\n" - }, - "html_filename": "ComponentManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-each", - "shortDoc": "Executes the specified function once for each item in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The function to execute.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": false, - "doc": "

The scope to execute in. Defaults to this.

\n", - "name": "scope" - } - ], - "name": "each", - "owner": "Ext.AbstractManager", - "doc": "

Executes the specified function once for each item in the collection.\nReturning false from the function will cease iteration.

\n\n

The paramaters passed to the function are:

\n\n
\n\n", - "linenr": 116, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-get", - "shortDoc": "Returns an item by id. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The id of the item

\n", - "name": "id" - } - ], - "name": "get", - "owner": "Ext.AbstractManager", - "doc": "

Returns an item by id.\nFor additional details see Ext.util.HashMap.get.

\n", - "linenr": 29, - "return": { - "type": "Mixed", - "doc": "

The item, undefined if not found.

\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-getCount", - "shortDoc": "Gets the number of items in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - - ], - "name": "getCount", - "owner": "Ext.AbstractManager", - "doc": "

Gets the number of items in the collection.

\n", - "linenr": 133, - "return": { - "type": "Number", - "doc": "

The number of items in the collection.

\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered", - "shortDoc": "Checks if an item type is registered. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The mnemonic string by which the class may be looked up

\n", - "name": "type" - } - ], - "name": "isRegistered", - "owner": "Ext.AbstractManager", - "doc": "

Checks if an item type is registered.

\n", - "linenr": 65, - "return": { - "type": "Boolean", - "doc": "

Whether the type is registered.

\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable", - "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The item id

\n", - "name": "id" - }, - { - "type": "Function", - "optional": false, - "doc": "

The callback function. Called with a single parameter, the item.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": false, - "doc": "

The scope (this reference) in which the callback is executed. Defaults to the item.

\n", - "name": "scope" - } - ], - "name": "onAvailable", - "owner": "Ext.AbstractManager", - "doc": "

Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.

\n", - "linenr": 93, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-register", - "shortDoc": "Registers an item to be managed ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The item to register

\n", - "name": "item" - } - ], - "name": "register", - "owner": "Ext.AbstractManager", - "doc": "

Registers an item to be managed

\n", - "linenr": 39, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-registerType", - "shortDoc": "Registers a new item constructor, keyed by a type key. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The mnemonic string by which the class may be looked up.

\n", - "name": "type" - }, - { - "type": "Constructor", - "optional": false, - "doc": "

The new instance class.

\n", - "name": "cls" - } - ], - "name": "registerType", - "owner": "Ext.AbstractManager", - "doc": "

Registers a new item constructor, keyed by a type key.\n\n", - "linenr": 55, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-unregister", - "shortDoc": "Unregisters an item by removing it from this manager ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The item to unregister

\n", - "name": "item" - } - ], - "name": "unregister", - "owner": "Ext.AbstractManager", - "doc": "

Unregisters an item by removing it from this manager

\n", - "linenr": 47, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractManager.html" - } - ], - "property": [ - { - "type": "Ext.util.MixedCollection", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractManager.html#Ext-AbstractManager-property-all", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "name": "all", - "owner": "Ext.AbstractManager", - "doc": "

Contains all of the items currently managed

\n", - "linenr": 19, - "html_filename": "AbstractManager.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": true, - "alias": null, - "superclasses": [ - "Ext.AbstractManager" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "ComponentManager.html#Ext-ComponentManager", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js", - "private": false, - "alternateClassNames": [ - "Ext.ComponentMgr" - ], - "name": "Ext.ComponentManager", - "doc": "

Provides a registry of all Components (instances of Ext.Component or any subclass\nthereof) on a page so that they can be easily accessed by component\nid (see get, or the convenience method Ext.getCmp).

\n\n\n

This object also provides a registry of available Component classes\nindexed by a mnemonic code known as the Component's xtype.\nThe xtype provides a way to avoid instantiating child Components\nwhen creating a full, nested config object for a complete Ext page.

\n\n\n

A child Component may be specified simply as a config object\nas long as the correct xtype is specified so that if and when the Component\nneeds rendering, the correct type can be looked up for lazy instantiation.

\n\n\n

For a list of all available xtypes, see Ext.Component.

\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "ComponentManager.html", - "extends": "Ext.AbstractManager" -}); \ No newline at end of file +Ext.data.JsonP.Ext_ComponentManager({"tagname":"class","html":"

Alternate names

Ext.ComponentMgr

Hierarchy

Ext.Base
Ext.AbstractManager
Ext.ComponentManager

Files

Provides a registry of all Components (instances of Ext.Component or any subclass\nthereof) on a page so that they can be easily accessed by component\nid (see get, or the convenience method Ext.getCmp).

\n\n\n

This object also provides a registry of available Component classes\nindexed by a mnemonic code known as the Component's xtype.\nThe xtype provides a way to avoid instantiating child Components\nwhen creating a full, nested config object for a complete Ext page.

\n\n\n

A child Component may be specified simply as a config object\nas long as the correct xtype is specified so that if and when the Component\nneeds rendering, the correct type can be looked up for lazy instantiation.

\n\n\n

For a list of all available xtypes, see Ext.Component.

\n\n
Defined By

Properties

 

Contains all of the items currently managed

\n

Contains all of the items currently managed

\n
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
Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to in...

Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.

\n

Parameters

  • config : Object

    A configuration object for the Component you wish to create.

    \n
  • defaultType : Function (optional)

    The constructor to provide the default Component type if\nthe config object does not contain a xtype. (Optional if the config contains a xtype).

    \n

Returns

Executes the specified function once for each item in the collection. ...

Executes the specified function once for each item in the collection.

\n

Parameters

  • fn : Function

    The function to execute.

    \n

    Parameters

    • key : String

      The key of the item

      \n
    • value : Number

      The value of the item

      \n
    • length : Number

      The total number of items in the collection

      \n

    Returns

  • scope : Object

    The scope to execute in. Defaults to this.

    \n
Returns an item by id. ...

Returns an item by id.\nFor additional details see Ext.util.HashMap.get.

\n

Parameters

  • id : String

    The id of the item

    \n

Returns

  • Object

    The item, undefined if not found.

    \n
Gets the number of items in the collection. ...

Gets the number of items in the collection.

\n

Returns

  • Number

    The number of items in the collection.

    \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
Checks if an item type is registered. ...

Checks if an item type is registered.

\n

Parameters

  • type : String

    The mnemonic string by which the class may be looked up

    \n

Returns

  • Boolean

    Whether the type is registered.

    \n
Registers a function that will be called when an item with the specified id is added to the manager. ...

Registers a function that will be called when an item with the specified id is added to the manager.\nThis will happen on instantiation.

\n

Parameters

  • id : String

    The item id

    \n
  • fn : Function

    The callback function. Called with a single parameter, the item.

    \n
  • scope : Object

    The scope (this reference) in which the callback is executed.\nDefaults to the item.

    \n
Registers an item to be managed ...

Registers an item to be managed

\n

Parameters

  • item : Object

    The item to register

    \n
Registers a new item constructor, keyed by a type key. ...

Registers a new item constructor, keyed by a type key.

\n

Parameters

  • type : String

    The mnemonic string by which the class may be looked up.

    \n
  • cls : Function

    The new instance class.

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

Unregisters an item by removing it from this manager ...

Unregisters an item by removing it from this manager

\n

Parameters

  • item : Object

    The item to unregister

    \n
","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.AbstractManager","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.AbstractManager","Ext.ComponentManager"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":null,"required":null,"protected":false,"name":"all","id":"property-all"},{"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.ComponentManager","template":false,"required":null,"protected":false,"name":"create","id":"method-create"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"each","id":"method-each"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"get","id":"method-get"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"getCount","id":"method-getCount"},{"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.AbstractManager","template":false,"required":null,"protected":false,"name":"isRegistered","id":"method-isRegistered"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"onAvailable","id":"method-onAvailable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"register","id":"method-register"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"registerType","id":"method-registerType"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractManager","template":false,"required":null,"protected":false,"name":"unregister","id":"method-unregister"}],"event":[]},"private":false,"component":false,"name":"Ext.ComponentManager","alternateClassNames":["Ext.ComponentMgr"],"id":"class-Ext.ComponentManager","mixedInto":[],"xtypes":{},"files":[{"href":"ComponentManager.html#Ext-ComponentManager","filename":"ComponentManager.js"}]}); \ No newline at end of file