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

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