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