Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / src / widgets / form / DateField.js
1 /*!
2  * Ext JS Library 3.0.3
3  * Copyright(c) 2006-2009 Ext JS, LLC
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 /**
8  * @class Ext.form.DateField
9  * @extends Ext.form.TriggerField
10  * Provides a date input field with a {@link Ext.DatePicker} dropdown and automatic date validation.
11  * @constructor
12  * Create a new DateField
13  * @param {Object} config
14  * @xtype datefield
15  */
16 Ext.form.DateField = Ext.extend(Ext.form.TriggerField,  {
17     /**
18      * @cfg {String} format
19      * The default date format string which can be overriden for localization support.  The format must be
20      * valid according to {@link Date#parseDate} (defaults to <tt>'m/d/Y'</tt>).
21      */
22     format : "m/d/Y",
23     /**
24      * @cfg {String} altFormats
25      * Multiple date formats separated by "<tt>|</tt>" to try when parsing a user input value and it
26      * does not match the defined format (defaults to
27      * <tt>'m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d'</tt>).
28      */
29     altFormats : "m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d",
30     /**
31      * @cfg {String} disabledDaysText
32      * The tooltip to display when the date falls on a disabled day (defaults to <tt>'Disabled'</tt>)
33      */
34     disabledDaysText : "Disabled",
35     /**
36      * @cfg {String} disabledDatesText
37      * The tooltip text to display when the date falls on a disabled date (defaults to <tt>'Disabled'</tt>)
38      */
39     disabledDatesText : "Disabled",
40     /**
41      * @cfg {String} minText
42      * The error text to display when the date in the cell is before <tt>{@link #minValue}</tt> (defaults to
43      * <tt>'The date in this field must be after {minValue}'</tt>).
44      */
45     minText : "The date in this field must be equal to or after {0}",
46     /**
47      * @cfg {String} maxText
48      * The error text to display when the date in the cell is after <tt>{@link #maxValue}</tt> (defaults to
49      * <tt>'The date in this field must be before {maxValue}'</tt>).
50      */
51     maxText : "The date in this field must be equal to or before {0}",
52     /**
53      * @cfg {String} invalidText
54      * The error text to display when the date in the field is invalid (defaults to
55      * <tt>'{value} is not a valid date - it must be in the format {format}'</tt>).
56      */
57     invalidText : "{0} is not a valid date - it must be in the format {1}",
58     /**
59      * @cfg {String} triggerClass
60      * An additional CSS class used to style the trigger button.  The trigger will always get the
61      * class <tt>'x-form-trigger'</tt> and <tt>triggerClass</tt> will be <b>appended</b> if specified
62      * (defaults to <tt>'x-form-date-trigger'</tt> which displays a calendar icon).
63      */
64     triggerClass : 'x-form-date-trigger',
65     /**
66      * @cfg {Boolean} showToday
67      * <tt>false</tt> to hide the footer area of the DatePicker containing the Today button and disable
68      * the keyboard handler for spacebar that selects the current date (defaults to <tt>true</tt>).
69      */
70     showToday : true,
71     /**
72      * @cfg {Date/String} minValue
73      * The minimum allowed date. Can be either a Javascript date object or a string date in a
74      * valid format (defaults to null).
75      */
76     /**
77      * @cfg {Date/String} maxValue
78      * The maximum allowed date. Can be either a Javascript date object or a string date in a
79      * valid format (defaults to null).
80      */
81     /**
82      * @cfg {Array} disabledDays
83      * An array of days to disable, 0 based (defaults to null). Some examples:<pre><code>
84 // disable Sunday and Saturday:
85 disabledDays:  [0, 6]
86 // disable weekdays:
87 disabledDays: [1,2,3,4,5]
88      * </code></pre>
89      */
90     /**
91      * @cfg {Array} disabledDates
92      * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
93      * expression so they are very powerful. Some examples:<pre><code>
94 // disable these exact dates:
95 disabledDates: ["03/08/2003", "09/16/2003"]
96 // disable these days for every year:
97 disabledDates: ["03/08", "09/16"]
98 // only match the beginning (useful if you are using short years):
99 disabledDates: ["^03/08"]
100 // disable every day in March 2006:
101 disabledDates: ["03/../2006"]
102 // disable every day in every March:
103 disabledDates: ["^03"]
104      * </code></pre>
105      * Note that the format of the dates included in the array should exactly match the {@link #format} config.
106      * In order to support regular expressions, if you are using a {@link #format date format} that has "." in
107      * it, you will have to escape the dot when restricting dates. For example: <tt>["03\\.08\\.03"]</tt>.
108      */
109     /**
110      * @cfg {String/Object} autoCreate
111      * A {@link Ext.DomHelper DomHelper element specification object}, or <tt>true</tt> for the default element
112      * specification object:<pre><code>
113      * autoCreate: {tag: "input", type: "text", size: "10", autocomplete: "off"}
114      * </code></pre>
115      */
116
117     // private
118     defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"},
119
120     initComponent : function(){
121         Ext.form.DateField.superclass.initComponent.call(this);
122
123         this.addEvents(
124             /**
125              * @event select
126              * Fires when a date is selected via the date picker.
127              * @param {Ext.form.DateField} this
128              * @param {Date} date The date that was selected
129              */
130             'select'
131         );
132
133         if(Ext.isString(this.minValue)){
134             this.minValue = this.parseDate(this.minValue);
135         }
136         if(Ext.isString(this.maxValue)){
137             this.maxValue = this.parseDate(this.maxValue);
138         }
139         this.disabledDatesRE = null;
140         this.initDisabledDays();
141     },
142
143     // private
144     initDisabledDays : function(){
145         if(this.disabledDates){
146             var dd = this.disabledDates,
147                 len = dd.length - 1, 
148                 re = "(?:";
149                 
150             Ext.each(dd, function(d, i){
151                 re += Ext.isDate(d) ? '^' + Ext.escapeRe(d.dateFormat(this.format)) + '$' : dd[i];
152                 if(i != len){
153                     re += '|';
154                 }
155             }, this);
156             this.disabledDatesRE = new RegExp(re + ')');
157         }
158     },
159
160     /**
161      * Replaces any existing disabled dates with new values and refreshes the DatePicker.
162      * @param {Array} disabledDates An array of date strings (see the <tt>{@link #disabledDates}</tt> config
163      * for details on supported values) used to disable a pattern of dates.
164      */
165     setDisabledDates : function(dd){
166         this.disabledDates = dd;
167         this.initDisabledDays();
168         if(this.menu){
169             this.menu.picker.setDisabledDates(this.disabledDatesRE);
170         }
171     },
172
173     /**
174      * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker.
175      * @param {Array} disabledDays An array of disabled day indexes. See the <tt>{@link #disabledDays}</tt>
176      * config for details on supported values.
177      */
178     setDisabledDays : function(dd){
179         this.disabledDays = dd;
180         if(this.menu){
181             this.menu.picker.setDisabledDays(dd);
182         }
183     },
184
185     /**
186      * Replaces any existing <tt>{@link #minValue}</tt> with the new value and refreshes the DatePicker.
187      * @param {Date} value The minimum date that can be selected
188      */
189     setMinValue : function(dt){
190         this.minValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
191         if(this.menu){
192             this.menu.picker.setMinDate(this.minValue);
193         }
194     },
195
196     /**
197      * Replaces any existing <tt>{@link #maxValue}</tt> with the new value and refreshes the DatePicker.
198      * @param {Date} value The maximum date that can be selected
199      */
200     setMaxValue : function(dt){
201         this.maxValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
202         if(this.menu){
203             this.menu.picker.setMaxDate(this.maxValue);
204         }
205     },
206
207     // private
208     validateValue : function(value){
209         value = this.formatDate(value);
210         if(!Ext.form.DateField.superclass.validateValue.call(this, value)){
211             return false;
212         }
213         if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid
214              return true;
215         }
216         var svalue = value;
217         value = this.parseDate(value);
218         if(!value){
219             this.markInvalid(String.format(this.invalidText, svalue, this.format));
220             return false;
221         }
222         var time = value.getTime();
223         if(this.minValue && time < this.minValue.getTime()){
224             this.markInvalid(String.format(this.minText, this.formatDate(this.minValue)));
225             return false;
226         }
227         if(this.maxValue && time > this.maxValue.getTime()){
228             this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue)));
229             return false;
230         }
231         if(this.disabledDays){
232             var day = value.getDay();
233             for(var i = 0; i < this.disabledDays.length; i++) {
234                 if(day === this.disabledDays[i]){
235                     this.markInvalid(this.disabledDaysText);
236                     return false;
237                 }
238             }
239         }
240         var fvalue = this.formatDate(value);
241         if(this.disabledDatesRE && this.disabledDatesRE.test(fvalue)){
242             this.markInvalid(String.format(this.disabledDatesText, fvalue));
243             return false;
244         }
245         return true;
246     },
247
248     // private
249     // Provides logic to override the default TriggerField.validateBlur which just returns true
250     validateBlur : function(){
251         return !this.menu || !this.menu.isVisible();
252     },
253
254     /**
255      * Returns the current date value of the date field.
256      * @return {Date} The date value
257      */
258     getValue : function(){
259         return this.parseDate(Ext.form.DateField.superclass.getValue.call(this)) || "";
260     },
261
262     /**
263      * Sets the value of the date field.  You can pass a date object or any string that can be
264      * parsed into a valid date, using <tt>{@link #format}</tt> as the date format, according
265      * to the same rules as {@link Date#parseDate} (the default format used is <tt>"m/d/Y"</tt>).
266      * <br />Usage:
267      * <pre><code>
268 //All of these calls set the same date value (May 4, 2006)
269
270 //Pass a date object:
271 var dt = new Date('5/4/2006');
272 dateField.setValue(dt);
273
274 //Pass a date string (default format):
275 dateField.setValue('05/04/2006');
276
277 //Pass a date string (custom format):
278 dateField.format = 'Y-m-d';
279 dateField.setValue('2006-05-04');
280 </code></pre>
281      * @param {String/Date} date The date or valid date string
282      * @return {Ext.form.Field} this
283      */
284     setValue : function(date){
285         return Ext.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
286     },
287
288     // private
289     parseDate : function(value){
290         if(!value || Ext.isDate(value)){
291             return value;
292         }
293         var v = Date.parseDate(value, this.format);
294         if(!v && this.altFormats){
295             if(!this.altFormatsArray){
296                 this.altFormatsArray = this.altFormats.split("|");
297             }
298             for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){
299                 v = Date.parseDate(value, this.altFormatsArray[i]);
300             }
301         }
302         return v;
303     },
304
305     // private
306     onDestroy : function(){
307                 Ext.destroy(this.menu);
308         Ext.form.DateField.superclass.onDestroy.call(this);
309     },
310
311     // private
312     formatDate : function(date){
313         return Ext.isDate(date) ? date.dateFormat(this.format) : date;
314     },
315
316     /**
317      * @method onTriggerClick
318      * @hide
319      */
320     // private
321     // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
322     onTriggerClick : function(){
323         if(this.disabled){
324             return;
325         }
326         if(this.menu == null){
327             this.menu = new Ext.menu.DateMenu({
328                 hideOnClick: false
329             });
330         }
331         this.onFocus();
332         Ext.apply(this.menu.picker,  {
333             minDate : this.minValue,
334             maxDate : this.maxValue,
335             disabledDatesRE : this.disabledDatesRE,
336             disabledDatesText : this.disabledDatesText,
337             disabledDays : this.disabledDays,
338             disabledDaysText : this.disabledDaysText,
339             format : this.format,
340             showToday : this.showToday,
341             minText : String.format(this.minText, this.formatDate(this.minValue)),
342             maxText : String.format(this.maxText, this.formatDate(this.maxValue))
343         });
344         this.menu.picker.setValue(this.getValue() || new Date());
345         this.menu.show(this.el, "tl-bl?");
346         this.menuEvents('on');
347     },
348     
349     //private
350     menuEvents: function(method){
351         this.menu[method]('select', this.onSelect, this);
352         this.menu[method]('hide', this.onMenuHide, this);
353         this.menu[method]('show', this.onFocus, this);
354     },
355     
356     onSelect: function(m, d){
357         this.setValue(d);
358         this.fireEvent('select', this, d);
359         this.menu.hide();
360     },
361     
362     onMenuHide: function(){
363         this.focus(false, 60);
364         this.menuEvents('un');
365     },
366
367     // private
368     beforeBlur : function(){
369         var v = this.parseDate(this.getRawValue());
370         if(v){
371             this.setValue(v);
372         }
373     }
374
375     /**
376      * @cfg {Boolean} grow @hide
377      */
378     /**
379      * @cfg {Number} growMin @hide
380      */
381     /**
382      * @cfg {Number} growMax @hide
383      */
384     /**
385      * @hide
386      * @method autoSize
387      */
388 });
389 Ext.reg('datefield', Ext.form.DateField);