docs/output/Ext.ComponentManager.js

   1 Ext.data.JsonP.Ext_ComponentManager({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "protected": false,
  16         "tagname": "method",
  17         "href": "ComponentManager.html#Ext-ComponentManager-method-create",
  18         "shortDoc": "Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to in...",
  19         "static": false,
  20         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js",
  21         "private": false,
  22         "params": [
  23           {
  24             "type": "Object",
  25             "optional": false,
  26             "doc": "<p>A configuration object for the Component you wish to create.</p>\n",
  27             "name": "config"
  28           },
  29           {
  30             "type": "Constructor",
  31             "optional": false,
  32             "doc": "<p>The constructor to provide the default Component type if\nthe config object does not contain a <code>xtype</code>. (Optional if the config contains a <code>xtype</code>).</p>\n",
  33             "name": "defaultType"
  34           }
  35         ],
  36         "name": "create",
  37         "owner": "Ext.ComponentManager",
  38         "doc": "<p>Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.</p>\n",
  39         "linenr": 25,
  40         "return": {
  41           "type": "Ext.Component",
  42           "doc": "<p>The newly instantiated Component.</p>\n"
  43         },
  44         "html_filename": "ComponentManager.html"
  45       },
  46       {
  47         "deprecated": null,
  48         "alias": null,
  49         "protected": false,
  50         "tagname": "method",
  51         "href": "AbstractManager.html#Ext-AbstractManager-method-each",
  52         "shortDoc": "Executes the specified function once for each item in the collection. ...",
  53         "static": false,
  54         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
  55         "private": false,
  56         "params": [
  57           {
  58             "type": "Object",
  59             "optional": false,
  60             "doc": "<p>The function to execute.</p>\n",
  61             "name": "fn"
  62           },
  63           {
  64             "type": "Object",
  65             "optional": false,
  66             "doc": "<p>The scope to execute in. Defaults to <tt>this</tt>.</p>\n",
  67             "name": "scope"
  68           }
  69         ],
  70         "name": "each",
  71         "owner": "Ext.AbstractManager",
  72         "doc": "<p>Executes the specified function once for each item in the collection.\nReturning false from the function will cease iteration.</p>\n\n<p>The paramaters passed to the function are:</p>\n\n<div class=\"mdetail-params\"><ul>\n<li><b>key</b> : String<p class=\"sub-desc\">The key of the item</p></li>\n<li><b>value</b> : Number<p class=\"sub-desc\">The value of the item</p></li>\n<li><b>length</b> : Number<p class=\"sub-desc\">The total number of items in the collection</p></li>\n</ul></div>\n\n",
  73         "linenr": 116,
  74         "return": {
  75           "type": "void",
  76           "doc": "\n"
  77         },
  78         "html_filename": "AbstractManager.html"
  79       },
  80       {
  81         "deprecated": null,
  82         "alias": null,
  83         "protected": false,
  84         "tagname": "method",
  85         "href": "AbstractManager.html#Ext-AbstractManager-method-get",
  86         "shortDoc": "Returns an item by id. ...",
  87         "static": false,
  88         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
  89         "private": false,
  90         "params": [
  91           {
  92             "type": "String",
  93             "optional": false,
  94             "doc": "<p>The id of the item</p>\n",
  95             "name": "id"
  96           }
  97         ],
  98         "name": "get",
  99         "owner": "Ext.AbstractManager",
 100         "doc": "<p>Returns an item by id.\nFor additional details see <a href=\"#/api/Ext.util.HashMap-method-get\" rel=\"Ext.util.HashMap-method-get\" class=\"docClass\">Ext.util.HashMap.get</a>.</p>\n",
 101         "linenr": 29,
 102         "return": {
 103           "type": "Mixed",
 104           "doc": "<p>The item, <code>undefined</code> if not found.</p>\n"
 105         },
 106         "html_filename": "AbstractManager.html"
 107       },
 108       {
 109         "deprecated": null,
 110         "alias": null,
 111         "protected": false,
 112         "tagname": "method",
 113         "href": "AbstractManager.html#Ext-AbstractManager-method-getCount",
 114         "shortDoc": "Gets the number of items in the collection. ...",
 115         "static": false,
 116         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 117         "private": false,
 118         "params": [
 119
 120         ],
 121         "name": "getCount",
 122         "owner": "Ext.AbstractManager",
 123         "doc": "<p>Gets the number of items in the collection.</p>\n",
 124         "linenr": 133,
 125         "return": {
 126           "type": "Number",
 127           "doc": "<p>The number of items in the collection.</p>\n"
 128         },
 129         "html_filename": "AbstractManager.html"
 130       },
 131       {
 132         "deprecated": null,
 133         "alias": null,
 134         "protected": false,
 135         "tagname": "method",
 136         "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered",
 137         "shortDoc": "Checks if an item type is registered. ...",
 138         "static": false,
 139         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 140         "private": false,
 141         "params": [
 142           {
 143             "type": "String",
 144             "optional": false,
 145             "doc": "<p>The mnemonic string by which the class may be looked up</p>\n",
 146             "name": "type"
 147           }
 148         ],
 149         "name": "isRegistered",
 150         "owner": "Ext.AbstractManager",
 151         "doc": "<p>Checks if an item type is registered.</p>\n",
 152         "linenr": 65,
 153         "return": {
 154           "type": "Boolean",
 155           "doc": "<p>Whether the type is registered.</p>\n"
 156         },
 157         "html_filename": "AbstractManager.html"
 158       },
 159       {
 160         "deprecated": null,
 161         "alias": null,
 162         "protected": false,
 163         "tagname": "method",
 164         "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable",
 165         "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. ...",
 166         "static": false,
 167         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 168         "private": false,
 169         "params": [
 170           {
 171             "type": "String",
 172             "optional": false,
 173             "doc": "<p>The item id</p>\n",
 174             "name": "id"
 175           },
 176           {
 177             "type": "Function",
 178             "optional": false,
 179             "doc": "<p>The callback function. Called with a single parameter, the item.</p>\n",
 180             "name": "fn"
 181           },
 182           {
 183             "type": "Object",
 184             "optional": false,
 185             "doc": "<p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>\n",
 186             "name": "scope"
 187           }
 188         ],
 189         "name": "onAvailable",
 190         "owner": "Ext.AbstractManager",
 191         "doc": "<p>Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.</p>\n",
 192         "linenr": 93,
 193         "return": {
 194           "type": "void",
 195           "doc": "\n"
 196         },
 197         "html_filename": "AbstractManager.html"
 198       },
 199       {
 200         "deprecated": null,
 201         "alias": null,
 202         "protected": false,
 203         "tagname": "method",
 204         "href": "AbstractManager.html#Ext-AbstractManager-method-register",
 205         "shortDoc": "Registers an item to be managed ...",
 206         "static": false,
 207         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 208         "private": false,
 209         "params": [
 210           {
 211             "type": "Mixed",
 212             "optional": false,
 213             "doc": "<p>The item to register</p>\n",
 214             "name": "item"
 215           }
 216         ],
 217         "name": "register",
 218         "owner": "Ext.AbstractManager",
 219         "doc": "<p>Registers an item to be managed</p>\n",
 220         "linenr": 39,
 221         "return": {
 222           "type": "void",
 223           "doc": "\n"
 224         },
 225         "html_filename": "AbstractManager.html"
 226       },
 227       {
 228         "deprecated": null,
 229         "alias": null,
 230         "protected": false,
 231         "tagname": "method",
 232         "href": "AbstractManager.html#Ext-AbstractManager-method-registerType",
 233         "shortDoc": "Registers a new item constructor, keyed by a type key. ...",
 234         "static": false,
 235         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 236         "private": false,
 237         "params": [
 238           {
 239             "type": "String",
 240             "optional": false,
 241             "doc": "<p>The mnemonic string by which the class may be looked up.</p>\n",
 242             "name": "type"
 243           },
 244           {
 245             "type": "Constructor",
 246             "optional": false,
 247             "doc": "<p>The new instance class.</p>\n",
 248             "name": "cls"
 249           }
 250         ],
 251         "name": "registerType",
 252         "owner": "Ext.AbstractManager",
 253         "doc": "<p>Registers a new item constructor, keyed by a type key.\n\n",
 254         "linenr": 55,
 255         "return": {
 256           "type": "void",
 257           "doc": "\n"
 258         },
 259         "html_filename": "AbstractManager.html"
 260       },
 261       {
 262         "deprecated": null,
 263         "alias": null,
 264         "protected": false,
 265         "tagname": "method",
 266         "href": "AbstractManager.html#Ext-AbstractManager-method-unregister",
 267         "shortDoc": "Unregisters an item by removing it from this manager ...",
 268         "static": false,
 269         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 270         "private": false,
 271         "params": [
 272           {
 273             "type": "Mixed",
 274             "optional": false,
 275             "doc": "<p>The item to unregister</p>\n",
 276             "name": "item"
 277           }
 278         ],
 279         "name": "unregister",
 280         "owner": "Ext.AbstractManager",
 281         "doc": "<p>Unregisters an item by removing it from this manager</p>\n",
 282         "linenr": 47,
 283         "return": {
 284           "type": "void",
 285           "doc": "\n"
 286         },
 287         "html_filename": "AbstractManager.html"
 288       }
 289     ],
 290     "property": [
 291       {
 292         "type": "Ext.util.MixedCollection",
 293         "deprecated": null,
 294         "alias": null,
 295         "protected": false,
 296         "tagname": "property",
 297         "href": "AbstractManager.html#Ext-AbstractManager-property-all",
 298         "static": false,
 299         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 300         "private": false,
 301         "name": "all",
 302         "owner": "Ext.AbstractManager",
 303         "doc": "<p>Contains all of the items currently managed</p>\n",
 304         "linenr": 19,
 305         "html_filename": "AbstractManager.html"
 306       }
 307     ],
 308     "cssVar": [
 309
 310     ],
 311     "cssMixin": [
 312
 313     ],
 314     "event": [
 315
 316     ]
 317   },
 318   "singleton": true,
 319   "alias": null,
 320   "superclasses": [
 321     "Ext.AbstractManager"
 322   ],
 323   "protected": false,
 324   "tagname": "class",
 325   "mixins": [
 326
 327   ],
 328   "href": "ComponentManager.html#Ext-ComponentManager",
 329   "subclasses": [
 330
 331   ],
 332   "static": false,
 333   "author": null,
 334   "component": false,
 335   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js",
 336   "private": false,
 337   "alternateClassNames": [
 338     "Ext.ComponentMgr"
 339   ],
 340   "name": "Ext.ComponentManager",
 341   "doc": "<p>Provides a registry of all Components (instances of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> or any subclass\nthereof) on a page so that they can be easily accessed by <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">component</a>\n<a href=\"#/api/Ext.Component-cfg-id\" rel=\"Ext.Component-cfg-id\" class=\"docClass\">id</a> (see <a href=\"#/api/Ext.ComponentManager-method-get\" rel=\"Ext.ComponentManager-method-get\" class=\"docClass\">get</a>, or the convenience method <a href=\"#/api/Ext-method-getCmp\" rel=\"Ext-method-getCmp\" class=\"docClass\">Ext.getCmp</a>).</p>\n\n\n<p>This object also provides a registry of available Component <i>classes</i>\nindexed by a mnemonic code known as the Component's xtype.\nThe <code>xtype</code> provides a way to avoid instantiating child Components\nwhen creating a full, nested config object for a complete <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> page.</p>\n\n\n<p>A child Component may be specified simply as a <i>config object</i>\nas long as the correct <code>xtype</code> is specified so that if and when the Component\nneeds rendering, the correct type can be looked up for lazy instantiation.</p>\n\n\n<p>For a list of all available <code>xtypes</code>, see <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a>.</p>\n\n",
 342   "mixedInto": [
 343
 344   ],
 345   "linenr": 1,
 346   "xtypes": [
 347
 348   ],
 349   "html_filename": "ComponentManager.html",
 350   "extends": "Ext.AbstractManager"
 351 });