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.hiddenField = this.el.insertSibling({ tag:'input', type:'hidden', name: this.name },
155                     'before', true);
156             this.hiddenField.value = this.value ? this.formatDate(this.value, 'Y-m-d') : '';
157             // prevent input submission
158             this.hiddenName = this.name;
159         }
160             
161             
162     },
163     
164     // private
165     validateValue : function(value)
166     {
167         value = this.formatDate(value);
168         if(!Roo.form.DateField.superclass.validateValue.call(this, value)){
169             Roo.log('super failed');
170             return false;
171         }
172         if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid
173              return true;
174         }
175         var svalue = value;
176         value = this.parseDate(value);
177         if(!value){
178             Roo.log('parse date failed' + svalue);
179             this.markInvalid(String.format(this.invalidText, svalue, this.format));
180             return false;
181         }
182         var time = value.getTime();
183         if(this.minValue && time < this.minValue.getTime()){
184             this.markInvalid(String.format(this.minText, this.formatDate(this.minValue)));
185             return false;
186         }
187         if(this.maxValue && time > this.maxValue.getTime()){
188             this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue)));
189             return false;
190         }
191         if(this.disabledDays){
192             var day = value.getDay();
193             for(var i = 0; i < this.disabledDays.length; i++) {
194                 if(day === this.disabledDays[i]){
195                     this.markInvalid(this.disabledDaysText);
196                     return false;
197                 }
198             }
199         }
200         var fvalue = this.formatDate(value);
201         if(this.ddMatch && this.ddMatch.test(fvalue)){
202             this.markInvalid(String.format(this.disabledDatesText, fvalue));
203             return false;
204         }
205         return true;
206     },
207
208     // private
209     // Provides logic to override the default TriggerField.validateBlur which just returns true
210     validateBlur : function(){
211         return !this.menu || !this.menu.isVisible();
212     },
213
214     /**
215      * Returns the current date value of the date field.
216      * @return {Date} The date value
217      */
218     getValue : function(){
219         
220         return  this.hiddenField ?
221                 this.hiddenField.value :
222                 this.parseDate(Roo.form.DateField.superclass.getValue.call(this)) || "";
223     },
224
225     /**
226      * Sets the value of the date field.  You can pass a date object or any string that can be parsed into a valid
227      * date, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}
228      * (the default format used is "m/d/y").
229      * <br />Usage:
230      * <pre><code>
231 //All of these calls set the same date value (May 4, 2006)
232
233 //Pass a date object:
234 var dt = new Date('5/4/06');
235 dateField.setValue(dt);
236
237 //Pass a date string (default format):
238 dateField.setValue('5/4/06');
239
240 //Pass a date string (custom format):
241 dateField.format = 'Y-m-d';
242 dateField.setValue('2006-5-4');
243 </code></pre>
244      * @param {String/Date} date The date or valid date string
245      */
246     setValue : function(date){
247         if (this.hiddenField) {
248             this.hiddenField.value = this.formatDate(this.parseDate(date), 'Y-m-d');
249         }
250         Roo.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date)));
251         // make sure the value field is always stored as a date..
252         this.value = this.parseDate(date);
253         
254         
255     },
256
257     // private
258     parseDate : function(value){
259         if(!value || value instanceof Date){
260             return value;
261         }
262         var v = Date.parseDate(value, this.format);
263          if (!v && this.useIso) {
264             v = Date.parseDate(value, 'Y-m-d');
265         }
266         if(!v && this.altFormats){
267             if(!this.altFormatsArray){
268                 this.altFormatsArray = this.altFormats.split("|");
269             }
270             for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){
271                 v = Date.parseDate(value, this.altFormatsArray[i]);
272             }
273         }
274         return v;
275     },
276
277     // private
278     formatDate : function(date, fmt){
279         return (!date || !(date instanceof Date)) ?
280                date : date.dateFormat(fmt || this.format);
281     },
282
283     // private
284     menuListeners : {
285         select: function(m, d){
286             
287             this.setValue(d);
288             this.fireEvent('select', this, d);
289         },
290         show : function(){ // retain focus styling
291             this.onFocus();
292         },
293         hide : function(){
294             this.focus.defer(10, this);
295             var ml = this.menuListeners;
296             this.menu.un("select", ml.select,  this);
297             this.menu.un("show", ml.show,  this);
298             this.menu.un("hide", ml.hide,  this);
299         }
300     },
301
302     // private
303     // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker
304     onTriggerClick : function(){
305         if(this.disabled){
306             return;
307         }
308         if(this.menu == null){
309             this.menu = new Roo.menu.DateMenu();
310         }
311         Roo.apply(this.menu.picker,  {
312             showClear: this.allowBlank,
313             minDate : this.minValue,
314             maxDate : this.maxValue,
315             disabledDatesRE : this.ddMatch,
316             disabledDatesText : this.disabledDatesText,
317             disabledDays : this.disabledDays,
318             disabledDaysText : this.disabledDaysText,
319             format : this.useIso ? 'Y-m-d' : this.format,
320             minText : String.format(this.minText, this.formatDate(this.minValue)),
321             maxText : String.format(this.maxText, this.formatDate(this.maxValue))
322         });
323         this.menu.on(Roo.apply({}, this.menuListeners, {
324             scope:this
325         }));
326         this.menu.picker.setValue(this.getValue() || new Date());
327         this.menu.show(this.el, "tl-bl?");
328     },
329
330     beforeBlur : function(){
331         var v = this.parseDate(this.getRawValue());
332         if(v){
333             this.setValue(v);
334         }
335     }
336
337     /** @cfg {Boolean} grow @hide */
338     /** @cfg {Number} growMin @hide */
339     /** @cfg {Number} growMax @hide */
340     /**
341      * @hide
342      * @method autoSize
343      */
344 });