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