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