docs/output/Ext.PluginManager.js

   1 Ext.data.JsonP.Ext_PluginManager({
   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": "PluginManager.html#Ext-PluginManager-method-create",
  18         "shortDoc": "Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to insta...",
  19         "static": false,
  20         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/PluginManager.js",
  21         "private": false,
  22         "params": [
  23           {
  24             "type": "Object",
  25             "optional": false,
  26             "doc": "<p>A configuration object for the Plugin 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 Plugin type if\nthe config object does not contain a <code>ptype</code>. (Optional if the config contains a <code>ptype</code>).</p>\n",
  33             "name": "defaultType"
  34           }
  35         ],
  36         "name": "create",
  37         "owner": "Ext.PluginManager",
  38         "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",
  39         "linenr": 19,
  40         "return": {
  41           "type": "Ext.Component",
  42           "doc": "<p>The newly instantiated Plugin.</p>\n"
  43         },
  44         "html_filename": "PluginManager.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": "PluginManager.html#Ext-PluginManager-method-findByType",
  86         "shortDoc": "Returns all plugins registered with the given type. ...",
  87         "static": false,
  88         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/PluginManager.js",
  89         "private": false,
  90         "params": [
  91           {
  92             "type": "String",
  93             "optional": false,
  94             "doc": "<p>The type to search for</p>\n",
  95             "name": "type"
  96           },
  97           {
  98             "type": "Boolean",
  99             "optional": false,
 100             "doc": "<p>True to only return plugins of this type where the plugin's isDefault property is truthy</p>\n",
 101             "name": "defaultsOnly"
 102           }
 103         ],
 104         "name": "findByType",
 105         "owner": "Ext.PluginManager",
 106         "doc": "<p>Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.</p>\n",
 107         "linenr": 61,
 108         "return": {
 109           "type": "Array",
 110           "doc": "<p>All matching plugins</p>\n"
 111         },
 112         "html_filename": "PluginManager.html"
 113       },
 114       {
 115         "deprecated": null,
 116         "alias": null,
 117         "protected": false,
 118         "tagname": "method",
 119         "href": "AbstractManager.html#Ext-AbstractManager-method-get",
 120         "shortDoc": "Returns an item by id. ...",
 121         "static": false,
 122         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 123         "private": false,
 124         "params": [
 125           {
 126             "type": "String",
 127             "optional": false,
 128             "doc": "<p>The id of the item</p>\n",
 129             "name": "id"
 130           }
 131         ],
 132         "name": "get",
 133         "owner": "Ext.AbstractManager",
 134         "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",
 135         "linenr": 29,
 136         "return": {
 137           "type": "Mixed",
 138           "doc": "<p>The item, <code>undefined</code> if not found.</p>\n"
 139         },
 140         "html_filename": "AbstractManager.html"
 141       },
 142       {
 143         "deprecated": null,
 144         "alias": null,
 145         "protected": false,
 146         "tagname": "method",
 147         "href": "AbstractManager.html#Ext-AbstractManager-method-getCount",
 148         "shortDoc": "Gets the number of items in the collection. ...",
 149         "static": false,
 150         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 151         "private": false,
 152         "params": [
 153
 154         ],
 155         "name": "getCount",
 156         "owner": "Ext.AbstractManager",
 157         "doc": "<p>Gets the number of items in the collection.</p>\n",
 158         "linenr": 133,
 159         "return": {
 160           "type": "Number",
 161           "doc": "<p>The number of items in the collection.</p>\n"
 162         },
 163         "html_filename": "AbstractManager.html"
 164       },
 165       {
 166         "deprecated": null,
 167         "alias": null,
 168         "protected": false,
 169         "tagname": "method",
 170         "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered",
 171         "shortDoc": "Checks if an item type is registered. ...",
 172         "static": false,
 173         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 174         "private": false,
 175         "params": [
 176           {
 177             "type": "String",
 178             "optional": false,
 179             "doc": "<p>The mnemonic string by which the class may be looked up</p>\n",
 180             "name": "type"
 181           }
 182         ],
 183         "name": "isRegistered",
 184         "owner": "Ext.AbstractManager",
 185         "doc": "<p>Checks if an item type is registered.</p>\n",
 186         "linenr": 65,
 187         "return": {
 188           "type": "Boolean",
 189           "doc": "<p>Whether the type is registered.</p>\n"
 190         },
 191         "html_filename": "AbstractManager.html"
 192       },
 193       {
 194         "deprecated": null,
 195         "alias": null,
 196         "protected": false,
 197         "tagname": "method",
 198         "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable",
 199         "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. ...",
 200         "static": false,
 201         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 202         "private": false,
 203         "params": [
 204           {
 205             "type": "String",
 206             "optional": false,
 207             "doc": "<p>The item id</p>\n",
 208             "name": "id"
 209           },
 210           {
 211             "type": "Function",
 212             "optional": false,
 213             "doc": "<p>The callback function. Called with a single parameter, the item.</p>\n",
 214             "name": "fn"
 215           },
 216           {
 217             "type": "Object",
 218             "optional": false,
 219             "doc": "<p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>\n",
 220             "name": "scope"
 221           }
 222         ],
 223         "name": "onAvailable",
 224         "owner": "Ext.AbstractManager",
 225         "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",
 226         "linenr": 93,
 227         "return": {
 228           "type": "void",
 229           "doc": "\n"
 230         },
 231         "html_filename": "AbstractManager.html"
 232       },
 233       {
 234         "deprecated": null,
 235         "alias": null,
 236         "protected": false,
 237         "tagname": "method",
 238         "href": "AbstractManager.html#Ext-AbstractManager-method-register",
 239         "shortDoc": "Registers an item to be managed ...",
 240         "static": false,
 241         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 242         "private": false,
 243         "params": [
 244           {
 245             "type": "Mixed",
 246             "optional": false,
 247             "doc": "<p>The item to register</p>\n",
 248             "name": "item"
 249           }
 250         ],
 251         "name": "register",
 252         "owner": "Ext.AbstractManager",
 253         "doc": "<p>Registers an item to be managed</p>\n",
 254         "linenr": 39,
 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-registerType",
 267         "shortDoc": "Registers a new item constructor, keyed by a type key. ...",
 268         "static": false,
 269         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 270         "private": false,
 271         "params": [
 272           {
 273             "type": "String",
 274             "optional": false,
 275             "doc": "<p>The mnemonic string by which the class may be looked up.</p>\n",
 276             "name": "type"
 277           },
 278           {
 279             "type": "Constructor",
 280             "optional": false,
 281             "doc": "<p>The new instance class.</p>\n",
 282             "name": "cls"
 283           }
 284         ],
 285         "name": "registerType",
 286         "owner": "Ext.AbstractManager",
 287         "doc": "<p>Registers a new item constructor, keyed by a type key.\n\n",
 288         "linenr": 55,
 289         "return": {
 290           "type": "void",
 291           "doc": "\n"
 292         },
 293         "html_filename": "AbstractManager.html"
 294       },
 295       {
 296         "deprecated": null,
 297         "alias": null,
 298         "protected": false,
 299         "tagname": "method",
 300         "href": "AbstractManager.html#Ext-AbstractManager-method-unregister",
 301         "shortDoc": "Unregisters an item by removing it from this manager ...",
 302         "static": false,
 303         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 304         "private": false,
 305         "params": [
 306           {
 307             "type": "Mixed",
 308             "optional": false,
 309             "doc": "<p>The item to unregister</p>\n",
 310             "name": "item"
 311           }
 312         ],
 313         "name": "unregister",
 314         "owner": "Ext.AbstractManager",
 315         "doc": "<p>Unregisters an item by removing it from this manager</p>\n",
 316         "linenr": 47,
 317         "return": {
 318           "type": "void",
 319           "doc": "\n"
 320         },
 321         "html_filename": "AbstractManager.html"
 322       }
 323     ],
 324     "property": [
 325       {
 326         "type": "Ext.util.MixedCollection",
 327         "deprecated": null,
 328         "alias": null,
 329         "protected": false,
 330         "tagname": "property",
 331         "href": "AbstractManager.html#Ext-AbstractManager-property-all",
 332         "static": false,
 333         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js",
 334         "private": false,
 335         "name": "all",
 336         "owner": "Ext.AbstractManager",
 337         "doc": "<p>Contains all of the items currently managed</p>\n",
 338         "linenr": 19,
 339         "html_filename": "AbstractManager.html"
 340       }
 341     ],
 342     "cssVar": [
 343
 344     ],
 345     "cssMixin": [
 346
 347     ],
 348     "event": [
 349
 350     ]
 351   },
 352   "singleton": true,
 353   "alias": null,
 354   "superclasses": [
 355     "Ext.AbstractManager"
 356   ],
 357   "protected": false,
 358   "tagname": "class",
 359   "mixins": [
 360
 361   ],
 362   "href": "PluginManager.html#Ext-PluginManager",
 363   "subclasses": [
 364
 365   ],
 366   "static": false,
 367   "author": null,
 368   "component": false,
 369   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/PluginManager.js",
 370   "private": false,
 371   "alternateClassNames": [
 372     "Ext.PluginMgr"
 373   ],
 374   "name": "Ext.PluginManager",
 375   "doc": "<p>Provides a registry of available Plugin <i>classes</i> indexed by a mnemonic code known as the Plugin's ptype.\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",
 376   "mixedInto": [
 377
 378   ],
 379   "linenr": 1,
 380   "xtypes": [
 381
 382   ],
 383   "html_filename": "PluginManager.html",
 384   "extends": "Ext.AbstractManager"
 385 });