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