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