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