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