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

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