fix docs add optvalues
[roojs1] / docs / symbols / Roo.bootstrap.form.CheckBox.json
1 {
2   "name" : "Roo.bootstrap.form.CheckBox",
3   "augments" : [
4     "Roo.bootstrap.form.Input",
5     "Roo.bootstrap.Component",
6     "Roo.Component",
7     "Roo.util.Observable"
8   ],
9   "childClasses" : {  },
10   "tree_children" : [],
11   "tree_parent" : [],
12   "desc" : "Bootstrap CheckBox class",
13   "isSingleton" : false,
14   "isStatic" : false,
15   "isBuiltin" : false,
16   "isAbstract" : false,
17   "isBuilderTop" : false,
18   "memberOf" : "CheckBox",
19   "example" : "",
20   "deprecated" : "",
21   "since" : "",
22   "see" : "",
23   "params" : [
24     {
25       "name" : "config",
26       "type" : "Object",
27       "desc" : "The config object",
28       "isOptional" : false
29     }
30   ],
31   "returns" : [],
32   "throws" : "",
33   "requires" : "",
34   "config" : [
35     {
36       "name" : "validFeedbackIcon",
37       "type" : "String",
38       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
39       "memberOf" : "Roo.bootstrap.form.Input",
40       "isOptional" : false,
41       "optvalues" : []
42     },
43     {
44       "name" : "lg",
45       "type" : "Number",
46       "desc" : "colspan out of 12 for large computer-sized screens",
47       "memberOf" : "Roo.bootstrap.form.Input",
48       "isOptional" : false,
49       "optvalues" : []
50     },
51     {
52       "name" : "accept",
53       "type" : "String",
54       "desc" : "o) use for file input only. (default empt",
55       "memberOf" : "Roo.bootstrap.form.Input",
56       "isOptional" : false,
57       "optvalues" : [
58         "image",
59         "video",
60         "audio"
61       ]
62     },
63     {
64       "name" : "afterButton",
65       "type" : "Roo.bootstrap.Button",
66       "desc" : "to show before",
67       "memberOf" : "Roo.bootstrap.form.Input",
68       "isOptional" : false,
69       "optvalues" : []
70     },
71     {
72       "name" : "xs",
73       "type" : "Number",
74       "desc" : "colspan out of 12 for mobile-sized screens",
75       "memberOf" : "Roo.bootstrap.form.Input",
76       "isOptional" : false,
77       "optvalues" : []
78     },
79     {
80       "name" : "hideMode",
81       "type" : "String",
82       "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",
83       "memberOf" : "Roo.Component",
84       "isOptional" : false,
85       "optvalues" : [
86         "display",
87         "visibility"
88       ]
89     },
90     {
91       "name" : "disableKeyFilter",
92       "type" : "Boolean",
93       "desc" : "True to disable input keystroke filtering (defaults to false)",
94       "memberOf" : "Roo.bootstrap.form.Input",
95       "isOptional" : false,
96       "optvalues" : []
97     },
98     {
99       "name" : "xattr",
100       "type" : "Object",
101       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
102       "memberOf" : "Roo.bootstrap.Component",
103       "isOptional" : false,
104       "optvalues" : []
105     },
106     {
107       "name" : "disabled",
108       "type" : "Boolean",
109       "desc" : "is it disabled",
110       "memberOf" : "Roo.bootstrap.form.Input",
111       "isOptional" : false,
112       "optvalues" : []
113     },
114     {
115       "name" : "validator",
116       "type" : "Function",
117       "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
118       "memberOf" : "Roo.bootstrap.form.Input",
119       "isOptional" : false,
120       "optvalues" : []
121     },
122     {
123       "name" : "name",
124       "type" : "String",
125       "desc" : "name of the input",
126       "memberOf" : "Roo.bootstrap.form.Input",
127       "isOptional" : false,
128       "optvalues" : []
129     },
130     {
131       "name" : "inputValue",
132       "type" : "String",
133       "desc" : "The value that should go into the generated input element's value when checked.",
134       "memberOf" : "",
135       "isOptional" : false,
136       "optvalues" : []
137     },
138     {
139       "name" : "weight",
140       "type" : "String",
141       "desc" : "s) The text that appears beside the checkb",
142       "memberOf" : "",
143       "isOptional" : false,
144       "optvalues" : [
145         "primary",
146         "warning",
147         "info",
148         "danger",
149         "success"
150       ]
151     },
152     {
153       "name" : "autocomplete",
154       "type" : "String",
155       "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
156       "memberOf" : "Roo.bootstrap.form.Input",
157       "isOptional" : false,
158       "optvalues" : []
159     },
160     {
161       "name" : "tooltip",
162       "type" : "String",
163       "desc" : "label tooltip",
164       "memberOf" : "",
165       "isOptional" : false,
166       "optvalues" : []
167     },
168     {
169       "name" : "labelAlign",
170       "type" : "String",
171       "desc" : "",
172       "memberOf" : "Roo.bootstrap.form.Input",
173       "isOptional" : false,
174       "optvalues" : [
175         "top",
176         "left"
177       ]
178     },
179     {
180       "name" : "regexText",
181       "type" : "String",
182       "desc" : "-- Depricated - use Invalid Text",
183       "memberOf" : "Roo.bootstrap.form.Input",
184       "isOptional" : false,
185       "optvalues" : []
186     },
187     {
188       "name" : "allowDomMove",
189       "type" : "Boolean",
190       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
191       "memberOf" : "Roo.Component",
192       "isOptional" : false,
193       "optvalues" : []
194     },
195     {
196       "name" : "boxLabel",
197       "type" : "String",
198       "desc" : "The text that appears beside the checkbox",
199       "memberOf" : "",
200       "isOptional" : false,
201       "optvalues" : []
202     },
203     {
204       "name" : "style",
205       "type" : "String",
206       "desc" : "any extra css",
207       "memberOf" : "Roo.bootstrap.Component",
208       "isOptional" : false,
209       "optvalues" : []
210     },
211     {
212       "name" : "labelmd",
213       "type" : "Number",
214       "desc" : "set the width of label (1-12)",
215       "memberOf" : "Roo.bootstrap.form.Input",
216       "isOptional" : false,
217       "optvalues" : []
218     },
219     {
220       "name" : "value",
221       "type" : "string",
222       "desc" : "default value of the input",
223       "memberOf" : "Roo.bootstrap.form.Input",
224       "isOptional" : false,
225       "optvalues" : []
226     },
227     {
228       "name" : "hasFeedback",
229       "type" : "Boolean",
230       "desc" : "e) default tr",
231       "memberOf" : "Roo.bootstrap.form.Input",
232       "isOptional" : false,
233       "optvalues" : [
234         "true",
235         "false"
236       ]
237     },
238     {
239       "name" : "actionMode",
240       "type" : "String",
241       "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",
242       "memberOf" : "Roo.Component",
243       "isOptional" : false,
244       "optvalues" : []
245     },
246     {
247       "name" : "sm",
248       "type" : "Number",
249       "desc" : "colspan out of 12 for tablet-sized screens",
250       "memberOf" : "Roo.bootstrap.form.Input",
251       "isOptional" : false,
252       "optvalues" : []
253     },
254     {
255       "name" : "minLengthText",
256       "type" : "String",
257       "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
258       "memberOf" : "Roo.bootstrap.form.Input",
259       "isOptional" : false,
260       "optvalues" : []
261     },
262     {
263       "name" : "maxLengthText",
264       "type" : "String",
265       "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
266       "memberOf" : "Roo.bootstrap.form.Input",
267       "isOptional" : false,
268       "optvalues" : []
269     },
270     {
271       "name" : "groupId",
272       "type" : "String",
273       "desc" : "the checkbox group id // normal just use for checkbox",
274       "memberOf" : "",
275       "isOptional" : false,
276       "optvalues" : []
277     },
278     {
279       "name" : "listeners",
280       "type" : "Object",
281       "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>",
282       "memberOf" : "Roo.util.Observable",
283       "isOptional" : false,
284       "optvalues" : []
285     },
286     {
287       "name" : "container_method",
288       "type" : "string",
289       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
290       "memberOf" : "Roo.bootstrap.Component",
291       "isOptional" : false,
292       "optvalues" : []
293     },
294     {
295       "name" : "readOnly",
296       "type" : "Boolean",
297       "desc" : "Specifies that the field should be read-only",
298       "memberOf" : "Roo.bootstrap.form.Input",
299       "isOptional" : false,
300       "optvalues" : []
301     },
302     {
303       "name" : "indicatorpos",
304       "type" : "String",
305       "desc" : "t) default le",
306       "memberOf" : "Roo.bootstrap.form.Input",
307       "isOptional" : false,
308       "optvalues" : [
309         "left",
310         "right"
311       ]
312     },
313     {
314       "name" : "align",
315       "type" : "String",
316       "desc" : "t) Default le",
317       "memberOf" : "Roo.bootstrap.form.Input",
318       "isOptional" : false,
319       "optvalues" : [
320         "left",
321         "center",
322         "right"
323       ]
324     },
325     {
326       "name" : "checked",
327       "type" : "Boolean",
328       "desc" : "initnal the element",
329       "memberOf" : "",
330       "isOptional" : false,
331       "optvalues" : []
332     },
333     {
334       "name" : "inline",
335       "type" : "Boolean",
336       "desc" : "inline the element (default false)",
337       "memberOf" : "",
338       "isOptional" : false,
339       "optvalues" : []
340     },
341     {
342       "name" : "size",
343       "type" : "string",
344       "desc" : "- (lg|sm) or leave empty..",
345       "memberOf" : "Roo.bootstrap.form.Input",
346       "isOptional" : false,
347       "optvalues" : []
348     },
349     {
350       "name" : "labellg",
351       "type" : "Number",
352       "desc" : "set the width of label (1-12)",
353       "memberOf" : "Roo.bootstrap.form.Input",
354       "isOptional" : false,
355       "optvalues" : []
356     },
357     {
358       "name" : "focusClass",
359       "type" : "String",
360       "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
361       "memberOf" : "Roo.bootstrap.form.Input",
362       "isOptional" : false,
363       "optvalues" : []
364     },
365     {
366       "name" : "labelxs",
367       "type" : "Number",
368       "desc" : "set the width of label (1-12)",
369       "memberOf" : "Roo.bootstrap.form.Input",
370       "isOptional" : false,
371       "optvalues" : []
372     },
373     {
374       "name" : "validateOnBlur",
375       "type" : "Boolean",
376       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
377       "memberOf" : "Roo.bootstrap.form.Input",
378       "isOptional" : false,
379       "optvalues" : []
380     },
381     {
382       "name" : "cls",
383       "type" : "String",
384       "desc" : "css class",
385       "memberOf" : "Roo.bootstrap.Component",
386       "isOptional" : false,
387       "optvalues" : []
388     },
389     {
390       "name" : "inputType",
391       "type" : "String",
392       "desc" : "",
393       "memberOf" : "Roo.bootstrap.form.Input",
394       "isOptional" : false,
395       "optvalues" : [
396         "button",
397         "checkbox",
398         "email",
399         "file",
400         "hidden",
401         "image",
402         "number",
403         "password",
404         "radio",
405         "range",
406         "reset",
407         "search",
408         "submit",
409         "text"
410       ]
411     },
412     {
413       "name" : "validationEvent",
414       "type" : "String/Boolean",
415       "desc" : "The event that should initiate field validation. Set to false to disable\n      automatic validation (defaults to \"keyup\").",
416       "memberOf" : "Roo.bootstrap.form.Input",
417       "isOptional" : false,
418       "optvalues" : []
419     },
420     {
421       "name" : "invalidClass",
422       "type" : "String",
423       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
424       "memberOf" : "Roo.bootstrap.form.Input",
425       "isOptional" : false,
426       "optvalues" : []
427     },
428     {
429       "name" : "maskRe",
430       "type" : "String",
431       "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
432       "memberOf" : "Roo.bootstrap.form.Input",
433       "isOptional" : false,
434       "optvalues" : []
435     },
436     {
437       "name" : "vtype",
438       "type" : "String",
439       "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
440       "memberOf" : "Roo.bootstrap.form.Input",
441       "isOptional" : false,
442       "optvalues" : []
443     },
444     {
445       "name" : "fieldLabel",
446       "type" : "string",
447       "desc" : "- the label associated",
448       "memberOf" : "Roo.bootstrap.form.Input",
449       "isOptional" : false,
450       "optvalues" : []
451     },
452     {
453       "name" : "can_build_overlaid",
454       "type" : "Boolean",
455       "desc" : "True if element can be rebuild from a HTML page",
456       "memberOf" : "Roo.bootstrap.Component",
457       "isOptional" : false,
458       "optvalues" : []
459     },
460     {
461       "name" : "before",
462       "type" : "string",
463       "desc" : "- input group add on before",
464       "memberOf" : "Roo.bootstrap.form.Input",
465       "isOptional" : false,
466       "optvalues" : []
467     },
468     {
469       "name" : "selectOnFocus",
470       "type" : "Boolean",
471       "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
472       "memberOf" : "Roo.bootstrap.form.Input",
473       "isOptional" : false,
474       "optvalues" : []
475     },
476     {
477       "name" : "validationDelay",
478       "type" : "Number",
479       "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
480       "memberOf" : "Roo.bootstrap.form.Input",
481       "isOptional" : false,
482       "optvalues" : []
483     },
484     {
485       "name" : "blankText",
486       "type" : "String",
487       "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
488       "memberOf" : "Roo.bootstrap.form.Input",
489       "isOptional" : false,
490       "optvalues" : []
491     },
492     {
493       "name" : "disableClass",
494       "type" : "String",
495       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
496       "memberOf" : "Roo.Component",
497       "isOptional" : false,
498       "optvalues" : []
499     },
500     {
501       "name" : "invalidFeedbackIcon",
502       "type" : "String",
503       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
504       "memberOf" : "Roo.bootstrap.form.Input",
505       "isOptional" : false,
506       "optvalues" : []
507     },
508     {
509       "name" : "visibilityEl",
510       "type" : "string|object",
511       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
512       "memberOf" : "Roo.bootstrap.Component",
513       "isOptional" : false,
514       "optvalues" : [
515         "el",
516         "parent"
517       ]
518     },
519     {
520       "name" : "placeholder",
521       "type" : "string",
522       "desc" : "- placeholder to put in text.",
523       "memberOf" : "Roo.bootstrap.form.Input",
524       "isOptional" : false,
525       "optvalues" : []
526     },
527     {
528       "name" : "dataId",
529       "type" : "string",
530       "desc" : "cutomer id",
531       "memberOf" : "Roo.bootstrap.Component",
532       "isOptional" : false,
533       "optvalues" : []
534     },
535     {
536       "name" : "md",
537       "type" : "Number",
538       "desc" : "colspan out of 12 for computer-sized screens",
539       "memberOf" : "Roo.bootstrap.form.Input",
540       "isOptional" : false,
541       "optvalues" : []
542     },
543     {
544       "name" : "regex",
545       "type" : "RegExp",
546       "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value.  If the test fails, the field will be marked invalid using {@link #regexText}.",
547       "memberOf" : "Roo.bootstrap.form.Input",
548       "isOptional" : false,
549       "optvalues" : []
550     },
551     {
552       "name" : "labelWidth",
553       "type" : "Number",
554       "desc" : "set the width of label",
555       "memberOf" : "Roo.bootstrap.form.Input",
556       "isOptional" : false,
557       "optvalues" : []
558     },
559     {
560       "name" : "minLength",
561       "type" : "Number",
562       "desc" : "Minimum input field length required (defaults to 0)",
563       "memberOf" : "Roo.bootstrap.form.Input",
564       "isOptional" : false,
565       "optvalues" : []
566     },
567     {
568       "name" : "capture",
569       "type" : "String",
570       "desc" : "a) use for file input only. (default empt",
571       "memberOf" : "Roo.bootstrap.form.Input",
572       "isOptional" : false,
573       "optvalues" : [
574         "user",
575         "camera"
576       ]
577     },
578     {
579       "name" : "validClass",
580       "type" : "String",
581       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
582       "memberOf" : "Roo.bootstrap.form.Input",
583       "isOptional" : false,
584       "optvalues" : []
585     },
586     {
587       "name" : "allowBlank",
588       "type" : "Boolean",
589       "desc" : "False to validate that the value length > 0 (defaults to true)",
590       "memberOf" : "Roo.bootstrap.form.Input",
591       "isOptional" : false,
592       "optvalues" : []
593     },
594     {
595       "name" : "valueOff",
596       "type" : "String",
597       "desc" : "The value that should go into the generated input element's value when unchecked.",
598       "memberOf" : "",
599       "isOptional" : false,
600       "optvalues" : []
601     },
602     {
603       "name" : "preventMark",
604       "type" : "Boolean",
605       "desc" : "Do not show tick or cross if error/success",
606       "memberOf" : "Roo.bootstrap.form.Input",
607       "isOptional" : false,
608       "optvalues" : []
609     },
610     {
611       "name" : "forceFeedback",
612       "type" : "Boolean",
613       "desc" : "e) Default fal",
614       "memberOf" : "Roo.bootstrap.form.Input",
615       "isOptional" : false,
616       "optvalues" : [
617         "true",
618         "false"
619       ]
620     },
621     {
622       "name" : "labelsm",
623       "type" : "Number",
624       "desc" : "set the width of label (1-12)",
625       "memberOf" : "Roo.bootstrap.form.Input",
626       "isOptional" : false,
627       "optvalues" : []
628     },
629     {
630       "name" : "after",
631       "type" : "string",
632       "desc" : "- input group add on after",
633       "memberOf" : "Roo.bootstrap.form.Input",
634       "isOptional" : false,
635       "optvalues" : []
636     },
637     {
638       "name" : "maxLength",
639       "type" : "Number",
640       "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
641       "memberOf" : "Roo.bootstrap.form.Input",
642       "isOptional" : false,
643       "optvalues" : []
644     },
645     {
646       "name" : "invalidText",
647       "type" : "String",
648       "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
649       "memberOf" : "Roo.bootstrap.form.Input",
650       "isOptional" : false,
651       "optvalues" : []
652     }
653   ],
654   "methods" : [
655     {
656       "name" : "markValid",
657       "type" : "function",
658       "desc" : "Mark this field as valid",
659       "sig" : "()\n{\n\n}",
660       "static" : false,
661       "memberOf" : "",
662       "isStatic" : false,
663       "isConstructor" : false,
664       "isPrivate" : false,
665       "example" : "",
666       "deprecated" : "",
667       "since" : "",
668       "see" : "",
669       "exceptions" : "",
670       "requires" : "",
671       "params" : [],
672       "returns" : []
673     },
674     {
675       "name" : "markInvalid",
676       "type" : "function",
677       "desc" : "Mark this field as invalid",
678       "sig" : "(msg)",
679       "static" : false,
680       "memberOf" : "",
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" : "msg",
693           "type" : "String",
694           "desc" : "The validation message",
695           "isOptional" : false
696         }
697       ],
698       "returns" : []
699     },
700     {
701       "name" : "register",
702       "type" : "function",
703       "desc" : "register a CheckBox Group",
704       "sig" : "(the)",
705       "static" : true,
706       "memberOf" : "",
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" : "the",
719           "type" : "Roo.bootstrap.form.CheckBox",
720           "desc" : "CheckBox to add",
721           "isOptional" : false
722         }
723       ],
724       "returns" : []
725     },
726     {
727       "name" : "get",
728       "type" : "function",
729       "desc" : "fetch a CheckBox Group based on the group ID",
730       "sig" : "(the)",
731       "static" : true,
732       "memberOf" : "",
733       "isStatic" : true,
734       "isConstructor" : false,
735       "isPrivate" : false,
736       "example" : "",
737       "deprecated" : "",
738       "since" : "",
739       "see" : "",
740       "exceptions" : "",
741       "requires" : "",
742       "params" : [
743         {
744           "name" : "the",
745           "type" : "string",
746           "desc" : "group ID",
747           "isOptional" : false
748         }
749       ],
750       "returns" : []
751     },
752     {
753       "name" : "inputEl",
754       "type" : "function",
755       "desc" : "return the real input element.",
756       "sig" : "()\n{\n\n}",
757       "static" : false,
758       "memberOf" : "",
759       "isStatic" : false,
760       "isConstructor" : false,
761       "isPrivate" : false,
762       "example" : "",
763       "deprecated" : "",
764       "since" : "",
765       "see" : "",
766       "exceptions" : "",
767       "requires" : "",
768       "params" : [],
769       "returns" : []
770     },
771     {
772       "name" : "setRawValue",
773       "type" : "function",
774       "desc" : "Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.",
775       "sig" : "(value)",
776       "static" : false,
777       "memberOf" : "Roo.bootstrap.form.Input",
778       "isStatic" : false,
779       "isConstructor" : false,
780       "isPrivate" : false,
781       "example" : "",
782       "deprecated" : "",
783       "since" : "",
784       "see" : "",
785       "exceptions" : "",
786       "requires" : "",
787       "params" : [
788         {
789           "name" : "value",
790           "type" : "Mixed",
791           "desc" : "The value to set",
792           "isOptional" : false
793         }
794       ],
795       "returns" : []
796     },
797     {
798       "name" : "getValue",
799       "type" : "function",
800       "desc" : "Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {@link #getRawValue}.",
801       "sig" : "()\n{\n\n}",
802       "static" : false,
803       "memberOf" : "Roo.bootstrap.form.Input",
804       "isStatic" : false,
805       "isConstructor" : false,
806       "isPrivate" : false,
807       "example" : "",
808       "deprecated" : "",
809       "since" : "",
810       "see" : "",
811       "exceptions" : "",
812       "requires" : "",
813       "params" : [],
814       "returns" : [
815         {
816           "name" : "",
817           "type" : "Mixed",
818           "desc" : "value The field value"
819         }
820       ]
821     },
822     {
823       "name" : "getRawValue",
824       "type" : "function",
825       "desc" : "Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.",
826       "sig" : "()\n{\n\n}",
827       "static" : false,
828       "memberOf" : "Roo.bootstrap.form.Input",
829       "isStatic" : false,
830       "isConstructor" : false,
831       "isPrivate" : false,
832       "example" : "",
833       "deprecated" : "",
834       "since" : "",
835       "see" : "",
836       "exceptions" : "",
837       "requires" : "",
838       "params" : [],
839       "returns" : [
840         {
841           "name" : "",
842           "type" : "Mixed",
843           "desc" : "value The field value"
844         }
845       ]
846     },
847     {
848       "name" : "setValue",
849       "type" : "function",
850       "desc" : "Sets a data value into the field and validates it.  To set the value directly without validation see {@link #setRawValue}.",
851       "sig" : "(value)",
852       "static" : false,
853       "memberOf" : "Roo.bootstrap.form.Input",
854       "isStatic" : false,
855       "isConstructor" : false,
856       "isPrivate" : false,
857       "example" : "",
858       "deprecated" : "",
859       "since" : "",
860       "see" : "",
861       "exceptions" : "",
862       "requires" : "",
863       "params" : [
864         {
865           "name" : "value",
866           "type" : "Mixed",
867           "desc" : "The value to set",
868           "isOptional" : false
869         }
870       ],
871       "returns" : []
872     },
873     {
874       "name" : "reset",
875       "type" : "function",
876       "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
877       "sig" : "()\n{\n\n}",
878       "static" : false,
879       "memberOf" : "Roo.bootstrap.form.Input",
880       "isStatic" : false,
881       "isConstructor" : false,
882       "isPrivate" : false,
883       "example" : "",
884       "deprecated" : "",
885       "since" : "",
886       "see" : "",
887       "exceptions" : "",
888       "requires" : "",
889       "params" : [],
890       "returns" : []
891     },
892     {
893       "name" : "validate",
894       "type" : "function",
895       "desc" : "Validates the field value",
896       "sig" : "()\n{\n\n}",
897       "static" : false,
898       "memberOf" : "Roo.bootstrap.form.Input",
899       "isStatic" : false,
900       "isConstructor" : false,
901       "isPrivate" : false,
902       "example" : "",
903       "deprecated" : "",
904       "since" : "",
905       "see" : "",
906       "exceptions" : "",
907       "requires" : "",
908       "params" : [],
909       "returns" : [
910         {
911           "name" : "",
912           "type" : "Boolean",
913           "desc" : "True if the value is valid, else false"
914         }
915       ]
916     },
917     {
918       "name" : "getName",
919       "type" : "function",
920       "desc" : "Returns the name of the field",
921       "sig" : "()\n{\n\n}",
922       "static" : false,
923       "memberOf" : "Roo.bootstrap.form.Input",
924       "isStatic" : false,
925       "isConstructor" : false,
926       "isPrivate" : false,
927       "example" : "",
928       "deprecated" : "",
929       "since" : "",
930       "see" : "",
931       "exceptions" : "",
932       "requires" : "",
933       "params" : [],
934       "returns" : [
935         {
936           "name" : "",
937           "type" : "Mixed",
938           "desc" : "name The name field"
939         }
940       ]
941     },
942     {
943       "name" : "clearInvalid",
944       "type" : "function",
945       "desc" : "Clear any invalid styles/messages for this field",
946       "sig" : "()\n{\n\n}",
947       "static" : false,
948       "memberOf" : "Roo.bootstrap.form.Input",
949       "isStatic" : false,
950       "isConstructor" : false,
951       "isPrivate" : false,
952       "example" : "",
953       "deprecated" : "",
954       "since" : "",
955       "see" : "",
956       "exceptions" : "",
957       "requires" : "",
958       "params" : [],
959       "returns" : []
960     },
961     {
962       "name" : "validateValue",
963       "type" : "function",
964       "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
965       "sig" : "(value)",
966       "static" : false,
967       "memberOf" : "Roo.bootstrap.form.Input",
968       "isStatic" : false,
969       "isConstructor" : false,
970       "isPrivate" : false,
971       "example" : "",
972       "deprecated" : "",
973       "since" : "",
974       "see" : "",
975       "exceptions" : "",
976       "requires" : "",
977       "params" : [
978         {
979           "name" : "value",
980           "type" : "Mixed",
981           "desc" : "The value to validate",
982           "isOptional" : false
983         }
984       ],
985       "returns" : [
986         {
987           "name" : "",
988           "type" : "Boolean",
989           "desc" : "True if the value is valid, else false"
990         }
991       ]
992     },
993     {
994       "name" : "tooltipEl",
995       "type" : "function",
996       "desc" : "Fetch the element to display the tooltip on.",
997       "sig" : "()\n{\n\n}",
998       "static" : false,
999       "memberOf" : "Roo.bootstrap.Component",
1000       "isStatic" : false,
1001       "isConstructor" : false,
1002       "isPrivate" : false,
1003       "example" : "",
1004       "deprecated" : "",
1005       "since" : "",
1006       "see" : "",
1007       "exceptions" : "",
1008       "requires" : "",
1009       "params" : [],
1010       "returns" : [
1011         {
1012           "name" : "",
1013           "type" : "Roo.Element",
1014           "desc" : "defaults to this.el"
1015         }
1016       ]
1017     },
1018     {
1019       "name" : "hide",
1020       "type" : "function",
1021       "desc" : "Hide a component - adds 'hidden' class",
1022       "sig" : "()\n{\n\n}",
1023       "static" : false,
1024       "memberOf" : "Roo.bootstrap.Component",
1025       "isStatic" : false,
1026       "isConstructor" : false,
1027       "isPrivate" : false,
1028       "example" : "",
1029       "deprecated" : "",
1030       "since" : "",
1031       "see" : "",
1032       "exceptions" : "",
1033       "requires" : "",
1034       "params" : [],
1035       "returns" : []
1036     },
1037     {
1038       "name" : "show",
1039       "type" : "function",
1040       "desc" : "Show a component - removes 'hidden' class",
1041       "sig" : "()\n{\n\n}",
1042       "static" : false,
1043       "memberOf" : "Roo.bootstrap.Component",
1044       "isStatic" : false,
1045       "isConstructor" : false,
1046       "isPrivate" : false,
1047       "example" : "",
1048       "deprecated" : "",
1049       "since" : "",
1050       "see" : "",
1051       "exceptions" : "",
1052       "requires" : "",
1053       "params" : [],
1054       "returns" : []
1055     },
1056     {
1057       "name" : "setVisibilityEl",
1058       "type" : "function",
1059       "desc" : "Set the element that will be used to show or hide",
1060       "sig" : "()\n{\n\n}",
1061       "static" : false,
1062       "memberOf" : "Roo.bootstrap.Component",
1063       "isStatic" : false,
1064       "isConstructor" : false,
1065       "isPrivate" : false,
1066       "example" : "",
1067       "deprecated" : "",
1068       "since" : "",
1069       "see" : "",
1070       "exceptions" : "",
1071       "requires" : "",
1072       "params" : [],
1073       "returns" : []
1074     },
1075     {
1076       "name" : "getVisibilityEl",
1077       "type" : "function",
1078       "desc" : "Get the element that will be used to show or hide",
1079       "sig" : "()\n{\n\n}",
1080       "static" : false,
1081       "memberOf" : "Roo.bootstrap.Component",
1082       "isStatic" : false,
1083       "isConstructor" : false,
1084       "isPrivate" : false,
1085       "example" : "",
1086       "deprecated" : "",
1087       "since" : "",
1088       "see" : "",
1089       "exceptions" : "",
1090       "requires" : "",
1091       "params" : [],
1092       "returns" : []
1093     },
1094     {
1095       "name" : "initEvents",
1096       "type" : "function",
1097       "desc" : "Initialize Events for the element",
1098       "sig" : "()\n{\n\n}",
1099       "static" : false,
1100       "memberOf" : "Roo.bootstrap.Component",
1101       "isStatic" : false,
1102       "isConstructor" : false,
1103       "isPrivate" : false,
1104       "example" : "",
1105       "deprecated" : "",
1106       "since" : "",
1107       "see" : "",
1108       "exceptions" : "",
1109       "requires" : "",
1110       "params" : [],
1111       "returns" : []
1112     },
1113     {
1114       "name" : "getChildContainer",
1115       "type" : "function",
1116       "desc" : "Fetch the element to add children to",
1117       "sig" : "()\n{\n\n}",
1118       "static" : false,
1119       "memberOf" : "Roo.bootstrap.Component",
1120       "isStatic" : false,
1121       "isConstructor" : false,
1122       "isPrivate" : false,
1123       "example" : "",
1124       "deprecated" : "",
1125       "since" : "",
1126       "see" : "",
1127       "exceptions" : "",
1128       "requires" : "",
1129       "params" : [],
1130       "returns" : [
1131         {
1132           "name" : "",
1133           "type" : "Roo.Element",
1134           "desc" : "defaults to this.el"
1135         }
1136       ]
1137     },
1138     {
1139       "name" : "getId",
1140       "type" : "function",
1141       "desc" : "Returns the id of this component.",
1142       "sig" : "()\n{\n\n}",
1143       "static" : false,
1144       "memberOf" : "Roo.Component",
1145       "isStatic" : false,
1146       "isConstructor" : false,
1147       "isPrivate" : false,
1148       "example" : "",
1149       "deprecated" : "",
1150       "since" : "",
1151       "see" : "",
1152       "exceptions" : "",
1153       "requires" : "",
1154       "params" : [],
1155       "returns" : [
1156         {
1157           "name" : "",
1158           "type" : "String",
1159           "desc" : ""
1160         }
1161       ]
1162     },
1163     {
1164       "name" : "render",
1165       "type" : "function",
1166       "desc" : "If this is a lazy rendering component, render it to its container element.",
1167       "sig" : "(container)",
1168       "static" : false,
1169       "memberOf" : "Roo.Component",
1170       "isStatic" : false,
1171       "isConstructor" : false,
1172       "isPrivate" : false,
1173       "example" : "",
1174       "deprecated" : "",
1175       "since" : "",
1176       "see" : "",
1177       "exceptions" : "",
1178       "requires" : "",
1179       "params" : [
1180         {
1181           "name" : "container",
1182           "type" : "String/HTMLElement/Element",
1183           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
1184           "isOptional" : false
1185         }
1186       ],
1187       "returns" : []
1188     },
1189     {
1190       "name" : "destroy",
1191       "type" : "function",
1192       "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}.",
1193       "sig" : "()\n{\n\n}",
1194       "static" : false,
1195       "memberOf" : "Roo.Component",
1196       "isStatic" : false,
1197       "isConstructor" : false,
1198       "isPrivate" : false,
1199       "example" : "",
1200       "deprecated" : "",
1201       "since" : "",
1202       "see" : "",
1203       "exceptions" : "",
1204       "requires" : "",
1205       "params" : [],
1206       "returns" : []
1207     },
1208     {
1209       "name" : "isVisible",
1210       "type" : "function",
1211       "desc" : "Returns true if this component is visible.",
1212       "sig" : "()\n{\n\n}",
1213       "static" : false,
1214       "memberOf" : "Roo.Component",
1215       "isStatic" : false,
1216       "isConstructor" : false,
1217       "isPrivate" : false,
1218       "example" : "",
1219       "deprecated" : "",
1220       "since" : "",
1221       "see" : "",
1222       "exceptions" : "",
1223       "requires" : "",
1224       "params" : [],
1225       "returns" : []
1226     },
1227     {
1228       "name" : "setDisabled",
1229       "type" : "function",
1230       "desc" : "Convenience function for setting disabled/enabled by boolean.",
1231       "sig" : "(disabled)",
1232       "static" : false,
1233       "memberOf" : "Roo.Component",
1234       "isStatic" : false,
1235       "isConstructor" : false,
1236       "isPrivate" : false,
1237       "example" : "",
1238       "deprecated" : "",
1239       "since" : "",
1240       "see" : "",
1241       "exceptions" : "",
1242       "requires" : "",
1243       "params" : [
1244         {
1245           "name" : "disabled",
1246           "type" : "Boolean",
1247           "desc" : "",
1248           "isOptional" : false
1249         }
1250       ],
1251       "returns" : []
1252     },
1253     {
1254       "name" : "focus",
1255       "type" : "function",
1256       "desc" : "Try to focus this component.",
1257       "sig" : "(selectText)",
1258       "static" : false,
1259       "memberOf" : "Roo.Component",
1260       "isStatic" : false,
1261       "isConstructor" : false,
1262       "isPrivate" : false,
1263       "example" : "",
1264       "deprecated" : "",
1265       "since" : "",
1266       "see" : "",
1267       "exceptions" : "",
1268       "requires" : "",
1269       "params" : [
1270         {
1271           "name" : "selectText",
1272           "type" : "Boolean",
1273           "desc" : "True to also select the text in this component (if applicable)",
1274           "isOptional" : false
1275         }
1276       ],
1277       "returns" : [
1278         {
1279           "name" : "",
1280           "type" : "Roo.Component",
1281           "desc" : "this"
1282         }
1283       ]
1284     },
1285     {
1286       "name" : "enable",
1287       "type" : "function",
1288       "desc" : "Enable this component.",
1289       "sig" : "()\n{\n\n}",
1290       "static" : false,
1291       "memberOf" : "Roo.Component",
1292       "isStatic" : false,
1293       "isConstructor" : false,
1294       "isPrivate" : false,
1295       "example" : "",
1296       "deprecated" : "",
1297       "since" : "",
1298       "see" : "",
1299       "exceptions" : "",
1300       "requires" : "",
1301       "params" : [],
1302       "returns" : [
1303         {
1304           "name" : "",
1305           "type" : "Roo.Component",
1306           "desc" : "this"
1307         }
1308       ]
1309     },
1310     {
1311       "name" : "setVisible",
1312       "type" : "function",
1313       "desc" : "Convenience function to hide or show this component by boolean.",
1314       "sig" : "(visible)",
1315       "static" : false,
1316       "memberOf" : "Roo.Component",
1317       "isStatic" : false,
1318       "isConstructor" : false,
1319       "isPrivate" : false,
1320       "example" : "",
1321       "deprecated" : "",
1322       "since" : "",
1323       "see" : "",
1324       "exceptions" : "",
1325       "requires" : "",
1326       "params" : [
1327         {
1328           "name" : "visible",
1329           "type" : "Boolean",
1330           "desc" : "True to show, false to hide",
1331           "isOptional" : false
1332         }
1333       ],
1334       "returns" : [
1335         {
1336           "name" : "",
1337           "type" : "Roo.Component",
1338           "desc" : "this"
1339         }
1340       ]
1341     },
1342     {
1343       "name" : "disable",
1344       "type" : "function",
1345       "desc" : "Disable this component.",
1346       "sig" : "()\n{\n\n}",
1347       "static" : false,
1348       "memberOf" : "Roo.Component",
1349       "isStatic" : false,
1350       "isConstructor" : false,
1351       "isPrivate" : false,
1352       "example" : "",
1353       "deprecated" : "",
1354       "since" : "",
1355       "see" : "",
1356       "exceptions" : "",
1357       "requires" : "",
1358       "params" : [],
1359       "returns" : [
1360         {
1361           "name" : "",
1362           "type" : "Roo.Component",
1363           "desc" : "this"
1364         }
1365       ]
1366     },
1367     {
1368       "name" : "getEl",
1369       "type" : "function",
1370       "desc" : "Returns the underlying {@link Roo.Element}.",
1371       "sig" : "()\n{\n\n}",
1372       "static" : false,
1373       "memberOf" : "Roo.Component",
1374       "isStatic" : false,
1375       "isConstructor" : false,
1376       "isPrivate" : false,
1377       "example" : "",
1378       "deprecated" : "",
1379       "since" : "",
1380       "see" : "",
1381       "exceptions" : "",
1382       "requires" : "",
1383       "params" : [],
1384       "returns" : [
1385         {
1386           "name" : "",
1387           "type" : "Roo.Element",
1388           "desc" : "The element"
1389         }
1390       ]
1391     },
1392     {
1393       "name" : "purgeListeners",
1394       "type" : "function",
1395       "desc" : "Removes all listeners for this object",
1396       "sig" : "()\n{\n\n}",
1397       "static" : false,
1398       "memberOf" : "Roo.util.Observable",
1399       "isStatic" : false,
1400       "isConstructor" : false,
1401       "isPrivate" : false,
1402       "example" : "",
1403       "deprecated" : "",
1404       "since" : "",
1405       "see" : "",
1406       "exceptions" : "",
1407       "requires" : "",
1408       "params" : [],
1409       "returns" : []
1410     },
1411     {
1412       "name" : "on",
1413       "type" : "function",
1414       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1415       "sig" : "(eventName, handler, scope, options)",
1416       "static" : false,
1417       "memberOf" : "Roo.util.Observable",
1418       "isStatic" : false,
1419       "isConstructor" : false,
1420       "isPrivate" : false,
1421       "example" : "",
1422       "deprecated" : "",
1423       "since" : "",
1424       "see" : "",
1425       "exceptions" : "",
1426       "requires" : "",
1427       "params" : [
1428         {
1429           "name" : "eventName",
1430           "type" : "String",
1431           "desc" : "The type of event to listen for",
1432           "isOptional" : false
1433         },
1434         {
1435           "name" : "handler",
1436           "type" : "Function",
1437           "desc" : "The method the event invokes",
1438           "isOptional" : false
1439         },
1440         {
1441           "name" : "scope",
1442           "type" : "Object",
1443           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1444           "isOptional" : false
1445         },
1446         {
1447           "name" : "options",
1448           "type" : "Object",
1449           "desc" : "(optional)",
1450           "isOptional" : false
1451         }
1452       ],
1453       "returns" : []
1454     },
1455     {
1456       "name" : "un",
1457       "type" : "function",
1458       "desc" : "Removes a listener (shorthand for removeListener)",
1459       "sig" : "(eventName, handler, scope)",
1460       "static" : false,
1461       "memberOf" : "Roo.util.Observable",
1462       "isStatic" : false,
1463       "isConstructor" : false,
1464       "isPrivate" : false,
1465       "example" : "",
1466       "deprecated" : "",
1467       "since" : "",
1468       "see" : "",
1469       "exceptions" : "",
1470       "requires" : "",
1471       "params" : [
1472         {
1473           "name" : "eventName",
1474           "type" : "String",
1475           "desc" : "The type of event to listen for",
1476           "isOptional" : false
1477         },
1478         {
1479           "name" : "handler",
1480           "type" : "Function",
1481           "desc" : "The handler to remove",
1482           "isOptional" : false
1483         },
1484         {
1485           "name" : "scope",
1486           "type" : "Object",
1487           "desc" : "(optional) The scope (this object) for the handler",
1488           "isOptional" : false
1489         }
1490       ],
1491       "returns" : []
1492     },
1493     {
1494       "name" : "addEvents",
1495       "type" : "function",
1496       "desc" : "Used to define events on this Observable",
1497       "sig" : "(object)",
1498       "static" : false,
1499       "memberOf" : "Roo.util.Observable",
1500       "isStatic" : false,
1501       "isConstructor" : false,
1502       "isPrivate" : false,
1503       "example" : "",
1504       "deprecated" : "",
1505       "since" : "",
1506       "see" : "",
1507       "exceptions" : "",
1508       "requires" : "",
1509       "params" : [
1510         {
1511           "name" : "object",
1512           "type" : "Object",
1513           "desc" : "The object with the events defined",
1514           "isOptional" : false
1515         }
1516       ],
1517       "returns" : []
1518     },
1519     {
1520       "name" : "releaseCapture",
1521       "type" : "function",
1522       "desc" : "Removes <b>all</b> added captures from the Observable.",
1523       "sig" : "(o)",
1524       "static" : true,
1525       "memberOf" : "Roo.util.Observable",
1526       "isStatic" : true,
1527       "isConstructor" : false,
1528       "isPrivate" : false,
1529       "example" : "",
1530       "deprecated" : "",
1531       "since" : "",
1532       "see" : "",
1533       "exceptions" : "",
1534       "requires" : "",
1535       "params" : [
1536         {
1537           "name" : "o",
1538           "type" : "Observable",
1539           "desc" : "The Observable to release",
1540           "isOptional" : false
1541         }
1542       ],
1543       "returns" : []
1544     },
1545     {
1546       "name" : "removeListener",
1547       "type" : "function",
1548       "desc" : "Removes a listener",
1549       "sig" : "(eventName, handler, scope)",
1550       "static" : false,
1551       "memberOf" : "Roo.util.Observable",
1552       "isStatic" : false,
1553       "isConstructor" : false,
1554       "isPrivate" : false,
1555       "example" : "",
1556       "deprecated" : "",
1557       "since" : "",
1558       "see" : "",
1559       "exceptions" : "",
1560       "requires" : "",
1561       "params" : [
1562         {
1563           "name" : "eventName",
1564           "type" : "String",
1565           "desc" : "The type of event to listen for",
1566           "isOptional" : false
1567         },
1568         {
1569           "name" : "handler",
1570           "type" : "Function",
1571           "desc" : "The handler to remove",
1572           "isOptional" : false
1573         },
1574         {
1575           "name" : "scope",
1576           "type" : "Object",
1577           "desc" : "(optional) The scope (this object) for the handler",
1578           "isOptional" : false
1579         }
1580       ],
1581       "returns" : []
1582     },
1583     {
1584       "name" : "fireEvent",
1585       "type" : "function",
1586       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1587       "sig" : "(eventName, args)",
1588       "static" : false,
1589       "memberOf" : "Roo.util.Observable",
1590       "isStatic" : false,
1591       "isConstructor" : false,
1592       "isPrivate" : false,
1593       "example" : "",
1594       "deprecated" : "",
1595       "since" : "",
1596       "see" : "",
1597       "exceptions" : "",
1598       "requires" : "",
1599       "params" : [
1600         {
1601           "name" : "eventName",
1602           "type" : "String",
1603           "desc" : "",
1604           "isOptional" : false
1605         },
1606         {
1607           "name" : "args",
1608           "type" : "Object...",
1609           "desc" : "Variable number of parameters are passed to handlers",
1610           "isOptional" : false
1611         }
1612       ],
1613       "returns" : [
1614         {
1615           "name" : "",
1616           "type" : "Boolean",
1617           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1618         }
1619       ]
1620     },
1621     {
1622       "name" : "hasListener",
1623       "type" : "function",
1624       "desc" : "Checks to see if this object has any listeners for a specified event",
1625       "sig" : "(eventName)",
1626       "static" : false,
1627       "memberOf" : "Roo.util.Observable",
1628       "isStatic" : false,
1629       "isConstructor" : false,
1630       "isPrivate" : false,
1631       "example" : "",
1632       "deprecated" : "",
1633       "since" : "",
1634       "see" : "",
1635       "exceptions" : "",
1636       "requires" : "",
1637       "params" : [
1638         {
1639           "name" : "eventName",
1640           "type" : "String",
1641           "desc" : "The name of the event to check for",
1642           "isOptional" : false
1643         }
1644       ],
1645       "returns" : [
1646         {
1647           "name" : "",
1648           "type" : "Boolean",
1649           "desc" : "True if the event is being listened for, else false"
1650         }
1651       ]
1652     },
1653     {
1654       "name" : "capture",
1655       "type" : "function",
1656       "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.",
1657       "sig" : "(o, fn, scope)",
1658       "static" : true,
1659       "memberOf" : "Roo.util.Observable",
1660       "isStatic" : true,
1661       "isConstructor" : false,
1662       "isPrivate" : false,
1663       "example" : "",
1664       "deprecated" : "",
1665       "since" : "",
1666       "see" : "",
1667       "exceptions" : "",
1668       "requires" : "",
1669       "params" : [
1670         {
1671           "name" : "o",
1672           "type" : "Observable",
1673           "desc" : "The Observable to capture",
1674           "isOptional" : false
1675         },
1676         {
1677           "name" : "fn",
1678           "type" : "Function",
1679           "desc" : "The function to call",
1680           "isOptional" : false
1681         },
1682         {
1683           "name" : "scope",
1684           "type" : "Object",
1685           "desc" : "(optional) The scope (this object) for the fn",
1686           "isOptional" : false
1687         }
1688       ],
1689       "returns" : []
1690     },
1691     {
1692       "name" : "addListener",
1693       "type" : "function",
1694       "desc" : "Appends an event handler to this component",
1695       "sig" : "(eventName, handler, scope, options)",
1696       "static" : false,
1697       "memberOf" : "Roo.util.Observable",
1698       "isStatic" : false,
1699       "isConstructor" : false,
1700       "isPrivate" : false,
1701       "example" : "",
1702       "deprecated" : "",
1703       "since" : "",
1704       "see" : "",
1705       "exceptions" : "",
1706       "requires" : "",
1707       "params" : [
1708         {
1709           "name" : "eventName",
1710           "type" : "String",
1711           "desc" : "The type of event to listen for",
1712           "isOptional" : false
1713         },
1714         {
1715           "name" : "handler",
1716           "type" : "Function",
1717           "desc" : "The method the event invokes",
1718           "isOptional" : false
1719         },
1720         {
1721           "name" : "scope",
1722           "type" : "Object",
1723           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1724           "isOptional" : false
1725         },
1726         {
1727           "name" : "options",
1728           "type" : "Object",
1729           "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>",
1730           "isOptional" : false
1731         }
1732       ],
1733       "returns" : []
1734     }
1735   ],
1736   "events" : [
1737     {
1738       "name" : "check",
1739       "type" : "function",
1740       "desc" : "Fires when the element is checked or unchecked.",
1741       "sig" : "function (_self, checked)\n{\n\n}",
1742       "memberOf" : "",
1743       "example" : "",
1744       "deprecated" : "",
1745       "since" : "",
1746       "see" : "",
1747       "params" : [
1748         {
1749           "name" : "this",
1750           "type" : "Roo.bootstrap.form.CheckBox",
1751           "desc" : "This input",
1752           "isOptional" : false
1753         },
1754         {
1755           "name" : "checked",
1756           "type" : "Boolean",
1757           "desc" : "The new checked value",
1758           "isOptional" : false
1759         }
1760       ],
1761       "returns" : []
1762     },
1763     {
1764       "name" : "click",
1765       "type" : "function",
1766       "desc" : "Fires when the element is click.",
1767       "sig" : "function (_self)\n{\n\n}",
1768       "memberOf" : "",
1769       "example" : "",
1770       "deprecated" : "",
1771       "since" : "",
1772       "see" : "",
1773       "params" : [
1774         {
1775           "name" : "this",
1776           "type" : "Roo.bootstrap.form.CheckBox",
1777           "desc" : "This input",
1778           "isOptional" : false
1779         }
1780       ],
1781       "returns" : []
1782     },
1783     {
1784       "name" : "paste",
1785       "type" : "function",
1786       "desc" : "Fires after the user pastes into input",
1787       "sig" : "function (_self, e)\n{\n\n}",
1788       "memberOf" : "Roo.bootstrap.form.Input",
1789       "example" : "",
1790       "deprecated" : "",
1791       "since" : "",
1792       "see" : "",
1793       "params" : [
1794         {
1795           "name" : "this",
1796           "type" : "Roo.form.Field",
1797           "desc" : "",
1798           "isOptional" : false
1799         },
1800         {
1801           "name" : "e",
1802           "type" : "Roo.EventObject",
1803           "desc" : "The event Object",
1804           "isOptional" : false
1805         }
1806       ],
1807       "returns" : []
1808     },
1809     {
1810       "name" : "change",
1811       "type" : "function",
1812       "desc" : "Fires just before the field blurs if the field value has changed.",
1813       "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
1814       "memberOf" : "Roo.bootstrap.form.Input",
1815       "example" : "",
1816       "deprecated" : "",
1817       "since" : "",
1818       "see" : "",
1819       "params" : [
1820         {
1821           "name" : "this",
1822           "type" : "Roo.form.Field",
1823           "desc" : "",
1824           "isOptional" : false
1825         },
1826         {
1827           "name" : "newValue",
1828           "type" : "Mixed",
1829           "desc" : "The new value",
1830           "isOptional" : false
1831         },
1832         {
1833           "name" : "oldValue",
1834           "type" : "Mixed",
1835           "desc" : "The original value",
1836           "isOptional" : false
1837         }
1838       ],
1839       "returns" : []
1840     },
1841     {
1842       "name" : "valid",
1843       "type" : "function",
1844       "desc" : "Fires after the field has been validated with no errors.",
1845       "sig" : "function (_self)\n{\n\n}",
1846       "memberOf" : "Roo.bootstrap.form.Input",
1847       "example" : "",
1848       "deprecated" : "",
1849       "since" : "",
1850       "see" : "",
1851       "params" : [
1852         {
1853           "name" : "this",
1854           "type" : "Roo.form.Field",
1855           "desc" : "",
1856           "isOptional" : false
1857         }
1858       ],
1859       "returns" : []
1860     },
1861     {
1862       "name" : "specialkey",
1863       "type" : "function",
1864       "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
1865       "sig" : "function (_self, e)\n{\n\n}",
1866       "memberOf" : "Roo.bootstrap.form.Input",
1867       "example" : "",
1868       "deprecated" : "",
1869       "since" : "",
1870       "see" : "",
1871       "params" : [
1872         {
1873           "name" : "this",
1874           "type" : "Roo.form.Field",
1875           "desc" : "",
1876           "isOptional" : false
1877         },
1878         {
1879           "name" : "e",
1880           "type" : "Roo.EventObject",
1881           "desc" : "The event object",
1882           "isOptional" : false
1883         }
1884       ],
1885       "returns" : []
1886     },
1887     {
1888       "name" : "focus",
1889       "type" : "function",
1890       "desc" : "Fires when this field receives input focus.",
1891       "sig" : "function (_self)\n{\n\n}",
1892       "memberOf" : "Roo.bootstrap.form.Input",
1893       "example" : "",
1894       "deprecated" : "",
1895       "since" : "",
1896       "see" : "",
1897       "params" : [
1898         {
1899           "name" : "this",
1900           "type" : "Roo.form.Field",
1901           "desc" : "",
1902           "isOptional" : false
1903         }
1904       ],
1905       "returns" : []
1906     },
1907     {
1908       "name" : "keyup",
1909       "type" : "function",
1910       "desc" : "Fires after the key up",
1911       "sig" : "function (_self, e)\n{\n\n}",
1912       "memberOf" : "Roo.bootstrap.form.Input",
1913       "example" : "",
1914       "deprecated" : "",
1915       "since" : "",
1916       "see" : "",
1917       "params" : [
1918         {
1919           "name" : "this",
1920           "type" : "Roo.form.Field",
1921           "desc" : "",
1922           "isOptional" : false
1923         },
1924         {
1925           "name" : "e",
1926           "type" : "Roo.EventObject",
1927           "desc" : "The event Object",
1928           "isOptional" : false
1929         }
1930       ],
1931       "returns" : []
1932     },
1933     {
1934       "name" : "blur",
1935       "type" : "function",
1936       "desc" : "Fires when this field loses input focus.",
1937       "sig" : "function (_self)\n{\n\n}",
1938       "memberOf" : "Roo.bootstrap.form.Input",
1939       "example" : "",
1940       "deprecated" : "",
1941       "since" : "",
1942       "see" : "",
1943       "params" : [
1944         {
1945           "name" : "this",
1946           "type" : "Roo.form.Field",
1947           "desc" : "",
1948           "isOptional" : false
1949         }
1950       ],
1951       "returns" : []
1952     },
1953     {
1954       "name" : "invalid",
1955       "type" : "function",
1956       "desc" : "Fires after the field has been marked as invalid.",
1957       "sig" : "function (_self, msg)\n{\n\n}",
1958       "memberOf" : "Roo.bootstrap.form.Input",
1959       "example" : "",
1960       "deprecated" : "",
1961       "since" : "",
1962       "see" : "",
1963       "params" : [
1964         {
1965           "name" : "this",
1966           "type" : "Roo.form.Field",
1967           "desc" : "",
1968           "isOptional" : false
1969         },
1970         {
1971           "name" : "msg",
1972           "type" : "String",
1973           "desc" : "The validation message",
1974           "isOptional" : false
1975         }
1976       ],
1977       "returns" : []
1978     },
1979     {
1980       "name" : "childrenrendered",
1981       "type" : "function",
1982       "desc" : "Fires when the children have been rendered..",
1983       "sig" : "function (_self)\n{\n\n}",
1984       "memberOf" : "Roo.bootstrap.Component",
1985       "example" : "",
1986       "deprecated" : "",
1987       "since" : "",
1988       "see" : "",
1989       "params" : [
1990         {
1991           "name" : "this",
1992           "type" : "Roo.bootstrap.Component",
1993           "desc" : "",
1994           "isOptional" : false
1995         }
1996       ],
1997       "returns" : []
1998     },
1999     {
2000       "name" : "beforerender",
2001       "type" : "function",
2002       "desc" : "Fires before the component is rendered. Return false to stop the render.",
2003       "sig" : "function (_self)\n{\n\n}",
2004       "memberOf" : "Roo.Component",
2005       "example" : "",
2006       "deprecated" : "",
2007       "since" : "",
2008       "see" : "",
2009       "params" : [
2010         {
2011           "name" : "this",
2012           "type" : "Roo.Component",
2013           "desc" : "",
2014           "isOptional" : false
2015         }
2016       ],
2017       "returns" : []
2018     },
2019     {
2020       "name" : "disable",
2021       "type" : "function",
2022       "desc" : "Fires after the component is disabled.",
2023       "sig" : "function (_self)\n{\n\n}",
2024       "memberOf" : "Roo.Component",
2025       "example" : "",
2026       "deprecated" : "",
2027       "since" : "",
2028       "see" : "",
2029       "params" : [
2030         {
2031           "name" : "this",
2032           "type" : "Roo.Component",
2033           "desc" : "",
2034           "isOptional" : false
2035         }
2036       ],
2037       "returns" : []
2038     },
2039     {
2040       "name" : "render",
2041       "type" : "function",
2042       "desc" : "Fires after the component is rendered.",
2043       "sig" : "function (_self)\n{\n\n}",
2044       "memberOf" : "Roo.Component",
2045       "example" : "",
2046       "deprecated" : "",
2047       "since" : "",
2048       "see" : "",
2049       "params" : [
2050         {
2051           "name" : "this",
2052           "type" : "Roo.Component",
2053           "desc" : "",
2054           "isOptional" : false
2055         }
2056       ],
2057       "returns" : []
2058     },
2059     {
2060       "name" : "destroy",
2061       "type" : "function",
2062       "desc" : "Fires after the component is destroyed.",
2063       "sig" : "function (_self)\n{\n\n}",
2064       "memberOf" : "Roo.Component",
2065       "example" : "",
2066       "deprecated" : "",
2067       "since" : "",
2068       "see" : "",
2069       "params" : [
2070         {
2071           "name" : "this",
2072           "type" : "Roo.Component",
2073           "desc" : "",
2074           "isOptional" : false
2075         }
2076       ],
2077       "returns" : []
2078     },
2079     {
2080       "name" : "hide",
2081       "type" : "function",
2082       "desc" : "Fires after the component is hidden.",
2083       "sig" : "function (_self)\n{\n\n}",
2084       "memberOf" : "Roo.Component",
2085       "example" : "",
2086       "deprecated" : "",
2087       "since" : "",
2088       "see" : "",
2089       "params" : [
2090         {
2091           "name" : "this",
2092           "type" : "Roo.Component",
2093           "desc" : "",
2094           "isOptional" : false
2095         }
2096       ],
2097       "returns" : []
2098     },
2099     {
2100       "name" : "beforehide",
2101       "type" : "function",
2102       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
2103       "sig" : "function (_self)\n{\n\n}",
2104       "memberOf" : "Roo.Component",
2105       "example" : "",
2106       "deprecated" : "",
2107       "since" : "",
2108       "see" : "",
2109       "params" : [
2110         {
2111           "name" : "this",
2112           "type" : "Roo.Component",
2113           "desc" : "",
2114           "isOptional" : false
2115         }
2116       ],
2117       "returns" : []
2118     },
2119     {
2120       "name" : "show",
2121       "type" : "function",
2122       "desc" : "Fires after the component is shown.",
2123       "sig" : "function (_self)\n{\n\n}",
2124       "memberOf" : "Roo.Component",
2125       "example" : "",
2126       "deprecated" : "",
2127       "since" : "",
2128       "see" : "",
2129       "params" : [
2130         {
2131           "name" : "this",
2132           "type" : "Roo.Component",
2133           "desc" : "",
2134           "isOptional" : false
2135         }
2136       ],
2137       "returns" : []
2138     },
2139     {
2140       "name" : "beforeshow",
2141       "type" : "function",
2142       "desc" : "Fires before the component is shown.  Return false to stop the show.",
2143       "sig" : "function (_self)\n{\n\n}",
2144       "memberOf" : "Roo.Component",
2145       "example" : "",
2146       "deprecated" : "",
2147       "since" : "",
2148       "see" : "",
2149       "params" : [
2150         {
2151           "name" : "this",
2152           "type" : "Roo.Component",
2153           "desc" : "",
2154           "isOptional" : false
2155         }
2156       ],
2157       "returns" : []
2158     },
2159     {
2160       "name" : "enable",
2161       "type" : "function",
2162       "desc" : "Fires after the component is enabled.",
2163       "sig" : "function (_self)\n{\n\n}",
2164       "memberOf" : "Roo.Component",
2165       "example" : "",
2166       "deprecated" : "",
2167       "since" : "",
2168       "see" : "",
2169       "params" : [
2170         {
2171           "name" : "this",
2172           "type" : "Roo.Component",
2173           "desc" : "",
2174           "isOptional" : false
2175         }
2176       ],
2177       "returns" : []
2178     },
2179     {
2180       "name" : "beforedestroy",
2181       "type" : "function",
2182       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
2183       "sig" : "function (_self)\n{\n\n}",
2184       "memberOf" : "Roo.Component",
2185       "example" : "",
2186       "deprecated" : "",
2187       "since" : "",
2188       "see" : "",
2189       "params" : [
2190         {
2191           "name" : "this",
2192           "type" : "Roo.Component",
2193           "desc" : "",
2194           "isOptional" : false
2195         }
2196       ],
2197       "returns" : []
2198     }
2199   ]
2200 }