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