git.roojs.org Git - roojs1/blob - docs/symbols/Roo.NestedLayoutPanel.json

   1 {
   2   "name" : "Roo.NestedLayoutPanel",
   3   "augments" : [
   4     "Roo.ContentPanel",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "Create a new NestedLayoutPanel.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "NestedLayoutPanel",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "layout",
  19       "type" : "Roo.BorderLayout",
  20       "desc" : "The layout for this panel",
  21       "isOptional" : false
  22     },
  23     {
  24       "name" : "config",
  25       "type" : "String/Object",
  26       "desc" : "A string to set only the title or a config object",
  27       "isOptional" : false
  28     }
  29   ],
  30   "returns" : [],
  31   "config" : [
  32     {
  33       "name" : "loadOnce",
  34       "type" : "Boolean",
  35       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
  36       "memberOf" : "Roo.ContentPanel",
  37       "optvals" : []
  38     },
  39     {
  40       "name" : "listeners",
  41       "type" : "Object",
  42       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  43       "memberOf" : "Roo.util.Observable",
  44       "optvals" : []
  45     },
  46     {
  47       "name" : "autoScroll",
  48       "type" : "Boolean",
  49       "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
  50       "memberOf" : "Roo.ContentPanel",
  51       "optvals" : []
  52     },
  53     {
  54       "name" : "fitToFrame",
  55       "type" : "Boolean",
  56       "desc" : "True for this panel to adjust its size to fit when the region resizes  (defaults to false)",
  57       "memberOf" : "Roo.ContentPanel",
  58       "optvals" : []
  59     },
  60     {
  61       "name" : "background",
  62       "type" : "Boolean",
  63       "desc" : "True if the panel should not be activated when it is added (defaults to false)",
  64       "memberOf" : "Roo.ContentPanel",
  65       "optvals" : []
  66     },
  67     {
  68       "name" : "toolbar",
  69       "type" : "Toolbar",
  70       "desc" : "A toolbar for this panel",
  71       "memberOf" : "Roo.ContentPanel",
  72       "optvals" : []
  73     },
  74     {
  75       "name" : "region",
  76       "type" : "String",
  77       "desc" : "t) which region to put this panel on (when used with xtype constructors)",
  78       "memberOf" : "Roo.ContentPanel",
  79       "optvals" : [
  80         "center",
  81         "north",
  82         "south",
  83         "east",
  84         "west"
  85       ]
  86     },
  87     {
  88       "name" : "content",
  89       "type" : "String",
  90       "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
  91       "memberOf" : "Roo.ContentPanel",
  92       "optvals" : []
  93     },
  94     {
  95       "name" : "title",
  96       "type" : "String",
  97       "desc" : "The title for this panel",
  98       "memberOf" : "Roo.ContentPanel",
  99       "optvals" : []
 100     },
 101     {
 102       "name" : "style",
 103       "type" : "String",
 104       "desc" : "Extra style to add to the content panel",
 105       "memberOf" : "Roo.ContentPanel",
 106       "optvals" : []
 107     },
 108     {
 109       "name" : "autoCreate",
 110       "type" : "Boolean/Object",
 111       "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
 112       "memberOf" : "Roo.ContentPanel",
 113       "optvals" : []
 114     },
 115     {
 116       "name" : "fitContainer",
 117       "type" : "Boolean",
 118       "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)",
 119       "memberOf" : "Roo.ContentPanel",
 120       "optvals" : []
 121     },
 122     {
 123       "name" : "closable",
 124       "type" : "Boolean",
 125       "desc" : "True if the panel can be closed/removed",
 126       "memberOf" : "Roo.ContentPanel",
 127       "optvals" : []
 128     },
 129     {
 130       "name" : "params",
 131       "type" : "String/Object",
 132       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
 133       "memberOf" : "Roo.ContentPanel",
 134       "optvals" : []
 135     },
 136     {
 137       "name" : "adjustments",
 138       "type" : "Array",
 139       "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
 140       "memberOf" : "Roo.ContentPanel",
 141       "optvals" : []
 142     },
 143     {
 144       "name" : "url",
 145       "type" : "String",
 146       "desc" : "Calls {@link #setUrl} with this value",
 147       "memberOf" : "Roo.ContentPanel",
 148       "optvals" : []
 149     },
 150     {
 151       "name" : "resizeEl",
 152       "type" : "String/HTMLElement/Element",
 153       "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
 154       "memberOf" : "Roo.ContentPanel",
 155       "optvals" : []
 156     }
 157   ],
 158   "methods" : [
 159     {
 160       "name" : "addxtype",
 161       "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n</code></pre>",
 162       "isStatic" : false,
 163       "isConstructor" : false,
 164       "isPrivate" : false,
 165       "memberOf" : "Roo.NestedLayoutPanel",
 166       "example" : "",
 167       "deprecated" : "",
 168       "since" : "",
 169       "see" : "",
 170       "params" : [
 171         {
 172           "name" : "cfg",
 173           "type" : "Object",
 174           "desc" : "Xtype definition of item to add.",
 175           "isOptional" : false
 176         }
 177       ],
 178       "returns" : []
 179     },
 180     {
 181       "name" : "getLayout",
 182       "desc" : "Returns the nested BorderLayout for this panel",
 183       "isStatic" : false,
 184       "isConstructor" : false,
 185       "isPrivate" : false,
 186       "memberOf" : "Roo.NestedLayoutPanel",
 187       "example" : "",
 188       "deprecated" : "",
 189       "since" : "",
 190       "see" : "",
 191       "params" : [],
 192       "returns" : [
 193         {
 194           "name" : "",
 195           "type" : "Roo.BorderLayout",
 196           "desc" : ""
 197         }
 198       ]
 199     },
 200     {
 201       "name" : "load",
 202       "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
 203       "isStatic" : false,
 204       "isConstructor" : false,
 205       "isPrivate" : false,
 206       "memberOf" : "Roo.ContentPanel",
 207       "example" : "",
 208       "deprecated" : "",
 209       "since" : "",
 210       "see" : "",
 211       "params" : [
 212         {
 213           "name" : "url",
 214           "type" : "Object/String/Function",
 215           "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
 216           "isOptional" : false
 217         },
 218         {
 219           "name" : "params",
 220           "type" : "String/Object",
 221           "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&amp;param2=2\" or an object {param1: 1, param2: 2}",
 222           "isOptional" : false
 223         },
 224         {
 225           "name" : "callback",
 226           "type" : "Function",
 227           "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
 228           "isOptional" : false
 229         },
 230         {
 231           "name" : "discardUrl",
 232           "type" : "Boolean",
 233           "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
 234           "isOptional" : false
 235         }
 236       ],
 237       "returns" : [
 238         {
 239           "name" : "",
 240           "type" : "Roo.ContentPanel",
 241           "desc" : "this"
 242         }
 243       ]
 244     },
 245     {
 246       "name" : "getUpdateManager",
 247       "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
 248       "isStatic" : false,
 249       "isConstructor" : false,
 250       "isPrivate" : false,
 251       "memberOf" : "Roo.ContentPanel",
 252       "example" : "",
 253       "deprecated" : "",
 254       "since" : "",
 255       "see" : "",
 256       "params" : [],
 257       "returns" : [
 258         {
 259           "name" : "",
 260           "type" : "Roo.UpdateManager",
 261           "desc" : "The UpdateManager"
 262         }
 263       ]
 264     },
 265     {
 266       "name" : "isClosable",
 267       "desc" : "Returns true is this panel was configured to be closable",
 268       "isStatic" : false,
 269       "isConstructor" : false,
 270       "isPrivate" : false,
 271       "memberOf" : "Roo.ContentPanel",
 272       "example" : "",
 273       "deprecated" : "",
 274       "since" : "",
 275       "see" : "",
 276       "params" : [],
 277       "returns" : [
 278         {
 279           "name" : "",
 280           "type" : "Boolean",
 281           "desc" : ""
 282         }
 283       ]
 284     },
 285     {
 286       "name" : "destroy",
 287       "desc" : "Destroys this panel",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "memberOf" : "Roo.ContentPanel",
 292       "example" : "",
 293       "deprecated" : "",
 294       "since" : "",
 295       "see" : "",
 296       "params" : [],
 297       "returns" : []
 298     },
 299     {
 300       "name" : "getEl",
 301       "desc" : "Returns this panel's element - used by regiosn to add.",
 302       "isStatic" : false,
 303       "isConstructor" : false,
 304       "isPrivate" : false,
 305       "memberOf" : "Roo.ContentPanel",
 306       "example" : "",
 307       "deprecated" : "",
 308       "since" : "",
 309       "see" : "",
 310       "params" : [],
 311       "returns" : [
 312         {
 313           "name" : "",
 314           "type" : "Roo.Element",
 315           "desc" : ""
 316         }
 317       ]
 318     },
 319     {
 320       "name" : "setContent",
 321       "desc" : "Updates this panel's element",
 322       "isStatic" : false,
 323       "isConstructor" : false,
 324       "isPrivate" : false,
 325       "memberOf" : "Roo.ContentPanel",
 326       "example" : "",
 327       "deprecated" : "",
 328       "since" : "",
 329       "see" : "",
 330       "params" : [
 331         {
 332           "name" : "content",
 333           "type" : "String",
 334           "desc" : "The new content",
 335           "isOptional" : false
 336         },
 337         {
 338           "name" : "loadScripts",
 339           "type" : "Boolean",
 340           "desc" : "(optional) true to look for and process scripts",
 341           "isOptional" : false
 342         }
 343       ],
 344       "returns" : []
 345     },
 346     {
 347       "name" : "getId",
 348       "desc" : "Returns this panel's id",
 349       "isStatic" : false,
 350       "isConstructor" : false,
 351       "isPrivate" : false,
 352       "memberOf" : "Roo.ContentPanel",
 353       "example" : "",
 354       "deprecated" : "",
 355       "since" : "",
 356       "see" : "",
 357       "params" : [],
 358       "returns" : [
 359         {
 360           "name" : "",
 361           "type" : "String",
 362           "desc" : ""
 363         }
 364       ]
 365     },
 366     {
 367       "name" : "refresh",
 368       "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n  Will fail silently if the {@link #setUrl} method has not been called.\n  This does not activate the panel, just updates its content.",
 369       "isStatic" : false,
 370       "isConstructor" : false,
 371       "isPrivate" : false,
 372       "memberOf" : "Roo.ContentPanel",
 373       "example" : "",
 374       "deprecated" : "",
 375       "since" : "",
 376       "see" : "",
 377       "params" : [],
 378       "returns" : []
 379     },
 380     {
 381       "name" : "getTitle",
 382       "desc" : "Returns this panel's title",
 383       "isStatic" : false,
 384       "isConstructor" : false,
 385       "isPrivate" : false,
 386       "memberOf" : "Roo.ContentPanel",
 387       "example" : "",
 388       "deprecated" : "",
 389       "since" : "",
 390       "see" : "",
 391       "params" : [],
 392       "returns" : [
 393         {
 394           "name" : "",
 395           "type" : "String",
 396           "desc" : ""
 397         }
 398       ]
 399     },
 400     {
 401       "name" : "setTitle",
 402       "desc" : "Set this panel's title",
 403       "isStatic" : false,
 404       "isConstructor" : false,
 405       "isPrivate" : false,
 406       "memberOf" : "Roo.ContentPanel",
 407       "example" : "",
 408       "deprecated" : "",
 409       "since" : "",
 410       "see" : "",
 411       "params" : [
 412         {
 413           "name" : "title",
 414           "type" : "String",
 415           "desc" : "",
 416           "isOptional" : false
 417         }
 418       ],
 419       "returns" : []
 420     },
 421     {
 422       "name" : "getToolbar",
 423       "desc" : "Returns the toolbar for this Panel if one was configured.",
 424       "isStatic" : false,
 425       "isConstructor" : false,
 426       "isPrivate" : false,
 427       "memberOf" : "Roo.ContentPanel",
 428       "example" : "",
 429       "deprecated" : "",
 430       "since" : "",
 431       "see" : "",
 432       "params" : [],
 433       "returns" : [
 434         {
 435           "name" : "",
 436           "type" : "Roo.Toolbar",
 437           "desc" : ""
 438         }
 439       ]
 440     },
 441     {
 442       "name" : "setUrl",
 443       "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
 444       "isStatic" : false,
 445       "isConstructor" : false,
 446       "isPrivate" : false,
 447       "memberOf" : "Roo.ContentPanel",
 448       "example" : "",
 449       "deprecated" : "",
 450       "since" : "",
 451       "see" : "",
 452       "params" : [
 453         {
 454           "name" : "url",
 455           "type" : "String/Function",
 456           "desc" : "The URL to load the content from or a function to call to get the URL",
 457           "isOptional" : false
 458         },
 459         {
 460           "name" : "params",
 461           "type" : "String/Object",
 462           "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
 463           "isOptional" : false
 464         },
 465         {
 466           "name" : "loadOnce",
 467           "type" : "Boolean",
 468           "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
 469           "isOptional" : false
 470         }
 471       ],
 472       "returns" : [
 473         {
 474           "name" : "",
 475           "type" : "Roo.UpdateManager",
 476           "desc" : "The UpdateManager"
 477         }
 478       ]
 479     },
 480     {
 481       "name" : "purgeListeners",
 482       "desc" : "Removes all listeners for this object",
 483       "isStatic" : false,
 484       "isConstructor" : false,
 485       "isPrivate" : false,
 486       "memberOf" : "Roo.util.Observable",
 487       "example" : "",
 488       "deprecated" : "",
 489       "since" : "",
 490       "see" : "",
 491       "params" : [],
 492       "returns" : []
 493     },
 494     {
 495       "name" : "on",
 496       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 497       "isStatic" : false,
 498       "isConstructor" : false,
 499       "isPrivate" : false,
 500       "memberOf" : "Roo.util.Observable",
 501       "example" : "",
 502       "deprecated" : "",
 503       "since" : "",
 504       "see" : "",
 505       "params" : [
 506         {
 507           "name" : "eventName",
 508           "type" : "String",
 509           "desc" : "The type of event to listen for",
 510           "isOptional" : false
 511         },
 512         {
 513           "name" : "handler",
 514           "type" : "Function",
 515           "desc" : "The method the event invokes",
 516           "isOptional" : false
 517         },
 518         {
 519           "name" : "scope",
 520           "type" : "Object",
 521           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 522           "isOptional" : false
 523         },
 524         {
 525           "name" : "options",
 526           "type" : "Object",
 527           "desc" : "(optional)",
 528           "isOptional" : false
 529         }
 530       ],
 531       "returns" : []
 532     },
 533     {
 534       "name" : "un",
 535       "desc" : "Removes a listener (shorthand for removeListener)",
 536       "isStatic" : false,
 537       "isConstructor" : false,
 538       "isPrivate" : false,
 539       "memberOf" : "Roo.util.Observable",
 540       "example" : "",
 541       "deprecated" : "",
 542       "since" : "",
 543       "see" : "",
 544       "params" : [
 545         {
 546           "name" : "eventName",
 547           "type" : "String",
 548           "desc" : "The type of event to listen for",
 549           "isOptional" : false
 550         },
 551         {
 552           "name" : "handler",
 553           "type" : "Function",
 554           "desc" : "The handler to remove",
 555           "isOptional" : false
 556         },
 557         {
 558           "name" : "scope",
 559           "type" : "Object",
 560           "desc" : "(optional) The scope (this object) for the handler",
 561           "isOptional" : false
 562         }
 563       ],
 564       "returns" : []
 565     },
 566     {
 567       "name" : "addEvents",
 568       "desc" : "Used to define events on this Observable",
 569       "isStatic" : false,
 570       "isConstructor" : false,
 571       "isPrivate" : false,
 572       "memberOf" : "Roo.util.Observable",
 573       "example" : "",
 574       "deprecated" : "",
 575       "since" : "",
 576       "see" : "",
 577       "params" : [
 578         {
 579           "name" : "object",
 580           "type" : "Object",
 581           "desc" : "The object with the events defined",
 582           "isOptional" : false
 583         }
 584       ],
 585       "returns" : []
 586     },
 587     {
 588       "name" : "releaseCapture",
 589       "desc" : "Removes <b>all</b> added captures from the Observable.",
 590       "isStatic" : true,
 591       "isConstructor" : false,
 592       "isPrivate" : false,
 593       "memberOf" : "Roo.util.Observable",
 594       "example" : "",
 595       "deprecated" : "",
 596       "since" : "",
 597       "see" : "",
 598       "params" : [
 599         {
 600           "name" : "o",
 601           "type" : "Observable",
 602           "desc" : "The Observable to release",
 603           "isOptional" : false
 604         }
 605       ],
 606       "returns" : []
 607     },
 608     {
 609       "name" : "removeListener",
 610       "desc" : "Removes a listener",
 611       "isStatic" : false,
 612       "isConstructor" : false,
 613       "isPrivate" : false,
 614       "memberOf" : "Roo.util.Observable",
 615       "example" : "",
 616       "deprecated" : "",
 617       "since" : "",
 618       "see" : "",
 619       "params" : [
 620         {
 621           "name" : "eventName",
 622           "type" : "String",
 623           "desc" : "The type of event to listen for",
 624           "isOptional" : false
 625         },
 626         {
 627           "name" : "handler",
 628           "type" : "Function",
 629           "desc" : "The handler to remove",
 630           "isOptional" : false
 631         },
 632         {
 633           "name" : "scope",
 634           "type" : "Object",
 635           "desc" : "(optional) The scope (this object) for the handler",
 636           "isOptional" : false
 637         }
 638       ],
 639       "returns" : []
 640     },
 641     {
 642       "name" : "fireEvent",
 643       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "memberOf" : "Roo.util.Observable",
 648       "example" : "",
 649       "deprecated" : "",
 650       "since" : "",
 651       "see" : "",
 652       "params" : [
 653         {
 654           "name" : "eventName",
 655           "type" : "String",
 656           "desc" : "",
 657           "isOptional" : false
 658         },
 659         {
 660           "name" : "args",
 661           "type" : "Object...",
 662           "desc" : "Variable number of parameters are passed to handlers",
 663           "isOptional" : false
 664         }
 665       ],
 666       "returns" : [
 667         {
 668           "name" : "",
 669           "type" : "Boolean",
 670           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 671         }
 672       ]
 673     },
 674     {
 675       "name" : "hasListener",
 676       "desc" : "Checks to see if this object has any listeners for a specified event",
 677       "isStatic" : false,
 678       "isConstructor" : false,
 679       "isPrivate" : false,
 680       "memberOf" : "Roo.util.Observable",
 681       "example" : "",
 682       "deprecated" : "",
 683       "since" : "",
 684       "see" : "",
 685       "params" : [
 686         {
 687           "name" : "eventName",
 688           "type" : "String",
 689           "desc" : "The name of the event to check for",
 690           "isOptional" : false
 691         }
 692       ],
 693       "returns" : [
 694         {
 695           "name" : "",
 696           "type" : "Boolean",
 697           "desc" : "True if the event is being listened for, else false"
 698         }
 699       ]
 700     },
 701     {
 702       "name" : "capture",
 703       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 704       "isStatic" : true,
 705       "isConstructor" : false,
 706       "isPrivate" : false,
 707       "memberOf" : "Roo.util.Observable",
 708       "example" : "",
 709       "deprecated" : "",
 710       "since" : "",
 711       "see" : "",
 712       "params" : [
 713         {
 714           "name" : "o",
 715           "type" : "Observable",
 716           "desc" : "The Observable to capture",
 717           "isOptional" : false
 718         },
 719         {
 720           "name" : "fn",
 721           "type" : "Function",
 722           "desc" : "The function to call",
 723           "isOptional" : false
 724         },
 725         {
 726           "name" : "scope",
 727           "type" : "Object",
 728           "desc" : "(optional) The scope (this object) for the fn",
 729           "isOptional" : false
 730         }
 731       ],
 732       "returns" : []
 733     },
 734     {
 735       "name" : "addListener",
 736       "desc" : "Appends an event handler to this component",
 737       "isStatic" : false,
 738       "isConstructor" : false,
 739       "isPrivate" : false,
 740       "memberOf" : "Roo.util.Observable",
 741       "example" : "",
 742       "deprecated" : "",
 743       "since" : "",
 744       "see" : "",
 745       "params" : [
 746         {
 747           "name" : "eventName",
 748           "type" : "String",
 749           "desc" : "The type of event to listen for",
 750           "isOptional" : false
 751         },
 752         {
 753           "name" : "handler",
 754           "type" : "Function",
 755           "desc" : "The method the event invokes",
 756           "isOptional" : false
 757         },
 758         {
 759           "name" : "scope",
 760           "type" : "Object",
 761           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 762           "isOptional" : false
 763         },
 764         {
 765           "name" : "options",
 766           "type" : "Object",
 767           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 768           "isOptional" : false
 769         }
 770       ],
 771       "returns" : []
 772     }
 773   ],
 774   "events" : [
 775     {
 776       "name" : "deactivate",
 777       "desc" : "Fires when this panel is activated.",
 778       "memberOf" : "Roo.ContentPanel",
 779       "example" : "",
 780       "deprecated" : "",
 781       "since" : "",
 782       "see" : "",
 783       "params" : [
 784         {
 785           "name" : "this",
 786           "type" : "Roo.ContentPanel",
 787           "desc" : "",
 788           "isOptional" : false
 789         }
 790       ],
 791       "returns" : []
 792     },
 793     {
 794       "name" : "resize",
 795       "desc" : "Fires when this panel is resized if fitToFrame is true.",
 796       "memberOf" : "Roo.ContentPanel",
 797       "example" : "",
 798       "deprecated" : "",
 799       "since" : "",
 800       "see" : "",
 801       "params" : [
 802         {
 803           "name" : "this",
 804           "type" : "Roo.ContentPanel",
 805           "desc" : "",
 806           "isOptional" : false
 807         },
 808         {
 809           "name" : "width",
 810           "type" : "Number",
 811           "desc" : "The width after any component adjustments",
 812           "isOptional" : false
 813         },
 814         {
 815           "name" : "height",
 816           "type" : "Number",
 817           "desc" : "The height after any component adjustments",
 818           "isOptional" : false
 819         }
 820       ],
 821       "returns" : []
 822     },
 823     {
 824       "name" : "render",
 825       "desc" : "Fires when this tab is created",
 826       "memberOf" : "Roo.ContentPanel",
 827       "example" : "",
 828       "deprecated" : "",
 829       "since" : "",
 830       "see" : "",
 831       "params" : [
 832         {
 833           "name" : "this",
 834           "type" : "Roo.ContentPanel",
 835           "desc" : "",
 836           "isOptional" : false
 837         }
 838       ],
 839       "returns" : []
 840     },
 841     {
 842       "name" : "activate",
 843       "desc" : "Fires when this panel is activated.",
 844       "memberOf" : "Roo.ContentPanel",
 845       "example" : "",
 846       "deprecated" : "",
 847       "since" : "",
 848       "see" : "",
 849       "params" : [
 850         {
 851           "name" : "this",
 852           "type" : "Roo.ContentPanel",
 853           "desc" : "",
 854           "isOptional" : false
 855         }
 856       ],
 857       "returns" : []
 858     }
 859   ]
 860 }