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

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