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