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