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