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