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

   1 {
   2   "name" : "Roo.bootstrap.panel.Tabs",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : [],
   7   "desc" : "A lightweight tab container.\n<br><br>\nUsage:\n<pre><code>\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n</code></pre>",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "Tabs",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "container",
  19       "type" : "String/HTMLElement/Roo.Element",
  20       "desc" : "The id, DOM element or Roo.Element container where this TabPanel is to be rendered.",
  21       "isOptional" : false
  22     },
  23     {
  24       "name" : "config",
  25       "type" : "Object/Boolean",
  26       "desc" : "Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.",
  27       "isOptional" : false
  28     }
  29   ],
  30   "returns" : [],
  31   "throws" : "",
  32   "requires" : "",
  33   "config" : [
  34     {
  35       "name" : "listeners",
  36       "type" : "Object",
  37       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  38       "memberOf" : "Roo.util.Observable"
  39     }
  40   ],
  41   "methods" : [
  42     {
  43       "name" : "setTabWidth",
  44       "type" : "function",
  45       "desc" : "Resizes all the tabs to the passed width",
  46       "sig" : "(The)",
  47       "static" : false,
  48       "memberOf" : "",
  49       "isStatic" : false,
  50       "isConstructor" : false,
  51       "isPrivate" : false,
  52       "example" : "",
  53       "deprecated" : "",
  54       "since" : "",
  55       "see" : "",
  56       "exceptions" : "",
  57       "requires" : "",
  58       "params" : [
  59         {
  60           "name" : "The",
  61           "type" : "Number",
  62           "desc" : "new width",
  63           "isOptional" : false
  64         }
  65       ],
  66       "returns" : []
  67     },
  68     {
  69       "name" : "endUpdate",
  70       "type" : "function",
  71       "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
  72       "sig" : "()\n{\n\n}",
  73       "static" : false,
  74       "memberOf" : "",
  75       "isStatic" : false,
  76       "isConstructor" : false,
  77       "isPrivate" : false,
  78       "example" : "",
  79       "deprecated" : "",
  80       "since" : "",
  81       "see" : "",
  82       "exceptions" : "",
  83       "requires" : "",
  84       "params" : [],
  85       "returns" : []
  86     },
  87     {
  88       "name" : "disableTab",
  89       "type" : "function",
  90       "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
  91       "sig" : "(id)",
  92       "static" : false,
  93       "memberOf" : "",
  94       "isStatic" : false,
  95       "isConstructor" : false,
  96       "isPrivate" : false,
  97       "example" : "",
  98       "deprecated" : "",
  99       "since" : "",
 100       "see" : "",
 101       "exceptions" : "",
 102       "requires" : "",
 103       "params" : [
 104         {
 105           "name" : "id",
 106           "type" : "String/Number",
 107           "desc" : "The id or index of the TabPanelItem to disable.",
 108           "isOptional" : false
 109         }
 110       ],
 111       "returns" : []
 112     },
 113     {
 114       "name" : "getTab",
 115       "type" : "function",
 116       "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
 117       "sig" : "(id)",
 118       "static" : false,
 119       "memberOf" : "",
 120       "isStatic" : false,
 121       "isConstructor" : false,
 122       "isPrivate" : false,
 123       "example" : "",
 124       "deprecated" : "",
 125       "since" : "",
 126       "see" : "",
 127       "exceptions" : "",
 128       "requires" : "",
 129       "params" : [
 130         {
 131           "name" : "id",
 132           "type" : "String/Number",
 133           "desc" : "The id or index of the TabPanelItem to fetch.",
 134           "isOptional" : false
 135         }
 136       ],
 137       "returns" : [
 138         {
 139           "name" : "",
 140           "type" : "Roo.TabPanelItem",
 141           "desc" : ""
 142         }
 143       ]
 144     },
 145     {
 146       "name" : "unhideTab",
 147       "type" : "function",
 148       "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
 149       "sig" : "(id)",
 150       "static" : false,
 151       "memberOf" : "",
 152       "isStatic" : false,
 153       "isConstructor" : false,
 154       "isPrivate" : false,
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "exceptions" : "",
 160       "requires" : "",
 161       "params" : [
 162         {
 163           "name" : "id",
 164           "type" : "String/Number",
 165           "desc" : "The id or index of the TabPanelItem to unhide.",
 166           "isOptional" : false
 167         }
 168       ],
 169       "returns" : []
 170     },
 171     {
 172       "name" : "beginUpdate",
 173       "type" : "function",
 174       "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
 175       "sig" : "()\n{\n\n}",
 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       "returns" : []
 189     },
 190     {
 191       "name" : "enableTab",
 192       "type" : "function",
 193       "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
 194       "sig" : "(id)",
 195       "static" : false,
 196       "memberOf" : "",
 197       "isStatic" : false,
 198       "isConstructor" : false,
 199       "isPrivate" : false,
 200       "example" : "",
 201       "deprecated" : "",
 202       "since" : "",
 203       "see" : "",
 204       "exceptions" : "",
 205       "requires" : "",
 206       "params" : [
 207         {
 208           "name" : "id",
 209           "type" : "String/Number",
 210           "desc" : "The id or index of the TabPanelItem to enable.",
 211           "isOptional" : false
 212         }
 213       ],
 214       "returns" : []
 215     },
 216     {
 217       "name" : "getCount",
 218       "type" : "function",
 219       "desc" : "Returns the number of tabs in this TabPanel.",
 220       "sig" : "()\n{\n\n}",
 221       "static" : false,
 222       "memberOf" : "",
 223       "isStatic" : false,
 224       "isConstructor" : false,
 225       "isPrivate" : false,
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "exceptions" : "",
 231       "requires" : "",
 232       "params" : [],
 233       "returns" : [
 234         {
 235           "name" : "",
 236           "type" : "Number",
 237           "desc" : ""
 238         }
 239       ]
 240     },
 241     {
 242       "name" : "destroy",
 243       "type" : "function",
 244       "desc" : "Destroys this TabPanel",
 245       "sig" : "(removeEl)",
 246       "static" : false,
 247       "memberOf" : "",
 248       "isStatic" : false,
 249       "isConstructor" : false,
 250       "isPrivate" : false,
 251       "example" : "",
 252       "deprecated" : "",
 253       "since" : "",
 254       "see" : "",
 255       "exceptions" : "",
 256       "requires" : "",
 257       "params" : [
 258         {
 259           "name" : "removeEl",
 260           "type" : "Boolean",
 261           "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
 262           "isOptional" : false
 263         }
 264       ],
 265       "returns" : []
 266     },
 267     {
 268       "name" : "syncHeight",
 269       "type" : "function",
 270       "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
 271       "sig" : "(targetHeight)",
 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         {
 285           "name" : "targetHeight",
 286           "type" : "Number",
 287           "desc" : "(optional) Override the starting height from the elements height",
 288           "isOptional" : false
 289         }
 290       ],
 291       "returns" : []
 292     },
 293     {
 294       "name" : "activate",
 295       "type" : "function",
 296       "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
 297       "sig" : "(id)",
 298       "static" : false,
 299       "memberOf" : "",
 300       "isStatic" : false,
 301       "isConstructor" : false,
 302       "isPrivate" : false,
 303       "example" : "",
 304       "deprecated" : "",
 305       "since" : "",
 306       "see" : "",
 307       "exceptions" : "",
 308       "requires" : "",
 309       "params" : [
 310         {
 311           "name" : "id",
 312           "type" : "String/Number",
 313           "desc" : "The id or index of the TabPanelItem to activate.",
 314           "isOptional" : false
 315         }
 316       ],
 317       "returns" : [
 318         {
 319           "name" : "",
 320           "type" : "Roo.TabPanelItem",
 321           "desc" : "The TabPanelItem."
 322         }
 323       ]
 324     },
 325     {
 326       "name" : "autoSizeTabs",
 327       "type" : "function",
 328       "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
 329       "sig" : "()\n{\n\n}",
 330       "static" : false,
 331       "memberOf" : "",
 332       "isStatic" : false,
 333       "isConstructor" : false,
 334       "isPrivate" : false,
 335       "example" : "",
 336       "deprecated" : "",
 337       "since" : "",
 338       "see" : "",
 339       "exceptions" : "",
 340       "requires" : "",
 341       "params" : [],
 342       "returns" : []
 343     },
 344     {
 345       "name" : "addTabItem",
 346       "type" : "function",
 347       "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
 348       "sig" : "(item)",
 349       "static" : false,
 350       "memberOf" : "",
 351       "isStatic" : false,
 352       "isConstructor" : false,
 353       "isPrivate" : false,
 354       "example" : "",
 355       "deprecated" : "",
 356       "since" : "",
 357       "see" : "",
 358       "exceptions" : "",
 359       "requires" : "",
 360       "params" : [
 361         {
 362           "name" : "item",
 363           "type" : "Roo.TabPanelItem",
 364           "desc" : "The TabPanelItem to add",
 365           "isOptional" : false
 366         }
 367       ],
 368       "returns" : []
 369     },
 370     {
 371       "name" : "addTab",
 372       "type" : "function",
 373       "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
 374       "sig" : "(id, text, content, closable)",
 375       "static" : false,
 376       "memberOf" : "",
 377       "isStatic" : false,
 378       "isConstructor" : false,
 379       "isPrivate" : false,
 380       "example" : "",
 381       "deprecated" : "",
 382       "since" : "",
 383       "see" : "",
 384       "exceptions" : "",
 385       "requires" : "",
 386       "params" : [
 387         {
 388           "name" : "id",
 389           "type" : "String",
 390           "desc" : "The id of the div to use <b>or create</b>",
 391           "isOptional" : false
 392         },
 393         {
 394           "name" : "text",
 395           "type" : "String",
 396           "desc" : "The text for the tab",
 397           "isOptional" : false
 398         },
 399         {
 400           "name" : "content",
 401           "type" : "String",
 402           "desc" : "(optional) Content to put in the TabPanelItem body",
 403           "isOptional" : false
 404         },
 405         {
 406           "name" : "closable",
 407           "type" : "Boolean",
 408           "desc" : "(optional) True to create a close icon on the tab",
 409           "isOptional" : false
 410         }
 411       ],
 412       "returns" : [
 413         {
 414           "name" : "",
 415           "type" : "Roo.TabPanelItem",
 416           "desc" : "The created TabPanelItem"
 417         }
 418       ]
 419     },
 420     {
 421       "name" : "removeTab",
 422       "type" : "function",
 423       "desc" : "Removes a {@link Roo.TabPanelItem}.",
 424       "sig" : "(id)",
 425       "static" : false,
 426       "memberOf" : "",
 427       "isStatic" : false,
 428       "isConstructor" : false,
 429       "isPrivate" : false,
 430       "example" : "",
 431       "deprecated" : "",
 432       "since" : "",
 433       "see" : "",
 434       "exceptions" : "",
 435       "requires" : "",
 436       "params" : [
 437         {
 438           "name" : "id",
 439           "type" : "String/Number",
 440           "desc" : "The id or index of the TabPanelItem to remove.",
 441           "isOptional" : false
 442         }
 443       ],
 444       "returns" : []
 445     },
 446     {
 447       "name" : "hideTab",
 448       "type" : "function",
 449       "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
 450       "sig" : "(id)",
 451       "static" : false,
 452       "memberOf" : "",
 453       "isStatic" : false,
 454       "isConstructor" : false,
 455       "isPrivate" : false,
 456       "example" : "",
 457       "deprecated" : "",
 458       "since" : "",
 459       "see" : "",
 460       "exceptions" : "",
 461       "requires" : "",
 462       "params" : [
 463         {
 464           "name" : "id",
 465           "type" : "String/Number",
 466           "desc" : "The id or index of the TabPanelItem to hide.",
 467           "isOptional" : false
 468         }
 469       ],
 470       "returns" : []
 471     },
 472     {
 473       "name" : "getActiveTab",
 474       "type" : "function",
 475       "desc" : "Gets the active {@link Roo.TabPanelItem}.",
 476       "sig" : "()\n{\n\n}",
 477       "static" : false,
 478       "memberOf" : "",
 479       "isStatic" : false,
 480       "isConstructor" : false,
 481       "isPrivate" : false,
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "exceptions" : "",
 487       "requires" : "",
 488       "params" : [],
 489       "returns" : [
 490         {
 491           "name" : "",
 492           "type" : "Roo.TabPanelItem",
 493           "desc" : "The active TabPanelItem or null if none are active."
 494         }
 495       ]
 496     },
 497     {
 498       "name" : "purgeListeners",
 499       "type" : "function",
 500       "desc" : "Removes all listeners for this object",
 501       "sig" : "()\n{\n\n}",
 502       "static" : false,
 503       "memberOf" : "Roo.util.Observable",
 504       "isStatic" : false,
 505       "isConstructor" : false,
 506       "isPrivate" : false,
 507       "example" : "",
 508       "deprecated" : "",
 509       "since" : "",
 510       "see" : "",
 511       "exceptions" : "",
 512       "requires" : "",
 513       "params" : [],
 514       "returns" : []
 515     },
 516     {
 517       "name" : "on",
 518       "type" : "function",
 519       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 520       "sig" : "(eventName, handler, scope, options)",
 521       "static" : false,
 522       "memberOf" : "Roo.util.Observable",
 523       "isStatic" : false,
 524       "isConstructor" : false,
 525       "isPrivate" : false,
 526       "example" : "",
 527       "deprecated" : "",
 528       "since" : "",
 529       "see" : "",
 530       "exceptions" : "",
 531       "requires" : "",
 532       "params" : [
 533         {
 534           "name" : "eventName",
 535           "type" : "String",
 536           "desc" : "The type of event to listen for",
 537           "isOptional" : false
 538         },
 539         {
 540           "name" : "handler",
 541           "type" : "Function",
 542           "desc" : "The method the event invokes",
 543           "isOptional" : false
 544         },
 545         {
 546           "name" : "scope",
 547           "type" : "Object",
 548           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 549           "isOptional" : false
 550         },
 551         {
 552           "name" : "options",
 553           "type" : "Object",
 554           "desc" : "(optional)",
 555           "isOptional" : false
 556         }
 557       ],
 558       "returns" : []
 559     },
 560     {
 561       "name" : "un",
 562       "type" : "function",
 563       "desc" : "Removes a listener (shorthand for removeListener)",
 564       "sig" : "(eventName, handler, scope)",
 565       "static" : false,
 566       "memberOf" : "Roo.util.Observable",
 567       "isStatic" : false,
 568       "isConstructor" : false,
 569       "isPrivate" : false,
 570       "example" : "",
 571       "deprecated" : "",
 572       "since" : "",
 573       "see" : "",
 574       "exceptions" : "",
 575       "requires" : "",
 576       "params" : [
 577         {
 578           "name" : "eventName",
 579           "type" : "String",
 580           "desc" : "The type of event to listen for",
 581           "isOptional" : false
 582         },
 583         {
 584           "name" : "handler",
 585           "type" : "Function",
 586           "desc" : "The handler to remove",
 587           "isOptional" : false
 588         },
 589         {
 590           "name" : "scope",
 591           "type" : "Object",
 592           "desc" : "(optional) The scope (this object) for the handler",
 593           "isOptional" : false
 594         }
 595       ],
 596       "returns" : []
 597     },
 598     {
 599       "name" : "addEvents",
 600       "type" : "function",
 601       "desc" : "Used to define events on this Observable",
 602       "sig" : "(object)",
 603       "static" : false,
 604       "memberOf" : "Roo.util.Observable",
 605       "isStatic" : false,
 606       "isConstructor" : false,
 607       "isPrivate" : false,
 608       "example" : "",
 609       "deprecated" : "",
 610       "since" : "",
 611       "see" : "",
 612       "exceptions" : "",
 613       "requires" : "",
 614       "params" : [
 615         {
 616           "name" : "object",
 617           "type" : "Object",
 618           "desc" : "The object with the events defined",
 619           "isOptional" : false
 620         }
 621       ],
 622       "returns" : []
 623     },
 624     {
 625       "name" : "releaseCapture",
 626       "type" : "function",
 627       "desc" : "Removes <b>all</b> added captures from the Observable.",
 628       "sig" : "(o)",
 629       "static" : true,
 630       "memberOf" : "Roo.util.Observable",
 631       "isStatic" : true,
 632       "isConstructor" : false,
 633       "isPrivate" : false,
 634       "example" : "",
 635       "deprecated" : "",
 636       "since" : "",
 637       "see" : "",
 638       "exceptions" : "",
 639       "requires" : "",
 640       "params" : [
 641         {
 642           "name" : "o",
 643           "type" : "Observable",
 644           "desc" : "The Observable to release",
 645           "isOptional" : false
 646         }
 647       ],
 648       "returns" : []
 649     },
 650     {
 651       "name" : "removeListener",
 652       "type" : "function",
 653       "desc" : "Removes a listener",
 654       "sig" : "(eventName, handler, scope)",
 655       "static" : false,
 656       "memberOf" : "Roo.util.Observable",
 657       "isStatic" : false,
 658       "isConstructor" : false,
 659       "isPrivate" : false,
 660       "example" : "",
 661       "deprecated" : "",
 662       "since" : "",
 663       "see" : "",
 664       "exceptions" : "",
 665       "requires" : "",
 666       "params" : [
 667         {
 668           "name" : "eventName",
 669           "type" : "String",
 670           "desc" : "The type of event to listen for",
 671           "isOptional" : false
 672         },
 673         {
 674           "name" : "handler",
 675           "type" : "Function",
 676           "desc" : "The handler to remove",
 677           "isOptional" : false
 678         },
 679         {
 680           "name" : "scope",
 681           "type" : "Object",
 682           "desc" : "(optional) The scope (this object) for the handler",
 683           "isOptional" : false
 684         }
 685       ],
 686       "returns" : []
 687     },
 688     {
 689       "name" : "fireEvent",
 690       "type" : "function",
 691       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 692       "sig" : "(eventName, args)",
 693       "static" : false,
 694       "memberOf" : "Roo.util.Observable",
 695       "isStatic" : false,
 696       "isConstructor" : false,
 697       "isPrivate" : false,
 698       "example" : "",
 699       "deprecated" : "",
 700       "since" : "",
 701       "see" : "",
 702       "exceptions" : "",
 703       "requires" : "",
 704       "params" : [
 705         {
 706           "name" : "eventName",
 707           "type" : "String",
 708           "desc" : "",
 709           "isOptional" : false
 710         },
 711         {
 712           "name" : "args",
 713           "type" : "Object...",
 714           "desc" : "Variable number of parameters are passed to handlers",
 715           "isOptional" : false
 716         }
 717       ],
 718       "returns" : [
 719         {
 720           "name" : "",
 721           "type" : "Boolean",
 722           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 723         }
 724       ]
 725     },
 726     {
 727       "name" : "hasListener",
 728       "type" : "function",
 729       "desc" : "Checks to see if this object has any listeners for a specified event",
 730       "sig" : "(eventName)",
 731       "static" : false,
 732       "memberOf" : "Roo.util.Observable",
 733       "isStatic" : false,
 734       "isConstructor" : false,
 735       "isPrivate" : false,
 736       "example" : "",
 737       "deprecated" : "",
 738       "since" : "",
 739       "see" : "",
 740       "exceptions" : "",
 741       "requires" : "",
 742       "params" : [
 743         {
 744           "name" : "eventName",
 745           "type" : "String",
 746           "desc" : "The name of the event to check for",
 747           "isOptional" : false
 748         }
 749       ],
 750       "returns" : [
 751         {
 752           "name" : "",
 753           "type" : "Boolean",
 754           "desc" : "True if the event is being listened for, else false"
 755         }
 756       ]
 757     },
 758     {
 759       "name" : "capture",
 760       "type" : "function",
 761       "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.",
 762       "sig" : "(o, fn, scope)",
 763       "static" : true,
 764       "memberOf" : "Roo.util.Observable",
 765       "isStatic" : true,
 766       "isConstructor" : false,
 767       "isPrivate" : false,
 768       "example" : "",
 769       "deprecated" : "",
 770       "since" : "",
 771       "see" : "",
 772       "exceptions" : "",
 773       "requires" : "",
 774       "params" : [
 775         {
 776           "name" : "o",
 777           "type" : "Observable",
 778           "desc" : "The Observable to capture",
 779           "isOptional" : false
 780         },
 781         {
 782           "name" : "fn",
 783           "type" : "Function",
 784           "desc" : "The function to call",
 785           "isOptional" : false
 786         },
 787         {
 788           "name" : "scope",
 789           "type" : "Object",
 790           "desc" : "(optional) The scope (this object) for the fn",
 791           "isOptional" : false
 792         }
 793       ],
 794       "returns" : []
 795     },
 796     {
 797       "name" : "addListener",
 798       "type" : "function",
 799       "desc" : "Appends an event handler to this component",
 800       "sig" : "(eventName, handler, scope, options)",
 801       "static" : false,
 802       "memberOf" : "Roo.util.Observable",
 803       "isStatic" : false,
 804       "isConstructor" : false,
 805       "isPrivate" : false,
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "exceptions" : "",
 811       "requires" : "",
 812       "params" : [
 813         {
 814           "name" : "eventName",
 815           "type" : "String",
 816           "desc" : "The type of event to listen for",
 817           "isOptional" : false
 818         },
 819         {
 820           "name" : "handler",
 821           "type" : "Function",
 822           "desc" : "The method the event invokes",
 823           "isOptional" : false
 824         },
 825         {
 826           "name" : "scope",
 827           "type" : "Object",
 828           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 829           "isOptional" : false
 830         },
 831         {
 832           "name" : "options",
 833           "type" : "Object",
 834           "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>",
 835           "isOptional" : false
 836         }
 837       ],
 838       "returns" : []
 839     }
 840   ],
 841   "events" : [
 842     {
 843       "name" : "tabchange",
 844       "type" : "function",
 845       "desc" : "Fires when the active tab changes",
 846       "sig" : "function (_self, activePanel)\n{\n\n}",
 847       "memberOf" : "",
 848       "example" : "",
 849       "deprecated" : "",
 850       "since" : "",
 851       "see" : "",
 852       "params" : [
 853         {
 854           "name" : "this",
 855           "type" : "Roo.TabPanel",
 856           "desc" : "",
 857           "isOptional" : false
 858         },
 859         {
 860           "name" : "activePanel",
 861           "type" : "Roo.TabPanelItem",
 862           "desc" : "The new active tab",
 863           "isOptional" : false
 864         }
 865       ],
 866       "returns" : []
 867     },
 868     {
 869       "name" : "beforetabchange",
 870       "type" : "function",
 871       "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
 872       "sig" : "function (_self, e, tab)\n{\n\n}",
 873       "memberOf" : "",
 874       "example" : "",
 875       "deprecated" : "",
 876       "since" : "",
 877       "see" : "",
 878       "params" : [
 879         {
 880           "name" : "this",
 881           "type" : "Roo.TabPanel",
 882           "desc" : "",
 883           "isOptional" : false
 884         },
 885         {
 886           "name" : "e",
 887           "type" : "Object",
 888           "desc" : "Set cancel to true on this object to cancel the tab change",
 889           "isOptional" : false
 890         },
 891         {
 892           "name" : "tab",
 893           "type" : "Roo.TabPanelItem",
 894           "desc" : "The tab being changed to",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : []
 899     }
 900   ]
 901 }