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