Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.bootstrap.TabPanel.json
1 {
2   "name" : "Roo.bootstrap.TabPanel",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap TabPanel class",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "TabPanel",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "The config object",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [],
26   "config" : [
27     {
28       "name" : "listeners",
29       "type" : "Object",
30       "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>",
31       "memberOf" : "Roo.util.Observable",
32       "optvals" : []
33     },
34     {
35       "name" : "tooltip",
36       "type" : "string",
37       "desc" : "Text for the tooltip",
38       "memberOf" : "Roo.bootstrap.Component",
39       "optvals" : []
40     },
41     {
42       "name" : "container_method",
43       "type" : "string",
44       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
45       "memberOf" : "Roo.bootstrap.Component",
46       "optvals" : []
47     },
48     {
49       "name" : "visibilityEl",
50       "type" : "string|object",
51       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
52       "memberOf" : "Roo.bootstrap.Component",
53       "optvals" : [
54         "el",
55         "parent"
56       ]
57     },
58     {
59       "name" : "tabId",
60       "type" : "String",
61       "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
62       "memberOf" : "Roo.bootstrap.TabPanel",
63       "optvals" : []
64     },
65     {
66       "name" : "navId",
67       "type" : "String",
68       "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()",
69       "memberOf" : "Roo.bootstrap.TabPanel",
70       "optvals" : []
71     },
72     {
73       "name" : "can_build_overlaid",
74       "type" : "Boolean",
75       "desc" : "True if element can be rebuild from a HTML page",
76       "memberOf" : "Roo.bootstrap.Component",
77       "optvals" : []
78     },
79     {
80       "name" : "hideMode",
81       "type" : "String",
82       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
83       "memberOf" : "Roo.Component",
84       "optvals" : [
85         "display",
86         "visibility"
87       ]
88     },
89     {
90       "name" : "style",
91       "type" : "String",
92       "desc" : "any extra css",
93       "memberOf" : "Roo.bootstrap.Component",
94       "optvals" : []
95     },
96     {
97       "name" : "allowDomMove",
98       "type" : "Boolean",
99       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
100       "memberOf" : "Roo.Component",
101       "optvals" : []
102     },
103     {
104       "name" : "html",
105       "type" : "String",
106       "desc" : "panel content",
107       "memberOf" : "Roo.bootstrap.TabPanel",
108       "optvals" : []
109     },
110     {
111       "name" : "cls",
112       "type" : "String",
113       "desc" : "css class",
114       "memberOf" : "Roo.bootstrap.Component",
115       "optvals" : []
116     },
117     {
118       "name" : "xattr",
119       "type" : "Object",
120       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
121       "memberOf" : "Roo.bootstrap.Component",
122       "optvals" : []
123     },
124     {
125       "name" : "actionMode",
126       "type" : "String",
127       "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",
128       "memberOf" : "Roo.Component",
129       "optvals" : []
130     },
131     {
132       "name" : "dataId",
133       "type" : "string",
134       "desc" : "cutomer id",
135       "memberOf" : "Roo.bootstrap.Component",
136       "optvals" : []
137     },
138     {
139       "name" : "active",
140       "type" : "Boolean",
141       "desc" : "panel active",
142       "memberOf" : "Roo.bootstrap.TabPanel",
143       "optvals" : []
144     },
145     {
146       "name" : "name",
147       "type" : "string",
148       "desc" : "Specifies name attribute",
149       "memberOf" : "Roo.bootstrap.Component",
150       "optvals" : []
151     },
152     {
153       "name" : "disableClass",
154       "type" : "String",
155       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
156       "memberOf" : "Roo.Component",
157       "optvals" : []
158     },
159     {
160       "name" : "href",
161       "type" : "String",
162       "desc" : "click to link..",
163       "memberOf" : "Roo.bootstrap.TabPanel",
164       "optvals" : []
165     },
166     {
167       "name" : "touchSlide",
168       "type" : "Boolean",
169       "desc" : "if swiping slides tab to next panel (default off)",
170       "memberOf" : "Roo.bootstrap.TabPanel",
171       "optvals" : []
172     }
173   ],
174   "methods" : [
175     {
176       "name" : "tooltipEl",
177       "desc" : "Fetch the element to display the tooltip on.",
178       "isStatic" : false,
179       "isConstructor" : false,
180       "isPrivate" : false,
181       "memberOf" : "Roo.bootstrap.Component",
182       "example" : "",
183       "deprecated" : "",
184       "since" : "",
185       "see" : "",
186       "params" : [],
187       "returns" : [
188         {
189           "name" : "",
190           "type" : "Roo.Element",
191           "desc" : "defaults to this.el"
192         }
193       ]
194     },
195     {
196       "name" : "hide",
197       "desc" : "Hide a component - adds 'hidden' class",
198       "isStatic" : false,
199       "isConstructor" : false,
200       "isPrivate" : false,
201       "memberOf" : "Roo.bootstrap.Component",
202       "example" : "",
203       "deprecated" : "",
204       "since" : "",
205       "see" : "",
206       "params" : [],
207       "returns" : []
208     },
209     {
210       "name" : "show",
211       "desc" : "Show a component - removes 'hidden' class",
212       "isStatic" : false,
213       "isConstructor" : false,
214       "isPrivate" : false,
215       "memberOf" : "Roo.bootstrap.Component",
216       "example" : "",
217       "deprecated" : "",
218       "since" : "",
219       "see" : "",
220       "params" : [],
221       "returns" : []
222     },
223     {
224       "name" : "setVisibilityEl",
225       "desc" : "Set the element that will be used to show or hide",
226       "isStatic" : false,
227       "isConstructor" : false,
228       "isPrivate" : false,
229       "memberOf" : "Roo.bootstrap.Component",
230       "example" : "",
231       "deprecated" : "",
232       "since" : "",
233       "see" : "",
234       "params" : [],
235       "returns" : []
236     },
237     {
238       "name" : "getVisibilityEl",
239       "desc" : "Get the element that will be used to show or hide",
240       "isStatic" : false,
241       "isConstructor" : false,
242       "isPrivate" : false,
243       "memberOf" : "Roo.bootstrap.Component",
244       "example" : "",
245       "deprecated" : "",
246       "since" : "",
247       "see" : "",
248       "params" : [],
249       "returns" : []
250     },
251     {
252       "name" : "initEvents",
253       "desc" : "Initialize Events for the element",
254       "isStatic" : false,
255       "isConstructor" : false,
256       "isPrivate" : false,
257       "memberOf" : "Roo.bootstrap.Component",
258       "example" : "",
259       "deprecated" : "",
260       "since" : "",
261       "see" : "",
262       "params" : [],
263       "returns" : []
264     },
265     {
266       "name" : "getChildContainer",
267       "desc" : "Fetch the element to add children to",
268       "isStatic" : false,
269       "isConstructor" : false,
270       "isPrivate" : false,
271       "memberOf" : "Roo.bootstrap.Component",
272       "example" : "",
273       "deprecated" : "",
274       "since" : "",
275       "see" : "",
276       "params" : [],
277       "returns" : [
278         {
279           "name" : "",
280           "type" : "Roo.Element",
281           "desc" : "defaults to this.el"
282         }
283       ]
284     },
285     {
286       "name" : "getId",
287       "desc" : "Returns the id of this component.",
288       "isStatic" : false,
289       "isConstructor" : false,
290       "isPrivate" : false,
291       "memberOf" : "Roo.Component",
292       "example" : "",
293       "deprecated" : "",
294       "since" : "",
295       "see" : "",
296       "params" : [],
297       "returns" : [
298         {
299           "name" : "",
300           "type" : "String",
301           "desc" : ""
302         }
303       ]
304     },
305     {
306       "name" : "render",
307       "desc" : "If this is a lazy rendering component, render it to its container element.",
308       "isStatic" : false,
309       "isConstructor" : false,
310       "isPrivate" : false,
311       "memberOf" : "Roo.Component",
312       "example" : "",
313       "deprecated" : "",
314       "since" : "",
315       "see" : "",
316       "params" : [
317         {
318           "name" : "container",
319           "type" : "String/HTMLElement/Element",
320           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
321           "isOptional" : false
322         }
323       ],
324       "returns" : []
325     },
326     {
327       "name" : "destroy",
328       "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}.",
329       "isStatic" : false,
330       "isConstructor" : false,
331       "isPrivate" : false,
332       "memberOf" : "Roo.Component",
333       "example" : "",
334       "deprecated" : "",
335       "since" : "",
336       "see" : "",
337       "params" : [],
338       "returns" : []
339     },
340     {
341       "name" : "isVisible",
342       "desc" : "Returns true if this component is visible.",
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     {
355       "name" : "setDisabled",
356       "desc" : "Convenience function for setting disabled/enabled by boolean.",
357       "isStatic" : false,
358       "isConstructor" : false,
359       "isPrivate" : false,
360       "memberOf" : "Roo.Component",
361       "example" : "",
362       "deprecated" : "",
363       "since" : "",
364       "see" : "",
365       "params" : [
366         {
367           "name" : "disabled",
368           "type" : "Boolean",
369           "desc" : "",
370           "isOptional" : false
371         }
372       ],
373       "returns" : []
374     },
375     {
376       "name" : "focus",
377       "desc" : "Try to focus this component.",
378       "isStatic" : false,
379       "isConstructor" : false,
380       "isPrivate" : false,
381       "memberOf" : "Roo.Component",
382       "example" : "",
383       "deprecated" : "",
384       "since" : "",
385       "see" : "",
386       "params" : [
387         {
388           "name" : "selectText",
389           "type" : "Boolean",
390           "desc" : "True to also select the text in this component (if applicable)",
391           "isOptional" : false
392         }
393       ],
394       "returns" : [
395         {
396           "name" : "",
397           "type" : "Roo.Component",
398           "desc" : "this"
399         }
400       ]
401     },
402     {
403       "name" : "enable",
404       "desc" : "Enable this component.",
405       "isStatic" : false,
406       "isConstructor" : false,
407       "isPrivate" : false,
408       "memberOf" : "Roo.Component",
409       "example" : "",
410       "deprecated" : "",
411       "since" : "",
412       "see" : "",
413       "params" : [],
414       "returns" : [
415         {
416           "name" : "",
417           "type" : "Roo.Component",
418           "desc" : "this"
419         }
420       ]
421     },
422     {
423       "name" : "setVisible",
424       "desc" : "Convenience function to hide or show this component by boolean.",
425       "isStatic" : false,
426       "isConstructor" : false,
427       "isPrivate" : false,
428       "memberOf" : "Roo.Component",
429       "example" : "",
430       "deprecated" : "",
431       "since" : "",
432       "see" : "",
433       "params" : [
434         {
435           "name" : "visible",
436           "type" : "Boolean",
437           "desc" : "True to show, false to hide",
438           "isOptional" : false
439         }
440       ],
441       "returns" : [
442         {
443           "name" : "",
444           "type" : "Roo.Component",
445           "desc" : "this"
446         }
447       ]
448     },
449     {
450       "name" : "disable",
451       "desc" : "Disable this component.",
452       "isStatic" : false,
453       "isConstructor" : false,
454       "isPrivate" : false,
455       "memberOf" : "Roo.Component",
456       "example" : "",
457       "deprecated" : "",
458       "since" : "",
459       "see" : "",
460       "params" : [],
461       "returns" : [
462         {
463           "name" : "",
464           "type" : "Roo.Component",
465           "desc" : "this"
466         }
467       ]
468     },
469     {
470       "name" : "getEl",
471       "desc" : "Returns the underlying {@link Roo.Element}.",
472       "isStatic" : false,
473       "isConstructor" : false,
474       "isPrivate" : false,
475       "memberOf" : "Roo.Component",
476       "example" : "",
477       "deprecated" : "",
478       "since" : "",
479       "see" : "",
480       "params" : [],
481       "returns" : [
482         {
483           "name" : "",
484           "type" : "Roo.Element",
485           "desc" : "The element"
486         }
487       ]
488     },
489     {
490       "name" : "purgeListeners",
491       "desc" : "Removes all listeners for this object",
492       "isStatic" : false,
493       "isConstructor" : false,
494       "isPrivate" : false,
495       "memberOf" : "Roo.util.Observable",
496       "example" : "",
497       "deprecated" : "",
498       "since" : "",
499       "see" : "",
500       "params" : [],
501       "returns" : []
502     },
503     {
504       "name" : "on",
505       "desc" : "Appends an event handler to this element (shorthand for addListener)",
506       "isStatic" : false,
507       "isConstructor" : false,
508       "isPrivate" : false,
509       "memberOf" : "Roo.util.Observable",
510       "example" : "",
511       "deprecated" : "",
512       "since" : "",
513       "see" : "",
514       "params" : [
515         {
516           "name" : "eventName",
517           "type" : "String",
518           "desc" : "The type of event to listen for",
519           "isOptional" : false
520         },
521         {
522           "name" : "handler",
523           "type" : "Function",
524           "desc" : "The method the event invokes",
525           "isOptional" : false
526         },
527         {
528           "name" : "scope",
529           "type" : "Object",
530           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
531           "isOptional" : false
532         },
533         {
534           "name" : "options",
535           "type" : "Object",
536           "desc" : "(optional)",
537           "isOptional" : false
538         }
539       ],
540       "returns" : []
541     },
542     {
543       "name" : "un",
544       "desc" : "Removes a listener (shorthand for removeListener)",
545       "isStatic" : false,
546       "isConstructor" : false,
547       "isPrivate" : false,
548       "memberOf" : "Roo.util.Observable",
549       "example" : "",
550       "deprecated" : "",
551       "since" : "",
552       "see" : "",
553       "params" : [
554         {
555           "name" : "eventName",
556           "type" : "String",
557           "desc" : "The type of event to listen for",
558           "isOptional" : false
559         },
560         {
561           "name" : "handler",
562           "type" : "Function",
563           "desc" : "The handler to remove",
564           "isOptional" : false
565         },
566         {
567           "name" : "scope",
568           "type" : "Object",
569           "desc" : "(optional) The scope (this object) for the handler",
570           "isOptional" : false
571         }
572       ],
573       "returns" : []
574     },
575     {
576       "name" : "addEvents",
577       "desc" : "Used to define events on this Observable",
578       "isStatic" : false,
579       "isConstructor" : false,
580       "isPrivate" : false,
581       "memberOf" : "Roo.util.Observable",
582       "example" : "",
583       "deprecated" : "",
584       "since" : "",
585       "see" : "",
586       "params" : [
587         {
588           "name" : "object",
589           "type" : "Object",
590           "desc" : "The object with the events defined",
591           "isOptional" : false
592         }
593       ],
594       "returns" : []
595     },
596     {
597       "name" : "releaseCapture",
598       "desc" : "Removes <b>all</b> added captures from the Observable.",
599       "isStatic" : true,
600       "isConstructor" : false,
601       "isPrivate" : false,
602       "memberOf" : "Roo.util.Observable",
603       "example" : "",
604       "deprecated" : "",
605       "since" : "",
606       "see" : "",
607       "params" : [
608         {
609           "name" : "o",
610           "type" : "Observable",
611           "desc" : "The Observable to release",
612           "isOptional" : false
613         }
614       ],
615       "returns" : []
616     },
617     {
618       "name" : "removeListener",
619       "desc" : "Removes a listener",
620       "isStatic" : false,
621       "isConstructor" : false,
622       "isPrivate" : false,
623       "memberOf" : "Roo.util.Observable",
624       "example" : "",
625       "deprecated" : "",
626       "since" : "",
627       "see" : "",
628       "params" : [
629         {
630           "name" : "eventName",
631           "type" : "String",
632           "desc" : "The type of event to listen for",
633           "isOptional" : false
634         },
635         {
636           "name" : "handler",
637           "type" : "Function",
638           "desc" : "The handler to remove",
639           "isOptional" : false
640         },
641         {
642           "name" : "scope",
643           "type" : "Object",
644           "desc" : "(optional) The scope (this object) for the handler",
645           "isOptional" : false
646         }
647       ],
648       "returns" : []
649     },
650     {
651       "name" : "fireEvent",
652       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
653       "isStatic" : false,
654       "isConstructor" : false,
655       "isPrivate" : false,
656       "memberOf" : "Roo.util.Observable",
657       "example" : "",
658       "deprecated" : "",
659       "since" : "",
660       "see" : "",
661       "params" : [
662         {
663           "name" : "eventName",
664           "type" : "String",
665           "desc" : "",
666           "isOptional" : false
667         },
668         {
669           "name" : "args",
670           "type" : "Object...",
671           "desc" : "Variable number of parameters are passed to handlers",
672           "isOptional" : false
673         }
674       ],
675       "returns" : [
676         {
677           "name" : "",
678           "type" : "Boolean",
679           "desc" : "returns false if any of the handlers return false otherwise it returns true"
680         }
681       ]
682     },
683     {
684       "name" : "hasListener",
685       "desc" : "Checks to see if this object has any listeners for a specified event",
686       "isStatic" : false,
687       "isConstructor" : false,
688       "isPrivate" : false,
689       "memberOf" : "Roo.util.Observable",
690       "example" : "",
691       "deprecated" : "",
692       "since" : "",
693       "see" : "",
694       "params" : [
695         {
696           "name" : "eventName",
697           "type" : "String",
698           "desc" : "The name of the event to check for",
699           "isOptional" : false
700         }
701       ],
702       "returns" : [
703         {
704           "name" : "",
705           "type" : "Boolean",
706           "desc" : "True if the event is being listened for, else false"
707         }
708       ]
709     },
710     {
711       "name" : "capture",
712       "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.",
713       "isStatic" : true,
714       "isConstructor" : false,
715       "isPrivate" : false,
716       "memberOf" : "Roo.util.Observable",
717       "example" : "",
718       "deprecated" : "",
719       "since" : "",
720       "see" : "",
721       "params" : [
722         {
723           "name" : "o",
724           "type" : "Observable",
725           "desc" : "The Observable to capture",
726           "isOptional" : false
727         },
728         {
729           "name" : "fn",
730           "type" : "Function",
731           "desc" : "The function to call",
732           "isOptional" : false
733         },
734         {
735           "name" : "scope",
736           "type" : "Object",
737           "desc" : "(optional) The scope (this object) for the fn",
738           "isOptional" : false
739         }
740       ],
741       "returns" : []
742     },
743     {
744       "name" : "addListener",
745       "desc" : "Appends an event handler to this component",
746       "isStatic" : false,
747       "isConstructor" : false,
748       "isPrivate" : false,
749       "memberOf" : "Roo.util.Observable",
750       "example" : "",
751       "deprecated" : "",
752       "since" : "",
753       "see" : "",
754       "params" : [
755         {
756           "name" : "eventName",
757           "type" : "String",
758           "desc" : "The type of event to listen for",
759           "isOptional" : false
760         },
761         {
762           "name" : "handler",
763           "type" : "Function",
764           "desc" : "The method the event invokes",
765           "isOptional" : false
766         },
767         {
768           "name" : "scope",
769           "type" : "Object",
770           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
771           "isOptional" : false
772         },
773         {
774           "name" : "options",
775           "type" : "Object",
776           "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>",
777           "isOptional" : false
778         }
779       ],
780       "returns" : []
781     }
782   ],
783   "events" : [
784     {
785       "name" : "changed",
786       "desc" : "Fires when the active status changes",
787       "memberOf" : "Roo.bootstrap.TabPanel",
788       "example" : "",
789       "deprecated" : "",
790       "since" : "",
791       "see" : "",
792       "params" : [
793         {
794           "name" : "this",
795           "type" : "Roo.bootstrap.TabPanel",
796           "desc" : "",
797           "isOptional" : false
798         },
799         {
800           "name" : "state",
801           "type" : "Boolean",
802           "desc" : "the new state",
803           "isOptional" : false
804         }
805       ],
806       "returns" : []
807     },
808     {
809       "name" : "beforedeactivate",
810       "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
811       "memberOf" : "Roo.bootstrap.TabPanel",
812       "example" : "",
813       "deprecated" : "",
814       "since" : "",
815       "see" : "",
816       "params" : [
817         {
818           "name" : "this",
819           "type" : "Roo.bootstrap.TabPanel",
820           "desc" : "",
821           "isOptional" : false
822         }
823       ],
824       "returns" : [
825         {
826           "name" : "",
827           "type" : "Boolean",
828           "desc" : "false if there is an error"
829         }
830       ]
831     },
832     {
833       "name" : "childrenrendered",
834       "desc" : "Fires when the children have been rendered..",
835       "memberOf" : "Roo.bootstrap.Component",
836       "example" : "",
837       "deprecated" : "",
838       "since" : "",
839       "see" : "",
840       "params" : [
841         {
842           "name" : "this",
843           "type" : "Roo.bootstrap.Component",
844           "desc" : "",
845           "isOptional" : false
846         }
847       ],
848       "returns" : []
849     },
850     {
851       "name" : "beforerender",
852       "desc" : "Fires before the component is rendered. Return false to stop the render.",
853       "memberOf" : "Roo.Component",
854       "example" : "",
855       "deprecated" : "",
856       "since" : "",
857       "see" : "",
858       "params" : [
859         {
860           "name" : "this",
861           "type" : "Roo.Component",
862           "desc" : "",
863           "isOptional" : false
864         }
865       ],
866       "returns" : []
867     },
868     {
869       "name" : "disable",
870       "desc" : "Fires after the component is disabled.",
871       "memberOf" : "Roo.Component",
872       "example" : "",
873       "deprecated" : "",
874       "since" : "",
875       "see" : "",
876       "params" : [
877         {
878           "name" : "this",
879           "type" : "Roo.Component",
880           "desc" : "",
881           "isOptional" : false
882         }
883       ],
884       "returns" : []
885     },
886     {
887       "name" : "render",
888       "desc" : "Fires after the component is rendered.",
889       "memberOf" : "Roo.Component",
890       "example" : "",
891       "deprecated" : "",
892       "since" : "",
893       "see" : "",
894       "params" : [
895         {
896           "name" : "this",
897           "type" : "Roo.Component",
898           "desc" : "",
899           "isOptional" : false
900         }
901       ],
902       "returns" : []
903     },
904     {
905       "name" : "destroy",
906       "desc" : "Fires after the component is destroyed.",
907       "memberOf" : "Roo.Component",
908       "example" : "",
909       "deprecated" : "",
910       "since" : "",
911       "see" : "",
912       "params" : [
913         {
914           "name" : "this",
915           "type" : "Roo.Component",
916           "desc" : "",
917           "isOptional" : false
918         }
919       ],
920       "returns" : []
921     },
922     {
923       "name" : "hide",
924       "desc" : "Fires after the component is hidden.",
925       "memberOf" : "Roo.Component",
926       "example" : "",
927       "deprecated" : "",
928       "since" : "",
929       "see" : "",
930       "params" : [
931         {
932           "name" : "this",
933           "type" : "Roo.Component",
934           "desc" : "",
935           "isOptional" : false
936         }
937       ],
938       "returns" : []
939     },
940     {
941       "name" : "beforehide",
942       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
943       "memberOf" : "Roo.Component",
944       "example" : "",
945       "deprecated" : "",
946       "since" : "",
947       "see" : "",
948       "params" : [
949         {
950           "name" : "this",
951           "type" : "Roo.Component",
952           "desc" : "",
953           "isOptional" : false
954         }
955       ],
956       "returns" : []
957     },
958     {
959       "name" : "show",
960       "desc" : "Fires after the component is shown.",
961       "memberOf" : "Roo.Component",
962       "example" : "",
963       "deprecated" : "",
964       "since" : "",
965       "see" : "",
966       "params" : [
967         {
968           "name" : "this",
969           "type" : "Roo.Component",
970           "desc" : "",
971           "isOptional" : false
972         }
973       ],
974       "returns" : []
975     },
976     {
977       "name" : "beforeshow",
978       "desc" : "Fires before the component is shown.  Return false to stop the show.",
979       "memberOf" : "Roo.Component",
980       "example" : "",
981       "deprecated" : "",
982       "since" : "",
983       "see" : "",
984       "params" : [
985         {
986           "name" : "this",
987           "type" : "Roo.Component",
988           "desc" : "",
989           "isOptional" : false
990         }
991       ],
992       "returns" : []
993     },
994     {
995       "name" : "enable",
996       "desc" : "Fires after the component is enabled.",
997       "memberOf" : "Roo.Component",
998       "example" : "",
999       "deprecated" : "",
1000       "since" : "",
1001       "see" : "",
1002       "params" : [
1003         {
1004           "name" : "this",
1005           "type" : "Roo.Component",
1006           "desc" : "",
1007           "isOptional" : false
1008         }
1009       ],
1010       "returns" : []
1011     },
1012     {
1013       "name" : "beforedestroy",
1014       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1015       "memberOf" : "Roo.Component",
1016       "example" : "",
1017       "deprecated" : "",
1018       "since" : "",
1019       "see" : "",
1020       "params" : [
1021         {
1022           "name" : "this",
1023           "type" : "Roo.Component",
1024           "desc" : "",
1025           "isOptional" : false
1026         }
1027       ],
1028       "returns" : []
1029     }
1030   ]
1031 }