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