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