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