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

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