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