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

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