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