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