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