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