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

   1 {
   2   "name" : "Roo.TabPanel",
   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" : "TabPanel",
  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" : "getActiveTab",
  44       "type" : "function",
  45       "desc" : "Gets the active {@link Roo.TabPanelItem}.",
  46       "sig" : "()\n{\n\n}",
  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       "returns" : [
  60         {
  61           "name" : "",
  62           "type" : "Roo.TabPanelItem",
  63           "desc" : "The active TabPanelItem or null if none are active."
  64         }
  65       ]
  66     },
  67     {
  68       "name" : "beginUpdate",
  69       "type" : "function",
  70       "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
  71       "sig" : "()\n{\n\n}",
  72       "static" : false,
  73       "memberOf" : "",
  74       "isStatic" : false,
  75       "isConstructor" : false,
  76       "isPrivate" : false,
  77       "example" : "",
  78       "deprecated" : "",
  79       "since" : "",
  80       "see" : "",
  81       "exceptions" : "",
  82       "requires" : "",
  83       "params" : [],
  84       "returns" : []
  85     },
  86     {
  87       "name" : "unhideTab",
  88       "type" : "function",
  89       "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
  90       "sig" : "(id)",
  91       "static" : false,
  92       "memberOf" : "",
  93       "isStatic" : false,
  94       "isConstructor" : false,
  95       "isPrivate" : false,
  96       "example" : "",
  97       "deprecated" : "",
  98       "since" : "",
  99       "see" : "",
 100       "exceptions" : "",
 101       "requires" : "",
 102       "params" : [
 103         {
 104           "name" : "id",
 105           "type" : "String/Number",
 106           "desc" : "The id or index of the TabPanelItem to unhide.",
 107           "isOptional" : false
 108         }
 109       ],
 110       "returns" : []
 111     },
 112     {
 113       "name" : "enableTab",
 114       "type" : "function",
 115       "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
 116       "sig" : "(id)",
 117       "static" : false,
 118       "memberOf" : "",
 119       "isStatic" : false,
 120       "isConstructor" : false,
 121       "isPrivate" : false,
 122       "example" : "",
 123       "deprecated" : "",
 124       "since" : "",
 125       "see" : "",
 126       "exceptions" : "",
 127       "requires" : "",
 128       "params" : [
 129         {
 130           "name" : "id",
 131           "type" : "String/Number",
 132           "desc" : "The id or index of the TabPanelItem to enable.",
 133           "isOptional" : false
 134         }
 135       ],
 136       "returns" : []
 137     },
 138     {
 139       "name" : "setTabWidth",
 140       "type" : "function",
 141       "desc" : "Resizes all the tabs to the passed width",
 142       "sig" : "(The)",
 143       "static" : false,
 144       "memberOf" : "",
 145       "isStatic" : false,
 146       "isConstructor" : false,
 147       "isPrivate" : false,
 148       "example" : "",
 149       "deprecated" : "",
 150       "since" : "",
 151       "see" : "",
 152       "exceptions" : "",
 153       "requires" : "",
 154       "params" : [
 155         {
 156           "name" : "The",
 157           "type" : "Number",
 158           "desc" : "new width",
 159           "isOptional" : false
 160         }
 161       ],
 162       "returns" : []
 163     },
 164     {
 165       "name" : "endUpdate",
 166       "type" : "function",
 167       "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
 168       "sig" : "()\n{\n\n}",
 169       "static" : false,
 170       "memberOf" : "",
 171       "isStatic" : false,
 172       "isConstructor" : false,
 173       "isPrivate" : false,
 174       "example" : "",
 175       "deprecated" : "",
 176       "since" : "",
 177       "see" : "",
 178       "exceptions" : "",
 179       "requires" : "",
 180       "params" : [],
 181       "returns" : []
 182     },
 183     {
 184       "name" : "addTab",
 185       "type" : "function",
 186       "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.",
 187       "sig" : "(id, text, content, closable)",
 188       "static" : false,
 189       "memberOf" : "",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "example" : "",
 194       "deprecated" : "",
 195       "since" : "",
 196       "see" : "",
 197       "exceptions" : "",
 198       "requires" : "",
 199       "params" : [
 200         {
 201           "name" : "id",
 202           "type" : "String",
 203           "desc" : "The id of the div to use <b>or create</b>",
 204           "isOptional" : false
 205         },
 206         {
 207           "name" : "text",
 208           "type" : "String",
 209           "desc" : "The text for the tab",
 210           "isOptional" : false
 211         },
 212         {
 213           "name" : "content",
 214           "type" : "String",
 215           "desc" : "(optional) Content to put in the TabPanelItem body",
 216           "isOptional" : false
 217         },
 218         {
 219           "name" : "closable",
 220           "type" : "Boolean",
 221           "desc" : "(optional) True to create a close icon on the tab",
 222           "isOptional" : false
 223         }
 224       ],
 225       "returns" : [
 226         {
 227           "name" : "",
 228           "type" : "Roo.TabPanelItem",
 229           "desc" : "The created TabPanelItem"
 230         }
 231       ]
 232     },
 233     {
 234       "name" : "disableTab",
 235       "type" : "function",
 236       "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
 237       "sig" : "(id)",
 238       "static" : false,
 239       "memberOf" : "",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "id",
 252           "type" : "String/Number",
 253           "desc" : "The id or index of the TabPanelItem to disable.",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : []
 258     },
 259     {
 260       "name" : "destroy",
 261       "type" : "function",
 262       "desc" : "Destroys this TabPanel",
 263       "sig" : "(removeEl)",
 264       "static" : false,
 265       "memberOf" : "",
 266       "isStatic" : false,
 267       "isConstructor" : false,
 268       "isPrivate" : false,
 269       "example" : "",
 270       "deprecated" : "",
 271       "since" : "",
 272       "see" : "",
 273       "exceptions" : "",
 274       "requires" : "",
 275       "params" : [
 276         {
 277           "name" : "removeEl",
 278           "type" : "Boolean",
 279           "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
 280           "isOptional" : false
 281         }
 282       ],
 283       "returns" : []
 284     },
 285     {
 286       "name" : "getTab",
 287       "type" : "function",
 288       "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
 289       "sig" : "(id)",
 290       "static" : false,
 291       "memberOf" : "",
 292       "isStatic" : false,
 293       "isConstructor" : false,
 294       "isPrivate" : false,
 295       "example" : "",
 296       "deprecated" : "",
 297       "since" : "",
 298       "see" : "",
 299       "exceptions" : "",
 300       "requires" : "",
 301       "params" : [
 302         {
 303           "name" : "id",
 304           "type" : "String/Number",
 305           "desc" : "The id or index of the TabPanelItem to fetch.",
 306           "isOptional" : false
 307         }
 308       ],
 309       "returns" : [
 310         {
 311           "name" : "",
 312           "type" : "Roo.TabPanelItem",
 313           "desc" : ""
 314         }
 315       ]
 316     },
 317     {
 318       "name" : "getCount",
 319       "type" : "function",
 320       "desc" : "Returns the number of tabs in this TabPanel.",
 321       "sig" : "()\n{\n\n}",
 322       "static" : false,
 323       "memberOf" : "",
 324       "isStatic" : false,
 325       "isConstructor" : false,
 326       "isPrivate" : false,
 327       "example" : "",
 328       "deprecated" : "",
 329       "since" : "",
 330       "see" : "",
 331       "exceptions" : "",
 332       "requires" : "",
 333       "params" : [],
 334       "returns" : [
 335         {
 336           "name" : "",
 337           "type" : "Number",
 338           "desc" : ""
 339         }
 340       ]
 341     },
 342     {
 343       "name" : "autoSizeTabs",
 344       "type" : "function",
 345       "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
 346       "sig" : "()\n{\n\n}",
 347       "static" : false,
 348       "memberOf" : "",
 349       "isStatic" : false,
 350       "isConstructor" : false,
 351       "isPrivate" : false,
 352       "example" : "",
 353       "deprecated" : "",
 354       "since" : "",
 355       "see" : "",
 356       "exceptions" : "",
 357       "requires" : "",
 358       "params" : [],
 359       "returns" : []
 360     },
 361     {
 362       "name" : "removeTab",
 363       "type" : "function",
 364       "desc" : "Removes a {@link Roo.TabPanelItem}.",
 365       "sig" : "(id)",
 366       "static" : false,
 367       "memberOf" : "",
 368       "isStatic" : false,
 369       "isConstructor" : false,
 370       "isPrivate" : false,
 371       "example" : "",
 372       "deprecated" : "",
 373       "since" : "",
 374       "see" : "",
 375       "exceptions" : "",
 376       "requires" : "",
 377       "params" : [
 378         {
 379           "name" : "id",
 380           "type" : "String/Number",
 381           "desc" : "The id or index of the TabPanelItem to remove.",
 382           "isOptional" : false
 383         }
 384       ],
 385       "returns" : []
 386     },
 387     {
 388       "name" : "activate",
 389       "type" : "function",
 390       "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
 391       "sig" : "(id)",
 392       "static" : false,
 393       "memberOf" : "",
 394       "isStatic" : false,
 395       "isConstructor" : false,
 396       "isPrivate" : false,
 397       "example" : "",
 398       "deprecated" : "",
 399       "since" : "",
 400       "see" : "",
 401       "exceptions" : "",
 402       "requires" : "",
 403       "params" : [
 404         {
 405           "name" : "id",
 406           "type" : "String/Number",
 407           "desc" : "The id or index of the TabPanelItem to activate.",
 408           "isOptional" : false
 409         }
 410       ],
 411       "returns" : [
 412         {
 413           "name" : "",
 414           "type" : "Roo.TabPanelItem",
 415           "desc" : "The TabPanelItem."
 416         }
 417       ]
 418     },
 419     {
 420       "name" : "syncHeight",
 421       "type" : "function",
 422       "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
 423       "sig" : "(targetHeight)",
 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         {
 437           "name" : "targetHeight",
 438           "type" : "Number",
 439           "desc" : "(optional) Override the starting height from the elements height",
 440           "isOptional" : false
 441         }
 442       ],
 443       "returns" : []
 444     },
 445     {
 446       "name" : "addTabItem",
 447       "type" : "function",
 448       "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
 449       "sig" : "(item)",
 450       "static" : false,
 451       "memberOf" : "",
 452       "isStatic" : false,
 453       "isConstructor" : false,
 454       "isPrivate" : false,
 455       "example" : "",
 456       "deprecated" : "",
 457       "since" : "",
 458       "see" : "",
 459       "exceptions" : "",
 460       "requires" : "",
 461       "params" : [
 462         {
 463           "name" : "item",
 464           "type" : "Roo.TabPanelItem",
 465           "desc" : "The TabPanelItem to add",
 466           "isOptional" : false
 467         }
 468       ],
 469       "returns" : []
 470     },
 471     {
 472       "name" : "hideTab",
 473       "type" : "function",
 474       "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
 475       "sig" : "(id)",
 476       "static" : false,
 477       "memberOf" : "",
 478       "isStatic" : false,
 479       "isConstructor" : false,
 480       "isPrivate" : false,
 481       "example" : "",
 482       "deprecated" : "",
 483       "since" : "",
 484       "see" : "",
 485       "exceptions" : "",
 486       "requires" : "",
 487       "params" : [
 488         {
 489           "name" : "id",
 490           "type" : "String/Number",
 491           "desc" : "The id or index of the TabPanelItem to hide.",
 492           "isOptional" : false
 493         }
 494       ],
 495       "returns" : []
 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" : "beforetabchange",
 844       "type" : "function",
 845       "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
 846       "sig" : "function (_self, e, tab)\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" : "e",
 861           "type" : "Object",
 862           "desc" : "Set cancel to true on this object to cancel the tab change",
 863           "isOptional" : false
 864         },
 865         {
 866           "name" : "tab",
 867           "type" : "Roo.TabPanelItem",
 868           "desc" : "The tab being changed to",
 869           "isOptional" : false
 870         }
 871       ],
 872       "returns" : []
 873     },
 874     {
 875       "name" : "tabchange",
 876       "type" : "function",
 877       "desc" : "Fires when the active tab changes",
 878       "sig" : "function (_self, activePanel)\n{\n\n}",
 879       "memberOf" : "",
 880       "example" : "",
 881       "deprecated" : "",
 882       "since" : "",
 883       "see" : "",
 884       "params" : [
 885         {
 886           "name" : "this",
 887           "type" : "Roo.TabPanel",
 888           "desc" : "",
 889           "isOptional" : false
 890         },
 891         {
 892           "name" : "activePanel",
 893           "type" : "Roo.TabPanelItem",
 894           "desc" : "The new active tab",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : []
 899     }
 900   ]
 901 }