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