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

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