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