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

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