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