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