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

   1 {
   2   "name" : "Roo.Button",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : [
   7     "Roo.Toolbar.SplitButton",
   8     "Roo.SplitButton",
   9     "Roo.Toolbar.Button"
  10   ],
  11   "desc" : "Simple Button class",
  12   "isSingleton" : false,
  13   "isStatic" : false,
  14   "isBuiltin" : false,
  15   "memberOf" : "Button",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "config",
  23       "type" : "Object",
  24       "desc" : "The config object",
  25       "isOptional" : false
  26     }
  27   ],
  28   "returns" : [],
  29   "throws" : "",
  30   "requires" : "",
  31   "config" : [
  32     {
  33       "name" : "listeners",
  34       "type" : "Object",
  35       "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>",
  36       "memberOf" : "Roo.util.Observable"
  37     },
  38     {
  39       "name" : "tooltip",
  40       "type" : "String/Object",
  41       "desc" : "The tooltip for the button - can be a string or QuickTips config object",
  42       "memberOf" : ""
  43     },
  44     {
  45       "name" : "text",
  46       "type" : "String",
  47       "desc" : "The button text",
  48       "memberOf" : ""
  49     },
  50     {
  51       "name" : "renderTo",
  52       "type" : "String/HTMLElement/Element",
  53       "desc" : "The element to append the button to",
  54       "memberOf" : ""
  55     },
  56     {
  57       "name" : "hidden",
  58       "type" : "Boolean",
  59       "desc" : "True to start hidden (defaults to false)",
  60       "memberOf" : ""
  61     },
  62     {
  63       "name" : "toggleGroup",
  64       "type" : "String",
  65       "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n   applies if enableToggle = true)",
  66       "memberOf" : ""
  67     },
  68     {
  69       "name" : "handleMouseEvents",
  70       "type" : "Boolean",
  71       "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
  72       "memberOf" : ""
  73     },
  74     {
  75       "name" : "menu",
  76       "type" : "Roo.menu.Menu",
  77       "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
  78       "memberOf" : ""
  79     },
  80     {
  81       "name" : "enableToggle",
  82       "type" : "Boolean",
  83       "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
  84       "memberOf" : ""
  85     },
  86     {
  87       "name" : "handler",
  88       "type" : "Function",
  89       "desc" : "A function called when the button is clicked (can be used instead of click event)",
  90       "memberOf" : ""
  91     },
  92     {
  93       "name" : "scope",
  94       "type" : "Object",
  95       "desc" : "The scope of the handler",
  96       "memberOf" : ""
  97     },
  98     {
  99       "name" : "minWidth",
 100       "type" : "Number",
 101       "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
 102       "memberOf" : ""
 103     },
 104     {
 105       "name" : "disabled",
 106       "type" : "Boolean",
 107       "desc" : "True to start disabled (defaults to false)",
 108       "memberOf" : ""
 109     },
 110     {
 111       "name" : "pressed",
 112       "type" : "Boolean",
 113       "desc" : "True to start pressed (only if enableToggle = true)",
 114       "memberOf" : ""
 115     },
 116     {
 117       "name" : "template",
 118       "type" : "Roo.Template",
 119       "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
 120       "memberOf" : ""
 121     },
 122     {
 123       "name" : "cls",
 124       "type" : "String",
 125       "desc" : "A CSS class to apply to the button's main element.",
 126       "memberOf" : ""
 127     },
 128     {
 129       "name" : "tabIndex",
 130       "type" : "Number",
 131       "desc" : "The DOM tabIndex for this button (defaults to undefined)",
 132       "memberOf" : ""
 133     },
 134     {
 135       "name" : "iconCls",
 136       "type" : "String",
 137       "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
 138       "memberOf" : ""
 139     },
 140     {
 141       "name" : "menuAlign",
 142       "type" : "String",
 143       "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
 144       "memberOf" : ""
 145     },
 146     {
 147       "name" : "icon",
 148       "type" : "String",
 149       "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
 150       "memberOf" : ""
 151     },
 152     {
 153       "name" : "tooltipType",
 154       "type" : "String",
 155       "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
 156       "memberOf" : ""
 157     },
 158     {
 159       "name" : "clickEvent",
 160       "type" : "String",
 161       "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
 162       "memberOf" : ""
 163     },
 164     {
 165       "name" : "repeat",
 166       "type" : "Boolean/Object",
 167       "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n  an {@link Roo.util.ClickRepeater} config object (defaults to false).",
 168       "memberOf" : ""
 169     },
 170     {
 171       "name" : "type",
 172       "type" : "String",
 173       "desc" : "The button's type, corresponding to the DOM input element type attribute.  Either \"submit,\" \"reset\" or \"button\" (default).",
 174       "memberOf" : ""
 175     }
 176   ],
 177   "methods" : [
 178     {
 179       "name" : "show",
 180       "type" : "function",
 181       "desc" : "Show this button",
 182       "sig" : "()\n{\n\n}",
 183       "static" : false,
 184       "memberOf" : "",
 185       "isStatic" : false,
 186       "isConstructor" : false,
 187       "isPrivate" : false,
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "exceptions" : "",
 193       "requires" : "",
 194       "params" : [],
 195       "returns" : []
 196     },
 197     {
 198       "name" : "focus",
 199       "type" : "function",
 200       "desc" : "Focus the button",
 201       "sig" : "()\n{\n\n}",
 202       "static" : false,
 203       "memberOf" : "",
 204       "isStatic" : false,
 205       "isConstructor" : false,
 206       "isPrivate" : false,
 207       "example" : "",
 208       "deprecated" : "",
 209       "since" : "",
 210       "see" : "",
 211       "exceptions" : "",
 212       "requires" : "",
 213       "params" : [],
 214       "returns" : []
 215     },
 216     {
 217       "name" : "setHandler",
 218       "type" : "function",
 219       "desc" : "Assigns this button's click handler",
 220       "sig" : "(handler, scope)",
 221       "static" : false,
 222       "memberOf" : "",
 223       "isStatic" : false,
 224       "isConstructor" : false,
 225       "isPrivate" : false,
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "exceptions" : "",
 231       "requires" : "",
 232       "params" : [
 233         {
 234           "name" : "handler",
 235           "type" : "Function",
 236           "desc" : "The function to call when the button is clicked",
 237           "isOptional" : false
 238         },
 239         {
 240           "name" : "scope",
 241           "type" : "Object",
 242           "desc" : "(optional) Scope for the function passed in",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : []
 247     },
 248     {
 249       "name" : "disable",
 250       "type" : "function",
 251       "desc" : "Disable this button",
 252       "sig" : "()\n{\n\n}",
 253       "static" : false,
 254       "memberOf" : "",
 255       "isStatic" : false,
 256       "isConstructor" : false,
 257       "isPrivate" : false,
 258       "example" : "",
 259       "deprecated" : "",
 260       "since" : "",
 261       "see" : "",
 262       "exceptions" : "",
 263       "requires" : "",
 264       "params" : [],
 265       "returns" : []
 266     },
 267     {
 268       "name" : "enable",
 269       "type" : "function",
 270       "desc" : "Enable this button",
 271       "sig" : "()\n{\n\n}",
 272       "static" : false,
 273       "memberOf" : "",
 274       "isStatic" : false,
 275       "isConstructor" : false,
 276       "isPrivate" : false,
 277       "example" : "",
 278       "deprecated" : "",
 279       "since" : "",
 280       "see" : "",
 281       "exceptions" : "",
 282       "requires" : "",
 283       "params" : [],
 284       "returns" : []
 285     },
 286     {
 287       "name" : "getEl",
 288       "type" : "function",
 289       "desc" : "Returns the button's underlying element",
 290       "sig" : "()\n{\n\n}",
 291       "static" : false,
 292       "memberOf" : "",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "example" : "",
 297       "deprecated" : "",
 298       "since" : "",
 299       "see" : "",
 300       "exceptions" : "",
 301       "requires" : "",
 302       "params" : [],
 303       "returns" : [
 304         {
 305           "name" : "",
 306           "type" : "Roo.Element",
 307           "desc" : "The element"
 308         }
 309       ]
 310     },
 311     {
 312       "name" : "setDisabled",
 313       "type" : "function",
 314       "desc" : "Convenience function for boolean enable/disable",
 315       "sig" : "(enabled)",
 316       "static" : false,
 317       "memberOf" : "",
 318       "isStatic" : false,
 319       "isConstructor" : false,
 320       "isPrivate" : false,
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "exceptions" : "",
 326       "requires" : "",
 327       "params" : [
 328         {
 329           "name" : "enabled",
 330           "type" : "Boolean",
 331           "desc" : "True to enable, false to disable",
 332           "isOptional" : false
 333         }
 334       ],
 335       "returns" : []
 336     },
 337     {
 338       "name" : "setVisible",
 339       "type" : "function",
 340       "desc" : "Convenience function for boolean show/hide",
 341       "sig" : "(visible)",
 342       "static" : false,
 343       "memberOf" : "",
 344       "isStatic" : false,
 345       "isConstructor" : false,
 346       "isPrivate" : false,
 347       "example" : "",
 348       "deprecated" : "",
 349       "since" : "",
 350       "see" : "",
 351       "exceptions" : "",
 352       "requires" : "",
 353       "params" : [
 354         {
 355           "name" : "visible",
 356           "type" : "Boolean",
 357           "desc" : "True to show, false to hide",
 358           "isOptional" : false
 359         }
 360       ],
 361       "returns" : []
 362     },
 363     {
 364       "name" : "destroy",
 365       "type" : "function",
 366       "desc" : "Destroys this Button and removes any listeners.",
 367       "sig" : "()\n{\n\n}",
 368       "static" : false,
 369       "memberOf" : "",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "example" : "",
 374       "deprecated" : "",
 375       "since" : "",
 376       "see" : "",
 377       "exceptions" : "",
 378       "requires" : "",
 379       "params" : [],
 380       "returns" : []
 381     },
 382     {
 383       "name" : "getText",
 384       "type" : "function",
 385       "desc" : "Gets the text for this button",
 386       "sig" : "()\n{\n\n}",
 387       "static" : false,
 388       "memberOf" : "",
 389       "isStatic" : false,
 390       "isConstructor" : false,
 391       "isPrivate" : false,
 392       "example" : "",
 393       "deprecated" : "",
 394       "since" : "",
 395       "see" : "",
 396       "exceptions" : "",
 397       "requires" : "",
 398       "params" : [],
 399       "returns" : [
 400         {
 401           "name" : "",
 402           "type" : "String",
 403           "desc" : "The button text"
 404         }
 405       ]
 406     },
 407     {
 408       "name" : "setText",
 409       "type" : "function",
 410       "desc" : "Sets this button's text",
 411       "sig" : "(text)",
 412       "static" : false,
 413       "memberOf" : "",
 414       "isStatic" : false,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "exceptions" : "",
 422       "requires" : "",
 423       "params" : [
 424         {
 425           "name" : "text",
 426           "type" : "String",
 427           "desc" : "The button text",
 428           "isOptional" : false
 429         }
 430       ],
 431       "returns" : []
 432     },
 433     {
 434       "name" : "toggle",
 435       "type" : "function",
 436       "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
 437       "sig" : "(state)",
 438       "static" : false,
 439       "memberOf" : "",
 440       "isStatic" : false,
 441       "isConstructor" : false,
 442       "isPrivate" : false,
 443       "example" : "",
 444       "deprecated" : "",
 445       "since" : "",
 446       "see" : "",
 447       "exceptions" : "",
 448       "requires" : "",
 449       "params" : [
 450         {
 451           "name" : "state",
 452           "type" : "Boolean",
 453           "desc" : "(optional) Force a particular state",
 454           "isOptional" : false
 455         }
 456       ],
 457       "returns" : []
 458     },
 459     {
 460       "name" : "hide",
 461       "type" : "function",
 462       "desc" : "Hide this button",
 463       "sig" : "()\n{\n\n}",
 464       "static" : false,
 465       "memberOf" : "",
 466       "isStatic" : false,
 467       "isConstructor" : false,
 468       "isPrivate" : false,
 469       "example" : "",
 470       "deprecated" : "",
 471       "since" : "",
 472       "see" : "",
 473       "exceptions" : "",
 474       "requires" : "",
 475       "params" : [],
 476       "returns" : []
 477     },
 478     {
 479       "name" : "purgeListeners",
 480       "type" : "function",
 481       "desc" : "Removes all listeners for this object",
 482       "sig" : "()\n{\n\n}",
 483       "static" : false,
 484       "memberOf" : "Roo.util.Observable",
 485       "isStatic" : false,
 486       "isConstructor" : false,
 487       "isPrivate" : false,
 488       "example" : "",
 489       "deprecated" : "",
 490       "since" : "",
 491       "see" : "",
 492       "exceptions" : "",
 493       "requires" : "",
 494       "params" : [],
 495       "returns" : []
 496     },
 497     {
 498       "name" : "on",
 499       "type" : "function",
 500       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 501       "sig" : "(eventName, handler, scope, options)",
 502       "static" : false,
 503       "memberOf" : "Roo.util.Observable",
 504       "isStatic" : false,
 505       "isConstructor" : false,
 506       "isPrivate" : false,
 507       "example" : "",
 508       "deprecated" : "",
 509       "since" : "",
 510       "see" : "",
 511       "exceptions" : "",
 512       "requires" : "",
 513       "params" : [
 514         {
 515           "name" : "eventName",
 516           "type" : "String",
 517           "desc" : "The type of event to listen for",
 518           "isOptional" : false
 519         },
 520         {
 521           "name" : "handler",
 522           "type" : "Function",
 523           "desc" : "The method the event invokes",
 524           "isOptional" : false
 525         },
 526         {
 527           "name" : "scope",
 528           "type" : "Object",
 529           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 530           "isOptional" : false
 531         },
 532         {
 533           "name" : "options",
 534           "type" : "Object",
 535           "desc" : "(optional)",
 536           "isOptional" : false
 537         }
 538       ],
 539       "returns" : []
 540     },
 541     {
 542       "name" : "un",
 543       "type" : "function",
 544       "desc" : "Removes a listener (shorthand for removeListener)",
 545       "sig" : "(eventName, handler, scope)",
 546       "static" : false,
 547       "memberOf" : "Roo.util.Observable",
 548       "isStatic" : false,
 549       "isConstructor" : false,
 550       "isPrivate" : false,
 551       "example" : "",
 552       "deprecated" : "",
 553       "since" : "",
 554       "see" : "",
 555       "exceptions" : "",
 556       "requires" : "",
 557       "params" : [
 558         {
 559           "name" : "eventName",
 560           "type" : "String",
 561           "desc" : "The type of event to listen for",
 562           "isOptional" : false
 563         },
 564         {
 565           "name" : "handler",
 566           "type" : "Function",
 567           "desc" : "The handler to remove",
 568           "isOptional" : false
 569         },
 570         {
 571           "name" : "scope",
 572           "type" : "Object",
 573           "desc" : "(optional) The scope (this object) for the handler",
 574           "isOptional" : false
 575         }
 576       ],
 577       "returns" : []
 578     },
 579     {
 580       "name" : "addEvents",
 581       "type" : "function",
 582       "desc" : "Used to define events on this Observable",
 583       "sig" : "(object)",
 584       "static" : false,
 585       "memberOf" : "Roo.util.Observable",
 586       "isStatic" : false,
 587       "isConstructor" : false,
 588       "isPrivate" : false,
 589       "example" : "",
 590       "deprecated" : "",
 591       "since" : "",
 592       "see" : "",
 593       "exceptions" : "",
 594       "requires" : "",
 595       "params" : [
 596         {
 597           "name" : "object",
 598           "type" : "Object",
 599           "desc" : "The object with the events defined",
 600           "isOptional" : false
 601         }
 602       ],
 603       "returns" : []
 604     },
 605     {
 606       "name" : "releaseCapture",
 607       "type" : "function",
 608       "desc" : "Removes <b>all</b> added captures from the Observable.",
 609       "sig" : "(o)",
 610       "static" : true,
 611       "memberOf" : "Roo.util.Observable",
 612       "isStatic" : true,
 613       "isConstructor" : false,
 614       "isPrivate" : false,
 615       "example" : "",
 616       "deprecated" : "",
 617       "since" : "",
 618       "see" : "",
 619       "exceptions" : "",
 620       "requires" : "",
 621       "params" : [
 622         {
 623           "name" : "o",
 624           "type" : "Observable",
 625           "desc" : "The Observable to release",
 626           "isOptional" : false
 627         }
 628       ],
 629       "returns" : []
 630     },
 631     {
 632       "name" : "removeListener",
 633       "type" : "function",
 634       "desc" : "Removes a listener",
 635       "sig" : "(eventName, handler, scope)",
 636       "static" : false,
 637       "memberOf" : "Roo.util.Observable",
 638       "isStatic" : false,
 639       "isConstructor" : false,
 640       "isPrivate" : false,
 641       "example" : "",
 642       "deprecated" : "",
 643       "since" : "",
 644       "see" : "",
 645       "exceptions" : "",
 646       "requires" : "",
 647       "params" : [
 648         {
 649           "name" : "eventName",
 650           "type" : "String",
 651           "desc" : "The type of event to listen for",
 652           "isOptional" : false
 653         },
 654         {
 655           "name" : "handler",
 656           "type" : "Function",
 657           "desc" : "The handler to remove",
 658           "isOptional" : false
 659         },
 660         {
 661           "name" : "scope",
 662           "type" : "Object",
 663           "desc" : "(optional) The scope (this object) for the handler",
 664           "isOptional" : false
 665         }
 666       ],
 667       "returns" : []
 668     },
 669     {
 670       "name" : "fireEvent",
 671       "type" : "function",
 672       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 673       "sig" : "(eventName, args)",
 674       "static" : false,
 675       "memberOf" : "Roo.util.Observable",
 676       "isStatic" : false,
 677       "isConstructor" : false,
 678       "isPrivate" : false,
 679       "example" : "",
 680       "deprecated" : "",
 681       "since" : "",
 682       "see" : "",
 683       "exceptions" : "",
 684       "requires" : "",
 685       "params" : [
 686         {
 687           "name" : "eventName",
 688           "type" : "String",
 689           "desc" : "",
 690           "isOptional" : false
 691         },
 692         {
 693           "name" : "args",
 694           "type" : "Object...",
 695           "desc" : "Variable number of parameters are passed to handlers",
 696           "isOptional" : false
 697         }
 698       ],
 699       "returns" : [
 700         {
 701           "name" : "",
 702           "type" : "Boolean",
 703           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 704         }
 705       ]
 706     },
 707     {
 708       "name" : "hasListener",
 709       "type" : "function",
 710       "desc" : "Checks to see if this object has any listeners for a specified event",
 711       "sig" : "(eventName)",
 712       "static" : false,
 713       "memberOf" : "Roo.util.Observable",
 714       "isStatic" : false,
 715       "isConstructor" : false,
 716       "isPrivate" : false,
 717       "example" : "",
 718       "deprecated" : "",
 719       "since" : "",
 720       "see" : "",
 721       "exceptions" : "",
 722       "requires" : "",
 723       "params" : [
 724         {
 725           "name" : "eventName",
 726           "type" : "String",
 727           "desc" : "The name of the event to check for",
 728           "isOptional" : false
 729         }
 730       ],
 731       "returns" : [
 732         {
 733           "name" : "",
 734           "type" : "Boolean",
 735           "desc" : "True if the event is being listened for, else false"
 736         }
 737       ]
 738     },
 739     {
 740       "name" : "capture",
 741       "type" : "function",
 742       "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.",
 743       "sig" : "(o, fn, scope)",
 744       "static" : true,
 745       "memberOf" : "Roo.util.Observable",
 746       "isStatic" : true,
 747       "isConstructor" : false,
 748       "isPrivate" : false,
 749       "example" : "",
 750       "deprecated" : "",
 751       "since" : "",
 752       "see" : "",
 753       "exceptions" : "",
 754       "requires" : "",
 755       "params" : [
 756         {
 757           "name" : "o",
 758           "type" : "Observable",
 759           "desc" : "The Observable to capture",
 760           "isOptional" : false
 761         },
 762         {
 763           "name" : "fn",
 764           "type" : "Function",
 765           "desc" : "The function to call",
 766           "isOptional" : false
 767         },
 768         {
 769           "name" : "scope",
 770           "type" : "Object",
 771           "desc" : "(optional) The scope (this object) for the fn",
 772           "isOptional" : false
 773         }
 774       ],
 775       "returns" : []
 776     },
 777     {
 778       "name" : "addListener",
 779       "type" : "function",
 780       "desc" : "Appends an event handler to this component",
 781       "sig" : "(eventName, handler, scope, options)",
 782       "static" : false,
 783       "memberOf" : "Roo.util.Observable",
 784       "isStatic" : false,
 785       "isConstructor" : false,
 786       "isPrivate" : false,
 787       "example" : "",
 788       "deprecated" : "",
 789       "since" : "",
 790       "see" : "",
 791       "exceptions" : "",
 792       "requires" : "",
 793       "params" : [
 794         {
 795           "name" : "eventName",
 796           "type" : "String",
 797           "desc" : "The type of event to listen for",
 798           "isOptional" : false
 799         },
 800         {
 801           "name" : "handler",
 802           "type" : "Function",
 803           "desc" : "The method the event invokes",
 804           "isOptional" : false
 805         },
 806         {
 807           "name" : "scope",
 808           "type" : "Object",
 809           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 810           "isOptional" : false
 811         },
 812         {
 813           "name" : "options",
 814           "type" : "Object",
 815           "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>",
 816           "isOptional" : false
 817         }
 818       ],
 819       "returns" : []
 820     }
 821   ],
 822   "events" : [
 823     {
 824       "name" : "render",
 825       "type" : "function",
 826       "desc" : "Fires when the button is rendered",
 827       "sig" : "function (_self)\n{\n\n}",
 828       "memberOf" : "",
 829       "example" : "",
 830       "deprecated" : "",
 831       "since" : "",
 832       "see" : "",
 833       "params" : [
 834         {
 835           "name" : "this",
 836           "type" : "Button",
 837           "desc" : "",
 838           "isOptional" : false
 839         }
 840       ],
 841       "returns" : []
 842     },
 843     {
 844       "name" : "click",
 845       "type" : "function",
 846       "desc" : "Fires when this button is clicked",
 847       "sig" : "function (_self, e)\n{\n\n}",
 848       "memberOf" : "",
 849       "example" : "",
 850       "deprecated" : "",
 851       "since" : "",
 852       "see" : "",
 853       "params" : [
 854         {
 855           "name" : "this",
 856           "type" : "Button",
 857           "desc" : "",
 858           "isOptional" : false
 859         },
 860         {
 861           "name" : "e",
 862           "type" : "EventObject",
 863           "desc" : "The click event",
 864           "isOptional" : false
 865         }
 866       ],
 867       "returns" : []
 868     },
 869     {
 870       "name" : "mouseover",
 871       "type" : "function",
 872       "desc" : "Fires when the mouse hovers over the button",
 873       "sig" : "function (_self, e)\n{\n\n}",
 874       "memberOf" : "",
 875       "example" : "",
 876       "deprecated" : "",
 877       "since" : "",
 878       "see" : "",
 879       "params" : [
 880         {
 881           "name" : "this",
 882           "type" : "Button",
 883           "desc" : "",
 884           "isOptional" : false
 885         },
 886         {
 887           "name" : "e",
 888           "type" : "Event",
 889           "desc" : "The event object",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : []
 894     },
 895     {
 896       "name" : "toggle",
 897       "type" : "function",
 898       "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
 899       "sig" : "function (_self, pressed)\n{\n\n}",
 900       "memberOf" : "",
 901       "example" : "",
 902       "deprecated" : "",
 903       "since" : "",
 904       "see" : "",
 905       "params" : [
 906         {
 907           "name" : "this",
 908           "type" : "Button",
 909           "desc" : "",
 910           "isOptional" : false
 911         },
 912         {
 913           "name" : "pressed",
 914           "type" : "Boolean",
 915           "desc" : "",
 916           "isOptional" : false
 917         }
 918       ],
 919       "returns" : []
 920     },
 921     {
 922       "name" : "mouseout",
 923       "type" : "function",
 924       "desc" : "Fires when the mouse exits the button",
 925       "sig" : "function (_self, e)\n{\n\n}",
 926       "memberOf" : "",
 927       "example" : "",
 928       "deprecated" : "",
 929       "since" : "",
 930       "see" : "",
 931       "params" : [
 932         {
 933           "name" : "this",
 934           "type" : "Button",
 935           "desc" : "",
 936           "isOptional" : false
 937         },
 938         {
 939           "name" : "e",
 940           "type" : "Event",
 941           "desc" : "The event object",
 942           "isOptional" : false
 943         }
 944       ],
 945       "returns" : []
 946     }
 947   ]
 948 }