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

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