b59dbe1e09d825245505ffc1ad04c7e69f978006
[roojs1] / docs / symbols / Roo.DatePicker.json
1 {
2   "name" : "Roo.DatePicker",
3   "augments" : [
4     "Roo.Component",
5     "Roo.util.Observable"
6   ],
7   "childClasses" : {  },
8   "tree_children" : [],
9   "tree_parent" : [],
10   "desc" : "Simple date picker class.",
11   "isSingleton" : false,
12   "isStatic" : false,
13   "isBuiltin" : false,
14   "isAbstract" : false,
15   "isBuilderTop" : false,
16   "memberOf" : "DatePicker",
17   "example" : "",
18   "deprecated" : "",
19   "since" : "",
20   "see" : "",
21   "params" : [
22     {
23       "name" : "config",
24       "type" : "Object",
25       "desc" : "The config object",
26       "isOptional" : false
27     }
28   ],
29   "returns" : [],
30   "throws" : "",
31   "requires" : "",
32   "config" : [
33     {
34       "name" : "startDay",
35       "type" : "Number",
36       "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
37       "memberOf" : "Roo.DatePicker"
38     },
39     {
40       "name" : "monthYearText",
41       "type" : "String",
42       "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
43       "memberOf" : "Roo.DatePicker"
44     },
45     {
46       "name" : "monthNames",
47       "type" : "Array",
48       "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
49       "memberOf" : "Roo.DatePicker"
50     },
51     {
52       "name" : "listeners",
53       "type" : "Object",
54       "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>",
55       "memberOf" : "Roo.util.Observable"
56     },
57     {
58       "name" : "format",
59       "type" : "String",
60       "desc" : "The default date format string which can be overriden for localization support.  The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
61       "memberOf" : "Roo.DatePicker"
62     },
63     {
64       "name" : "nextText",
65       "type" : "String",
66       "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
67       "memberOf" : "Roo.DatePicker"
68     },
69     {
70       "name" : "maxText",
71       "type" : "String",
72       "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
73       "memberOf" : "Roo.DatePicker"
74     },
75     {
76       "name" : "constrainToViewport",
77       "type" : "Boolean",
78       "desc" : "True to constrain the date picker to the viewport (defaults to true)",
79       "memberOf" : "Roo.DatePicker"
80     },
81     {
82       "name" : "minText",
83       "type" : "String",
84       "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
85       "memberOf" : "Roo.DatePicker"
86     },
87     {
88       "name" : "disabledDatesText",
89       "type" : "String",
90       "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
91       "memberOf" : "Roo.DatePicker"
92     },
93     {
94       "name" : "todayTip",
95       "type" : "String",
96       "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
97       "memberOf" : "Roo.DatePicker"
98     },
99     {
100       "name" : "hideMode",
101       "type" : "String",
102       "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\".",
103       "memberOf" : "Roo.Component"
104     },
105     {
106       "name" : "todayText",
107       "type" : "String",
108       "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
109       "memberOf" : "Roo.DatePicker"
110     },
111     {
112       "name" : "cancelText",
113       "type" : "String",
114       "desc" : "The text to display on the cancel button",
115       "memberOf" : "Roo.DatePicker"
116     },
117     {
118       "name" : "allowDomMove",
119       "type" : "Boolean",
120       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
121       "memberOf" : "Roo.Component"
122     },
123     {
124       "name" : "showClear",
125       "type" : "Bool",
126       "desc" : "Show a clear button (usefull for date form elements that can be blank.)",
127       "memberOf" : "Roo.DatePicker"
128     },
129     {
130       "name" : "prevText",
131       "type" : "String",
132       "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
133       "memberOf" : "Roo.DatePicker"
134     },
135     {
136       "name" : "dayNames",
137       "type" : "Array",
138       "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
139       "memberOf" : "Roo.DatePicker"
140     },
141     {
142       "name" : "actionMode",
143       "type" : "String",
144       "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",
145       "memberOf" : "Roo.Component"
146     },
147     {
148       "name" : "disabledDaysText",
149       "type" : "String",
150       "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
151       "memberOf" : "Roo.DatePicker"
152     },
153     {
154       "name" : "disabledDatesRE",
155       "type" : "RegExp",
156       "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
157       "memberOf" : "Roo.DatePicker"
158     },
159     {
160       "name" : "minDate",
161       "type" : "Date",
162       "desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
163       "memberOf" : "Roo.DatePicker"
164     },
165     {
166       "name" : "disabledDays",
167       "type" : "Array",
168       "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
169       "memberOf" : "Roo.DatePicker"
170     },
171     {
172       "name" : "okText",
173       "type" : "String",
174       "desc" : "The text to display on the ok button",
175       "memberOf" : "Roo.DatePicker"
176     },
177     {
178       "name" : "maxDate",
179       "type" : "Date",
180       "desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
181       "memberOf" : "Roo.DatePicker"
182     },
183     {
184       "name" : "disableClass",
185       "type" : "String",
186       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
187       "memberOf" : "Roo.Component"
188     }
189   ],
190   "methods" : [
191     {
192       "name" : "getValue",
193       "type" : "function",
194       "desc" : "Gets the current selected value of the date field",
195       "sig" : "()\n{\n\n}",
196       "static" : false,
197       "memberOf" : "",
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           "name" : "",
211           "type" : "Date",
212           "desc" : "The selected date"
213         }
214       ]
215     },
216     {
217       "name" : "setValue",
218       "type" : "function",
219       "desc" : "Sets the value of the date field",
220       "sig" : "(value)",
221       "static" : false,
222       "memberOf" : "",
223       "isStatic" : false,
224       "isConstructor" : false,
225       "isPrivate" : false,
226       "example" : "",
227       "deprecated" : "",
228       "since" : "",
229       "see" : "",
230       "exceptions" : "",
231       "requires" : "",
232       "params" : [
233         {
234           "name" : "value",
235           "type" : "Date",
236           "desc" : "The date to set",
237           "isOptional" : false
238         }
239       ],
240       "returns" : []
241     },
242     {
243       "name" : "getId",
244       "type" : "function",
245       "desc" : "Returns the id of this component.",
246       "sig" : "()\n{\n\n}",
247       "static" : false,
248       "memberOf" : "Roo.Component",
249       "isStatic" : false,
250       "isConstructor" : false,
251       "isPrivate" : false,
252       "example" : "",
253       "deprecated" : "",
254       "since" : "",
255       "see" : "",
256       "exceptions" : "",
257       "requires" : "",
258       "params" : [],
259       "returns" : [
260         {
261           "name" : "",
262           "type" : "String",
263           "desc" : ""
264         }
265       ]
266     },
267     {
268       "name" : "render",
269       "type" : "function",
270       "desc" : "If this is a lazy rendering component, render it to its container element.",
271       "sig" : "(container)",
272       "static" : false,
273       "memberOf" : "Roo.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         {
285           "name" : "container",
286           "type" : "String/HTMLElement/Element",
287           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
288           "isOptional" : false
289         }
290       ],
291       "returns" : []
292     },
293     {
294       "name" : "destroy",
295       "type" : "function",
296       "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}.",
297       "sig" : "()\n{\n\n}",
298       "static" : false,
299       "memberOf" : "Roo.Component",
300       "isStatic" : false,
301       "isConstructor" : false,
302       "isPrivate" : false,
303       "example" : "",
304       "deprecated" : "",
305       "since" : "",
306       "see" : "",
307       "exceptions" : "",
308       "requires" : "",
309       "params" : [],
310       "returns" : []
311     },
312     {
313       "name" : "isVisible",
314       "type" : "function",
315       "desc" : "Returns true if this component is visible.",
316       "sig" : "()\n{\n\n}",
317       "static" : false,
318       "memberOf" : "Roo.Component",
319       "isStatic" : false,
320       "isConstructor" : false,
321       "isPrivate" : false,
322       "example" : "",
323       "deprecated" : "",
324       "since" : "",
325       "see" : "",
326       "exceptions" : "",
327       "requires" : "",
328       "params" : [],
329       "returns" : []
330     },
331     {
332       "name" : "setDisabled",
333       "type" : "function",
334       "desc" : "Convenience function for setting disabled/enabled by boolean.",
335       "sig" : "(disabled)",
336       "static" : false,
337       "memberOf" : "Roo.Component",
338       "isStatic" : false,
339       "isConstructor" : false,
340       "isPrivate" : false,
341       "example" : "",
342       "deprecated" : "",
343       "since" : "",
344       "see" : "",
345       "exceptions" : "",
346       "requires" : "",
347       "params" : [
348         {
349           "name" : "disabled",
350           "type" : "Boolean",
351           "desc" : "",
352           "isOptional" : false
353         }
354       ],
355       "returns" : []
356     },
357     {
358       "name" : "hide",
359       "type" : "function",
360       "desc" : "Hide this component.",
361       "sig" : "()\n{\n\n}",
362       "static" : false,
363       "memberOf" : "Roo.Component",
364       "isStatic" : false,
365       "isConstructor" : false,
366       "isPrivate" : false,
367       "example" : "",
368       "deprecated" : "",
369       "since" : "",
370       "see" : "",
371       "exceptions" : "",
372       "requires" : "",
373       "params" : [],
374       "returns" : [
375         {
376           "name" : "",
377           "type" : "Roo.Component",
378           "desc" : "this"
379         }
380       ]
381     },
382     {
383       "name" : "focus",
384       "type" : "function",
385       "desc" : "Try to focus this component.",
386       "sig" : "(selectText)",
387       "static" : false,
388       "memberOf" : "Roo.Component",
389       "isStatic" : false,
390       "isConstructor" : false,
391       "isPrivate" : false,
392       "example" : "",
393       "deprecated" : "",
394       "since" : "",
395       "see" : "",
396       "exceptions" : "",
397       "requires" : "",
398       "params" : [
399         {
400           "name" : "selectText",
401           "type" : "Boolean",
402           "desc" : "True to also select the text in this component (if applicable)",
403           "isOptional" : false
404         }
405       ],
406       "returns" : [
407         {
408           "name" : "",
409           "type" : "Roo.Component",
410           "desc" : "this"
411         }
412       ]
413     },
414     {
415       "name" : "show",
416       "type" : "function",
417       "desc" : "Show this component.",
418       "sig" : "()\n{\n\n}",
419       "static" : false,
420       "memberOf" : "Roo.Component",
421       "isStatic" : false,
422       "isConstructor" : false,
423       "isPrivate" : false,
424       "example" : "",
425       "deprecated" : "",
426       "since" : "",
427       "see" : "",
428       "exceptions" : "",
429       "requires" : "",
430       "params" : [],
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" : "select",
893       "type" : "function",
894       "desc" : "Fires when a date is selected",
895       "sig" : "function (_self, date)\n{\n\n}",
896       "memberOf" : "",
897       "example" : "",
898       "deprecated" : "",
899       "since" : "",
900       "see" : "",
901       "params" : [
902         {
903           "name" : "this",
904           "type" : "DatePicker",
905           "desc" : "",
906           "isOptional" : false
907         },
908         {
909           "name" : "date",
910           "type" : "Date",
911           "desc" : "The selected date",
912           "isOptional" : false
913         }
914       ],
915       "returns" : []
916     },
917     {
918       "name" : "monthchange",
919       "type" : "function",
920       "desc" : "Fires when the displayed month changes",
921       "sig" : "function (_self, date)\n{\n\n}",
922       "memberOf" : "",
923       "example" : "",
924       "deprecated" : "",
925       "since" : "",
926       "see" : "",
927       "params" : [
928         {
929           "name" : "this",
930           "type" : "DatePicker",
931           "desc" : "",
932           "isOptional" : false
933         },
934         {
935           "name" : "date",
936           "type" : "Date",
937           "desc" : "The selected month",
938           "isOptional" : false
939         }
940       ],
941       "returns" : []
942     },
943     {
944       "name" : "beforerender",
945       "type" : "function",
946       "desc" : "Fires before the component is rendered. Return false to stop the render.",
947       "sig" : "function (_self)\n{\n\n}",
948       "memberOf" : "Roo.Component",
949       "example" : "",
950       "deprecated" : "",
951       "since" : "",
952       "see" : "",
953       "params" : [
954         {
955           "name" : "this",
956           "type" : "Roo.Component",
957           "desc" : "",
958           "isOptional" : false
959         }
960       ],
961       "returns" : []
962     },
963     {
964       "name" : "disable",
965       "type" : "function",
966       "desc" : "Fires after the component is disabled.",
967       "sig" : "function (_self)\n{\n\n}",
968       "memberOf" : "Roo.Component",
969       "example" : "",
970       "deprecated" : "",
971       "since" : "",
972       "see" : "",
973       "params" : [
974         {
975           "name" : "this",
976           "type" : "Roo.Component",
977           "desc" : "",
978           "isOptional" : false
979         }
980       ],
981       "returns" : []
982     },
983     {
984       "name" : "render",
985       "type" : "function",
986       "desc" : "Fires after the component is rendered.",
987       "sig" : "function (_self)\n{\n\n}",
988       "memberOf" : "Roo.Component",
989       "example" : "",
990       "deprecated" : "",
991       "since" : "",
992       "see" : "",
993       "params" : [
994         {
995           "name" : "this",
996           "type" : "Roo.Component",
997           "desc" : "",
998           "isOptional" : false
999         }
1000       ],
1001       "returns" : []
1002     },
1003     {
1004       "name" : "destroy",
1005       "type" : "function",
1006       "desc" : "Fires after the component is destroyed.",
1007       "sig" : "function (_self)\n{\n\n}",
1008       "memberOf" : "Roo.Component",
1009       "example" : "",
1010       "deprecated" : "",
1011       "since" : "",
1012       "see" : "",
1013       "params" : [
1014         {
1015           "name" : "this",
1016           "type" : "Roo.Component",
1017           "desc" : "",
1018           "isOptional" : false
1019         }
1020       ],
1021       "returns" : []
1022     },
1023     {
1024       "name" : "hide",
1025       "type" : "function",
1026       "desc" : "Fires after the component is hidden.",
1027       "sig" : "function (_self)\n{\n\n}",
1028       "memberOf" : "Roo.Component",
1029       "example" : "",
1030       "deprecated" : "",
1031       "since" : "",
1032       "see" : "",
1033       "params" : [
1034         {
1035           "name" : "this",
1036           "type" : "Roo.Component",
1037           "desc" : "",
1038           "isOptional" : false
1039         }
1040       ],
1041       "returns" : []
1042     },
1043     {
1044       "name" : "beforehide",
1045       "type" : "function",
1046       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1047       "sig" : "function (_self)\n{\n\n}",
1048       "memberOf" : "Roo.Component",
1049       "example" : "",
1050       "deprecated" : "",
1051       "since" : "",
1052       "see" : "",
1053       "params" : [
1054         {
1055           "name" : "this",
1056           "type" : "Roo.Component",
1057           "desc" : "",
1058           "isOptional" : false
1059         }
1060       ],
1061       "returns" : []
1062     },
1063     {
1064       "name" : "show",
1065       "type" : "function",
1066       "desc" : "Fires after the component is shown.",
1067       "sig" : "function (_self)\n{\n\n}",
1068       "memberOf" : "Roo.Component",
1069       "example" : "",
1070       "deprecated" : "",
1071       "since" : "",
1072       "see" : "",
1073       "params" : [
1074         {
1075           "name" : "this",
1076           "type" : "Roo.Component",
1077           "desc" : "",
1078           "isOptional" : false
1079         }
1080       ],
1081       "returns" : []
1082     },
1083     {
1084       "name" : "beforeshow",
1085       "type" : "function",
1086       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1087       "sig" : "function (_self)\n{\n\n}",
1088       "memberOf" : "Roo.Component",
1089       "example" : "",
1090       "deprecated" : "",
1091       "since" : "",
1092       "see" : "",
1093       "params" : [
1094         {
1095           "name" : "this",
1096           "type" : "Roo.Component",
1097           "desc" : "",
1098           "isOptional" : false
1099         }
1100       ],
1101       "returns" : []
1102     },
1103     {
1104       "name" : "enable",
1105       "type" : "function",
1106       "desc" : "Fires after the component is enabled.",
1107       "sig" : "function (_self)\n{\n\n}",
1108       "memberOf" : "Roo.Component",
1109       "example" : "",
1110       "deprecated" : "",
1111       "since" : "",
1112       "see" : "",
1113       "params" : [
1114         {
1115           "name" : "this",
1116           "type" : "Roo.Component",
1117           "desc" : "",
1118           "isOptional" : false
1119         }
1120       ],
1121       "returns" : []
1122     },
1123     {
1124       "name" : "beforedestroy",
1125       "type" : "function",
1126       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1127       "sig" : "function (_self)\n{\n\n}",
1128       "memberOf" : "Roo.Component",
1129       "example" : "",
1130       "deprecated" : "",
1131       "since" : "",
1132       "see" : "",
1133       "params" : [
1134         {
1135           "name" : "this",
1136           "type" : "Roo.Component",
1137           "desc" : "",
1138           "isOptional" : false
1139         }
1140       ],
1141       "returns" : []
1142     }
1143   ]
1144 }