sync
[roojs1] / docs / symbols / Roo.bootstrap.BezierSignature.json
1 {
2   "name" : "Roo.bootstrap.BezierSignature",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap BezierSignature class\nThis script refer to:\n   Title: Signature Pad\n   Author: szimek\n   Availability: https://github.com/szimek/signature_pad",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "BezierSignature",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "The config object",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [],
26   "throws" : "",
27   "requires" : "",
28   "config" : [
29     {
30       "name" : "Callback",
31       "type" : "function",
32       "desc" : "when stroke begin.",
33       "memberOf" : ""
34     },
35     {
36       "name" : "listeners",
37       "type" : "Object",
38       "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>",
39       "memberOf" : "Roo.util.Observable"
40     },
41     {
42       "name" : "Radius",
43       "type" : "float|function",
44       "desc" : "of a single dot.",
45       "memberOf" : ""
46     },
47     {
48       "name" : "canvas",
49       "type" : "int",
50       "desc" : "height",
51       "memberOf" : ""
52     },
53     {
54       "name" : "Add",
55       "type" : "integer",
56       "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
57       "memberOf" : ""
58     },
59     {
60       "name" : "tooltip",
61       "type" : "string",
62       "desc" : "Text for the tooltip",
63       "memberOf" : "Roo.bootstrap.Component"
64     },
65     {
66       "name" : "container_method",
67       "type" : "string",
68       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
69       "memberOf" : "Roo.bootstrap.Component"
70     },
71     {
72       "name" : "visibilityEl",
73       "type" : "string|object",
74       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
75       "memberOf" : "Roo.bootstrap.Component"
76     },
77     {
78       "name" : "Weight",
79       "type" : "float",
80       "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
81       "memberOf" : ""
82     },
83     {
84       "name" : "can_build_overlaid",
85       "type" : "Boolean",
86       "desc" : "True if element can be rebuild from a HTML page",
87       "memberOf" : "Roo.bootstrap.Component"
88     },
89     {
90       "name" : "hideMode",
91       "type" : "String",
92       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
93       "memberOf" : "Roo.Component"
94     },
95     {
96       "name" : "style",
97       "type" : "String",
98       "desc" : "any extra css",
99       "memberOf" : "Roo.bootstrap.Component"
100     },
101     {
102       "name" : "allowDomMove",
103       "type" : "Boolean",
104       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
105       "memberOf" : "Roo.Component"
106     },
107     {
108       "name" : "Draw",
109       "type" : "integer",
110       "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
111       "memberOf" : ""
112     },
113     {
114       "name" : "cls",
115       "type" : "String",
116       "desc" : "css class",
117       "memberOf" : "Roo.bootstrap.Component"
118     },
119     {
120       "name" : "Color",
121       "type" : "string",
122       "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
123       "memberOf" : ""
124     },
125     {
126       "name" : "xattr",
127       "type" : "Object",
128       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
129       "memberOf" : "Roo.bootstrap.Component"
130     },
131     {
132       "name" : "actionMode",
133       "type" : "String",
134       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
135       "memberOf" : "Roo.Component"
136     },
137     {
138       "name" : "dataId",
139       "type" : "string",
140       "desc" : "cutomer id",
141       "memberOf" : "Roo.bootstrap.Component"
142     },
143     {
144       "name" : "Minimum",
145       "type" : "float",
146       "desc" : "width of a line. Defaults to 0.5.",
147       "memberOf" : ""
148     },
149     {
150       "name" : "Maximum",
151       "type" : "float",
152       "desc" : "width of a line. Defaults to 2.5.",
153       "memberOf" : ""
154     },
155     {
156       "name" : "name",
157       "type" : "string",
158       "desc" : "Specifies name attribute",
159       "memberOf" : "Roo.bootstrap.Component"
160     },
161     {
162       "name" : "disableClass",
163       "type" : "String",
164       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
165       "memberOf" : "Roo.Component"
166     }
167   ],
168   "methods" : [
169     {
170       "name" : "tooltipEl",
171       "type" : "function",
172       "desc" : "Fetch the element to display the tooltip on.",
173       "sig" : "()\n{\n\n}",
174       "static" : false,
175       "memberOf" : "Roo.bootstrap.Component",
176       "isStatic" : false,
177       "isConstructor" : false,
178       "isPrivate" : false,
179       "example" : "",
180       "deprecated" : "",
181       "since" : "",
182       "see" : "",
183       "exceptions" : "",
184       "requires" : "",
185       "params" : [],
186       "returns" : [
187         {
188           "name" : "",
189           "type" : "Roo.Element",
190           "desc" : "defaults to this.el"
191         }
192       ]
193     },
194     {
195       "name" : "hide",
196       "type" : "function",
197       "desc" : "Hide a component - adds 'hidden' class",
198       "sig" : "()\n{\n\n}",
199       "static" : false,
200       "memberOf" : "Roo.bootstrap.Component",
201       "isStatic" : false,
202       "isConstructor" : false,
203       "isPrivate" : false,
204       "example" : "",
205       "deprecated" : "",
206       "since" : "",
207       "see" : "",
208       "exceptions" : "",
209       "requires" : "",
210       "params" : [],
211       "returns" : []
212     },
213     {
214       "name" : "show",
215       "type" : "function",
216       "desc" : "Show a component - removes 'hidden' class",
217       "sig" : "()\n{\n\n}",
218       "static" : false,
219       "memberOf" : "Roo.bootstrap.Component",
220       "isStatic" : false,
221       "isConstructor" : false,
222       "isPrivate" : false,
223       "example" : "",
224       "deprecated" : "",
225       "since" : "",
226       "see" : "",
227       "exceptions" : "",
228       "requires" : "",
229       "params" : [],
230       "returns" : []
231     },
232     {
233       "name" : "setVisibilityEl",
234       "type" : "function",
235       "desc" : "Set the element that will be used to show or hide",
236       "sig" : "()\n{\n\n}",
237       "static" : false,
238       "memberOf" : "Roo.bootstrap.Component",
239       "isStatic" : false,
240       "isConstructor" : false,
241       "isPrivate" : false,
242       "example" : "",
243       "deprecated" : "",
244       "since" : "",
245       "see" : "",
246       "exceptions" : "",
247       "requires" : "",
248       "params" : [],
249       "returns" : []
250     },
251     {
252       "name" : "getVisibilityEl",
253       "type" : "function",
254       "desc" : "Get the element that will be used to show or hide",
255       "sig" : "()\n{\n\n}",
256       "static" : false,
257       "memberOf" : "Roo.bootstrap.Component",
258       "isStatic" : false,
259       "isConstructor" : false,
260       "isPrivate" : false,
261       "example" : "",
262       "deprecated" : "",
263       "since" : "",
264       "see" : "",
265       "exceptions" : "",
266       "requires" : "",
267       "params" : [],
268       "returns" : []
269     },
270     {
271       "name" : "initEvents",
272       "type" : "function",
273       "desc" : "Initialize Events for the element",
274       "sig" : "()\n{\n\n}",
275       "static" : false,
276       "memberOf" : "Roo.bootstrap.Component",
277       "isStatic" : false,
278       "isConstructor" : false,
279       "isPrivate" : false,
280       "example" : "",
281       "deprecated" : "",
282       "since" : "",
283       "see" : "",
284       "exceptions" : "",
285       "requires" : "",
286       "params" : [],
287       "returns" : []
288     },
289     {
290       "name" : "getChildContainer",
291       "type" : "function",
292       "desc" : "Fetch the element to add children to",
293       "sig" : "()\n{\n\n}",
294       "static" : false,
295       "memberOf" : "Roo.bootstrap.Component",
296       "isStatic" : false,
297       "isConstructor" : false,
298       "isPrivate" : false,
299       "example" : "",
300       "deprecated" : "",
301       "since" : "",
302       "see" : "",
303       "exceptions" : "",
304       "requires" : "",
305       "params" : [],
306       "returns" : [
307         {
308           "name" : "",
309           "type" : "Roo.Element",
310           "desc" : "defaults to this.el"
311         }
312       ]
313     },
314     {
315       "name" : "getId",
316       "type" : "function",
317       "desc" : "Returns the id of this component.",
318       "sig" : "()\n{\n\n}",
319       "static" : false,
320       "memberOf" : "Roo.Component",
321       "isStatic" : false,
322       "isConstructor" : false,
323       "isPrivate" : false,
324       "example" : "",
325       "deprecated" : "",
326       "since" : "",
327       "see" : "",
328       "exceptions" : "",
329       "requires" : "",
330       "params" : [],
331       "returns" : [
332         {
333           "name" : "",
334           "type" : "String",
335           "desc" : ""
336         }
337       ]
338     },
339     {
340       "name" : "render",
341       "type" : "function",
342       "desc" : "If this is a lazy rendering component, render it to its container element.",
343       "sig" : "(container)",
344       "static" : false,
345       "memberOf" : "Roo.Component",
346       "isStatic" : false,
347       "isConstructor" : false,
348       "isPrivate" : false,
349       "example" : "",
350       "deprecated" : "",
351       "since" : "",
352       "see" : "",
353       "exceptions" : "",
354       "requires" : "",
355       "params" : [
356         {
357           "name" : "container",
358           "type" : "String/HTMLElement/Element",
359           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
360           "isOptional" : false
361         }
362       ],
363       "returns" : []
364     },
365     {
366       "name" : "destroy",
367       "type" : "function",
368       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
369       "sig" : "()\n{\n\n}",
370       "static" : false,
371       "memberOf" : "Roo.Component",
372       "isStatic" : false,
373       "isConstructor" : false,
374       "isPrivate" : false,
375       "example" : "",
376       "deprecated" : "",
377       "since" : "",
378       "see" : "",
379       "exceptions" : "",
380       "requires" : "",
381       "params" : [],
382       "returns" : []
383     },
384     {
385       "name" : "isVisible",
386       "type" : "function",
387       "desc" : "Returns true if this component is visible.",
388       "sig" : "()\n{\n\n}",
389       "static" : false,
390       "memberOf" : "Roo.Component",
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" : "setDisabled",
405       "type" : "function",
406       "desc" : "Convenience function for setting disabled/enabled by boolean.",
407       "sig" : "(disabled)",
408       "static" : false,
409       "memberOf" : "Roo.Component",
410       "isStatic" : false,
411       "isConstructor" : false,
412       "isPrivate" : false,
413       "example" : "",
414       "deprecated" : "",
415       "since" : "",
416       "see" : "",
417       "exceptions" : "",
418       "requires" : "",
419       "params" : [
420         {
421           "name" : "disabled",
422           "type" : "Boolean",
423           "desc" : "",
424           "isOptional" : false
425         }
426       ],
427       "returns" : []
428     },
429     {
430       "name" : "focus",
431       "type" : "function",
432       "desc" : "Try to focus this component.",
433       "sig" : "(selectText)",
434       "static" : false,
435       "memberOf" : "Roo.Component",
436       "isStatic" : false,
437       "isConstructor" : false,
438       "isPrivate" : false,
439       "example" : "",
440       "deprecated" : "",
441       "since" : "",
442       "see" : "",
443       "exceptions" : "",
444       "requires" : "",
445       "params" : [
446         {
447           "name" : "selectText",
448           "type" : "Boolean",
449           "desc" : "True to also select the text in this component (if applicable)",
450           "isOptional" : false
451         }
452       ],
453       "returns" : [
454         {
455           "name" : "",
456           "type" : "Roo.Component",
457           "desc" : "this"
458         }
459       ]
460     },
461     {
462       "name" : "enable",
463       "type" : "function",
464       "desc" : "Enable this component.",
465       "sig" : "()\n{\n\n}",
466       "static" : false,
467       "memberOf" : "Roo.Component",
468       "isStatic" : false,
469       "isConstructor" : false,
470       "isPrivate" : false,
471       "example" : "",
472       "deprecated" : "",
473       "since" : "",
474       "see" : "",
475       "exceptions" : "",
476       "requires" : "",
477       "params" : [],
478       "returns" : [
479         {
480           "name" : "",
481           "type" : "Roo.Component",
482           "desc" : "this"
483         }
484       ]
485     },
486     {
487       "name" : "setVisible",
488       "type" : "function",
489       "desc" : "Convenience function to hide or show this component by boolean.",
490       "sig" : "(visible)",
491       "static" : false,
492       "memberOf" : "Roo.Component",
493       "isStatic" : false,
494       "isConstructor" : false,
495       "isPrivate" : false,
496       "example" : "",
497       "deprecated" : "",
498       "since" : "",
499       "see" : "",
500       "exceptions" : "",
501       "requires" : "",
502       "params" : [
503         {
504           "name" : "visible",
505           "type" : "Boolean",
506           "desc" : "True to show, false to hide",
507           "isOptional" : false
508         }
509       ],
510       "returns" : [
511         {
512           "name" : "",
513           "type" : "Roo.Component",
514           "desc" : "this"
515         }
516       ]
517     },
518     {
519       "name" : "disable",
520       "type" : "function",
521       "desc" : "Disable this component.",
522       "sig" : "()\n{\n\n}",
523       "static" : false,
524       "memberOf" : "Roo.Component",
525       "isStatic" : false,
526       "isConstructor" : false,
527       "isPrivate" : false,
528       "example" : "",
529       "deprecated" : "",
530       "since" : "",
531       "see" : "",
532       "exceptions" : "",
533       "requires" : "",
534       "params" : [],
535       "returns" : [
536         {
537           "name" : "",
538           "type" : "Roo.Component",
539           "desc" : "this"
540         }
541       ]
542     },
543     {
544       "name" : "getEl",
545       "type" : "function",
546       "desc" : "Returns the underlying {@link Roo.Element}.",
547       "sig" : "()\n{\n\n}",
548       "static" : false,
549       "memberOf" : "Roo.Component",
550       "isStatic" : false,
551       "isConstructor" : false,
552       "isPrivate" : false,
553       "example" : "",
554       "deprecated" : "",
555       "since" : "",
556       "see" : "",
557       "exceptions" : "",
558       "requires" : "",
559       "params" : [],
560       "returns" : [
561         {
562           "name" : "",
563           "type" : "Roo.Element",
564           "desc" : "The element"
565         }
566       ]
567     },
568     {
569       "name" : "purgeListeners",
570       "type" : "function",
571       "desc" : "Removes all listeners for this object",
572       "sig" : "()\n{\n\n}",
573       "static" : false,
574       "memberOf" : "Roo.util.Observable",
575       "isStatic" : false,
576       "isConstructor" : false,
577       "isPrivate" : false,
578       "example" : "",
579       "deprecated" : "",
580       "since" : "",
581       "see" : "",
582       "exceptions" : "",
583       "requires" : "",
584       "params" : [],
585       "returns" : []
586     },
587     {
588       "name" : "on",
589       "type" : "function",
590       "desc" : "Appends an event handler to this element (shorthand for addListener)",
591       "sig" : "(eventName, handler, scope, options)",
592       "static" : false,
593       "memberOf" : "Roo.util.Observable",
594       "isStatic" : false,
595       "isConstructor" : false,
596       "isPrivate" : false,
597       "example" : "",
598       "deprecated" : "",
599       "since" : "",
600       "see" : "",
601       "exceptions" : "",
602       "requires" : "",
603       "params" : [
604         {
605           "name" : "eventName",
606           "type" : "String",
607           "desc" : "The type of event to listen for",
608           "isOptional" : false
609         },
610         {
611           "name" : "handler",
612           "type" : "Function",
613           "desc" : "The method the event invokes",
614           "isOptional" : false
615         },
616         {
617           "name" : "scope",
618           "type" : "Object",
619           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
620           "isOptional" : false
621         },
622         {
623           "name" : "options",
624           "type" : "Object",
625           "desc" : "(optional)",
626           "isOptional" : false
627         }
628       ],
629       "returns" : []
630     },
631     {
632       "name" : "un",
633       "type" : "function",
634       "desc" : "Removes a listener (shorthand for removeListener)",
635       "sig" : "(eventName, handler, scope)",
636       "static" : false,
637       "memberOf" : "Roo.util.Observable",
638       "isStatic" : false,
639       "isConstructor" : false,
640       "isPrivate" : false,
641       "example" : "",
642       "deprecated" : "",
643       "since" : "",
644       "see" : "",
645       "exceptions" : "",
646       "requires" : "",
647       "params" : [
648         {
649           "name" : "eventName",
650           "type" : "String",
651           "desc" : "The type of event to listen for",
652           "isOptional" : false
653         },
654         {
655           "name" : "handler",
656           "type" : "Function",
657           "desc" : "The handler to remove",
658           "isOptional" : false
659         },
660         {
661           "name" : "scope",
662           "type" : "Object",
663           "desc" : "(optional) The scope (this object) for the handler",
664           "isOptional" : false
665         }
666       ],
667       "returns" : []
668     },
669     {
670       "name" : "addEvents",
671       "type" : "function",
672       "desc" : "Used to define events on this Observable",
673       "sig" : "(object)",
674       "static" : false,
675       "memberOf" : "Roo.util.Observable",
676       "isStatic" : false,
677       "isConstructor" : false,
678       "isPrivate" : false,
679       "example" : "",
680       "deprecated" : "",
681       "since" : "",
682       "see" : "",
683       "exceptions" : "",
684       "requires" : "",
685       "params" : [
686         {
687           "name" : "object",
688           "type" : "Object",
689           "desc" : "The object with the events defined",
690           "isOptional" : false
691         }
692       ],
693       "returns" : []
694     },
695     {
696       "name" : "releaseCapture",
697       "type" : "function",
698       "desc" : "Removes <b>all</b> added captures from the Observable.",
699       "sig" : "(o)",
700       "static" : true,
701       "memberOf" : "Roo.util.Observable",
702       "isStatic" : true,
703       "isConstructor" : false,
704       "isPrivate" : false,
705       "example" : "",
706       "deprecated" : "",
707       "since" : "",
708       "see" : "",
709       "exceptions" : "",
710       "requires" : "",
711       "params" : [
712         {
713           "name" : "o",
714           "type" : "Observable",
715           "desc" : "The Observable to release",
716           "isOptional" : false
717         }
718       ],
719       "returns" : []
720     },
721     {
722       "name" : "removeListener",
723       "type" : "function",
724       "desc" : "Removes a listener",
725       "sig" : "(eventName, handler, scope)",
726       "static" : false,
727       "memberOf" : "Roo.util.Observable",
728       "isStatic" : false,
729       "isConstructor" : false,
730       "isPrivate" : false,
731       "example" : "",
732       "deprecated" : "",
733       "since" : "",
734       "see" : "",
735       "exceptions" : "",
736       "requires" : "",
737       "params" : [
738         {
739           "name" : "eventName",
740           "type" : "String",
741           "desc" : "The type of event to listen for",
742           "isOptional" : false
743         },
744         {
745           "name" : "handler",
746           "type" : "Function",
747           "desc" : "The handler to remove",
748           "isOptional" : false
749         },
750         {
751           "name" : "scope",
752           "type" : "Object",
753           "desc" : "(optional) The scope (this object) for the handler",
754           "isOptional" : false
755         }
756       ],
757       "returns" : []
758     },
759     {
760       "name" : "fireEvent",
761       "type" : "function",
762       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
763       "sig" : "(eventName, args)",
764       "static" : false,
765       "memberOf" : "Roo.util.Observable",
766       "isStatic" : false,
767       "isConstructor" : false,
768       "isPrivate" : false,
769       "example" : "",
770       "deprecated" : "",
771       "since" : "",
772       "see" : "",
773       "exceptions" : "",
774       "requires" : "",
775       "params" : [
776         {
777           "name" : "eventName",
778           "type" : "String",
779           "desc" : "",
780           "isOptional" : false
781         },
782         {
783           "name" : "args",
784           "type" : "Object...",
785           "desc" : "Variable number of parameters are passed to handlers",
786           "isOptional" : false
787         }
788       ],
789       "returns" : [
790         {
791           "name" : "",
792           "type" : "Boolean",
793           "desc" : "returns false if any of the handlers return false otherwise it returns true"
794         }
795       ]
796     },
797     {
798       "name" : "hasListener",
799       "type" : "function",
800       "desc" : "Checks to see if this object has any listeners for a specified event",
801       "sig" : "(eventName)",
802       "static" : false,
803       "memberOf" : "Roo.util.Observable",
804       "isStatic" : false,
805       "isConstructor" : false,
806       "isPrivate" : false,
807       "example" : "",
808       "deprecated" : "",
809       "since" : "",
810       "see" : "",
811       "exceptions" : "",
812       "requires" : "",
813       "params" : [
814         {
815           "name" : "eventName",
816           "type" : "String",
817           "desc" : "The name of the event to check for",
818           "isOptional" : false
819         }
820       ],
821       "returns" : [
822         {
823           "name" : "",
824           "type" : "Boolean",
825           "desc" : "True if the event is being listened for, else false"
826         }
827       ]
828     },
829     {
830       "name" : "capture",
831       "type" : "function",
832       "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.",
833       "sig" : "(o, fn, scope)",
834       "static" : true,
835       "memberOf" : "Roo.util.Observable",
836       "isStatic" : true,
837       "isConstructor" : false,
838       "isPrivate" : false,
839       "example" : "",
840       "deprecated" : "",
841       "since" : "",
842       "see" : "",
843       "exceptions" : "",
844       "requires" : "",
845       "params" : [
846         {
847           "name" : "o",
848           "type" : "Observable",
849           "desc" : "The Observable to capture",
850           "isOptional" : false
851         },
852         {
853           "name" : "fn",
854           "type" : "Function",
855           "desc" : "The function to call",
856           "isOptional" : false
857         },
858         {
859           "name" : "scope",
860           "type" : "Object",
861           "desc" : "(optional) The scope (this object) for the fn",
862           "isOptional" : false
863         }
864       ],
865       "returns" : []
866     },
867     {
868       "name" : "addListener",
869       "type" : "function",
870       "desc" : "Appends an event handler to this component",
871       "sig" : "(eventName, handler, scope, options)",
872       "static" : false,
873       "memberOf" : "Roo.util.Observable",
874       "isStatic" : false,
875       "isConstructor" : false,
876       "isPrivate" : false,
877       "example" : "",
878       "deprecated" : "",
879       "since" : "",
880       "see" : "",
881       "exceptions" : "",
882       "requires" : "",
883       "params" : [
884         {
885           "name" : "eventName",
886           "type" : "String",
887           "desc" : "The type of event to listen for",
888           "isOptional" : false
889         },
890         {
891           "name" : "handler",
892           "type" : "Function",
893           "desc" : "The method the event invokes",
894           "isOptional" : false
895         },
896         {
897           "name" : "scope",
898           "type" : "Object",
899           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
900           "isOptional" : false
901         },
902         {
903           "name" : "options",
904           "type" : "Object",
905           "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>",
906           "isOptional" : false
907         }
908       ],
909       "returns" : []
910     }
911   ],
912   "events" : [
913     {
914       "name" : "childrenrendered",
915       "type" : "function",
916       "desc" : "Fires when the children have been rendered..",
917       "sig" : "function (_self)\n{\n\n}",
918       "memberOf" : "Roo.bootstrap.Component",
919       "example" : "",
920       "deprecated" : "",
921       "since" : "",
922       "see" : "",
923       "params" : [
924         {
925           "name" : "this",
926           "type" : "Roo.bootstrap.Component",
927           "desc" : "",
928           "isOptional" : false
929         }
930       ],
931       "returns" : []
932     },
933     {
934       "name" : "beforerender",
935       "type" : "function",
936       "desc" : "Fires before the component is rendered. Return false to stop the render.",
937       "sig" : "function (_self)\n{\n\n}",
938       "memberOf" : "Roo.Component",
939       "example" : "",
940       "deprecated" : "",
941       "since" : "",
942       "see" : "",
943       "params" : [
944         {
945           "name" : "this",
946           "type" : "Roo.Component",
947           "desc" : "",
948           "isOptional" : false
949         }
950       ],
951       "returns" : []
952     },
953     {
954       "name" : "disable",
955       "type" : "function",
956       "desc" : "Fires after the component is disabled.",
957       "sig" : "function (_self)\n{\n\n}",
958       "memberOf" : "Roo.Component",
959       "example" : "",
960       "deprecated" : "",
961       "since" : "",
962       "see" : "",
963       "params" : [
964         {
965           "name" : "this",
966           "type" : "Roo.Component",
967           "desc" : "",
968           "isOptional" : false
969         }
970       ],
971       "returns" : []
972     },
973     {
974       "name" : "render",
975       "type" : "function",
976       "desc" : "Fires after the component is rendered.",
977       "sig" : "function (_self)\n{\n\n}",
978       "memberOf" : "Roo.Component",
979       "example" : "",
980       "deprecated" : "",
981       "since" : "",
982       "see" : "",
983       "params" : [
984         {
985           "name" : "this",
986           "type" : "Roo.Component",
987           "desc" : "",
988           "isOptional" : false
989         }
990       ],
991       "returns" : []
992     },
993     {
994       "name" : "destroy",
995       "type" : "function",
996       "desc" : "Fires after the component is destroyed.",
997       "sig" : "function (_self)\n{\n\n}",
998       "memberOf" : "Roo.Component",
999       "example" : "",
1000       "deprecated" : "",
1001       "since" : "",
1002       "see" : "",
1003       "params" : [
1004         {
1005           "name" : "this",
1006           "type" : "Roo.Component",
1007           "desc" : "",
1008           "isOptional" : false
1009         }
1010       ],
1011       "returns" : []
1012     },
1013     {
1014       "name" : "hide",
1015       "type" : "function",
1016       "desc" : "Fires after the component is hidden.",
1017       "sig" : "function (_self)\n{\n\n}",
1018       "memberOf" : "Roo.Component",
1019       "example" : "",
1020       "deprecated" : "",
1021       "since" : "",
1022       "see" : "",
1023       "params" : [
1024         {
1025           "name" : "this",
1026           "type" : "Roo.Component",
1027           "desc" : "",
1028           "isOptional" : false
1029         }
1030       ],
1031       "returns" : []
1032     },
1033     {
1034       "name" : "beforehide",
1035       "type" : "function",
1036       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1037       "sig" : "function (_self)\n{\n\n}",
1038       "memberOf" : "Roo.Component",
1039       "example" : "",
1040       "deprecated" : "",
1041       "since" : "",
1042       "see" : "",
1043       "params" : [
1044         {
1045           "name" : "this",
1046           "type" : "Roo.Component",
1047           "desc" : "",
1048           "isOptional" : false
1049         }
1050       ],
1051       "returns" : []
1052     },
1053     {
1054       "name" : "show",
1055       "type" : "function",
1056       "desc" : "Fires after the component is shown.",
1057       "sig" : "function (_self)\n{\n\n}",
1058       "memberOf" : "Roo.Component",
1059       "example" : "",
1060       "deprecated" : "",
1061       "since" : "",
1062       "see" : "",
1063       "params" : [
1064         {
1065           "name" : "this",
1066           "type" : "Roo.Component",
1067           "desc" : "",
1068           "isOptional" : false
1069         }
1070       ],
1071       "returns" : []
1072     },
1073     {
1074       "name" : "beforeshow",
1075       "type" : "function",
1076       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1077       "sig" : "function (_self)\n{\n\n}",
1078       "memberOf" : "Roo.Component",
1079       "example" : "",
1080       "deprecated" : "",
1081       "since" : "",
1082       "see" : "",
1083       "params" : [
1084         {
1085           "name" : "this",
1086           "type" : "Roo.Component",
1087           "desc" : "",
1088           "isOptional" : false
1089         }
1090       ],
1091       "returns" : []
1092     },
1093     {
1094       "name" : "enable",
1095       "type" : "function",
1096       "desc" : "Fires after the component is enabled.",
1097       "sig" : "function (_self)\n{\n\n}",
1098       "memberOf" : "Roo.Component",
1099       "example" : "",
1100       "deprecated" : "",
1101       "since" : "",
1102       "see" : "",
1103       "params" : [
1104         {
1105           "name" : "this",
1106           "type" : "Roo.Component",
1107           "desc" : "",
1108           "isOptional" : false
1109         }
1110       ],
1111       "returns" : []
1112     },
1113     {
1114       "name" : "beforedestroy",
1115       "type" : "function",
1116       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1117       "sig" : "function (_self)\n{\n\n}",
1118       "memberOf" : "Roo.Component",
1119       "example" : "",
1120       "deprecated" : "",
1121       "since" : "",
1122       "see" : "",
1123       "params" : [
1124         {
1125           "name" : "this",
1126           "type" : "Roo.Component",
1127           "desc" : "",
1128           "isOptional" : false
1129         }
1130       ],
1131       "returns" : []
1132     }
1133   ]
1134 }