sync
[roojs1] / docs / symbols / Roo.form.Checkbox.json
1 {
2   "name" : "Roo.form.Checkbox",
3   "augments" : [
4     "Roo.form.Field",
5     "Roo.BoxComponent",
6     "Roo.Component",
7     "Roo.util.Observable"
8   ],
9   "desc" : "Single checkbox field.  Can be used as a direct replacement for traditional checkbox fields.",
10   "isSingleton" : false,
11   "isStatic" : false,
12   "isBuiltin" : false,
13   "memberOf" : "Checkbox",
14   "example" : "",
15   "deprecated" : "",
16   "since" : "",
17   "see" : "",
18   "params" : [
19     {
20       "name" : "config",
21       "type" : "Object",
22       "desc" : "Configuration options",
23       "isOptional" : false
24     }
25   ],
26   "returns" : [
27   ],
28   "config" : [
29     {
30       "name" : "inputType",
31       "type" : "String",
32       "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
33       "memberOf" : "Roo.form.Field",
34       "values" : [
35       ]
36     },
37     {
38       "name" : "listeners",
39       "type" : "Object",
40       "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>",
41       "memberOf" : "Roo.util.Observable",
42       "values" : [
43       ]
44     },
45     {
46       "name" : "msgFx",
47       "type" : "String",
48       "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
49       "memberOf" : "Roo.form.Field",
50       "values" : [
51       ]
52     },
53     {
54       "name" : "inputValue",
55       "type" : "String",
56       "desc" : "The value that should go into the generated input element's value attribute",
57       "memberOf" : "Roo.form.Checkbox",
58       "values" : [
59       ]
60     },
61     {
62       "name" : "fieldLabel",
63       "type" : "String",
64       "desc" : "Label to use when rendering a form.",
65       "memberOf" : "Roo.form.Field",
66       "values" : [
67       ]
68     },
69     {
70       "name" : "validationDelay",
71       "type" : "Number",
72       "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
73       "memberOf" : "Roo.form.Field",
74       "values" : [
75       ]
76     },
77     {
78       "name" : "msgTarget",
79       "type" : "String",
80       "desc" : "The location where error text should display.  Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n</pre>",
81       "memberOf" : "Roo.form.Field",
82       "values" : [
83       ]
84     },
85     {
86       "name" : "hideMode",
87       "type" : "String",
88       "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\".",
89       "memberOf" : "Roo.Component",
90       "values" : [
91         "(display",
92         "visibility)"
93       ]
94     },
95     {
96       "name" : "disabled",
97       "type" : "Boolean",
98       "desc" : "True to disable the field (defaults to false).",
99       "memberOf" : "Roo.form.Field",
100       "values" : [
101       ]
102     },
103     {
104       "name" : "value",
105       "type" : "Mixed",
106       "desc" : "A value to initialize this field with.",
107       "memberOf" : "Roo.form.Field",
108       "values" : [
109       ]
110     },
111     {
112       "name" : "allowDomMove",
113       "type" : "Boolean",
114       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
115       "memberOf" : "Roo.Component",
116       "values" : [
117       ]
118     },
119     {
120       "name" : "tabIndex",
121       "type" : "Number",
122       "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
123       "memberOf" : "Roo.form.Field",
124       "values" : [
125       ]
126     },
127     {
128       "name" : "readOnly",
129       "type" : "Boolean",
130       "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
131       "memberOf" : "Roo.form.Field",
132       "values" : [
133       ]
134     },
135     {
136       "name" : "invalidClass",
137       "type" : "String",
138       "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
139       "memberOf" : "Roo.form.Field",
140       "values" : [
141       ]
142     },
143     {
144       "name" : "cls",
145       "type" : "String",
146       "desc" : "A CSS class to apply to the field's underlying element.",
147       "memberOf" : "Roo.form.Field",
148       "values" : [
149       ]
150     },
151     {
152       "name" : "autoCreate",
153       "type" : "String/Object",
154       "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
155       "memberOf" : "Roo.form.Checkbox",
156       "values" : [
157       ]
158     },
159     {
160       "name" : "valueOff",
161       "type" : "String",
162       "desc" : "The value that should go into the generated input element's value when unchecked.",
163       "memberOf" : "Roo.form.Checkbox",
164       "values" : [
165       ]
166     },
167     {
168       "name" : "invalidText",
169       "type" : "String",
170       "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
171       "memberOf" : "Roo.form.Field",
172       "values" : [
173       ]
174     },
175     {
176       "name" : "actionMode",
177       "type" : "String",
178       "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",
179       "memberOf" : "Roo.Component",
180       "values" : [
181       ]
182     },
183     {
184       "name" : "boxLabel",
185       "type" : "String",
186       "desc" : "The text that appears beside the checkbox",
187       "memberOf" : "Roo.form.Checkbox",
188       "values" : [
189       ]
190     },
191     {
192       "name" : "width",
193       "type" : "Number",
194       "desc" : "width (optional) size of component",
195       "memberOf" : "Roo.BoxComponent",
196       "values" : [
197       ]
198     },
199     {
200       "name" : "validateOnBlur",
201       "type" : "Boolean",
202       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
203       "memberOf" : "Roo.form.Field",
204       "values" : [
205       ]
206     },
207     {
208       "name" : "validationEvent",
209       "type" : "String/Boolean",
210       "desc" : "The event that should initiate field validation. Set to false to disable\n      automatic validation (defaults to \"keyup\").",
211       "memberOf" : "Roo.form.Field",
212       "values" : [
213       ]
214     },
215     {
216       "name" : "fieldClass",
217       "type" : "String",
218       "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
219       "memberOf" : "Roo.form.Checkbox",
220       "values" : [
221       ]
222     },
223     {
224       "name" : "checked",
225       "type" : "Boolean",
226       "desc" : "True if the the checkbox should render already checked (defaults to false)",
227       "memberOf" : "Roo.form.Checkbox",
228       "values" : [
229       ]
230     },
231     {
232       "name" : "focusClass",
233       "type" : "String",
234       "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
235       "memberOf" : "Roo.form.Checkbox",
236       "values" : [
237       ]
238     },
239     {
240       "name" : "name",
241       "type" : "String",
242       "desc" : "The field's HTML name attribute.",
243       "memberOf" : "Roo.form.Field",
244       "values" : [
245       ]
246     },
247     {
248       "name" : "qtip",
249       "type" : "String",
250       "desc" : "Mouse over tip",
251       "memberOf" : "Roo.form.Field",
252       "values" : [
253       ]
254     },
255     {
256       "name" : "height",
257       "type" : "Number",
258       "desc" : "height (optional) size of component",
259       "memberOf" : "Roo.BoxComponent",
260       "values" : [
261       ]
262     },
263     {
264       "name" : "disableClass",
265       "type" : "String",
266       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
267       "memberOf" : "Roo.Component",
268       "values" : [
269       ]
270     }
271   ],
272   "methods" : [
273     {
274       "name" : "setValue",
275       "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
276       "isStatic" : false,
277       "isConstructor" : false,
278       "isPrivate" : false,
279       "memberOf" : "Roo.form.Checkbox",
280       "example" : "",
281       "deprecated" : "",
282       "since" : "",
283       "see" : "",
284       "params" : [
285         {
286           "name" : "value",
287           "type" : "Boolean/String",
288           "desc" : "- the value to set",
289           "isOptional" : false
290         },
291         {
292           "name" : "suppressEvent",
293           "type" : "Boolean/String",
294           "desc" : "- whether to suppress the checkchange event.",
295           "isOptional" : false
296         }
297       ],
298       "returns" : [
299       ]
300     },
301     {
302       "name" : "getValue",
303       "desc" : "Returns the checked state of the checkbox.",
304       "isStatic" : false,
305       "isConstructor" : false,
306       "isPrivate" : false,
307       "memberOf" : "Roo.form.Checkbox",
308       "example" : "",
309       "deprecated" : "",
310       "since" : "",
311       "see" : "",
312       "params" : [
313       ],
314       "returns" : [
315         {
316           "name" : "",
317           "type" : "Boolean",
318           "desc" : "True if checked, else false"
319         }
320       ]
321     },
322     {
323       "name" : "validate",
324       "desc" : "Validates the field value",
325       "isStatic" : false,
326       "isConstructor" : false,
327       "isPrivate" : false,
328       "memberOf" : "Roo.form.Field",
329       "example" : "",
330       "deprecated" : "",
331       "since" : "",
332       "see" : "",
333       "params" : [
334       ],
335       "returns" : [
336         {
337           "name" : "",
338           "type" : "Boolean",
339           "desc" : "True if the value is valid, else false"
340         }
341       ]
342     },
343     {
344       "name" : "getName",
345       "desc" : "Returns the name attribute of the field if available",
346       "isStatic" : false,
347       "isConstructor" : false,
348       "isPrivate" : false,
349       "memberOf" : "Roo.form.Field",
350       "example" : "",
351       "deprecated" : "",
352       "since" : "",
353       "see" : "",
354       "params" : [
355       ],
356       "returns" : [
357         {
358           "name" : "",
359           "type" : "String",
360           "desc" : "name The field name"
361         }
362       ]
363     },
364     {
365       "name" : "markInvalid",
366       "desc" : "Mark this field as invalid",
367       "isStatic" : false,
368       "isConstructor" : false,
369       "isPrivate" : false,
370       "memberOf" : "Roo.form.Field",
371       "example" : "",
372       "deprecated" : "",
373       "since" : "",
374       "see" : "",
375       "params" : [
376         {
377           "name" : "msg",
378           "type" : "String",
379           "desc" : "The validation message",
380           "isOptional" : false
381         }
382       ],
383       "returns" : [
384       ]
385     },
386     {
387       "name" : "getRawValue",
388       "desc" : "Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.",
389       "isStatic" : false,
390       "isConstructor" : false,
391       "isPrivate" : false,
392       "memberOf" : "Roo.form.Field",
393       "example" : "",
394       "deprecated" : "",
395       "since" : "",
396       "see" : "",
397       "params" : [
398       ],
399       "returns" : [
400         {
401           "name" : "",
402           "type" : "Mixed",
403           "desc" : "value The field value"
404         }
405       ]
406     },
407     {
408       "name" : "applyTo",
409       "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
410       "isStatic" : false,
411       "isConstructor" : false,
412       "isPrivate" : false,
413       "memberOf" : "Roo.form.Field",
414       "example" : "",
415       "deprecated" : "",
416       "since" : "",
417       "see" : "",
418       "params" : [
419         {
420           "name" : "el",
421           "type" : "String/HTMLElement/Element",
422           "desc" : "The id of the node, a DOM node or an existing Element",
423           "isOptional" : false
424         }
425       ],
426       "returns" : [
427         {
428           "name" : "",
429           "type" : "Roo.form.Field",
430           "desc" : "this"
431         }
432       ]
433     },
434     {
435       "name" : "resetHasChanged",
436       "desc" : "stores the current value in loadedValue",
437       "isStatic" : false,
438       "isConstructor" : false,
439       "isPrivate" : false,
440       "memberOf" : "Roo.form.Field",
441       "example" : "",
442       "deprecated" : "",
443       "since" : "",
444       "see" : "",
445       "params" : [
446       ],
447       "returns" : [
448       ]
449     },
450     {
451       "name" : "isDirty",
452       "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED  - it never worked well - use hasChanged/resetHasChanged.",
453       "isStatic" : false,
454       "isConstructor" : false,
455       "isPrivate" : false,
456       "memberOf" : "Roo.form.Field",
457       "example" : "",
458       "deprecated" : "",
459       "since" : "",
460       "see" : "",
461       "params" : [
462       ],
463       "returns" : [
464       ]
465     },
466     {
467       "name" : "setRawValue",
468       "desc" : "Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.",
469       "isStatic" : false,
470       "isConstructor" : false,
471       "isPrivate" : false,
472       "memberOf" : "Roo.form.Field",
473       "example" : "",
474       "deprecated" : "",
475       "since" : "",
476       "see" : "",
477       "params" : [
478         {
479           "name" : "value",
480           "type" : "Mixed",
481           "desc" : "The value to set",
482           "isOptional" : false
483         }
484       ],
485       "returns" : [
486       ]
487     },
488     {
489       "name" : "clearInvalid",
490       "desc" : "Clear any invalid styles/messages for this field",
491       "isStatic" : false,
492       "isConstructor" : false,
493       "isPrivate" : false,
494       "memberOf" : "Roo.form.Field",
495       "example" : "",
496       "deprecated" : "",
497       "since" : "",
498       "see" : "",
499       "params" : [
500       ],
501       "returns" : [
502       ]
503     },
504     {
505       "name" : "isValid",
506       "desc" : "Returns whether or not the field value is currently valid",
507       "isStatic" : false,
508       "isConstructor" : false,
509       "isPrivate" : false,
510       "memberOf" : "Roo.form.Field",
511       "example" : "",
512       "deprecated" : "",
513       "since" : "",
514       "see" : "",
515       "params" : [
516         {
517           "name" : "preventMark",
518           "type" : "Boolean",
519           "desc" : "True to disable marking the field invalid",
520           "isOptional" : false
521         }
522       ],
523       "returns" : [
524         {
525           "name" : "",
526           "type" : "Boolean",
527           "desc" : "True if the value is valid, else false"
528         }
529       ]
530     },
531     {
532       "name" : "reset",
533       "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
534       "isStatic" : false,
535       "isConstructor" : false,
536       "isPrivate" : false,
537       "memberOf" : "Roo.form.Field",
538       "example" : "",
539       "deprecated" : "",
540       "since" : "",
541       "see" : "",
542       "params" : [
543       ],
544       "returns" : [
545       ]
546     },
547     {
548       "name" : "hasChanged",
549       "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
550       "isStatic" : false,
551       "isConstructor" : false,
552       "isPrivate" : false,
553       "memberOf" : "Roo.form.Field",
554       "example" : "",
555       "deprecated" : "",
556       "since" : "",
557       "see" : "",
558       "params" : [
559       ],
560       "returns" : [
561       ]
562     },
563     {
564       "name" : "updateBox",
565       "desc" : "Sets the current box measurements of the component's underlying element.",
566       "isStatic" : false,
567       "isConstructor" : false,
568       "isPrivate" : false,
569       "memberOf" : "Roo.BoxComponent",
570       "example" : "",
571       "deprecated" : "",
572       "since" : "",
573       "see" : "",
574       "params" : [
575         {
576           "name" : "box",
577           "type" : "Object",
578           "desc" : "An object in the format {x, y, width, height}",
579           "isOptional" : false
580         }
581       ],
582       "returns" : [
583       ]
584     },
585     {
586       "name" : "setPagePosition",
587       "desc" : "Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
588       "isStatic" : false,
589       "isConstructor" : false,
590       "isPrivate" : false,
591       "memberOf" : "Roo.BoxComponent",
592       "example" : "",
593       "deprecated" : "",
594       "since" : "",
595       "see" : "",
596       "params" : [
597         {
598           "name" : "x",
599           "type" : "Number",
600           "desc" : "The new x position",
601           "isOptional" : false
602         },
603         {
604           "name" : "y",
605           "type" : "Number",
606           "desc" : "The new y position",
607           "isOptional" : false
608         }
609       ],
610       "returns" : [
611       ]
612     },
613     {
614       "name" : "syncSize",
615       "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
616       "isStatic" : false,
617       "isConstructor" : false,
618       "isPrivate" : false,
619       "memberOf" : "Roo.BoxComponent",
620       "example" : "",
621       "deprecated" : "",
622       "since" : "",
623       "see" : "",
624       "params" : [
625       ],
626       "returns" : [
627       ]
628     },
629     {
630       "name" : "setSize",
631       "desc" : "Sets the width and height of the component.  This method fires the resize event.  This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
632       "isStatic" : false,
633       "isConstructor" : false,
634       "isPrivate" : false,
635       "memberOf" : "Roo.BoxComponent",
636       "example" : "",
637       "deprecated" : "",
638       "since" : "",
639       "see" : "",
640       "params" : [
641         {
642           "name" : "width",
643           "type" : "Number/Object",
644           "desc" : "The new width to set, or a size object in the format {width, height}",
645           "isOptional" : false
646         },
647         {
648           "name" : "height",
649           "type" : "Number",
650           "desc" : "The new height to set (not required if a size object is passed as the first arg)",
651           "isOptional" : false
652         }
653       ],
654       "returns" : [
655         {
656           "name" : "",
657           "type" : "Roo.BoxComponent",
658           "desc" : "this"
659         }
660       ]
661     },
662     {
663       "name" : "getPosition",
664       "desc" : "Gets the current XY position of the component's underlying element.",
665       "isStatic" : false,
666       "isConstructor" : false,
667       "isPrivate" : false,
668       "memberOf" : "Roo.BoxComponent",
669       "example" : "",
670       "deprecated" : "",
671       "since" : "",
672       "see" : "",
673       "params" : [
674         {
675           "name" : "local",
676           "type" : "Boolean",
677           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
678           "isOptional" : false
679         }
680       ],
681       "returns" : [
682         {
683           "name" : "",
684           "type" : "Array",
685           "desc" : "The XY position of the element (e.g., [100, 200])"
686         }
687       ]
688     },
689     {
690       "name" : "onResize",
691       "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
692       "isStatic" : false,
693       "isConstructor" : false,
694       "isPrivate" : false,
695       "memberOf" : "Roo.BoxComponent",
696       "example" : "",
697       "deprecated" : "",
698       "since" : "",
699       "see" : "",
700       "params" : [
701         {
702           "name" : "adjWidth",
703           "type" : "Number",
704           "desc" : "The box-adjusted width that was set",
705           "isOptional" : false
706         },
707         {
708           "name" : "adjHeight",
709           "type" : "Number",
710           "desc" : "The box-adjusted height that was set",
711           "isOptional" : false
712         },
713         {
714           "name" : "rawWidth",
715           "type" : "Number",
716           "desc" : "The width that was originally specified",
717           "isOptional" : false
718         },
719         {
720           "name" : "rawHeight",
721           "type" : "Number",
722           "desc" : "The height that was originally specified",
723           "isOptional" : false
724         }
725       ],
726       "returns" : [
727       ]
728     },
729     {
730       "name" : "getBox",
731       "desc" : "Gets the current box measurements of the component's underlying element.",
732       "isStatic" : false,
733       "isConstructor" : false,
734       "isPrivate" : false,
735       "memberOf" : "Roo.BoxComponent",
736       "example" : "",
737       "deprecated" : "",
738       "since" : "",
739       "see" : "",
740       "params" : [
741         {
742           "name" : "local",
743           "type" : "Boolean",
744           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
745           "isOptional" : false
746         }
747       ],
748       "returns" : [
749       ]
750     },
751     {
752       "name" : "getSize",
753       "desc" : "Gets the current size of the component's underlying element.",
754       "isStatic" : false,
755       "isConstructor" : false,
756       "isPrivate" : false,
757       "memberOf" : "Roo.BoxComponent",
758       "example" : "",
759       "deprecated" : "",
760       "since" : "",
761       "see" : "",
762       "params" : [
763       ],
764       "returns" : [
765         {
766           "name" : "",
767           "type" : "Object",
768           "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
769         }
770       ]
771     },
772     {
773       "name" : "onPosition",
774       "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
775       "isStatic" : false,
776       "isConstructor" : false,
777       "isPrivate" : false,
778       "memberOf" : "Roo.BoxComponent",
779       "example" : "",
780       "deprecated" : "",
781       "since" : "",
782       "see" : "",
783       "params" : [
784         {
785           "name" : "x",
786           "type" : "Number",
787           "desc" : "The new x position",
788           "isOptional" : false
789         },
790         {
791           "name" : "y",
792           "type" : "Number",
793           "desc" : "The new y position",
794           "isOptional" : false
795         }
796       ],
797       "returns" : [
798       ]
799     },
800     {
801       "name" : "setPosition",
802       "desc" : "Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
803       "isStatic" : false,
804       "isConstructor" : false,
805       "isPrivate" : false,
806       "memberOf" : "Roo.BoxComponent",
807       "example" : "",
808       "deprecated" : "",
809       "since" : "",
810       "see" : "",
811       "params" : [
812         {
813           "name" : "left",
814           "type" : "Number",
815           "desc" : "The new left",
816           "isOptional" : false
817         },
818         {
819           "name" : "top",
820           "type" : "Number",
821           "desc" : "The new top",
822           "isOptional" : false
823         }
824       ],
825       "returns" : [
826       ]
827     },
828     {
829       "name" : "getId",
830       "desc" : "Returns the id of this component.",
831       "isStatic" : false,
832       "isConstructor" : false,
833       "isPrivate" : false,
834       "memberOf" : "Roo.Component",
835       "example" : "",
836       "deprecated" : "",
837       "since" : "",
838       "see" : "",
839       "params" : [
840       ],
841       "returns" : [
842         {
843           "name" : "",
844           "type" : "String",
845           "desc" : ""
846         }
847       ]
848     },
849     {
850       "name" : "render",
851       "desc" : "If this is a lazy rendering component, render it to its container element.",
852       "isStatic" : false,
853       "isConstructor" : false,
854       "isPrivate" : false,
855       "memberOf" : "Roo.Component",
856       "example" : "",
857       "deprecated" : "",
858       "since" : "",
859       "see" : "",
860       "params" : [
861         {
862           "name" : "container",
863           "type" : "String/HTMLElement/Element",
864           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
865           "isOptional" : false
866         }
867       ],
868       "returns" : [
869       ]
870     },
871     {
872       "name" : "destroy",
873       "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}.",
874       "isStatic" : false,
875       "isConstructor" : false,
876       "isPrivate" : false,
877       "memberOf" : "Roo.Component",
878       "example" : "",
879       "deprecated" : "",
880       "since" : "",
881       "see" : "",
882       "params" : [
883       ],
884       "returns" : [
885       ]
886     },
887     {
888       "name" : "isVisible",
889       "desc" : "Returns true if this component is visible.",
890       "isStatic" : false,
891       "isConstructor" : false,
892       "isPrivate" : false,
893       "memberOf" : "Roo.Component",
894       "example" : "",
895       "deprecated" : "",
896       "since" : "",
897       "see" : "",
898       "params" : [
899       ],
900       "returns" : [
901       ]
902     },
903     {
904       "name" : "setDisabled",
905       "desc" : "Convenience function for setting disabled/enabled by boolean.",
906       "isStatic" : false,
907       "isConstructor" : false,
908       "isPrivate" : false,
909       "memberOf" : "Roo.Component",
910       "example" : "",
911       "deprecated" : "",
912       "since" : "",
913       "see" : "",
914       "params" : [
915         {
916           "name" : "disabled",
917           "type" : "Boolean",
918           "desc" : "",
919           "isOptional" : false
920         }
921       ],
922       "returns" : [
923       ]
924     },
925     {
926       "name" : "hide",
927       "desc" : "Hide this component.",
928       "isStatic" : false,
929       "isConstructor" : false,
930       "isPrivate" : false,
931       "memberOf" : "Roo.Component",
932       "example" : "",
933       "deprecated" : "",
934       "since" : "",
935       "see" : "",
936       "params" : [
937       ],
938       "returns" : [
939         {
940           "name" : "",
941           "type" : "Roo.Component",
942           "desc" : "this"
943         }
944       ]
945     },
946     {
947       "name" : "focus",
948       "desc" : "Try to focus this component.",
949       "isStatic" : false,
950       "isConstructor" : false,
951       "isPrivate" : false,
952       "memberOf" : "Roo.Component",
953       "example" : "",
954       "deprecated" : "",
955       "since" : "",
956       "see" : "",
957       "params" : [
958         {
959           "name" : "selectText",
960           "type" : "Boolean",
961           "desc" : "True to also select the text in this component (if applicable)",
962           "isOptional" : false
963         }
964       ],
965       "returns" : [
966         {
967           "name" : "",
968           "type" : "Roo.Component",
969           "desc" : "this"
970         }
971       ]
972     },
973     {
974       "name" : "show",
975       "desc" : "Show this component.",
976       "isStatic" : false,
977       "isConstructor" : false,
978       "isPrivate" : false,
979       "memberOf" : "Roo.Component",
980       "example" : "",
981       "deprecated" : "",
982       "since" : "",
983       "see" : "",
984       "params" : [
985       ],
986       "returns" : [
987         {
988           "name" : "",
989           "type" : "Roo.Component",
990           "desc" : "this"
991         }
992       ]
993     },
994     {
995       "name" : "enable",
996       "desc" : "Enable this component.",
997       "isStatic" : false,
998       "isConstructor" : false,
999       "isPrivate" : false,
1000       "memberOf" : "Roo.Component",
1001       "example" : "",
1002       "deprecated" : "",
1003       "since" : "",
1004       "see" : "",
1005       "params" : [
1006       ],
1007       "returns" : [
1008         {
1009           "name" : "",
1010           "type" : "Roo.Component",
1011           "desc" : "this"
1012         }
1013       ]
1014     },
1015     {
1016       "name" : "setVisible",
1017       "desc" : "Convenience function to hide or show this component by boolean.",
1018       "isStatic" : false,
1019       "isConstructor" : false,
1020       "isPrivate" : false,
1021       "memberOf" : "Roo.Component",
1022       "example" : "",
1023       "deprecated" : "",
1024       "since" : "",
1025       "see" : "",
1026       "params" : [
1027         {
1028           "name" : "visible",
1029           "type" : "Boolean",
1030           "desc" : "True to show, false to hide",
1031           "isOptional" : false
1032         }
1033       ],
1034       "returns" : [
1035         {
1036           "name" : "",
1037           "type" : "Roo.Component",
1038           "desc" : "this"
1039         }
1040       ]
1041     },
1042     {
1043       "name" : "disable",
1044       "desc" : "Disable this component.",
1045       "isStatic" : false,
1046       "isConstructor" : false,
1047       "isPrivate" : false,
1048       "memberOf" : "Roo.Component",
1049       "example" : "",
1050       "deprecated" : "",
1051       "since" : "",
1052       "see" : "",
1053       "params" : [
1054       ],
1055       "returns" : [
1056         {
1057           "name" : "",
1058           "type" : "Roo.Component",
1059           "desc" : "this"
1060         }
1061       ]
1062     },
1063     {
1064       "name" : "getEl",
1065       "desc" : "Returns the underlying {@link Roo.Element}.",
1066       "isStatic" : false,
1067       "isConstructor" : false,
1068       "isPrivate" : false,
1069       "memberOf" : "Roo.Component",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075       ],
1076       "returns" : [
1077         {
1078           "name" : "",
1079           "type" : "Roo.Element",
1080           "desc" : "The element"
1081         }
1082       ]
1083     },
1084     {
1085       "name" : "purgeListeners",
1086       "desc" : "Removes all listeners for this object",
1087       "isStatic" : false,
1088       "isConstructor" : false,
1089       "isPrivate" : false,
1090       "memberOf" : "Roo.util.Observable",
1091       "example" : "",
1092       "deprecated" : "",
1093       "since" : "",
1094       "see" : "",
1095       "params" : [
1096       ],
1097       "returns" : [
1098       ]
1099     },
1100     {
1101       "name" : "on",
1102       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1103       "isStatic" : false,
1104       "isConstructor" : false,
1105       "isPrivate" : false,
1106       "memberOf" : "Roo.util.Observable",
1107       "example" : "",
1108       "deprecated" : "",
1109       "since" : "",
1110       "see" : "",
1111       "params" : [
1112         {
1113           "name" : "eventName",
1114           "type" : "String",
1115           "desc" : "The type of event to listen for",
1116           "isOptional" : false
1117         },
1118         {
1119           "name" : "handler",
1120           "type" : "Function",
1121           "desc" : "The method the event invokes",
1122           "isOptional" : false
1123         },
1124         {
1125           "name" : "scope",
1126           "type" : "Object",
1127           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1128           "isOptional" : false
1129         },
1130         {
1131           "name" : "options",
1132           "type" : "Object",
1133           "desc" : "(optional)",
1134           "isOptional" : false
1135         }
1136       ],
1137       "returns" : [
1138       ]
1139     },
1140     {
1141       "name" : "un",
1142       "desc" : "Removes a listener (shorthand for removeListener)",
1143       "isStatic" : false,
1144       "isConstructor" : false,
1145       "isPrivate" : false,
1146       "memberOf" : "Roo.util.Observable",
1147       "example" : "",
1148       "deprecated" : "",
1149       "since" : "",
1150       "see" : "",
1151       "params" : [
1152         {
1153           "name" : "eventName",
1154           "type" : "String",
1155           "desc" : "The type of event to listen for",
1156           "isOptional" : false
1157         },
1158         {
1159           "name" : "handler",
1160           "type" : "Function",
1161           "desc" : "The handler to remove",
1162           "isOptional" : false
1163         },
1164         {
1165           "name" : "scope",
1166           "type" : "Object",
1167           "desc" : "(optional) The scope (this object) for the handler",
1168           "isOptional" : false
1169         }
1170       ],
1171       "returns" : [
1172       ]
1173     },
1174     {
1175       "name" : "addEvents",
1176       "desc" : "Used to define events on this Observable",
1177       "isStatic" : false,
1178       "isConstructor" : false,
1179       "isPrivate" : false,
1180       "memberOf" : "Roo.util.Observable",
1181       "example" : "",
1182       "deprecated" : "",
1183       "since" : "",
1184       "see" : "",
1185       "params" : [
1186         {
1187           "name" : "object",
1188           "type" : "Object",
1189           "desc" : "The object with the events defined",
1190           "isOptional" : false
1191         }
1192       ],
1193       "returns" : [
1194       ]
1195     },
1196     {
1197       "name" : "releaseCapture",
1198       "desc" : "Removes <b>all</b> added captures from the Observable.",
1199       "isStatic" : true,
1200       "isConstructor" : false,
1201       "isPrivate" : false,
1202       "memberOf" : "Roo.util.Observable",
1203       "example" : "",
1204       "deprecated" : "",
1205       "since" : "",
1206       "see" : "",
1207       "params" : [
1208         {
1209           "name" : "o",
1210           "type" : "Observable",
1211           "desc" : "The Observable to release",
1212           "isOptional" : false
1213         }
1214       ],
1215       "returns" : [
1216       ]
1217     },
1218     {
1219       "name" : "removeListener",
1220       "desc" : "Removes a listener",
1221       "isStatic" : false,
1222       "isConstructor" : false,
1223       "isPrivate" : false,
1224       "memberOf" : "Roo.util.Observable",
1225       "example" : "",
1226       "deprecated" : "",
1227       "since" : "",
1228       "see" : "",
1229       "params" : [
1230         {
1231           "name" : "eventName",
1232           "type" : "String",
1233           "desc" : "The type of event to listen for",
1234           "isOptional" : false
1235         },
1236         {
1237           "name" : "handler",
1238           "type" : "Function",
1239           "desc" : "The handler to remove",
1240           "isOptional" : false
1241         },
1242         {
1243           "name" : "scope",
1244           "type" : "Object",
1245           "desc" : "(optional) The scope (this object) for the handler",
1246           "isOptional" : false
1247         }
1248       ],
1249       "returns" : [
1250       ]
1251     },
1252     {
1253       "name" : "fireEvent",
1254       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1255       "isStatic" : false,
1256       "isConstructor" : false,
1257       "isPrivate" : false,
1258       "memberOf" : "Roo.util.Observable",
1259       "example" : "",
1260       "deprecated" : "",
1261       "since" : "",
1262       "see" : "",
1263       "params" : [
1264         {
1265           "name" : "eventName",
1266           "type" : "String",
1267           "desc" : "",
1268           "isOptional" : false
1269         },
1270         {
1271           "name" : "args",
1272           "type" : "Object...",
1273           "desc" : "Variable number of parameters are passed to handlers",
1274           "isOptional" : false
1275         }
1276       ],
1277       "returns" : [
1278         {
1279           "name" : "",
1280           "type" : "Boolean",
1281           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1282         }
1283       ]
1284     },
1285     {
1286       "name" : "hasListener",
1287       "desc" : "Checks to see if this object has any listeners for a specified event",
1288       "isStatic" : false,
1289       "isConstructor" : false,
1290       "isPrivate" : false,
1291       "memberOf" : "Roo.util.Observable",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "eventName",
1299           "type" : "String",
1300           "desc" : "The name of the event to check for",
1301           "isOptional" : false
1302         }
1303       ],
1304       "returns" : [
1305         {
1306           "name" : "",
1307           "type" : "Boolean",
1308           "desc" : "True if the event is being listened for, else false"
1309         }
1310       ]
1311     },
1312     {
1313       "name" : "capture",
1314       "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.",
1315       "isStatic" : true,
1316       "isConstructor" : false,
1317       "isPrivate" : false,
1318       "memberOf" : "Roo.util.Observable",
1319       "example" : "",
1320       "deprecated" : "",
1321       "since" : "",
1322       "see" : "",
1323       "params" : [
1324         {
1325           "name" : "o",
1326           "type" : "Observable",
1327           "desc" : "The Observable to capture",
1328           "isOptional" : false
1329         },
1330         {
1331           "name" : "fn",
1332           "type" : "Function",
1333           "desc" : "The function to call",
1334           "isOptional" : false
1335         },
1336         {
1337           "name" : "scope",
1338           "type" : "Object",
1339           "desc" : "(optional) The scope (this object) for the fn",
1340           "isOptional" : false
1341         }
1342       ],
1343       "returns" : [
1344       ]
1345     },
1346     {
1347       "name" : "addListener",
1348       "desc" : "Appends an event handler to this component",
1349       "isStatic" : false,
1350       "isConstructor" : false,
1351       "isPrivate" : false,
1352       "memberOf" : "Roo.util.Observable",
1353       "example" : "",
1354       "deprecated" : "",
1355       "since" : "",
1356       "see" : "",
1357       "params" : [
1358         {
1359           "name" : "eventName",
1360           "type" : "String",
1361           "desc" : "The type of event to listen for",
1362           "isOptional" : false
1363         },
1364         {
1365           "name" : "handler",
1366           "type" : "Function",
1367           "desc" : "The method the event invokes",
1368           "isOptional" : false
1369         },
1370         {
1371           "name" : "scope",
1372           "type" : "Object",
1373           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1374           "isOptional" : false
1375         },
1376         {
1377           "name" : "options",
1378           "type" : "Object",
1379           "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>",
1380           "isOptional" : false
1381         }
1382       ],
1383       "returns" : [
1384       ]
1385     }
1386   ],
1387   "events" : [
1388     {
1389       "name" : "check",
1390       "desc" : "Fires when the checkbox is checked or unchecked.",
1391       "memberOf" : "Roo.form.Checkbox",
1392       "example" : "",
1393       "deprecated" : "",
1394       "since" : "",
1395       "see" : "",
1396       "params" : [
1397         {
1398           "name" : "this",
1399           "type" : "Roo.form.Checkbox",
1400           "desc" : "This checkbox",
1401           "isOptional" : false
1402         },
1403         {
1404           "name" : "checked",
1405           "type" : "Boolean",
1406           "desc" : "The new checked value",
1407           "isOptional" : false
1408         }
1409       ],
1410       "returns" : [
1411       ]
1412     },
1413     {
1414       "name" : "blur",
1415       "desc" : "Fires when this field loses input focus.",
1416       "memberOf" : "Roo.form.Field",
1417       "example" : "",
1418       "deprecated" : "",
1419       "since" : "",
1420       "see" : "",
1421       "params" : [
1422         {
1423           "name" : "this",
1424           "type" : "Roo.form.Field",
1425           "desc" : "",
1426           "isOptional" : false
1427         }
1428       ],
1429       "returns" : [
1430       ]
1431     },
1432     {
1433       "name" : "valid",
1434       "desc" : "Fires after the field has been validated with no errors.",
1435       "memberOf" : "Roo.form.Field",
1436       "example" : "",
1437       "deprecated" : "",
1438       "since" : "",
1439       "see" : "",
1440       "params" : [
1441         {
1442           "name" : "this",
1443           "type" : "Roo.form.Field",
1444           "desc" : "",
1445           "isOptional" : false
1446         }
1447       ],
1448       "returns" : [
1449       ]
1450     },
1451     {
1452       "name" : "specialkey",
1453       "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.",
1454       "memberOf" : "Roo.form.Field",
1455       "example" : "",
1456       "deprecated" : "",
1457       "since" : "",
1458       "see" : "",
1459       "params" : [
1460         {
1461           "name" : "this",
1462           "type" : "Roo.form.Field",
1463           "desc" : "",
1464           "isOptional" : false
1465         },
1466         {
1467           "name" : "e",
1468           "type" : "Roo.EventObject",
1469           "desc" : "The event object",
1470           "isOptional" : false
1471         }
1472       ],
1473       "returns" : [
1474       ]
1475     },
1476     {
1477       "name" : "focus",
1478       "desc" : "Fires when this field receives input focus.",
1479       "memberOf" : "Roo.form.Field",
1480       "example" : "",
1481       "deprecated" : "",
1482       "since" : "",
1483       "see" : "",
1484       "params" : [
1485         {
1486           "name" : "this",
1487           "type" : "Roo.form.Field",
1488           "desc" : "",
1489           "isOptional" : false
1490         }
1491       ],
1492       "returns" : [
1493       ]
1494     },
1495     {
1496       "name" : "keyup",
1497       "desc" : "Fires after the key up",
1498       "memberOf" : "Roo.form.Field",
1499       "example" : "",
1500       "deprecated" : "",
1501       "since" : "",
1502       "see" : "",
1503       "params" : [
1504         {
1505           "name" : "this",
1506           "type" : "Roo.form.Field",
1507           "desc" : "",
1508           "isOptional" : false
1509         },
1510         {
1511           "name" : "e",
1512           "type" : "Roo.EventObject",
1513           "desc" : "The event Object",
1514           "isOptional" : false
1515         }
1516       ],
1517       "returns" : [
1518       ]
1519     },
1520     {
1521       "name" : "invalid",
1522       "desc" : "Fires after the field has been marked as invalid.",
1523       "memberOf" : "Roo.form.Field",
1524       "example" : "",
1525       "deprecated" : "",
1526       "since" : "",
1527       "see" : "",
1528       "params" : [
1529         {
1530           "name" : "this",
1531           "type" : "Roo.form.Field",
1532           "desc" : "",
1533           "isOptional" : false
1534         },
1535         {
1536           "name" : "msg",
1537           "type" : "String",
1538           "desc" : "The validation message",
1539           "isOptional" : false
1540         }
1541       ],
1542       "returns" : [
1543       ]
1544     },
1545     {
1546       "name" : "change",
1547       "desc" : "Fires just before the field blurs if the field value has changed.",
1548       "memberOf" : "Roo.form.Field",
1549       "example" : "",
1550       "deprecated" : "",
1551       "since" : "",
1552       "see" : "",
1553       "params" : [
1554         {
1555           "name" : "this",
1556           "type" : "Roo.form.Field",
1557           "desc" : "",
1558           "isOptional" : false
1559         },
1560         {
1561           "name" : "newValue",
1562           "type" : "Mixed",
1563           "desc" : "The new value",
1564           "isOptional" : false
1565         },
1566         {
1567           "name" : "oldValue",
1568           "type" : "Mixed",
1569           "desc" : "The original value",
1570           "isOptional" : false
1571         }
1572       ],
1573       "returns" : [
1574       ]
1575     },
1576     {
1577       "name" : "move",
1578       "desc" : "Fires after the component is moved.",
1579       "memberOf" : "Roo.BoxComponent",
1580       "example" : "",
1581       "deprecated" : "",
1582       "since" : "",
1583       "see" : "",
1584       "params" : [
1585         {
1586           "name" : "this",
1587           "type" : "Roo.Component",
1588           "desc" : "",
1589           "isOptional" : false
1590         },
1591         {
1592           "name" : "x",
1593           "type" : "Number",
1594           "desc" : "The new x position",
1595           "isOptional" : false
1596         },
1597         {
1598           "name" : "y",
1599           "type" : "Number",
1600           "desc" : "The new y position",
1601           "isOptional" : false
1602         }
1603       ],
1604       "returns" : [
1605       ]
1606     },
1607     {
1608       "name" : "resize",
1609       "desc" : "Fires after the component is resized.",
1610       "memberOf" : "Roo.BoxComponent",
1611       "example" : "",
1612       "deprecated" : "",
1613       "since" : "",
1614       "see" : "",
1615       "params" : [
1616         {
1617           "name" : "this",
1618           "type" : "Roo.Component",
1619           "desc" : "",
1620           "isOptional" : false
1621         },
1622         {
1623           "name" : "adjWidth",
1624           "type" : "Number",
1625           "desc" : "The box-adjusted width that was set",
1626           "isOptional" : false
1627         },
1628         {
1629           "name" : "adjHeight",
1630           "type" : "Number",
1631           "desc" : "The box-adjusted height that was set",
1632           "isOptional" : false
1633         },
1634         {
1635           "name" : "rawWidth",
1636           "type" : "Number",
1637           "desc" : "The width that was originally specified",
1638           "isOptional" : false
1639         },
1640         {
1641           "name" : "rawHeight",
1642           "type" : "Number",
1643           "desc" : "The height that was originally specified",
1644           "isOptional" : false
1645         }
1646       ],
1647       "returns" : [
1648       ]
1649     },
1650     {
1651       "name" : "beforerender",
1652       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1653       "memberOf" : "Roo.Component",
1654       "example" : "",
1655       "deprecated" : "",
1656       "since" : "",
1657       "see" : "",
1658       "params" : [
1659         {
1660           "name" : "this",
1661           "type" : "Roo.Component",
1662           "desc" : "",
1663           "isOptional" : false
1664         }
1665       ],
1666       "returns" : [
1667       ]
1668     },
1669     {
1670       "name" : "disable",
1671       "desc" : "Fires after the component is disabled.",
1672       "memberOf" : "Roo.Component",
1673       "example" : "",
1674       "deprecated" : "",
1675       "since" : "",
1676       "see" : "",
1677       "params" : [
1678         {
1679           "name" : "this",
1680           "type" : "Roo.Component",
1681           "desc" : "",
1682           "isOptional" : false
1683         }
1684       ],
1685       "returns" : [
1686       ]
1687     },
1688     {
1689       "name" : "render",
1690       "desc" : "Fires after the component is rendered.",
1691       "memberOf" : "Roo.Component",
1692       "example" : "",
1693       "deprecated" : "",
1694       "since" : "",
1695       "see" : "",
1696       "params" : [
1697         {
1698           "name" : "this",
1699           "type" : "Roo.Component",
1700           "desc" : "",
1701           "isOptional" : false
1702         }
1703       ],
1704       "returns" : [
1705       ]
1706     },
1707     {
1708       "name" : "destroy",
1709       "desc" : "Fires after the component is destroyed.",
1710       "memberOf" : "Roo.Component",
1711       "example" : "",
1712       "deprecated" : "",
1713       "since" : "",
1714       "see" : "",
1715       "params" : [
1716         {
1717           "name" : "this",
1718           "type" : "Roo.Component",
1719           "desc" : "",
1720           "isOptional" : false
1721         }
1722       ],
1723       "returns" : [
1724       ]
1725     },
1726     {
1727       "name" : "hide",
1728       "desc" : "Fires after the component is hidden.",
1729       "memberOf" : "Roo.Component",
1730       "example" : "",
1731       "deprecated" : "",
1732       "since" : "",
1733       "see" : "",
1734       "params" : [
1735         {
1736           "name" : "this",
1737           "type" : "Roo.Component",
1738           "desc" : "",
1739           "isOptional" : false
1740         }
1741       ],
1742       "returns" : [
1743       ]
1744     },
1745     {
1746       "name" : "beforehide",
1747       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1748       "memberOf" : "Roo.Component",
1749       "example" : "",
1750       "deprecated" : "",
1751       "since" : "",
1752       "see" : "",
1753       "params" : [
1754         {
1755           "name" : "this",
1756           "type" : "Roo.Component",
1757           "desc" : "",
1758           "isOptional" : false
1759         }
1760       ],
1761       "returns" : [
1762       ]
1763     },
1764     {
1765       "name" : "show",
1766       "desc" : "Fires after the component is shown.",
1767       "memberOf" : "Roo.Component",
1768       "example" : "",
1769       "deprecated" : "",
1770       "since" : "",
1771       "see" : "",
1772       "params" : [
1773         {
1774           "name" : "this",
1775           "type" : "Roo.Component",
1776           "desc" : "",
1777           "isOptional" : false
1778         }
1779       ],
1780       "returns" : [
1781       ]
1782     },
1783     {
1784       "name" : "beforeshow",
1785       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1786       "memberOf" : "Roo.Component",
1787       "example" : "",
1788       "deprecated" : "",
1789       "since" : "",
1790       "see" : "",
1791       "params" : [
1792         {
1793           "name" : "this",
1794           "type" : "Roo.Component",
1795           "desc" : "",
1796           "isOptional" : false
1797         }
1798       ],
1799       "returns" : [
1800       ]
1801     },
1802     {
1803       "name" : "enable",
1804       "desc" : "Fires after the component is enabled.",
1805       "memberOf" : "Roo.Component",
1806       "example" : "",
1807       "deprecated" : "",
1808       "since" : "",
1809       "see" : "",
1810       "params" : [
1811         {
1812           "name" : "this",
1813           "type" : "Roo.Component",
1814           "desc" : "",
1815           "isOptional" : false
1816         }
1817       ],
1818       "returns" : [
1819       ]
1820     },
1821     {
1822       "name" : "beforedestroy",
1823       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1824       "memberOf" : "Roo.Component",
1825       "example" : "",
1826       "deprecated" : "",
1827       "since" : "",
1828       "see" : "",
1829       "params" : [
1830         {
1831           "name" : "this",
1832           "type" : "Roo.Component",
1833           "desc" : "",
1834           "isOptional" : false
1835         }
1836       ],
1837       "returns" : [
1838       ]
1839     }
1840   ]
1841 }