docs/output/Ext.PluginManager.js

   1 Ext.data.JsonP.Ext_PluginManager({
   2   "tagname": "class",
   3   "name": "Ext.PluginManager",
   4   "doc": "<p>Provides a registry of available Plugin <i>classes</i> indexed by a mnemonic code known as the Plugin's ptype.\nThe <code><a href=\"#/api/Ext.Component--xtype\" rel=\"Ext.Component--xtype\" class=\"docClass\">xtype</a></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><a href=\"#/api/Ext.Component--xtype\" rel=\"Ext.Component--xtype\" class=\"docClass\">xtype</a></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><a href=\"#/api/Ext.Component--xtype\" rel=\"Ext.Component--xtype\" class=\"docClass\">xtypes</a></code>, see <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a>.</p>\n\n",
   5   "extends": "Ext.AbstractManager",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.PluginMgr"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "create",
  24       "member": "Ext.PluginManager",
  25       "doc": "<p>Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to instantiate.</p>\n",
  26       "params": [
  27         {
  28           "type": "Object",
  29           "name": "config",
  30           "doc": "<p>A configuration object for the Plugin you wish to create.</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "Constructor",
  35           "name": "defaultType",
  36           "doc": "<p>The constructor to provide the default Plugin type if\nthe config object does not contain a <code>ptype</code>. (Optional if the config contains a <code>ptype</code>).</p>\n",
  37           "optional": false
  38         }
  39       ],
  40       "return": {
  41         "type": "Ext.Component",
  42         "doc": "<p>The newly instantiated Plugin.</p>\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js",
  47       "linenr": 19,
  48       "html_filename": "PluginManager.html",
  49       "href": "PluginManager.html#Ext-PluginManager-method-create",
  50       "shortDoc": "Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to insta..."
  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": "findByType",
  86       "member": "Ext.PluginManager",
  87       "doc": "<p>Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.</p>\n",
  88       "params": [
  89         {
  90           "type": "String",
  91           "name": "type",
  92           "doc": "<p>The type to search for</p>\n",
  93           "optional": false
  94         },
  95         {
  96           "type": "Boolean",
  97           "name": "defaultsOnly",
  98           "doc": "<p>True to only return plugins of this type where the plugin's isDefault property is truthy</p>\n",
  99           "optional": false
 100         }
 101       ],
 102       "return": {
 103         "type": "Array",
 104         "doc": "<p>All matching plugins</p>\n"
 105       },
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js",
 109       "linenr": 61,
 110       "html_filename": "PluginManager.html",
 111       "href": "PluginManager.html#Ext-PluginManager-method-findByType",
 112       "shortDoc": "<p>Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.</p>\n"
 113     },
 114     {
 115       "tagname": "method",
 116       "name": "get",
 117       "member": "Ext.AbstractManager",
 118       "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",
 119       "params": [
 120         {
 121           "type": "String",
 122           "name": "id",
 123           "doc": "<p>The id of the item</p>\n",
 124           "optional": false
 125         }
 126       ],
 127       "return": {
 128         "type": "Mixed",
 129         "doc": "<p>The item, <code>undefined</code> if not found.</p>\n"
 130       },
 131       "private": false,
 132       "static": false,
 133       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 134       "linenr": 31,
 135       "html_filename": "AbstractManager.html",
 136       "href": "AbstractManager.html#Ext-AbstractManager-method-get",
 137       "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"
 138     },
 139     {
 140       "tagname": "method",
 141       "name": "getCount",
 142       "member": "Ext.AbstractManager",
 143       "doc": "<p>Gets the number of items in the collection.</p>\n",
 144       "params": [
 145
 146       ],
 147       "return": {
 148         "type": "Number",
 149         "doc": "<p>The number of items in the collection.</p>\n"
 150       },
 151       "private": false,
 152       "static": false,
 153       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 154       "linenr": 135,
 155       "html_filename": "AbstractManager.html",
 156       "href": "AbstractManager.html#Ext-AbstractManager-method-getCount",
 157       "shortDoc": "<p>Gets the number of items in the collection.</p>\n"
 158     },
 159     {
 160       "tagname": "method",
 161       "name": "isRegistered",
 162       "member": "Ext.AbstractManager",
 163       "doc": "<p>Checks if an item type is registered.</p>\n",
 164       "params": [
 165         {
 166           "type": "String",
 167           "name": "type",
 168           "doc": "<p>The mnemonic string by which the class may be looked up</p>\n",
 169           "optional": false
 170         }
 171       ],
 172       "return": {
 173         "type": "Boolean",
 174         "doc": "<p>Whether the type is registered.</p>\n"
 175       },
 176       "private": false,
 177       "static": false,
 178       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 179       "linenr": 67,
 180       "html_filename": "AbstractManager.html",
 181       "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered",
 182       "shortDoc": "<p>Checks if an item type is registered.</p>\n"
 183     },
 184     {
 185       "tagname": "method",
 186       "name": "onAvailable",
 187       "member": "Ext.AbstractManager",
 188       "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",
 189       "params": [
 190         {
 191           "type": "String",
 192           "name": "id",
 193           "doc": "<p>The item id</p>\n",
 194           "optional": false
 195         },
 196         {
 197           "type": "Function",
 198           "name": "fn",
 199           "doc": "<p>The callback function. Called with a single parameter, the item.</p>\n",
 200           "optional": false
 201         },
 202         {
 203           "type": "Object",
 204           "name": "scope",
 205           "doc": "<p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>\n",
 206           "optional": false
 207         }
 208       ],
 209       "return": {
 210         "type": "void",
 211         "doc": "\n"
 212       },
 213       "private": false,
 214       "static": false,
 215       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 216       "linenr": 95,
 217       "html_filename": "AbstractManager.html",
 218       "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable",
 219       "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. This will happen..."
 220     },
 221     {
 222       "tagname": "method",
 223       "name": "register",
 224       "member": "Ext.AbstractManager",
 225       "doc": "<p>Registers an item to be managed</p>\n",
 226       "params": [
 227         {
 228           "type": "Mixed",
 229           "name": "item",
 230           "doc": "<p>The item to register</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": 41,
 242       "html_filename": "AbstractManager.html",
 243       "href": "AbstractManager.html#Ext-AbstractManager-method-register",
 244       "shortDoc": "<p>Registers an item to be managed</p>\n"
 245     },
 246     {
 247       "tagname": "method",
 248       "name": "registerType",
 249       "member": "Ext.AbstractManager",
 250       "doc": "<p>Registers a new item constructor, keyed by a type key.\n\n",
 251       "params": [
 252         {
 253           "type": "String",
 254           "name": "type",
 255           "doc": "<p>The mnemonic string by which the class may be looked up.</p>\n",
 256           "optional": false
 257         },
 258         {
 259           "type": "Constructor",
 260           "name": "cls",
 261           "doc": "<p>The new instance class.</p>\n",
 262           "optional": false
 263         }
 264       ],
 265       "return": {
 266         "type": "void",
 267         "doc": "\n"
 268       },
 269       "private": false,
 270       "static": false,
 271       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 272       "linenr": 57,
 273       "html_filename": "AbstractManager.html",
 274       "href": "AbstractManager.html#Ext-AbstractManager-method-registerType",
 275       "shortDoc": "<p>Registers a new item constructor, keyed by a type key.\n\n"
 276     },
 277     {
 278       "tagname": "method",
 279       "name": "unregister",
 280       "member": "Ext.AbstractManager",
 281       "doc": "<p>Unregisters an item by removing it from this manager</p>\n",
 282       "params": [
 283         {
 284           "type": "Mixed",
 285           "name": "item",
 286           "doc": "<p>The item to unregister</p>\n",
 287           "optional": false
 288         }
 289       ],
 290       "return": {
 291         "type": "void",
 292         "doc": "\n"
 293       },
 294       "private": false,
 295       "static": false,
 296       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 297       "linenr": 49,
 298       "html_filename": "AbstractManager.html",
 299       "href": "AbstractManager.html#Ext-AbstractManager-method-unregister",
 300       "shortDoc": "<p>Unregisters an item by removing it from this manager</p>\n"
 301     }
 302   ],
 303   "property": [
 304     {
 305       "tagname": "property",
 306       "name": "all",
 307       "member": "Ext.AbstractManager",
 308       "type": "Ext.util.MixedCollection",
 309       "doc": "<p>Contains all of the items currently managed</p>\n",
 310       "private": false,
 311       "static": false,
 312       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js",
 313       "linenr": 21,
 314       "html_filename": "AbstractManager.html",
 315       "href": "AbstractManager.html#Ext-AbstractManager-property-all"
 316     }
 317   ],
 318   "event": [
 319
 320   ],
 321   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js",
 322   "linenr": 1,
 323   "html_filename": "PluginManager.html",
 324   "href": "PluginManager.html#Ext-PluginManager",
 325   "cssVar": [
 326
 327   ],
 328   "cssMixin": [
 329
 330   ],
 331   "component": false,
 332   "superclasses": [
 333     "Ext.AbstractManager"
 334   ],
 335   "subclasses": [
 336
 337   ],
 338   "mixedInto": [
 339
 340   ],
 341   "allMixins": [
 342
 343   ]
 344 });