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