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