docs/source/Date.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-form-field-Date-method-constructor'><span id='Ext-form-field-Date'>/**
  19 </span></span> * @class Ext.form.field.Date
  20  * @extends Ext.form.field.Picker
  21
  22 Provides a date input field with a {@link Ext.picker.Date date picker} dropdown and automatic date
  23 validation.
  24
  25 This field recognizes and uses the JavaScript Date object as its main {@link #value} type. In addition,
  26 it recognizes string values which are parsed according to the {@link #format} and/or {@link #altFormats}
  27 configs. These may be reconfigured to use date formats appropriate for the user's locale.
  28
  29 The field may be limited to a certain range of dates by using the {@link #minValue}, {@link #maxValue},
  30 {@link #disabledDays}, and {@link #disabledDates} config parameters. These configurations will be used both
  31 in the field's validation, and in the date picker dropdown by preventing invalid dates from being selected.
  32 {@img Ext.form.Date/Ext.form.Date.png Ext.form.Date component}
  33 #Example usage:#
  34
  35     Ext.create('Ext.form.Panel', {
  36         width: 300,
  37         bodyPadding: 10,
  38         title: 'Dates',
  39         items: [{
  40             xtype: 'datefield',
  41             anchor: '100%',
  42             fieldLabel: 'From',
  43             name: 'from_date',
  44             maxValue: new Date()  // limited to the current date or prior
  45         }, {
  46             xtype: 'datefield',
  47             anchor: '100%',
  48             fieldLabel: 'To',
  49             name: 'to_date',
  50             value: new Date()  // defaults to today
  51         }],
  52             renderTo: Ext.getBody()
  53     });
  54
  55 #Date Formats Examples#
  56
  57 This example shows a couple of different date format parsing scenarios. Both use custom date format
  58 configurations; the first one matches the configured `format` while the second matches the `altFormats`.
  59
  60     Ext.create('Ext.form.Panel', {
  61         renderTo: Ext.getBody(),
  62         width: 300,
  63         bodyPadding: 10,
  64         title: 'Dates',
  65         items: [{
  66             xtype: 'datefield',
  67             anchor: '100%',
  68             fieldLabel: 'Date',
  69             name: 'date',
  70             // The value matches the format; will be parsed and displayed using that format.
  71             format: 'm d Y',
  72             value: '2 4 1978'
  73         }, {
  74             xtype: 'datefield',
  75             anchor: '100%',
  76             fieldLabel: 'Date',
  77             name: 'date',
  78             // The value does not match the format, but does match an altFormat; will be parsed
  79             // using the altFormat and displayed using the format.
  80             format: 'm d Y',
  81             altFormats: 'm,d,Y|m.d.Y',
  82             value: '2.4.1978'
  83         }]
  84     });
  85
  86  * @constructor
  87  * Create a new Date field
  88  * @param {Object} config
  89  *
  90  * @xtype datefield
  91  * @markdown
  92  * @docauthor Jason Johnston &lt;jason@sencha.com&gt;
  93  */
  94 Ext.define('Ext.form.field.Date', {
  95     extend:'Ext.form.field.Picker',
  96     alias: 'widget.datefield',
  97     requires: ['Ext.picker.Date'],
  98     alternateClassName: ['Ext.form.DateField', 'Ext.form.Date'],
  99
 100 <span id='Ext-form-field-Date-cfg-format'>    /**
 101 </span>     * @cfg {String} format
 102      * The default date format string which can be overriden for localization support.  The format must be
 103      * valid according to {@link Ext.Date#parse} (defaults to &lt;tt&gt;'m/d/Y'&lt;/tt&gt;).
 104      */
 105     format : &quot;m/d/Y&quot;,
 106 <span id='Ext-form-field-Date-cfg-altFormats'>    /**
 107 </span>     * @cfg {String} altFormats
 108      * Multiple date formats separated by &quot;&lt;tt&gt;|&lt;/tt&gt;&quot; to try when parsing a user input value and it
 109      * does not match the defined format (defaults to
 110      * &lt;tt&gt;'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|n-j|n/j'&lt;/tt&gt;).
 111      */
 112     altFormats : &quot;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|n-j|n/j&quot;,
 113 <span id='Ext-form-field-Date-cfg-disabledDaysText'>    /**
 114 </span>     * @cfg {String} disabledDaysText
 115      * The tooltip to display when the date falls on a disabled day (defaults to &lt;tt&gt;'Disabled'&lt;/tt&gt;)
 116      */
 117     disabledDaysText : &quot;Disabled&quot;,
 118 <span id='Ext-form-field-Date-cfg-disabledDatesText'>    /**
 119 </span>     * @cfg {String} disabledDatesText
 120      * The tooltip text to display when the date falls on a disabled date (defaults to &lt;tt&gt;'Disabled'&lt;/tt&gt;)
 121      */
 122     disabledDatesText : &quot;Disabled&quot;,
 123 <span id='Ext-form-field-Date-cfg-minText'>    /**
 124 </span>     * @cfg {String} minText
 125      * The error text to display when the date in the cell is before &lt;tt&gt;{@link #minValue}&lt;/tt&gt; (defaults to
 126      * &lt;tt&gt;'The date in this field must be after {minValue}'&lt;/tt&gt;).
 127      */
 128     minText : &quot;The date in this field must be equal to or after {0}&quot;,
 129 <span id='Ext-form-field-Date-cfg-maxText'>    /**
 130 </span>     * @cfg {String} maxText
 131      * The error text to display when the date in the cell is after &lt;tt&gt;{@link #maxValue}&lt;/tt&gt; (defaults to
 132      * &lt;tt&gt;'The date in this field must be before {maxValue}'&lt;/tt&gt;).
 133      */
 134     maxText : &quot;The date in this field must be equal to or before {0}&quot;,
 135 <span id='Ext-form-field-Date-cfg-invalidText'>    /**
 136 </span>     * @cfg {String} invalidText
 137      * The error text to display when the date in the field is invalid (defaults to
 138      * &lt;tt&gt;'{value} is not a valid date - it must be in the format {format}'&lt;/tt&gt;).
 139      */
 140     invalidText : &quot;{0} is not a valid date - it must be in the format {1}&quot;,
 141 <span id='Ext-form-field-Date-cfg-triggerCls'>    /**
 142 </span>     * @cfg {String} triggerCls
 143      * An additional CSS class used to style the trigger button.  The trigger will always get the
 144      * class &lt;tt&gt;'x-form-trigger'&lt;/tt&gt; and &lt;tt&gt;triggerCls&lt;/tt&gt; will be &lt;b&gt;appended&lt;/b&gt; if specified
 145      * (defaults to &lt;tt&gt;'x-form-date-trigger'&lt;/tt&gt; which displays a calendar icon).
 146      */
 147     triggerCls : Ext.baseCSSPrefix + 'form-date-trigger',
 148 <span id='Ext-form-field-Date-cfg-showToday'>    /**
 149 </span>     * @cfg {Boolean} showToday
 150      * &lt;tt&gt;false&lt;/tt&gt; to hide the footer area of the Date picker containing the Today button and disable
 151      * the keyboard handler for spacebar that selects the current date (defaults to &lt;tt&gt;true&lt;/tt&gt;).
 152      */
 153     showToday : true,
 154 <span id='Ext-form-field-Date-cfg-minValue'>    /**
 155 </span>     * @cfg {Date/String} minValue
 156      * The minimum allowed date. Can be either a Javascript date object or a string date in a
 157      * valid format (defaults to undefined).
 158      */
 159 <span id='Ext-form-field-Date-cfg-maxValue'>    /**
 160 </span>     * @cfg {Date/String} maxValue
 161      * The maximum allowed date. Can be either a Javascript date object or a string date in a
 162      * valid format (defaults to undefined).
 163      */
 164 <span id='Ext-form-field-Date-cfg-disabledDays'>    /**
 165 </span>     * @cfg {Array} disabledDays
 166      * An array of days to disable, 0 based (defaults to undefined). Some examples:&lt;pre&gt;&lt;code&gt;
 167 // disable Sunday and Saturday:
 168 disabledDays:  [0, 6]
 169 // disable weekdays:
 170 disabledDays: [1,2,3,4,5]
 171      * &lt;/code&gt;&lt;/pre&gt;
 172      */
 173 <span id='Ext-form-field-Date-cfg-disabledDates'>    /**
 174 </span>     * @cfg {Array} disabledDates
 175      * An array of &quot;dates&quot; to disable, as strings. These strings will be used to build a dynamic regular
 176      * expression so they are very powerful. Some examples:&lt;pre&gt;&lt;code&gt;
 177 // disable these exact dates:
 178 disabledDates: [&quot;03/08/2003&quot;, &quot;09/16/2003&quot;]
 179 // disable these days for every year:
 180 disabledDates: [&quot;03/08&quot;, &quot;09/16&quot;]
 181 // only match the beginning (useful if you are using short years):
 182 disabledDates: [&quot;^03/08&quot;]
 183 // disable every day in March 2006:
 184 disabledDates: [&quot;03/../2006&quot;]
 185 // disable every day in every March:
 186 disabledDates: [&quot;^03&quot;]
 187      * &lt;/code&gt;&lt;/pre&gt;
 188      * Note that the format of the dates included in the array should exactly match the {@link #format} config.
 189      * In order to support regular expressions, if you are using a {@link #format date format} that has &quot;.&quot; in
 190      * it, you will have to escape the dot when restricting dates. For example: &lt;tt&gt;[&quot;03\\.08\\.03&quot;]&lt;/tt&gt;.
 191      */
 192
 193 <span id='Ext-form-field-Date-cfg-submitFormat'>    /**
 194 </span>     * @cfg {String} submitFormat The date format string which will be submitted to the server.
 195      * The format must be valid according to {@link Ext.Date#parse} (defaults to &lt;tt&gt;{@link #format}&lt;/tt&gt;).
 196      */
 197
 198     // in the absence of a time value, a default value of 12 noon will be used
 199     // (note: 12 noon was chosen because it steers well clear of all DST timezone changes)
 200     initTime: '12', // 24 hour format
 201
 202     initTimeFormat: 'H',
 203
 204     matchFieldWidth: false,
 205 <span id='Ext-form-field-Date-cfg-startDay'>    /**
 206 </span>     * @cfg {Number} startDay
 207      * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)
 208      */
 209     startDay: 0,
 210
 211     initComponent : function(){
 212         var me = this,
 213             isString = Ext.isString,
 214             min, max;
 215
 216         min = me.minValue;
 217         max = me.maxValue;
 218         if(isString(min)){
 219             me.minValue = me.parseDate(min);
 220         }
 221         if(isString(max)){
 222             me.maxValue = me.parseDate(max);
 223         }
 224         me.disabledDatesRE = null;
 225         me.initDisabledDays();
 226
 227         me.callParent();
 228     },
 229
 230     initValue: function() {
 231         var me = this,
 232             value = me.value;
 233
 234         // If a String value was supplied, try to convert it to a proper Date
 235         if (Ext.isString(value)) {
 236             me.value = me.rawToValue(value);
 237         }
 238
 239         me.callParent();
 240     },
 241
 242     // private
 243     initDisabledDays : function(){
 244         if(this.disabledDates){
 245             var dd = this.disabledDates,
 246                 len = dd.length - 1,
 247                 re = &quot;(?:&quot;;
 248
 249             Ext.each(dd, function(d, i){
 250                 re += Ext.isDate(d) ? '^' + Ext.String.escapeRegex(d.dateFormat(this.format)) + '$' : dd[i];
 251                 if (i !== len) {
 252                     re += '|';
 253                 }
 254             }, this);
 255             this.disabledDatesRE = new RegExp(re + ')');
 256         }
 257     },
 258
 259 <span id='Ext-form-field-Date-method-setDisabledDates'>    /**
 260 </span>     * Replaces any existing disabled dates with new values and refreshes the Date picker.
 261      * @param {Array} disabledDates An array of date strings (see the &lt;tt&gt;{@link #disabledDates}&lt;/tt&gt; config
 262      * for details on supported values) used to disable a pattern of dates.
 263      */
 264     setDisabledDates : function(dd){
 265         var me = this,
 266             picker = me.picker;
 267
 268         me.disabledDates = dd;
 269         me.initDisabledDays();
 270         if (picker) {
 271             picker.setDisabledDates(me.disabledDatesRE);
 272         }
 273     },
 274
 275 <span id='Ext-form-field-Date-method-setDisabledDays'>    /**
 276 </span>     * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the Date picker.
 277      * @param {Array} disabledDays An array of disabled day indexes. See the &lt;tt&gt;{@link #disabledDays}&lt;/tt&gt;
 278      * config for details on supported values.
 279      */
 280     setDisabledDays : function(dd){
 281         var picker = this.picker;
 282
 283         this.disabledDays = dd;
 284         if (picker) {
 285             picker.setDisabledDays(dd);
 286         }
 287     },
 288
 289 <span id='Ext-form-field-Date-method-setMinValue'>    /**
 290 </span>     * Replaces any existing &lt;tt&gt;{@link #minValue}&lt;/tt&gt; with the new value and refreshes the Date picker.
 291      * @param {Date} value The minimum date that can be selected
 292      */
 293     setMinValue : function(dt){
 294         var me = this,
 295             picker = me.picker,
 296             minValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
 297
 298         me.minValue = minValue;
 299         if (picker) {
 300             picker.minText = Ext.String.format(me.minText, me.formatDate(me.minValue));
 301             picker.setMinDate(minValue);
 302         }
 303     },
 304
 305 <span id='Ext-form-field-Date-method-setMaxValue'>    /**
 306 </span>     * Replaces any existing &lt;tt&gt;{@link #maxValue}&lt;/tt&gt; with the new value and refreshes the Date picker.
 307      * @param {Date} value The maximum date that can be selected
 308      */
 309     setMaxValue : function(dt){
 310         var me = this,
 311             picker = me.picker,
 312             maxValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
 313
 314         me.maxValue = maxValue;
 315         if (picker) {
 316             picker.maxText = Ext.String.format(me.maxText, me.formatDate(me.maxValue));
 317             picker.setMaxDate(maxValue);
 318         }
 319     },
 320
 321 <span id='Ext-form-field-Date-method-getErrors'>    /**
 322 </span>     * Runs all of Date's validations and returns an array of any errors. Note that this first
 323      * runs Text's validations, so the returned array is an amalgamation of all field errors.
 324      * The additional validation checks are testing that the date format is valid, that the chosen
 325      * date is within the min and max date constraints set, that the date chosen is not in the disabledDates
 326      * regex and that the day chosed is not one of the disabledDays.
 327      * @param {Mixed} value The value to get errors for (defaults to the current field value)
 328      * @return {Array} All validation errors for this field
 329      */
 330     getErrors: function(value) {
 331         var me = this,
 332             format = Ext.String.format,
 333             clearTime = Ext.Date.clearTime,
 334             errors = me.callParent(arguments),
 335             disabledDays = me.disabledDays,
 336             disabledDatesRE = me.disabledDatesRE,
 337             minValue = me.minValue,
 338             maxValue = me.maxValue,
 339             len = disabledDays ? disabledDays.length : 0,
 340             i = 0,
 341             svalue,
 342             fvalue,
 343             day,
 344             time;
 345
 346         value = me.formatDate(value || me.processRawValue(me.getRawValue()));
 347
 348         if (value === null || value.length &lt; 1) { // if it's blank and textfield didn't flag it then it's valid
 349              return errors;
 350         }
 351
 352         svalue = value;
 353         value = me.parseDate(value);
 354         if (!value) {
 355             errors.push(format(me.invalidText, svalue, me.format));
 356             return errors;
 357         }
 358
 359         time = value.getTime();
 360         if (minValue &amp;&amp; time &lt; clearTime(minValue).getTime()) {
 361             errors.push(format(me.minText, me.formatDate(minValue)));
 362         }
 363
 364         if (maxValue &amp;&amp; time &gt; clearTime(maxValue).getTime()) {
 365             errors.push(format(me.maxText, me.formatDate(maxValue)));
 366         }
 367
 368         if (disabledDays) {
 369             day = value.getDay();
 370
 371             for(; i &lt; len; i++) {
 372                 if (day === disabledDays[i]) {
 373                     errors.push(me.disabledDaysText);
 374                     break;
 375                 }
 376             }
 377         }
 378
 379         fvalue = me.formatDate(value);
 380         if (disabledDatesRE &amp;&amp; disabledDatesRE.test(fvalue)) {
 381             errors.push(format(me.disabledDatesText, fvalue));
 382         }
 383
 384         return errors;
 385     },
 386
 387     rawToValue: function(rawValue) {
 388         return this.parseDate(rawValue) || rawValue || null;
 389     },
 390
 391     valueToRaw: function(value) {
 392         return this.formatDate(this.parseDate(value));
 393     },
 394
 395 <span id='Ext-form-field-Date-method-setValue'>    /**
 396 </span>     * Sets the value of the date field.  You can pass a date object or any string that can be
 397      * parsed into a valid date, using &lt;tt&gt;{@link #format}&lt;/tt&gt; as the date format, according
 398      * to the same rules as {@link Ext.Date#parse} (the default format used is &lt;tt&gt;&quot;m/d/Y&quot;&lt;/tt&gt;).
 399      * &lt;br /&gt;Usage:
 400      * &lt;pre&gt;&lt;code&gt;
 401 //All of these calls set the same date value (May 4, 2006)
 402
 403 //Pass a date object:
 404 var dt = new Date('5/4/2006');
 405 dateField.setValue(dt);
 406
 407 //Pass a date string (default format):
 408 dateField.setValue('05/04/2006');
 409
 410 //Pass a date string (custom format):
 411 dateField.format = 'Y-m-d';
 412 dateField.setValue('2006-05-04');
 413 &lt;/code&gt;&lt;/pre&gt;
 414      * @param {String/Date} date The date or valid date string
 415      * @return {Ext.form.field.Date} this
 416      * @method setValue
 417      */
 418
 419 <span id='Ext-form-field-Date-method-safeParse'>    /**
 420 </span>     * Attempts to parse a given string value using a given {@link Ext.Date#parse date format}.
 421      * @param {String} value The value to attempt to parse
 422      * @param {String} format A valid date format (see {@link Ext.Date#parse})
 423      * @return {Date} The parsed Date object, or null if the value could not be successfully parsed.
 424      */
 425     safeParse : function(value, format) {
 426         var me = this,
 427             utilDate = Ext.Date,
 428             parsedDate,
 429             result = null;
 430
 431         if (utilDate.formatContainsHourInfo(format)) {
 432             // if parse format contains hour information, no DST adjustment is necessary
 433             result = utilDate.parse(value, format);
 434         } else {
 435             // set time to 12 noon, then clear the time
 436             parsedDate = utilDate.parse(value + ' ' + me.initTime, format + ' ' + me.initTimeFormat);
 437             if (parsedDate) {
 438                 result = utilDate.clearTime(parsedDate);
 439             }
 440         }
 441         return result;
 442     },
 443
 444     // @private
 445     getSubmitValue: function() {
 446         var me = this,
 447             format = me.submitFormat || me.format,
 448             value = me.getValue();
 449
 450         return value ? Ext.Date.format(value, format) : null;
 451     },
 452
 453 <span id='Ext-form-field-Date-method-parseDate'>    /**
 454 </span>     * @private
 455      */
 456     parseDate : function(value) {
 457         if(!value || Ext.isDate(value)){
 458             return value;
 459         }
 460
 461         var me = this,
 462             val = me.safeParse(value, me.format),
 463             altFormats = me.altFormats,
 464             altFormatsArray = me.altFormatsArray,
 465             i = 0,
 466             len;
 467
 468         if (!val &amp;&amp; altFormats) {
 469             altFormatsArray = altFormatsArray || altFormats.split('|');
 470             len = altFormatsArray.length;
 471             for (; i &lt; len &amp;&amp; !val; ++i) {
 472                 val = me.safeParse(value, altFormatsArray[i]);
 473             }
 474         }
 475         return val;
 476     },
 477
 478     // private
 479     formatDate : function(date){
 480         return Ext.isDate(date) ? Ext.Date.dateFormat(date, this.format) : date;
 481     },
 482
 483     createPicker: function() {
 484         var me = this,
 485             format = Ext.String.format;
 486
 487         return Ext.create('Ext.picker.Date', {
 488             ownerCt: me.ownerCt,
 489             renderTo: document.body,
 490             floating: true,
 491             hidden: true,
 492             focusOnShow: true,
 493             minDate: me.minValue,
 494             maxDate: me.maxValue,
 495             disabledDatesRE: me.disabledDatesRE,
 496             disabledDatesText: me.disabledDatesText,
 497             disabledDays: me.disabledDays,
 498             disabledDaysText: me.disabledDaysText,
 499             format: me.format,
 500             showToday: me.showToday,
 501             startDay: me.startDay,
 502             minText: format(me.minText, me.formatDate(me.minValue)),
 503             maxText: format(me.maxText, me.formatDate(me.maxValue)),
 504             listeners: {
 505                 scope: me,
 506                 select: me.onSelect
 507             },
 508             keyNavConfig: {
 509                 esc: function() {
 510                     me.collapse();
 511                 }
 512             }
 513         });
 514     },
 515
 516     onSelect: function(m, d) {
 517         var me = this;
 518
 519         me.setValue(d);
 520         me.fireEvent('select', me, d);
 521         me.collapse();
 522     },
 523
 524 <span id='Ext-form-field-Date-method-onExpand'>    /**
 525 </span>     * @private
 526      * Sets the Date picker's value to match the current field value when expanding.
 527      */
 528     onExpand: function() {
 529         var me = this,
 530             value = me.getValue();
 531         me.picker.setValue(Ext.isDate(value) ? value : new Date());
 532     },
 533
 534 <span id='Ext-form-field-Date-method-onCollapse'>    /**
 535 </span>     * @private
 536      * Focuses the field when collapsing the Date picker.
 537      */
 538     onCollapse: function() {
 539         this.focus(false, 60);
 540     },
 541
 542     // private
 543     beforeBlur : function(){
 544         var me = this,
 545             v = me.parseDate(me.getRawValue()),
 546             focusTask = me.focusTask;
 547
 548         if (focusTask) {
 549             focusTask.cancel();
 550         }
 551
 552         if (v) {
 553             me.setValue(v);
 554         }
 555     }
 556
 557 <span id='Ext-form-field-Date-cfg-grow'>    /**
 558 </span>     * @cfg {Boolean} grow @hide
 559      */
 560 <span id='Ext-form-field-Date-cfg-growMin'>    /**
 561 </span>     * @cfg {Number} growMin @hide
 562      */
 563 <span id='Ext-form-field-Date-cfg-growMax'>    /**
 564 </span>     * @cfg {Number} growMax @hide
 565      */
 566 <span id='Ext-form-field-Date-method-autoSize'>    /**
 567 </span>     * @hide
 568      * @method autoSize
 569      */
 570 });
 571 </pre>
 572 </body>
 573 </html>