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