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

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