Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.form.Layout.json
1 {
2   "name" : "Roo.form.Layout",
3   "augments" : [
4     "Roo.Component",
5     "Roo.util.Observable"
6   ],
7   "desc" : "Creates a container for layout and rendering of fields in an {@link Roo.form.Form}.",
8   "isSingleton" : false,
9   "isStatic" : false,
10   "isBuiltin" : false,
11   "memberOf" : "Layout",
12   "example" : "",
13   "deprecated" : "",
14   "since" : "",
15   "see" : "",
16   "params" : [
17     {
18       "name" : "config",
19       "type" : "Object",
20       "desc" : "Configuration options",
21       "isOptional" : false
22     }
23   ],
24   "returns" : [],
25   "config" : [
26     {
27       "name" : "labelAlign",
28       "type" : "String",
29       "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
30       "memberOf" : "Roo.form.Layout",
31       "optvals" : []
32     },
33     {
34       "name" : "listeners",
35       "type" : "Object",
36       "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>",
37       "memberOf" : "Roo.util.Observable",
38       "optvals" : []
39     },
40     {
41       "name" : "hideLabels",
42       "type" : "Boolean",
43       "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
44       "memberOf" : "Roo.form.Layout",
45       "optvals" : []
46     },
47     {
48       "name" : "hideMode",
49       "type" : "String",
50       "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\".",
51       "memberOf" : "Roo.Component",
52       "optvals" : [
53         "display",
54         "visibility"
55       ]
56     },
57     {
58       "name" : "style",
59       "type" : "String/Object/Function",
60       "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
61       "memberOf" : "Roo.form.Layout",
62       "optvals" : []
63     },
64     {
65       "name" : "allowDomMove",
66       "type" : "Boolean",
67       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
68       "memberOf" : "Roo.Component",
69       "optvals" : []
70     },
71     {
72       "name" : "labelWidth",
73       "type" : "Number",
74       "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
75       "memberOf" : "Roo.form.Layout",
76       "optvals" : []
77     },
78     {
79       "name" : "labelSeparator",
80       "type" : "String",
81       "desc" : "The separator to use after field labels (defaults to ':')",
82       "memberOf" : "Roo.form.Layout",
83       "optvals" : []
84     },
85     {
86       "name" : "autoCreate",
87       "type" : "String/Object",
88       "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
89       "memberOf" : "Roo.form.Layout",
90       "optvals" : []
91     },
92     {
93       "name" : "clear",
94       "type" : "Boolean",
95       "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
96       "memberOf" : "Roo.form.Layout",
97       "optvals" : []
98     },
99     {
100       "name" : "actionMode",
101       "type" : "String",
102       "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",
103       "memberOf" : "Roo.Component",
104       "optvals" : []
105     },
106     {
107       "name" : "disableClass",
108       "type" : "String",
109       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
110       "memberOf" : "Roo.Component",
111       "optvals" : []
112     }
113   ],
114   "methods" : [
115     {
116       "name" : "addxtype",
117       "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are:  TextField, TextArea .... Button, Layout, FieldSet, Column",
118       "isStatic" : false,
119       "isConstructor" : false,
120       "isPrivate" : false,
121       "memberOf" : "Roo.form.Layout",
122       "example" : "",
123       "deprecated" : "",
124       "since" : "",
125       "see" : "",
126       "params" : [
127         {
128           "name" : "config",
129           "type" : "Object",
130           "desc" : "",
131           "isOptional" : false
132         }
133       ],
134       "returns" : []
135     },
136     {
137       "name" : "getId",
138       "desc" : "Returns the id of this component.",
139       "isStatic" : false,
140       "isConstructor" : false,
141       "isPrivate" : false,
142       "memberOf" : "Roo.Component",
143       "example" : "",
144       "deprecated" : "",
145       "since" : "",
146       "see" : "",
147       "params" : [],
148       "returns" : [
149         {
150           "name" : "",
151           "type" : "String",
152           "desc" : ""
153         }
154       ]
155     },
156     {
157       "name" : "render",
158       "desc" : "If this is a lazy rendering component, render it to its container element.",
159       "isStatic" : false,
160       "isConstructor" : false,
161       "isPrivate" : false,
162       "memberOf" : "Roo.Component",
163       "example" : "",
164       "deprecated" : "",
165       "since" : "",
166       "see" : "",
167       "params" : [
168         {
169           "name" : "container",
170           "type" : "String/HTMLElement/Element",
171           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
172           "isOptional" : false
173         }
174       ],
175       "returns" : []
176     },
177     {
178       "name" : "destroy",
179       "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}.",
180       "isStatic" : false,
181       "isConstructor" : false,
182       "isPrivate" : false,
183       "memberOf" : "Roo.Component",
184       "example" : "",
185       "deprecated" : "",
186       "since" : "",
187       "see" : "",
188       "params" : [],
189       "returns" : []
190     },
191     {
192       "name" : "isVisible",
193       "desc" : "Returns true if this component is visible.",
194       "isStatic" : false,
195       "isConstructor" : false,
196       "isPrivate" : false,
197       "memberOf" : "Roo.Component",
198       "example" : "",
199       "deprecated" : "",
200       "since" : "",
201       "see" : "",
202       "params" : [],
203       "returns" : []
204     },
205     {
206       "name" : "setDisabled",
207       "desc" : "Convenience function for setting disabled/enabled by boolean.",
208       "isStatic" : false,
209       "isConstructor" : false,
210       "isPrivate" : false,
211       "memberOf" : "Roo.Component",
212       "example" : "",
213       "deprecated" : "",
214       "since" : "",
215       "see" : "",
216       "params" : [
217         {
218           "name" : "disabled",
219           "type" : "Boolean",
220           "desc" : "",
221           "isOptional" : false
222         }
223       ],
224       "returns" : []
225     },
226     {
227       "name" : "hide",
228       "desc" : "Hide this component.",
229       "isStatic" : false,
230       "isConstructor" : false,
231       "isPrivate" : false,
232       "memberOf" : "Roo.Component",
233       "example" : "",
234       "deprecated" : "",
235       "since" : "",
236       "see" : "",
237       "params" : [],
238       "returns" : [
239         {
240           "name" : "",
241           "type" : "Roo.Component",
242           "desc" : "this"
243         }
244       ]
245     },
246     {
247       "name" : "focus",
248       "desc" : "Try to focus this component.",
249       "isStatic" : false,
250       "isConstructor" : false,
251       "isPrivate" : false,
252       "memberOf" : "Roo.Component",
253       "example" : "",
254       "deprecated" : "",
255       "since" : "",
256       "see" : "",
257       "params" : [
258         {
259           "name" : "selectText",
260           "type" : "Boolean",
261           "desc" : "True to also select the text in this component (if applicable)",
262           "isOptional" : false
263         }
264       ],
265       "returns" : [
266         {
267           "name" : "",
268           "type" : "Roo.Component",
269           "desc" : "this"
270         }
271       ]
272     },
273     {
274       "name" : "show",
275       "desc" : "Show this component.",
276       "isStatic" : false,
277       "isConstructor" : false,
278       "isPrivate" : false,
279       "memberOf" : "Roo.Component",
280       "example" : "",
281       "deprecated" : "",
282       "since" : "",
283       "see" : "",
284       "params" : [],
285       "returns" : [
286         {
287           "name" : "",
288           "type" : "Roo.Component",
289           "desc" : "this"
290         }
291       ]
292     },
293     {
294       "name" : "enable",
295       "desc" : "Enable this component.",
296       "isStatic" : false,
297       "isConstructor" : false,
298       "isPrivate" : false,
299       "memberOf" : "Roo.Component",
300       "example" : "",
301       "deprecated" : "",
302       "since" : "",
303       "see" : "",
304       "params" : [],
305       "returns" : [
306         {
307           "name" : "",
308           "type" : "Roo.Component",
309           "desc" : "this"
310         }
311       ]
312     },
313     {
314       "name" : "setVisible",
315       "desc" : "Convenience function to hide or show this component by boolean.",
316       "isStatic" : false,
317       "isConstructor" : false,
318       "isPrivate" : false,
319       "memberOf" : "Roo.Component",
320       "example" : "",
321       "deprecated" : "",
322       "since" : "",
323       "see" : "",
324       "params" : [
325         {
326           "name" : "visible",
327           "type" : "Boolean",
328           "desc" : "True to show, false to hide",
329           "isOptional" : false
330         }
331       ],
332       "returns" : [
333         {
334           "name" : "",
335           "type" : "Roo.Component",
336           "desc" : "this"
337         }
338       ]
339     },
340     {
341       "name" : "disable",
342       "desc" : "Disable this component.",
343       "isStatic" : false,
344       "isConstructor" : false,
345       "isPrivate" : false,
346       "memberOf" : "Roo.Component",
347       "example" : "",
348       "deprecated" : "",
349       "since" : "",
350       "see" : "",
351       "params" : [],
352       "returns" : [
353         {
354           "name" : "",
355           "type" : "Roo.Component",
356           "desc" : "this"
357         }
358       ]
359     },
360     {
361       "name" : "getEl",
362       "desc" : "Returns the underlying {@link Roo.Element}.",
363       "isStatic" : false,
364       "isConstructor" : false,
365       "isPrivate" : false,
366       "memberOf" : "Roo.Component",
367       "example" : "",
368       "deprecated" : "",
369       "since" : "",
370       "see" : "",
371       "params" : [],
372       "returns" : [
373         {
374           "name" : "",
375           "type" : "Roo.Element",
376           "desc" : "The element"
377         }
378       ]
379     },
380     {
381       "name" : "purgeListeners",
382       "desc" : "Removes all listeners for this object",
383       "isStatic" : false,
384       "isConstructor" : false,
385       "isPrivate" : false,
386       "memberOf" : "Roo.util.Observable",
387       "example" : "",
388       "deprecated" : "",
389       "since" : "",
390       "see" : "",
391       "params" : [],
392       "returns" : []
393     },
394     {
395       "name" : "on",
396       "desc" : "Appends an event handler to this element (shorthand for addListener)",
397       "isStatic" : false,
398       "isConstructor" : false,
399       "isPrivate" : false,
400       "memberOf" : "Roo.util.Observable",
401       "example" : "",
402       "deprecated" : "",
403       "since" : "",
404       "see" : "",
405       "params" : [
406         {
407           "name" : "eventName",
408           "type" : "String",
409           "desc" : "The type of event to listen for",
410           "isOptional" : false
411         },
412         {
413           "name" : "handler",
414           "type" : "Function",
415           "desc" : "The method the event invokes",
416           "isOptional" : false
417         },
418         {
419           "name" : "scope",
420           "type" : "Object",
421           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
422           "isOptional" : false
423         },
424         {
425           "name" : "options",
426           "type" : "Object",
427           "desc" : "(optional)",
428           "isOptional" : false
429         }
430       ],
431       "returns" : []
432     },
433     {
434       "name" : "un",
435       "desc" : "Removes a listener (shorthand for removeListener)",
436       "isStatic" : false,
437       "isConstructor" : false,
438       "isPrivate" : false,
439       "memberOf" : "Roo.util.Observable",
440       "example" : "",
441       "deprecated" : "",
442       "since" : "",
443       "see" : "",
444       "params" : [
445         {
446           "name" : "eventName",
447           "type" : "String",
448           "desc" : "The type of event to listen for",
449           "isOptional" : false
450         },
451         {
452           "name" : "handler",
453           "type" : "Function",
454           "desc" : "The handler to remove",
455           "isOptional" : false
456         },
457         {
458           "name" : "scope",
459           "type" : "Object",
460           "desc" : "(optional) The scope (this object) for the handler",
461           "isOptional" : false
462         }
463       ],
464       "returns" : []
465     },
466     {
467       "name" : "addEvents",
468       "desc" : "Used to define events on this Observable",
469       "isStatic" : false,
470       "isConstructor" : false,
471       "isPrivate" : false,
472       "memberOf" : "Roo.util.Observable",
473       "example" : "",
474       "deprecated" : "",
475       "since" : "",
476       "see" : "",
477       "params" : [
478         {
479           "name" : "object",
480           "type" : "Object",
481           "desc" : "The object with the events defined",
482           "isOptional" : false
483         }
484       ],
485       "returns" : []
486     },
487     {
488       "name" : "releaseCapture",
489       "desc" : "Removes <b>all</b> added captures from the Observable.",
490       "isStatic" : true,
491       "isConstructor" : false,
492       "isPrivate" : false,
493       "memberOf" : "Roo.util.Observable",
494       "example" : "",
495       "deprecated" : "",
496       "since" : "",
497       "see" : "",
498       "params" : [
499         {
500           "name" : "o",
501           "type" : "Observable",
502           "desc" : "The Observable to release",
503           "isOptional" : false
504         }
505       ],
506       "returns" : []
507     },
508     {
509       "name" : "removeListener",
510       "desc" : "Removes a listener",
511       "isStatic" : false,
512       "isConstructor" : false,
513       "isPrivate" : false,
514       "memberOf" : "Roo.util.Observable",
515       "example" : "",
516       "deprecated" : "",
517       "since" : "",
518       "see" : "",
519       "params" : [
520         {
521           "name" : "eventName",
522           "type" : "String",
523           "desc" : "The type of event to listen for",
524           "isOptional" : false
525         },
526         {
527           "name" : "handler",
528           "type" : "Function",
529           "desc" : "The handler to remove",
530           "isOptional" : false
531         },
532         {
533           "name" : "scope",
534           "type" : "Object",
535           "desc" : "(optional) The scope (this object) for the handler",
536           "isOptional" : false
537         }
538       ],
539       "returns" : []
540     },
541     {
542       "name" : "fireEvent",
543       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
544       "isStatic" : false,
545       "isConstructor" : false,
546       "isPrivate" : false,
547       "memberOf" : "Roo.util.Observable",
548       "example" : "",
549       "deprecated" : "",
550       "since" : "",
551       "see" : "",
552       "params" : [
553         {
554           "name" : "eventName",
555           "type" : "String",
556           "desc" : "",
557           "isOptional" : false
558         },
559         {
560           "name" : "args",
561           "type" : "Object...",
562           "desc" : "Variable number of parameters are passed to handlers",
563           "isOptional" : false
564         }
565       ],
566       "returns" : [
567         {
568           "name" : "",
569           "type" : "Boolean",
570           "desc" : "returns false if any of the handlers return false otherwise it returns true"
571         }
572       ]
573     },
574     {
575       "name" : "hasListener",
576       "desc" : "Checks to see if this object has any listeners for a specified event",
577       "isStatic" : false,
578       "isConstructor" : false,
579       "isPrivate" : false,
580       "memberOf" : "Roo.util.Observable",
581       "example" : "",
582       "deprecated" : "",
583       "since" : "",
584       "see" : "",
585       "params" : [
586         {
587           "name" : "eventName",
588           "type" : "String",
589           "desc" : "The name of the event to check for",
590           "isOptional" : false
591         }
592       ],
593       "returns" : [
594         {
595           "name" : "",
596           "type" : "Boolean",
597           "desc" : "True if the event is being listened for, else false"
598         }
599       ]
600     },
601     {
602       "name" : "capture",
603       "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.",
604       "isStatic" : true,
605       "isConstructor" : false,
606       "isPrivate" : false,
607       "memberOf" : "Roo.util.Observable",
608       "example" : "",
609       "deprecated" : "",
610       "since" : "",
611       "see" : "",
612       "params" : [
613         {
614           "name" : "o",
615           "type" : "Observable",
616           "desc" : "The Observable to capture",
617           "isOptional" : false
618         },
619         {
620           "name" : "fn",
621           "type" : "Function",
622           "desc" : "The function to call",
623           "isOptional" : false
624         },
625         {
626           "name" : "scope",
627           "type" : "Object",
628           "desc" : "(optional) The scope (this object) for the fn",
629           "isOptional" : false
630         }
631       ],
632       "returns" : []
633     },
634     {
635       "name" : "addListener",
636       "desc" : "Appends an event handler to this component",
637       "isStatic" : false,
638       "isConstructor" : false,
639       "isPrivate" : false,
640       "memberOf" : "Roo.util.Observable",
641       "example" : "",
642       "deprecated" : "",
643       "since" : "",
644       "see" : "",
645       "params" : [
646         {
647           "name" : "eventName",
648           "type" : "String",
649           "desc" : "The type of event to listen for",
650           "isOptional" : false
651         },
652         {
653           "name" : "handler",
654           "type" : "Function",
655           "desc" : "The method the event invokes",
656           "isOptional" : false
657         },
658         {
659           "name" : "scope",
660           "type" : "Object",
661           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
662           "isOptional" : false
663         },
664         {
665           "name" : "options",
666           "type" : "Object",
667           "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>",
668           "isOptional" : false
669         }
670       ],
671       "returns" : []
672     }
673   ],
674   "events" : [
675     {
676       "name" : "beforerender",
677       "desc" : "Fires before the component is rendered. Return false to stop the render.",
678       "memberOf" : "Roo.Component",
679       "example" : "",
680       "deprecated" : "",
681       "since" : "",
682       "see" : "",
683       "params" : [
684         {
685           "name" : "this",
686           "type" : "Roo.Component",
687           "desc" : "",
688           "isOptional" : false
689         }
690       ],
691       "returns" : []
692     },
693     {
694       "name" : "disable",
695       "desc" : "Fires after the component is disabled.",
696       "memberOf" : "Roo.Component",
697       "example" : "",
698       "deprecated" : "",
699       "since" : "",
700       "see" : "",
701       "params" : [
702         {
703           "name" : "this",
704           "type" : "Roo.Component",
705           "desc" : "",
706           "isOptional" : false
707         }
708       ],
709       "returns" : []
710     },
711     {
712       "name" : "render",
713       "desc" : "Fires after the component is rendered.",
714       "memberOf" : "Roo.Component",
715       "example" : "",
716       "deprecated" : "",
717       "since" : "",
718       "see" : "",
719       "params" : [
720         {
721           "name" : "this",
722           "type" : "Roo.Component",
723           "desc" : "",
724           "isOptional" : false
725         }
726       ],
727       "returns" : []
728     },
729     {
730       "name" : "destroy",
731       "desc" : "Fires after the component is destroyed.",
732       "memberOf" : "Roo.Component",
733       "example" : "",
734       "deprecated" : "",
735       "since" : "",
736       "see" : "",
737       "params" : [
738         {
739           "name" : "this",
740           "type" : "Roo.Component",
741           "desc" : "",
742           "isOptional" : false
743         }
744       ],
745       "returns" : []
746     },
747     {
748       "name" : "hide",
749       "desc" : "Fires after the component is hidden.",
750       "memberOf" : "Roo.Component",
751       "example" : "",
752       "deprecated" : "",
753       "since" : "",
754       "see" : "",
755       "params" : [
756         {
757           "name" : "this",
758           "type" : "Roo.Component",
759           "desc" : "",
760           "isOptional" : false
761         }
762       ],
763       "returns" : []
764     },
765     {
766       "name" : "beforehide",
767       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
768       "memberOf" : "Roo.Component",
769       "example" : "",
770       "deprecated" : "",
771       "since" : "",
772       "see" : "",
773       "params" : [
774         {
775           "name" : "this",
776           "type" : "Roo.Component",
777           "desc" : "",
778           "isOptional" : false
779         }
780       ],
781       "returns" : []
782     },
783     {
784       "name" : "show",
785       "desc" : "Fires after the component is shown.",
786       "memberOf" : "Roo.Component",
787       "example" : "",
788       "deprecated" : "",
789       "since" : "",
790       "see" : "",
791       "params" : [
792         {
793           "name" : "this",
794           "type" : "Roo.Component",
795           "desc" : "",
796           "isOptional" : false
797         }
798       ],
799       "returns" : []
800     },
801     {
802       "name" : "beforeshow",
803       "desc" : "Fires before the component is shown.  Return false to stop the show.",
804       "memberOf" : "Roo.Component",
805       "example" : "",
806       "deprecated" : "",
807       "since" : "",
808       "see" : "",
809       "params" : [
810         {
811           "name" : "this",
812           "type" : "Roo.Component",
813           "desc" : "",
814           "isOptional" : false
815         }
816       ],
817       "returns" : []
818     },
819     {
820       "name" : "enable",
821       "desc" : "Fires after the component is enabled.",
822       "memberOf" : "Roo.Component",
823       "example" : "",
824       "deprecated" : "",
825       "since" : "",
826       "see" : "",
827       "params" : [
828         {
829           "name" : "this",
830           "type" : "Roo.Component",
831           "desc" : "",
832           "isOptional" : false
833         }
834       ],
835       "returns" : []
836     },
837     {
838       "name" : "beforedestroy",
839       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
840       "memberOf" : "Roo.Component",
841       "example" : "",
842       "deprecated" : "",
843       "since" : "",
844       "see" : "",
845       "params" : [
846         {
847           "name" : "this",
848           "type" : "Roo.Component",
849           "desc" : "",
850           "isOptional" : false
851         }
852       ],
853       "returns" : []
854     }
855   ]
856 }