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