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