Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Date2.html
index 1a2a4b5..a0040a2 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
 </head>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-form-field-Date'>/**
-</span> * @class Ext.form.field.Date
- * @extends Ext.form.field.Picker
-
-Provides a date input field with a {@link Ext.picker.Date date picker} dropdown and automatic date
-validation.
-
-This field recognizes and uses the JavaScript Date object as its main {@link #value} type. In addition,
-it recognizes string values which are parsed according to the {@link #format} and/or {@link #altFormats}
-configs. These may be reconfigured to use date formats appropriate for the user's locale.
-
-The field may be limited to a certain range of dates by using the {@link #minValue}, {@link #maxValue},
-{@link #disabledDays}, and {@link #disabledDates} config parameters. These configurations will be used both
-in the field's validation, and in the date picker dropdown by preventing invalid dates from being selected.
-{@img Ext.form.Date/Ext.form.Date.png Ext.form.Date component}
-#Example usage:#
-
-    Ext.create('Ext.form.Panel', {
-        width: 300,
-        bodyPadding: 10,
-        title: 'Dates',
-        items: [{
-            xtype: 'datefield',
-            anchor: '100%',
-            fieldLabel: 'From',
-            name: 'from_date',
-            maxValue: new Date()  // limited to the current date or prior
-        }, {
-            xtype: 'datefield',
-            anchor: '100%',
-            fieldLabel: 'To',
-            name: 'to_date',
-            value: new Date()  // defaults to today
-        }],
-            renderTo: Ext.getBody()
-    });
-
-#Date Formats Examples#
-
-This example shows a couple of different date format parsing scenarios. Both use custom date format
-configurations; the first one matches the configured `format` while the second matches the `altFormats`.
-
-    Ext.create('Ext.form.Panel', {
-        renderTo: Ext.getBody(),
-        width: 300,
-        bodyPadding: 10,
-        title: 'Dates',
-        items: [{
-            xtype: 'datefield',
-            anchor: '100%',
-            fieldLabel: 'Date',
-            name: 'date',
-            // The value matches the format; will be parsed and displayed using that format.
-            format: 'm d Y',
-            value: '2 4 1978'
-        }, {
-            xtype: 'datefield',
-            anchor: '100%',
-            fieldLabel: 'Date',
-            name: 'date',
-            // The value does not match the format, but does match an altFormat; will be parsed
-            // using the altFormat and displayed using the format.
-            format: 'm d Y',
-            altFormats: 'm,d,Y|m.d.Y',
-            value: '2.4.1978'
-        }]
-    });
-
- * 
- * @markdown
- * @docauthor Jason Johnston &lt;jason@sencha.com&gt;
+</span> * @docauthor Jason Johnston &lt;jason@sencha.com&gt;
+ *
+ * Provides a date input field with a {@link Ext.picker.Date date picker} dropdown and automatic date
+ * validation.
+ *
+ * This field recognizes and uses the JavaScript Date object as its main {@link #value} type. In addition,
+ * it recognizes string values which are parsed according to the {@link #format} and/or {@link #altFormats}
+ * configs. These may be reconfigured to use date formats appropriate for the user's locale.
+ *
+ * The field may be limited to a certain range of dates by using the {@link #minValue}, {@link #maxValue},
+ * {@link #disabledDays}, and {@link #disabledDates} config parameters. These configurations will be used both
+ * in the field's validation, and in the date picker dropdown by preventing invalid dates from being selected.
+ *
+ * # Example usage
+ *
+ *     @example
+ *     Ext.create('Ext.form.Panel', {
+ *         renderTo: Ext.getBody(),
+ *         width: 300,
+ *         bodyPadding: 10,
+ *         title: 'Dates',
+ *         items: [{
+ *             xtype: 'datefield',
+ *             anchor: '100%',
+ *             fieldLabel: 'From',
+ *             name: 'from_date',
+ *             maxValue: new Date()  // limited to the current date or prior
+ *         }, {
+ *             xtype: 'datefield',
+ *             anchor: '100%',
+ *             fieldLabel: 'To',
+ *             name: 'to_date',
+ *             value: new Date()  // defaults to today
+ *         }]
+ *     });
+ *
+ * # Date Formats Examples
+ *
+ * This example shows a couple of different date format parsing scenarios. Both use custom date format
+ * configurations; the first one matches the configured `format` while the second matches the `altFormats`.
+ *
+ *     @example
+ *     Ext.create('Ext.form.Panel', {
+ *         renderTo: Ext.getBody(),
+ *         width: 300,
+ *         bodyPadding: 10,
+ *         title: 'Dates',
+ *         items: [{
+ *             xtype: 'datefield',
+ *             anchor: '100%',
+ *             fieldLabel: 'Date',
+ *             name: 'date',
+ *             // The value matches the format; will be parsed and displayed using that format.
+ *             format: 'm d Y',
+ *             value: '2 4 1978'
+ *         }, {
+ *             xtype: 'datefield',
+ *             anchor: '100%',
+ *             fieldLabel: 'Date',
+ *             name: 'date',
+ *             // The value does not match the format, but does match an altFormat; will be parsed
+ *             // using the altFormat and displayed using the format.
+ *             format: 'm d Y',
+ *             altFormats: 'm,d,Y|m.d.Y',
+ *             value: '2.4.1978'
+ *         }]
+ *     });
  */
 Ext.define('Ext.form.field.Date', {
     extend:'Ext.form.field.Picker',
@@ -95,100 +92,95 @@ Ext.define('Ext.form.field.Date', {
 
 <span id='Ext-form-field-Date-cfg-format'>    /**
 </span>     * @cfg {String} format
-     * The default date format string which can be overriden for localization support.  The format must be
-     * valid according to {@link Ext.Date#parse} (defaults to &lt;tt&gt;'m/d/Y'&lt;/tt&gt;).
+     * The default date format string which can be overriden for localization support. The format must be valid
+     * according to {@link Ext.Date#parse}.
      */
     format : &quot;m/d/Y&quot;,
 <span id='Ext-form-field-Date-cfg-altFormats'>    /**
 </span>     * @cfg {String} altFormats
-     * Multiple date formats separated by &quot;&lt;tt&gt;|&lt;/tt&gt;&quot; to try when parsing a user input value and it
-     * does not match the defined format (defaults to
-     * &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;).
+     * Multiple date formats separated by &quot;|&quot; to try when parsing a user input value and it does not match the defined
+     * format.
      */
     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;,
 <span id='Ext-form-field-Date-cfg-disabledDaysText'>    /**
 </span>     * @cfg {String} disabledDaysText
-     * The tooltip to display when the date falls on a disabled day (defaults to &lt;tt&gt;'Disabled'&lt;/tt&gt;)
+     * The tooltip to display when the date falls on a disabled day.
      */
     disabledDaysText : &quot;Disabled&quot;,
 <span id='Ext-form-field-Date-cfg-disabledDatesText'>    /**
 </span>     * @cfg {String} disabledDatesText
-     * The tooltip text to display when the date falls on a disabled date (defaults to &lt;tt&gt;'Disabled'&lt;/tt&gt;)
+     * The tooltip text to display when the date falls on a disabled date.
      */
     disabledDatesText : &quot;Disabled&quot;,
 <span id='Ext-form-field-Date-cfg-minText'>    /**
 </span>     * @cfg {String} minText
-     * The error text to display when the date in the cell is before &lt;tt&gt;{@link #minValue}&lt;/tt&gt; (defaults to
-     * &lt;tt&gt;'The date in this field must be after {minValue}'&lt;/tt&gt;).
+     * The error text to display when the date in the cell is before {@link #minValue}.
      */
     minText : &quot;The date in this field must be equal to or after {0}&quot;,
 <span id='Ext-form-field-Date-cfg-maxText'>    /**
 </span>     * @cfg {String} maxText
-     * The error text to display when the date in the cell is after &lt;tt&gt;{@link #maxValue}&lt;/tt&gt; (defaults to
-     * &lt;tt&gt;'The date in this field must be before {maxValue}'&lt;/tt&gt;).
+     * The error text to display when the date in the cell is after {@link #maxValue}.
      */
     maxText : &quot;The date in this field must be equal to or before {0}&quot;,
 <span id='Ext-form-field-Date-cfg-invalidText'>    /**
 </span>     * @cfg {String} invalidText
-     * The error text to display when the date in the field is invalid (defaults to
-     * &lt;tt&gt;'{value} is not a valid date - it must be in the format {format}'&lt;/tt&gt;).
+     * The error text to display when the date in the field is invalid.
      */
     invalidText : &quot;{0} is not a valid date - it must be in the format {1}&quot;,
 <span id='Ext-form-field-Date-cfg-triggerCls'>    /**
-</span>     * @cfg {String} triggerCls
-     * An additional CSS class used to style the trigger button.  The trigger will always get the
-     * 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
-     * (defaults to &lt;tt&gt;'x-form-date-trigger'&lt;/tt&gt; which displays a calendar icon).
+</span>     * @cfg {String} [triggerCls='x-form-date-trigger']
+     * An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger'
+     * and triggerCls will be **appended** if specified (default class displays a calendar icon).
      */
     triggerCls : Ext.baseCSSPrefix + 'form-date-trigger',
 <span id='Ext-form-field-Date-cfg-showToday'>    /**
 </span>     * @cfg {Boolean} showToday
-     * &lt;tt&gt;false&lt;/tt&gt; to hide the footer area of the Date picker containing the Today button and disable
-     * the keyboard handler for spacebar that selects the current date (defaults to &lt;tt&gt;true&lt;/tt&gt;).
+     * false to hide the footer area of the Date picker containing the Today button and disable the keyboard handler for
+     * spacebar that selects the current date.
      */
     showToday : true,
 <span id='Ext-form-field-Date-cfg-minValue'>    /**
 </span>     * @cfg {Date/String} minValue
-     * The minimum allowed date. Can be either a Javascript date object or a string date in a
-     * valid format (defaults to undefined).
+     * The minimum allowed date. Can be either a Javascript date object or a string date in a valid format.
      */
 <span id='Ext-form-field-Date-cfg-maxValue'>    /**
 </span>     * @cfg {Date/String} maxValue
-     * The maximum allowed date. Can be either a Javascript date object or a string date in a
-     * valid format (defaults to undefined).
+     * The maximum allowed date. Can be either a Javascript date object or a string date in a valid format.
      */
 <span id='Ext-form-field-Date-cfg-disabledDays'>    /**
-</span>     * @cfg {Array} disabledDays
-     * An array of days to disable, 0 based (defaults to undefined). Some examples:&lt;pre&gt;&lt;code&gt;
-// disable Sunday and Saturday:
-disabledDays:  [0, 6]
-// disable weekdays:
-disabledDays: [1,2,3,4,5]
-     * &lt;/code&gt;&lt;/pre&gt;
+</span>     * @cfg {Number[]} disabledDays
+     * An array of days to disable, 0 based. Some examples:
+     *
+     *     // disable Sunday and Saturday:
+     *     disabledDays:  [0, 6]
+     *     // disable weekdays:
+     *     disabledDays: [1,2,3,4,5]
      */
 <span id='Ext-form-field-Date-cfg-disabledDates'>    /**
-</span>     * @cfg {Array} disabledDates
-     * An array of &quot;dates&quot; to disable, as strings. These strings will be used to build a dynamic regular
-     * expression so they are very powerful. Some examples:&lt;pre&gt;&lt;code&gt;
-// disable these exact dates:
-disabledDates: [&quot;03/08/2003&quot;, &quot;09/16/2003&quot;]
-// disable these days for every year:
-disabledDates: [&quot;03/08&quot;, &quot;09/16&quot;]
-// only match the beginning (useful if you are using short years):
-disabledDates: [&quot;^03/08&quot;]
-// disable every day in March 2006:
-disabledDates: [&quot;03/../2006&quot;]
-// disable every day in every March:
-disabledDates: [&quot;^03&quot;]
-     * &lt;/code&gt;&lt;/pre&gt;
-     * Note that the format of the dates included in the array should exactly match the {@link #format} config.
-     * In order to support regular expressions, if you are using a {@link #format date format} that has &quot;.&quot; in
-     * it, you will have to escape the dot when restricting dates. For example: &lt;tt&gt;[&quot;03\\.08\\.03&quot;]&lt;/tt&gt;.
+</span>     * @cfg {String[]} disabledDates
+     * An array of &quot;dates&quot; to disable, as strings. These strings will be used to build a dynamic regular expression so
+     * they are very powerful. Some examples:
+     *
+     *     // disable these exact dates:
+     *     disabledDates: [&quot;03/08/2003&quot;, &quot;09/16/2003&quot;]
+     *     // disable these days for every year:
+     *     disabledDates: [&quot;03/08&quot;, &quot;09/16&quot;]
+     *     // only match the beginning (useful if you are using short years):
+     *     disabledDates: [&quot;^03/08&quot;]
+     *     // disable every day in March 2006:
+     *     disabledDates: [&quot;03/../2006&quot;]
+     *     // disable every day in every March:
+     *     disabledDates: [&quot;^03&quot;]
+     *
+     * Note that the format of the dates included in the array should exactly match the {@link #format} config. In order
+     * to support regular expressions, if you are using a {@link #format date format} that has &quot;.&quot; in it, you will have
+     * to escape the dot when restricting dates. For example: `[&quot;03\\.08\\.03&quot;]`.
      */
-    
+
 <span id='Ext-form-field-Date-cfg-submitFormat'>    /**
-</span>     * @cfg {String} submitFormat The date format string which will be submitted to the server.  
-     * The format must be valid according to {@link Ext.Date#parse} (defaults to &lt;tt&gt;{@link #format}&lt;/tt&gt;).
+</span>     * @cfg {String} submitFormat
+     * The date format string which will be submitted to the server. The format must be valid according to {@link
+     * Ext.Date#parse} (defaults to {@link #format}).
      */
 
     // in the absence of a time value, a default value of 12 noon will be used
@@ -200,10 +192,10 @@ disabledDates: [&quot;^03&quot;]
     matchFieldWidth: false,
 <span id='Ext-form-field-Date-cfg-startDay'>    /**
 </span>     * @cfg {Number} startDay
-     * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)
+     * Day index at which the week should begin, 0-based (defaults to Sunday)
      */
     startDay: 0,
-    
+
     initComponent : function(){
         var me = this,
             isString = Ext.isString,
@@ -254,13 +246,13 @@ disabledDates: [&quot;^03&quot;]
 
 <span id='Ext-form-field-Date-method-setDisabledDates'>    /**
 </span>     * Replaces any existing disabled dates with new values and refreshes the Date picker.
-     * @param {Array} disabledDates An array of date strings (see the &lt;tt&gt;{@link #disabledDates}&lt;/tt&gt; config
-     * for details on supported values) used to disable a pattern of dates.
+     * @param {String[]} disabledDates An array of date strings (see the {@link #disabledDates} config for details on
+     * supported values) used to disable a pattern of dates.
      */
     setDisabledDates : function(dd){
         var me = this,
             picker = me.picker;
-            
+
         me.disabledDates = dd;
         me.initDisabledDays();
         if (picker) {
@@ -270,12 +262,12 @@ disabledDates: [&quot;^03&quot;]
 
 <span id='Ext-form-field-Date-method-setDisabledDays'>    /**
 </span>     * Replaces any existing disabled days (by index, 0-6) with new values and refreshes the Date picker.
-     * @param {Array} disabledDays An array of disabled day indexes. See the &lt;tt&gt;{@link #disabledDays}&lt;/tt&gt;
-     * config for details on supported values.
+     * @param {Number[]} disabledDays An array of disabled day indexes. See the {@link #disabledDays} config for details on
+     * supported values.
      */
     setDisabledDays : function(dd){
         var picker = this.picker;
-            
+
         this.disabledDays = dd;
         if (picker) {
             picker.setDisabledDays(dd);
@@ -283,14 +275,14 @@ disabledDates: [&quot;^03&quot;]
     },
 
 <span id='Ext-form-field-Date-method-setMinValue'>    /**
-</span>     * Replaces any existing &lt;tt&gt;{@link #minValue}&lt;/tt&gt; with the new value and refreshes the Date picker.
+</span>     * Replaces any existing {@link #minValue} with the new value and refreshes the Date picker.
      * @param {Date} value The minimum date that can be selected
      */
     setMinValue : function(dt){
         var me = this,
             picker = me.picker,
             minValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
-            
+
         me.minValue = minValue;
         if (picker) {
             picker.minText = Ext.String.format(me.minText, me.formatDate(me.minValue));
@@ -299,14 +291,14 @@ disabledDates: [&quot;^03&quot;]
     },
 
 <span id='Ext-form-field-Date-method-setMaxValue'>    /**
-</span>     * Replaces any existing &lt;tt&gt;{@link #maxValue}&lt;/tt&gt; with the new value and refreshes the Date picker.
+</span>     * Replaces any existing {@link #maxValue} with the new value and refreshes the Date picker.
      * @param {Date} value The maximum date that can be selected
      */
     setMaxValue : function(dt){
         var me = this,
             picker = me.picker,
             maxValue = (Ext.isString(dt) ? me.parseDate(dt) : dt);
-            
+
         me.maxValue = maxValue;
         if (picker) {
             picker.maxText = Ext.String.format(me.maxText, me.formatDate(me.maxValue));
@@ -315,13 +307,12 @@ disabledDates: [&quot;^03&quot;]
     },
 
 <span id='Ext-form-field-Date-method-getErrors'>    /**
-</span>     * Runs all of Date's validations and returns an array of any errors. Note that this first
-     * runs Text's validations, so the returned array is an amalgamation of all field errors.
-     * The additional validation checks are testing that the date format is valid, that the chosen
-     * date is within the min and max date constraints set, that the date chosen is not in the disabledDates
-     * regex and that the day chosed is not one of the disabledDays.
-     * @param {Mixed} value The value to get errors for (defaults to the current field value)
-     * @return {Array} All validation errors for this field
+</span>     * Runs all of Date's validations and returns an array of any errors. Note that this first runs Text's validations,
+     * so the returned array is an amalgamation of all field errors. The additional validation checks are testing that
+     * the date format is valid, that the chosen date is within the min and max date constraints set, that the date
+     * chosen is not in the disabledDates regex and that the day chosed is not one of the disabledDays.
+     * @param {Object} [value] The value to get errors for (defaults to the current field value)
+     * @return {String[]} All validation errors for this field
      */
     getErrors: function(value) {
         var me = this,
@@ -389,27 +380,28 @@ disabledDates: [&quot;^03&quot;]
     },
 
 <span id='Ext-form-field-Date-method-setValue'>    /**
-</span>     * Sets the value of the date field.  You can pass a date object or any string that can be
-     * parsed into a valid date, using &lt;tt&gt;{@link #format}&lt;/tt&gt; as the date format, according
-     * 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;).
-     * &lt;br /&gt;Usage:
-     * &lt;pre&gt;&lt;code&gt;
-//All of these calls set the same date value (May 4, 2006)
-
-//Pass a date object:
-var dt = new Date('5/4/2006');
-dateField.setValue(dt);
-
-//Pass a date string (default format):
-dateField.setValue('05/04/2006');
-
-//Pass a date string (custom format):
-dateField.format = 'Y-m-d';
-dateField.setValue('2006-05-04');
-&lt;/code&gt;&lt;/pre&gt;
+</span>     * @method setValue
+     * Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid date,
+     * using {@link #format} as the date format, according to the same rules as {@link Ext.Date#parse} (the default
+     * format used is &quot;m/d/Y&quot;).
+     *
+     * Usage:
+     *
+     *     //All of these calls set the same date value (May 4, 2006)
+     *
+     *     //Pass a date object:
+     *     var dt = new Date('5/4/2006');
+     *     dateField.setValue(dt);
+     *
+     *     //Pass a date string (default format):
+     *     dateField.setValue('05/04/2006');
+     *
+     *     //Pass a date string (custom format):
+     *     dateField.format = 'Y-m-d';
+     *     dateField.setValue('2006-05-04');
+     *
      * @param {String/Date} date The date or valid date string
      * @return {Ext.form.field.Date} this
-     * @method setValue
      */
 
 <span id='Ext-form-field-Date-method-safeParse'>    /**
@@ -423,7 +415,7 @@ dateField.setValue('2006-05-04');
             utilDate = Ext.Date,
             parsedDate,
             result = null;
-            
+
         if (utilDate.formatContainsHourInfo(format)) {
             // if parse format contains hour information, no DST adjustment is necessary
             result = utilDate.parse(value, format);
@@ -436,14 +428,13 @@ dateField.setValue('2006-05-04');
         }
         return result;
     },
-    
+
     // @private
     getSubmitValue: function() {
-        var me = this,
-            format = me.submitFormat || me.format,
-            value = me.getValue();
-            
-        return value ? Ext.Date.format(value, format) : null;
+        var format = this.submitFormat || this.format,
+            value = this.getValue();
+
+        return value ? Ext.Date.format(value, format) : '';
     },
 
 <span id='Ext-form-field-Date-method-parseDate'>    /**
@@ -481,6 +472,7 @@ dateField.setValue('2006-05-04');
             format = Ext.String.format;
 
         return Ext.create('Ext.picker.Date', {
+            pickerField: me,
             ownerCt: me.ownerCt,
             renderTo: document.body,
             floating: true,
@@ -511,7 +503,7 @@ dateField.setValue('2006-05-04');
 
     onSelect: function(m, d) {
         var me = this;
-        
+
         me.setValue(d);
         me.fireEvent('select', me, d);
         me.collapse();
@@ -522,9 +514,8 @@ dateField.setValue('2006-05-04');
      * Sets the Date picker's value to match the current field value when expanding.
      */
     onExpand: function() {
-        var me = this,
-            value = me.getValue();
-        me.picker.setValue(Ext.isDate(value) ? value : new Date());
+        var value = this.getValue();
+        this.picker.setValue(Ext.isDate(value) ? value : new Date());
     },
 
 <span id='Ext-form-field-Date-method-onCollapse'>    /**
@@ -540,24 +531,27 @@ dateField.setValue('2006-05-04');
         var me = this,
             v = me.parseDate(me.getRawValue()),
             focusTask = me.focusTask;
-        
+
         if (focusTask) {
             focusTask.cancel();
         }
-        
+
         if (v) {
             me.setValue(v);
         }
     }
 
 <span id='Ext-form-field-Date-cfg-grow'>    /**
-</span>     * @cfg {Boolean} grow @hide
+</span>     * @hide
+     * @cfg {Boolean} grow
      */
 <span id='Ext-form-field-Date-cfg-growMin'>    /**
-</span>     * @cfg {Number} growMin @hide
+</span>     * @hide
+     * @cfg {Number} growMin
      */
 <span id='Ext-form-field-Date-cfg-growMax'>    /**
-</span>     * @cfg {Number} growMax @hide
+</span>     * @hide
+     * @cfg {Number} growMax
      */
 <span id='Ext-form-field-Date-method-autoSize'>    /**
 </span>     * @hide