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

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