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