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

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