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();
143 initEvents: function() {
144 Ext.form.DateField.superclass.initEvents.call(this);
145 this.keyNav = new Ext.KeyNav(this.el, {
146 "down": function(e) {
147 this.onTriggerClick();
156 initDisabledDays : function(){
157 if(this.disabledDates){
158 var dd = this.disabledDates,
162 Ext.each(dd, function(d, i){
163 re += Ext.isDate(d) ? '^' + Ext.escapeRe(d.dateFormat(this.format)) + '$' : dd[i];
168 this.disabledDatesRE = new RegExp(re + ')');
173 * Replaces any existing disabled dates with new values and refreshes the DatePicker.
174 * @param {Array} disabledDates An array of date strings (see the <tt>{@link #disabledDates}</tt> config
175 * for details on supported values) used to disable a pattern of dates.
177 setDisabledDates : function(dd){
178 this.disabledDates = dd;
179 this.initDisabledDays();
181 this.menu.picker.setDisabledDates(this.disabledDatesRE);
186 * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker.
187 * @param {Array} disabledDays An array of disabled day indexes. See the <tt>{@link #disabledDays}</tt>
188 * config for details on supported values.
190 setDisabledDays : function(dd){
191 this.disabledDays = dd;
193 this.menu.picker.setDisabledDays(dd);
198 * Replaces any existing <tt>{@link #minValue}</tt> with the new value and refreshes the DatePicker.
199 * @param {Date} value The minimum date that can be selected
201 setMinValue : function(dt){
202 this.minValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
204 this.menu.picker.setMinDate(this.minValue);
209 * Replaces any existing <tt>{@link #maxValue}</tt> with the new value and refreshes the DatePicker.
210 * @param {Date} value The maximum date that can be selected
212 setMaxValue : function(dt){
213 this.maxValue = (Ext.isString(dt) ? this.parseDate(dt) : dt);
215 this.menu.picker.setMaxDate(this.maxValue);
220 validateValue : function(value){
221 value = this.formatDate(value);
222 if(!Ext.form.DateField.superclass.validateValue.call(this, value)){
225 if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid
229 value = this.parseDate(value);
231 this.markInvalid(String.format(this.invalidText, svalue, this.format));
234 var time = value.getTime();
235 if(this.minValue && time < this.minValue.getTime()){
236 this.markInvalid(String.format(this.minText, this.formatDate(this.minValue)));
239 if(this.maxValue && time > this.maxValue.getTime()){
240 this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue)));
243 if(this.disabledDays){
244 var day = value.getDay();
245 for(var i = 0; i < this.disabledDays.length; i++) {
246 if(day === this.disabledDays[i]){
247 this.markInvalid(this.disabledDaysText);
252 var fvalue = this.formatDate(value);
253 if(this.disabledDatesRE && this.disabledDatesRE.test(fvalue)){
254 this.markInvalid(String.format(this.disabledDatesText, fvalue));
261 // Provides logic to override the default TriggerField.validateBlur which just returns true
262 validateBlur : function(){
263 return !this.menu || !this.menu.isVisible();
267 * Returns the current date value of the date field.
268 * @return {Date} The date value
270 getValue : function(){
271 return this.parseDate(Ext.form.DateField.superclass.getValue.call(this)) || "";
275 * Sets the value of the date field. You can pass a date object or any string that can be
276 * parsed into a valid date, using <tt>{@link #format}</tt> as the date format, according
277 * to the same rules as {@link Date#parseDate} (the default format used is <tt>"m/d/Y"</tt>).
280 //All of these calls set the same date value (May 4, 2006)
282 //Pass a date object:
283 var dt = new Date('5/4/2006');
284 dateField.setValue(dt);
286 //Pass a date string (default format):
287 dateField.setValue('05/04/2006');
289 //Pass a date string (custom format):
290 dateField.format = 'Y-m-d';
291 dateField.setValue('2006-05-04');
293 * @param {String/Date} date The date or valid date string
294 * @return {Ext.form.Field} this
296 setValue : function(date){
297 return Ext.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
301 parseDate : function(value){
302 if(!value || Ext.isDate(value)){
305 var v = Date.parseDate(value, this.format);
306 if(!v && this.altFormats){
307 if(!this.altFormatsArray){
308 this.altFormatsArray = this.altFormats.split("|");
310 for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){
311 v = Date.parseDate(value, this.altFormatsArray[i]);
318 onDestroy : function(){
319 Ext.destroy(this.menu, this.keyNav);
320 Ext.form.DateField.superclass.onDestroy.call(this);
324 formatDate : function(date){
325 return Ext.isDate(date) ? date.dateFormat(this.format) : date;
329 * @method onTriggerClick
333 // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
334 onTriggerClick : function(){
338 if(this.menu == null){
339 this.menu = new Ext.menu.DateMenu({
345 Ext.apply(this.menu.picker, {
346 minDate : this.minValue,
347 maxDate : this.maxValue,
348 disabledDatesRE : this.disabledDatesRE,
349 disabledDatesText : this.disabledDatesText,
350 disabledDays : this.disabledDays,
351 disabledDaysText : this.disabledDaysText,
352 format : this.format,
353 showToday : this.showToday,
354 minText : String.format(this.minText, this.formatDate(this.minValue)),
355 maxText : String.format(this.maxText, this.formatDate(this.maxValue))
357 this.menu.picker.setValue(this.getValue() || new Date());
358 this.menu.show(this.el, "tl-bl?");
359 this.menuEvents('on');
363 menuEvents: function(method){
364 this.menu[method]('select', this.onSelect, this);
365 this.menu[method]('hide', this.onMenuHide, this);
366 this.menu[method]('show', this.onFocus, this);
369 onSelect: function(m, d){
371 this.fireEvent('select', this, d);
375 onMenuHide: function(){
376 this.focus(false, 60);
377 this.menuEvents('un');
381 beforeBlur : function(){
382 var v = this.parseDate(this.getRawValue());
389 * @cfg {Boolean} grow @hide
392 * @cfg {Number} growMin @hide
395 * @cfg {Number} growMax @hide
402 Ext.reg('datefield', Ext.form.DateField);