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