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

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