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

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