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