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