3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
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.
12 * Create a new DateField
13 * @param {Object} config
16 Ext.form.DateField = Ext.extend(Ext.form.TriggerField, {
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>).
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>).
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",
31 * @cfg {String} disabledDaysText
32 * The tooltip to display when the date falls on a disabled day (defaults to <tt>'Disabled'</tt>)
34 disabledDaysText : "Disabled",
36 * @cfg {String} disabledDatesText
37 * The tooltip text to display when the date falls on a disabled date (defaults to <tt>'Disabled'</tt>)
39 disabledDatesText : "Disabled",
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>).
45 minText : "The date in this field must be equal to or after {0}",
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>).
51 maxText : "The date in this field must be equal to or before {0}",
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>).
57 invalidText : "{0} is not a valid date - it must be in the format {1}",
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).
64 triggerClass : 'x-form-date-trigger',
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>).
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).
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).
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:
87 disabledDays: [1,2,3,4,5]
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"]
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>.
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"}
118 defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"},
120 initComponent : function(){
121 Ext.form.DateField.superclass.initComponent.call(this);
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
133 if(Ext.isString(this.minValue)){
134 this.minValue = this.parseDate(this.minValue);
136 if(Ext.isString(this.maxValue)){
137 this.maxValue = this.parseDate(this.maxValue);
139 this.disabledDatesRE = null;
140 this.initDisabledDays();
144 initDisabledDays : function(){
145 if(this.disabledDates){
146 var dd = this.disabledDates,
150 Ext.each(dd, function(d, i){
151 re += Ext.isDate(d) ? '^' + Ext.escapeRe(d.dateFormat(this.format)) + '$' : dd[i];
156 this.disabledDatesRE = new RegExp(re + ')');
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.
165 setDisabledDates : function(dd){
166 this.disabledDates = dd;
167 this.initDisabledDays();
169 this.menu.picker.setDisabledDates(this.disabledDatesRE);
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.
178 setDisabledDays : function(dd){
179 this.disabledDays = dd;
181 this.menu.picker.setDisabledDays(dd);
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
189 setMinValue : function(dt){
190 this.minValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
192 this.menu.picker.setMinDate(this.minValue);
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
200 setMaxValue : function(dt){
201 this.maxValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
203 this.menu.picker.setMaxDate(this.maxValue);
208 validateValue : function(value){
209 value = this.formatDate(value);
210 if(!Ext.form.DateField.superclass.validateValue.call(this, value)){
213 if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid
217 value = this.parseDate(value);
219 this.markInvalid(String.format(this.invalidText, svalue, this.format));
222 var time = value.getTime();
223 if(this.minValue && time < this.minValue.getTime()){
224 this.markInvalid(String.format(this.minText, this.formatDate(this.minValue)));
227 if(this.maxValue && time > this.maxValue.getTime()){
228 this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue)));
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);
240 var fvalue = this.formatDate(value);
241 if(this.disabledDatesRE && this.disabledDatesRE.test(fvalue)){
242 this.markInvalid(String.format(this.disabledDatesText, fvalue));
249 // Provides logic to override the default TriggerField.validateBlur which just returns true
250 validateBlur : function(){
251 return !this.menu || !this.menu.isVisible();
255 * Returns the current date value of the date field.
256 * @return {Date} The date value
258 getValue : function(){
259 return this.parseDate(Ext.form.DateField.superclass.getValue.call(this)) || "";
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>).
268 //All of these calls set the same date value (May 4, 2006)
270 //Pass a date object:
271 var dt = new Date('5/4/2006');
272 dateField.setValue(dt);
274 //Pass a date string (default format):
275 dateField.setValue('05/04/2006');
277 //Pass a date string (custom format):
278 dateField.format = 'Y-m-d';
279 dateField.setValue('2006-05-04');
281 * @param {String/Date} date The date or valid date string
282 * @return {Ext.form.Field} this
284 setValue : function(date){
285 return Ext.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
289 parseDate : function(value){
290 if(!value || Ext.isDate(value)){
293 var v = Date.parseDate(value, this.format);
294 if(!v && this.altFormats){
295 if(!this.altFormatsArray){
296 this.altFormatsArray = this.altFormats.split("|");
298 for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){
299 v = Date.parseDate(value, this.altFormatsArray[i]);
306 onDestroy : function(){
307 Ext.destroy(this.menu);
308 Ext.form.DateField.superclass.onDestroy.call(this);
312 formatDate : function(date){
313 return Ext.isDate(date) ? date.dateFormat(this.format) : date;
317 * @method onTriggerClick
321 // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
322 onTriggerClick : function(){
326 if(this.menu == null){
327 this.menu = new Ext.menu.DateMenu({
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))
344 this.menu.picker.setValue(this.getValue() || new Date());
345 this.menu.show(this.el, "tl-bl?");
346 this.menuEvents('on');
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);
356 onSelect: function(m, d){
358 this.fireEvent('select', this, d);
362 onMenuHide: function(){
363 this.focus(false, 60);
364 this.menuEvents('un');
368 beforeBlur : function(){
369 var v = this.parseDate(this.getRawValue());
376 * @cfg {Boolean} grow @hide
379 * @cfg {Number} growMin @hide
382 * @cfg {Number} growMax @hide
389 Ext.reg('datefield', Ext.form.DateField);