docs/output/Ext.AbstractManager.js

   1 Ext.data.JsonP.Ext_AbstractManager({
   2   "tagname": "class",
   3   "name": "Ext.AbstractManager",
   4   "doc": "<p>Base Manager class</p>\n",
   5   "extends": "Object",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": true,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "create",
  24       "member": "Ext.AbstractManager",
  25       "doc": "<p>Creates and returns an instance of whatever this manager manages, based on the supplied type and config object</p>\n",
  26       "params": [
  27         {
  28           "type": "Object",
  29           "name": "config",
  30           "doc": "<p>The config object</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "String",
  35           "name": "defaultType",
  36           "doc": "<p>If no type is discovered in the config object, we fall back to this type</p>\n",
  37           "optional": false
  38         }
  39       ],
  40       "return": {
  41         "type": "Mixed",
  42         "doc": "<p>The instance of whatever this manager is managing</p>\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
  47       "linenr": 76,
  48       "html_filename": "AbstractManager.html",
  49       "href": "AbstractManager.html#Ext-AbstractManager-method-create",
  50       "shortDoc": "<p>Creates and returns an instance of whatever this manager manages, based on the supplied type and config object</p>\n"
  51     },
  52     {
  53       "tagname": "method",
  54       "name": "each",
  55       "member": "Ext.AbstractManager",
  56       "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",
  57       "params": [
  58         {
  59           "type": "Object",
  60           "name": "fn",
  61           "doc": "<p>The function to execute.</p>\n",
  62           "optional": false
  63         },
  64         {
  65           "type": "Object",
  66           "name": "scope",
  67           "doc": "<p>The scope to execute in. Defaults to <tt>this</tt>.</p>\n",
  68           "optional": false
  69         }
  70       ],
  71       "return": {
  72         "type": "void",
  73         "doc": "\n"
  74       },
  75       "private": false,
  76       "static": false,
  77       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
  78       "linenr": 118,
  79       "html_filename": "AbstractManager.html",
  80       "href": "AbstractManager.html#Ext-AbstractManager-method-each",
  81       "shortDoc": "Executes the specified function once for each item in the collection.\nReturning false from the function will cease it..."
  82     },
  83     {
  84       "tagname": "method",
  85       "name": "get",
  86       "member": "Ext.AbstractManager",
  87       "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",
  88       "params": [
  89         {
  90           "type": "String",
  91           "name": "id",
  92           "doc": "<p>The id of the item</p>\n",
  93           "optional": false
  94         }
  95       ],
  96       "return": {
  97         "type": "Mixed",
  98         "doc": "<p>The item, <code>undefined</code> if not found.</p>\n"
  99       },
 100       "private": false,
 101       "static": false,
 102       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 103       "linenr": 31,
 104       "html_filename": "AbstractManager.html",
 105       "href": "AbstractManager.html#Ext-AbstractManager-method-get",
 106       "shortDoc": "<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"
 107     },
 108     {
 109       "tagname": "method",
 110       "name": "getCount",
 111       "member": "Ext.AbstractManager",
 112       "doc": "<p>Gets the number of items in the collection.</p>\n",
 113       "params": [
 114
 115       ],
 116       "return": {
 117         "type": "Number",
 118         "doc": "<p>The number of items in the collection.</p>\n"
 119       },
 120       "private": false,
 121       "static": false,
 122       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 123       "linenr": 135,
 124       "html_filename": "AbstractManager.html",
 125       "href": "AbstractManager.html#Ext-AbstractManager-method-getCount",
 126       "shortDoc": "<p>Gets the number of items in the collection.</p>\n"
 127     },
 128     {
 129       "tagname": "method",
 130       "name": "isRegistered",
 131       "member": "Ext.AbstractManager",
 132       "doc": "<p>Checks if an item type is registered.</p>\n",
 133       "params": [
 134         {
 135           "type": "String",
 136           "name": "type",
 137           "doc": "<p>The mnemonic string by which the class may be looked up</p>\n",
 138           "optional": false
 139         }
 140       ],
 141       "return": {
 142         "type": "Boolean",
 143         "doc": "<p>Whether the type is registered.</p>\n"
 144       },
 145       "private": false,
 146       "static": false,
 147       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 148       "linenr": 67,
 149       "html_filename": "AbstractManager.html",
 150       "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered",
 151       "shortDoc": "<p>Checks if an item type is registered.</p>\n"
 152     },
 153     {
 154       "tagname": "method",
 155       "name": "onAvailable",
 156       "member": "Ext.AbstractManager",
 157       "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",
 158       "params": [
 159         {
 160           "type": "String",
 161           "name": "id",
 162           "doc": "<p>The item id</p>\n",
 163           "optional": false
 164         },
 165         {
 166           "type": "Function",
 167           "name": "fn",
 168           "doc": "<p>The callback function. Called with a single parameter, the item.</p>\n",
 169           "optional": false
 170         },
 171         {
 172           "type": "Object",
 173           "name": "scope",
 174           "doc": "<p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>\n",
 175           "optional": false
 176         }
 177       ],
 178       "return": {
 179         "type": "void",
 180         "doc": "\n"
 181       },
 182       "private": false,
 183       "static": false,
 184       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 185       "linenr": 95,
 186       "html_filename": "AbstractManager.html",
 187       "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable",
 188       "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. This will happen..."
 189     },
 190     {
 191       "tagname": "method",
 192       "name": "register",
 193       "member": "Ext.AbstractManager",
 194       "doc": "<p>Registers an item to be managed</p>\n",
 195       "params": [
 196         {
 197           "type": "Mixed",
 198           "name": "item",
 199           "doc": "<p>The item to register</p>\n",
 200           "optional": false
 201         }
 202       ],
 203       "return": {
 204         "type": "void",
 205         "doc": "\n"
 206       },
 207       "private": false,
 208       "static": false,
 209       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 210       "linenr": 41,
 211       "html_filename": "AbstractManager.html",
 212       "href": "AbstractManager.html#Ext-AbstractManager-method-register",
 213       "shortDoc": "<p>Registers an item to be managed</p>\n"
 214     },
 215     {
 216       "tagname": "method",
 217       "name": "registerType",
 218       "member": "Ext.AbstractManager",
 219       "doc": "<p>Registers a new item constructor, keyed by a type key.\n\n",
 220       "params": [
 221         {
 222           "type": "String",
 223           "name": "type",
 224           "doc": "<p>The mnemonic string by which the class may be looked up.</p>\n",
 225           "optional": false
 226         },
 227         {
 228           "type": "Constructor",
 229           "name": "cls",
 230           "doc": "<p>The new instance class.</p>\n",
 231           "optional": false
 232         }
 233       ],
 234       "return": {
 235         "type": "void",
 236         "doc": "\n"
 237       },
 238       "private": false,
 239       "static": false,
 240       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 241       "linenr": 57,
 242       "html_filename": "AbstractManager.html",
 243       "href": "AbstractManager.html#Ext-AbstractManager-method-registerType",
 244       "shortDoc": "<p>Registers a new item constructor, keyed by a type key.\n\n"
 245     },
 246     {
 247       "tagname": "method",
 248       "name": "unregister",
 249       "member": "Ext.AbstractManager",
 250       "doc": "<p>Unregisters an item by removing it from this manager</p>\n",
 251       "params": [
 252         {
 253           "type": "Mixed",
 254           "name": "item",
 255           "doc": "<p>The item to unregister</p>\n",
 256           "optional": false
 257         }
 258       ],
 259       "return": {
 260         "type": "void",
 261         "doc": "\n"
 262       },
 263       "private": false,
 264       "static": false,
 265       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 266       "linenr": 49,
 267       "html_filename": "AbstractManager.html",
 268       "href": "AbstractManager.html#Ext-AbstractManager-method-unregister",
 269       "shortDoc": "<p>Unregisters an item by removing it from this manager</p>\n"
 270     }
 271   ],
 272   "property": [
 273     {
 274       "tagname": "property",
 275       "name": "all",
 276       "member": "Ext.AbstractManager",
 277       "type": "Ext.util.MixedCollection",
 278       "doc": "<p>Contains all of the items currently managed</p>\n",
 279       "private": false,
 280       "static": false,
 281       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 282       "linenr": 21,
 283       "html_filename": "AbstractManager.html",
 284       "href": "AbstractManager.html#Ext-AbstractManager-property-all"
 285     }
 286   ],
 287   "event": [
 288
 289   ],
 290   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 291   "linenr": 1,
 292   "html_filename": "AbstractManager.html",
 293   "href": "AbstractManager.html#Ext-AbstractManager",
 294   "cssVar": [
 295
 296   ],
 297   "cssMixin": [
 298
 299   ],
 300   "component": false,
 301   "superclasses": [
 302
 303   ],
 304   "subclasses": [
 305     "Ext.ComponentManager",
 306     "Ext.ModelManager",
 307     "Ext.PluginManager"
 308   ],
 309   "mixedInto": [
 310
 311   ],
 312   "allMixins": [
 313
 314   ]
 315 });