Roo/form/DateField.js
[roojs1] / Roo / form / DateField.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11  
12 /**
13  * @class Roo.form.DateField
14  * @extends Roo.form.TriggerField
15  * Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation.
16 * @constructor
17 * Create a new DateField
18 * @param {Object} config
19  */
20 Roo.form.DateField = function(config){
21     Roo.form.DateField.superclass.constructor.call(this, config);
22     
23       this.addEvents({
24          
25         /**
26          * @event select
27          * Fires when a date is selected
28              * @param {Roo.form.DateField} combo This combo box
29              * @param {Date} date The date selected
30              */
31         'select' : true
32          
33     });
34     
35     
36     if(typeof this.minValue == "string") this.minValue = this.parseDate(this.minValue);
37     if(typeof this.maxValue == "string") this.maxValue = this.parseDate(this.maxValue);
38     this.ddMatch = null;
39     if(this.disabledDates){
40         var dd = this.disabledDates;
41         var re = "(?:";
42         for(var i = 0; i < dd.length; i++){
43             re += dd[i];
44             if(i != dd.length-1) re += "|";
45         }
46         this.ddMatch = new RegExp(re + ")");
47     }
48 };
49
50 Roo.extend(Roo.form.DateField, Roo.form.TriggerField,  {
51     /**
52      * @cfg {String} format
53      * The default date format string which can be overriden for localization support.  The format must be
54      * valid according to {@link Date#parseDate} (defaults to 'm/d/y').
55      */
56     format : "m/d/y",
57     /**
58      * @cfg {String} altFormats
59      * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
60      * format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').
61      */
62     altFormats : "m/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d",
63     /**
64      * @cfg {Array} disabledDays
65      * An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).
66      */
67     disabledDays : null,
68     /**
69      * @cfg {String} disabledDaysText
70      * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')
71      */
72     disabledDaysText : "Disabled",
73     /**
74      * @cfg {Array} disabledDates
75      * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
76      * expression so they are very powerful. Some examples:
77      * <ul>
78      * <li>["03/08/2003", "09/16/2003"] would disable those exact dates</li>
79      * <li>["03/08", "09/16"] would disable those days for every year</li>
80      * <li>["^03/08"] would only match the beginning (useful if you are using short years)</li>
81      * <li>["03/../2006"] would disable every day in March 2006</li>
82      * <li>["^03"] would disable every day in every March</li>
83      * </ul>
84      * In order to support regular expressions, if you are using a date format that has "." in it, you will have to
85      * escape the dot when restricting dates. For example: ["03\\.08\\.03"].
86      */
87     disabledDates : null,
88     /**
89      * @cfg {String} disabledDatesText
90      * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')
91      */
92     disabledDatesText : "Disabled",
93     /**
94      * @cfg {Date/String} minValue
95      * The minimum allowed date. Can be either a Javascript date object or a string date in a
96      * valid format (defaults to null).
97      */
98     minValue : null,
99     /**
100      * @cfg {Date/String} maxValue
101      * The maximum allowed date. Can be either a Javascript date object or a string date in a
102      * valid format (defaults to null).
103      */
104     maxValue : null,
105     /**
106      * @cfg {String} minText
107      * The error text to display when the date in the cell is before minValue (defaults to
108      * 'The date in this field must be after {minValue}').
109      */
110     minText : "The date in this field must be equal to or after {0}",
111     /**
112      * @cfg {String} maxText
113      * The error text to display when the date in the cell is after maxValue (defaults to
114      * 'The date in this field must be before {maxValue}').
115      */
116     maxText : "The date in this field must be equal to or before {0}",
117     /**
118      * @cfg {String} invalidText
119      * The error text to display when the date in the field is invalid (defaults to
120      * '{value} is not a valid date - it must be in the format {format}').
121      */
122     invalidText : "{0} is not a valid date - it must be in the format {1}",
123     /**
124      * @cfg {String} triggerClass
125      * An additional CSS class used to style the trigger button.  The trigger will always get the
126      * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'
127      * which displays a calendar icon).
128      */
129     triggerClass : 'x-form-date-trigger',
130     
131
132     /**
133      * @cfg {Boolean} useIso
134      * if enabled, then the date field will use a hidden field to store the 
135      * real value as iso formated date. default (false)
136      */ 
137     useIso : false,
138     /**
139      * @cfg {String/Object} autoCreate
140      * A DomHelper element spec, or true for a default element spec (defaults to
141      * {tag: "input", type: "text", size: "10", autocomplete: "off"})
142      */ 
143     // private
144     defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"},
145     
146     // private
147     hiddenField: false,
148     
149     onRender : function(ct, position)
150     {
151         Roo.form.DateField.superclass.onRender.call(this, ct, position);
152         if (this.useIso) {
153             this.el.dom.removeAttribute('name'); 
154             this.el.dom.setAttribute('name', this.name + '____hidden___' ); 
155             this.hiddenField = this.el.insertSibling({ tag:'input', type:'hidden', name: this.name },
156                     'before', true);
157             this.hiddenField.value = this.value ? this.formatDate(this.value, 'Y-m-d') : '';
158             // prevent input submission
159             this.hiddenName = this.name;
160         }
161             
162             
163     },
164     
165     // private
166     validateValue : function(value)
167     {
168         value = this.formatDate(value);
169         if(!Roo.form.DateField.superclass.validateValue.call(this, value)){
170             Roo.log('super failed');
171             return false;
172         }
173         if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid
174              return true;
175         }
176         var svalue = value;
177         value = this.parseDate(value);
178         if(!value){
179             Roo.log('parse date failed' + svalue);
180             this.markInvalid(String.format(this.invalidText, svalue, this.format));
181             return false;
182         }
183         var time = value.getTime();
184         if(this.minValue && time < this.minValue.getTime()){
185             this.markInvalid(String.format(this.minText, this.formatDate(this.minValue)));
186             return false;
187         }
188         if(this.maxValue && time > this.maxValue.getTime()){
189             this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue)));
190             return false;
191         }
192         if(this.disabledDays){
193             var day = value.getDay();
194             for(var i = 0; i < this.disabledDays.length; i++) {
195                 if(day === this.disabledDays[i]){
196                     this.markInvalid(this.disabledDaysText);
197                     return false;
198                 }
199             }
200         }
201         var fvalue = this.formatDate(value);
202         if(this.ddMatch && this.ddMatch.test(fvalue)){
203             this.markInvalid(String.format(this.disabledDatesText, fvalue));
204             return false;
205         }
206         return true;
207     },
208
209     // private
210     // Provides logic to override the default TriggerField.validateBlur which just returns true
211     validateBlur : function(){
212         return !this.menu || !this.menu.isVisible();
213     },
214
215     /**
216      * Returns the current date value of the date field.
217      * @return {Date} The date value
218      */
219     getValue : function(){
220         
221         return  this.hiddenField ?
222                 this.hiddenField.value :
223                 this.parseDate(Roo.form.DateField.superclass.getValue.call(this)) || "";
224     },
225
226     /**
227      * Sets the value of the date field.  You can pass a date object or any string that can be parsed into a valid
228      * date, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}
229      * (the default format used is "m/d/y").
230      * <br />Usage:
231      * <pre><code>
232 //All of these calls set the same date value (May 4, 2006)
233
234 //Pass a date object:
235 var dt = new Date('5/4/06');
236 dateField.setValue(dt);
237
238 //Pass a date string (default format):
239 dateField.setValue('5/4/06');
240
241 //Pass a date string (custom format):
242 dateField.format = 'Y-m-d';
243 dateField.setValue('2006-5-4');
244 </code></pre>
245      * @param {String/Date} date The date or valid date string
246      */
247     setValue : function(date){
248         if (this.hiddenField) {
249             this.hiddenField.value = this.formatDate(this.parseDate(date), 'Y-m-d');
250         }
251         Roo.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
252         // make sure the value field is always stored as a date..
253         this.value = this.parseDate(date);
254         
255         
256     },
257
258     // private
259     parseDate : function(value){
260         if(!value || value instanceof Date){
261             return value;
262         }
263         var v = Date.parseDate(value, this.format);
264          if (!v && this.useIso) {
265             v = Date.parseDate(value, 'Y-m-d');
266         }
267         if(!v && this.altFormats){
268             if(!this.altFormatsArray){
269                 this.altFormatsArray = this.altFormats.split("|");
270             }
271             for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){
272                 v = Date.parseDate(value, this.altFormatsArray[i]);
273             }
274         }
275         return v;
276     },
277
278     // private
279     formatDate : function(date, fmt){
280         return (!date || !(date instanceof Date)) ?
281                date : date.dateFormat(fmt || this.format);
282     },
283
284     // private
285     menuListeners : {
286         select: function(m, d){
287             
288             this.setValue(d);
289             this.fireEvent('select', this, d);
290         },
291         show : function(){ // retain focus styling
292             this.onFocus();
293         },
294         hide : function(){
295             this.focus.defer(10, this);
296             var ml = this.menuListeners;
297             this.menu.un("select", ml.select,  this);
298             this.menu.un("show", ml.show,  this);
299             this.menu.un("hide", ml.hide,  this);
300         }
301     },
302
303     // private
304     // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
305     onTriggerClick : function(){
306         if(this.disabled){
307             return;
308         }
309         if(this.menu == null){
310             this.menu = new Roo.menu.DateMenu();
311         }
312         Roo.apply(this.menu.picker,  {
313             showClear: this.allowBlank,
314             minDate : this.minValue,
315             maxDate : this.maxValue,
316             disabledDatesRE : this.ddMatch,
317             disabledDatesText : this.disabledDatesText,
318             disabledDays : this.disabledDays,
319             disabledDaysText : this.disabledDaysText,
320             format : this.useIso ? 'Y-m-d' : this.format,
321             minText : String.format(this.minText, this.formatDate(this.minValue)),
322             maxText : String.format(this.maxText, this.formatDate(this.maxValue))
323         });
324         this.menu.on(Roo.apply({}, this.menuListeners, {
325             scope:this
326         }));
327         this.menu.picker.setValue(this.getValue() || new Date());
328         this.menu.show(this.el, "tl-bl?");
329     },
330
331     beforeBlur : function(){
332         var v = this.parseDate(this.getRawValue());
333         if(v){
334             this.setValue(v);
335         }
336     }
337
338     /** @cfg {Boolean} grow @hide */
339     /** @cfg {Number} growMin @hide */
340     /** @cfg {Number} growMax @hide */
341     /**
342      * @hide
343      * @method autoSize
344      */
345 });