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