docs/output/Date.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Date-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Date-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Date-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Date"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Date.html#cls-Date">Date</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Global</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Date.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Date.html#cls-Date">Date</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr><tr><td class="hd-info"></td></tr></table><div class="description">The date parsing and formatting syntax contains a subset of
   2 <a href="http://www.php.net/date">PHP's date() function</a>, and the formats that are
   3 supported will provide results equivalent to their PHP versions.
   4 The following is a list of all currently supported formats:
   5 <pre>
   6 Format  Description                                                               Example returned values
   7 ------  -----------------------------------------------------------------------   -----------------------
   8   d     Day of the month, 2 digits with leading zeros                             01 to 31
   9   D     A short textual representation of the day of the week                     Mon to Sun
  10   j     Day of the month without leading zeros                                    1 to 31
  11   l     A full textual representation of the day of the week                      Sunday to Saturday
  12   N     ISO-8601 numeric representation of the day of the week                    1 (for Monday) through 7 (for Sunday)
  13   S     English ordinal suffix for the day of the month, 2 characters             st, nd, rd or th. Works well with j
  14   w     Numeric representation of the day of the week                             0 (for Sunday) to 6 (for Saturday)
  15   z     The day of the year (starting from 0)                                     0 to 364 (365 in leap years)
  16   W     ISO-8601 week number of year, weeks starting on Monday                    01 to 53
  17   F     A full textual representation of a month, such as January or March        January to December
  18   m     Numeric representation of a month, with leading zeros                     01 to 12
  19   M     A short textual representation of a month                                 Jan to Dec
  20   n     Numeric representation of a month, without leading zeros                  1 to 12
  21   t     Number of days in the given month                                         28 to 31
  22   L     Whether it's a leap year                                                  1 if it is a leap year, 0 otherwise.
  23   o     ISO-8601 year number (identical to (Y), but if the ISO week number (W)    Examples: 1998 or 2004
  24         belongs to the previous or next year, that year is used instead)
  25   Y     A full numeric representation of a year, 4 digits                         Examples: 1999 or 2003
  26   y     A two digit representation of a year                                      Examples: 99 or 03
  27   a     Lowercase Ante meridiem and Post meridiem                                 am or pm
  28   A     Uppercase Ante meridiem and Post meridiem                                 AM or PM
  29   g     12-hour format of an hour without leading zeros                           1 to 12
  30   G     24-hour format of an hour without leading zeros                           0 to 23
  31   h     12-hour format of an hour with leading zeros                              01 to 12
  32   H     24-hour format of an hour with leading zeros                              00 to 23
  33   i     Minutes, with leading zeros                                               00 to 59
  34   s     Seconds, with leading zeros                                               00 to 59
  35   u     Decimal fraction of a second                                              Examples:
  36         (minimum 1 digit, arbitrary number of digits allowed)                     001 (i.e. 0.001s) or
  37                                                                                   100 (i.e. 0.100s) or
  38                                                                                   999 (i.e. 0.999s) or
  39                                                                                   999876543210 (i.e. 0.999876543210s)
  40   O     Difference to Greenwich time (GMT) in hours and minutes                   Example: +1030
  41   P     Difference to Greenwich time (GMT) with colon between hours and minutes   Example: -08:00
  42   T     Timezone abbreviation of the machine running the code                     Examples: EST, MDT, PDT ...
  43   Z     Timezone offset in seconds (negative if west of UTC, positive if east)    -43200 to 50400
  44   c     ISO 8601 date
  45         Notes:                                                                    Examples:
  46         1) If unspecified, the month / day defaults to the current month / day,   1991 or
  47            the time defaults to midnight, while the timezone defaults to the      1992-10 or
  48            browser's timezone. If a time is specified, it must include both hours 1993-09-20 or
  49            and minutes. The "T" delimiter, seconds, milliseconds and timezone     1994-08-19T16:20+01:00 or
  50            are optional.                                                          1995-07-18T17:21:28-02:00 or
  51         2) The decimal fraction of a second, if specified, must contain at        1996-06-17T18:22:29.98765+03:00 or
  52            least 1 digit (there is no limit to the maximum number                 1997-05-16T19:23:30,12345-0400 or
  53            of digits allowed), and may be delimited by either a '.' or a ','      1998-04-15T20:24:31.2468Z or
  54         Refer to the examples on the right for the various levels of              1999-03-14T20:24:32Z or
  55         date-time granularity which are supported, or see                         2000-02-13T21:25:33
  56         http://www.w3.org/TR/NOTE-datetime for more info.                         2001-01-12 22:26:34
  57   U     Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)                1193432466 or -2138434463
  58   M$    Microsoft AJAX serialized dates                                           \/Date(1238606590509)\/ (i.e. UTC milliseconds since epoch) or
  59                                                                                   \/Date(1238606590509+0800)\/
  60 </pre>
  61 Example usage (note that you must escape format specifiers with '\\' to render them as character literals):
  62 <pre><code><i>// Sample date:</i>
  63 <i>// <em>'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'</em></i>
  64
  65 <b>var</b> dt = <b>new</b> Date(<em>'1/10/2007 03:05:01 PM GMT-0600'</em>);
  66 document.write(dt.format(<em>'Y-m-d'</em>));                           <i>// 2007-01-10</i>
  67 document.write(dt.format(<em>'F j, Y, g:i a'</em>));                   <i>// January 10, 2007, 3:05 pm</i>
  68 document.write(dt.format(<em>'l, \\t\\he jS \\of F Y h:i:s A'</em>));  <i>// Wednesday, the 10th of January 2007 03:05:01 PM</i></code></pre>
  69 Here are some standard date/time patterns that you might find helpful.  They
  70 are not part of the source of Date.js, but to use them you can simply copy this
  71 block of code into any script that is included after Date.js and they will also become
  72 globally available on the Date object.  Feel free to add or remove patterns as needed in your code.
  73 <pre><code>Date.patterns = {
  74     ISO8601Long:<em>"Y-m-d H:i:s"</em>,
  75     ISO8601Short:<em>"Y-m-d"</em>,
  76     ShortDate: <em>"n/j/Y"</em>,
  77     LongDate: <em>"l, F d, Y"</em>,
  78     FullDateTime: <em>"l, F d, Y g:i:s A"</em>,
  79     MonthDay: <em>"F d"</em>,
  80     ShortTime: <em>"g:i A"</em>,
  81     LongTime: <em>"g:i:s A"</em>,
  82     SortableDateTime: <em>"Y-m-d\\TH:i:s"</em>,
  83     UniversalSortableDateTime: <em>"Y-m-d H:i:sO"</em>,
  84     YearMonth: <em>"F, Y"</em>
  85 };</code></pre>
  86 Example usage:
  87 <pre><code><b>var</b> dt = <b>new</b> Date();
  88 document.write(dt.format(Date.patterns.ShortDate));</code></pre>
  89 <p>Developer-written, custom formats may be used by supplying both a formatting and a parsing function
  90 which perform to specialized requirements. The functions are stored in <a href="output/Date.html#Date-parseFunctions" ext:member="parseFunctions" ext:cls="Date">parseFunctions</a> and <a href="output/Date.html#Date-formatFunctions" ext:member="formatFunctions" ext:cls="Date">formatFunctions</a>.</p></div><div class="hr"></div><a id="Date-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-DAY"></a><b><a href="source/Date.html#prop-Date-DAY">DAY</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-HOUR"></a><b><a href="source/Date.html#prop-Date-HOUR">HOUR</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-MILLI"></a><b><a href="source/Date.html#prop-Date-MILLI">MILLI</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-MINUTE"></a><b><a href="source/Date.html#prop-Date-MINUTE">MINUTE</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-MONTH"></a><b><a href="source/Date.html#prop-Date-MONTH">MONTH</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-SECOND"></a><b><a href="source/Date.html#prop-Date-SECOND">SECOND</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-YEAR"></a><b><a href="source/Date.html#prop-Date-YEAR">YEAR</a></b> : String<div class="mdesc">Date interval constant</div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-dayNames"></a><b><a href="source/Date.html#prop-Date-dayNames">dayNames</a></b> : Array<div class="mdesc"><div class="short">An array of textual day names.\r
  91 Override these values for international dates.\r
  92 Example:\r
  93 Date.dayNames = [\r
  94     'SundayI...</div><div class="long">An array of textual day names.
  95 Override these values for international dates.
  96 Example:
  97 <pre><code>Date.dayNames = [
  98     <em>'SundayInYourLang'</em>,
  99     <em>'MondayInYourLang'</em>,
 100     ...
 101 ];</code></pre></div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-defaults"></a><b><a href="source/Date.html#prop-Date-defaults">defaults</a></b> : Object<div class="mdesc"><div class="short">An object hash containing default date values used during date parsing.\r
 102 The following properties are available:&lt;div c...</div><div class="long"><p>An object hash containing default date values used during date parsing.</p>
 103 <p>The following properties are available:<div class="mdetail-params"><ul>
 104 <li><code>y</code> : Number<div class="sub-desc">The default year value. (defaults to undefined)</div></li>
 105 <li><code>m</code> : Number<div class="sub-desc">The default 1-based month value. (defaults to undefined)</div></li>
 106 <li><code>d</code> : Number<div class="sub-desc">The default day value. (defaults to undefined)</div></li>
 107 <li><code>h</code> : Number<div class="sub-desc">The default hour value. (defaults to undefined)</div></li>
 108 <li><code>i</code> : Number<div class="sub-desc">The default minute value. (defaults to undefined)</div></li>
 109 <li><code>s</code> : Number<div class="sub-desc">The default second value. (defaults to undefined)</div></li>
 110 <li><code>ms</code> : Number<div class="sub-desc">The default millisecond value. (defaults to undefined)</div></li>
 111 </ul></div></p>
 112 <p>Override these properties to customize the default date values used by the <a href="output/Date.html#Date-parseDate" ext:member="parseDate" ext:cls="Date">parseDate</a> method.</p>
 113 <p><b>Note: In countries which experience Daylight Saving Time (i.e. DST), the <tt>h</tt>, <tt>i</tt>, <tt>s</tt>
 114 and <tt>ms</tt> properties may coincide with the exact time in which DST takes effect.
 115 It is the responsiblity of the developer to account for this.</b></p>
 116 Example Usage:
 117 <pre><code><i>// set <b>default</b> day value to the first day of the month</i>
 118 Date.defaults.d = 1;
 119
 120 <i>// parse a February date string containing only year and month values.</i>
 121 <i>// setting the <b>default</b> day value to 1 prevents weird date rollover issues</i>
 122 <i>// when attempting to parse the following date string on, <b>for</b> example, March 31st 2009.</i>
 123 Date.parseDate(<em>'2009-02'</em>, <em>'Y-m'</em>); <i>// returns a Date object representing February 1st 2009</i></code></pre></div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-formatCodes"></a><b><a href="source/Date.html#prop-Date-formatCodes">formatCodes</a></b> : Object<div class="mdesc"><div class="short">The base format-code to formatting-function hashmap used by the format method.\r
 124 Formatting functions are strings (or f...</div><div class="long">The base format-code to formatting-function hashmap used by the <a href="output/Date.html#Date-format" ext:member="format" ext:cls="Date">format</a> method.
 125 Formatting functions are strings (or functions which return strings) which
 126 will return the appropriate value when evaluated in the context of the Date object
 127 from which the <a href="output/Date.html#Date-format" ext:member="format" ext:cls="Date">format</a> method is called.
 128 Add to / override these mappings for custom date formatting.
 129 Note: Date.format() treats characters as literals if an appropriate mapping cannot be found.
 130 Example:
 131 <pre><code>Date.formatCodes.x = <em>"String.leftPad(this.getDate(), 2, <em>'0'</em>)"</em>;
 132 (<b>new</b> Date()).format(<em>"X"</em>); <i>// returns the current day of the month</i></code></pre></div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-formatFunctions"></a><b><a href="source/Date.html#prop-Date-formatFunctions">formatFunctions</a></b> : Object<div class="mdesc"><div class="short">An object hash in which each property is a date formatting function. The property name is the\r
 133 format string which cor...</div><div class="long"><p>An object hash in which each property is a date formatting function. The property name is the
 134 format string which corresponds to the produced formatted date string.</p>
 135 <p>This object is automatically populated with date formatting functions as
 136 date formats are requested for Ext standard formatting strings.</p>
 137 <p>Custom formatting functions may be inserted into this object, keyed by a name which from then on
 138 may be used as a format string to <a href="output/Date.html#Date-format" ext:member="format" ext:cls="Date">format</a>. Example:</p><pre><code>Date.formatFunctions[<em>'x-date-format'</em>] = myDateFormatter;</code></pre>
 139 <p>A formatting function should return a string repesentation of the passed Date object:<div class="mdetail-params"><ul>
 140 <li><code>date</code> : Date<div class="sub-desc">The Date to format.</div></li>
 141 </ul></div></p>
 142 <p>To enable date strings to also be <i>parsed</i> according to that format, a corresponding
 143 parsing function must be placed into the <a href="output/Date.html#Date-parseFunctions" ext:member="parseFunctions" ext:cls="Date">parseFunctions</a> property.</div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-monthNames"></a><b><a href="source/Date.html#prop-Date-monthNames">monthNames</a></b> : Array<div class="mdesc"><div class="short">An array of textual month names.\r
 144 Override these values for international dates.\r
 145 Example:\r
 146 Date.monthNames = [\r
 147     'Jan...</div><div class="long">An array of textual month names.
 148 Override these values for international dates.
 149 Example:
 150 <pre><code>Date.monthNames = [
 151     <em>'JanInYourLang'</em>,
 152     <em>'FebInYourLang'</em>,
 153     ...
 154 ];</code></pre></div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-monthNumbers"></a><b><a href="source/Date.html#prop-Date-monthNumbers">monthNumbers</a></b> : Object<div class="mdesc"><div class="short">An object hash of zero-based javascript month numbers (with short month names as keys. note: keys are case-sensitive)...</div><div class="long">An object hash of zero-based javascript month numbers (with short month names as keys. note: keys are case-sensitive).
 155 Override these values for international dates.
 156 Example:
 157 <pre><code>Date.monthNumbers = {
 158     <em>'ShortJanNameInYourLang'</em>:0,
 159     <em>'ShortFebNameInYourLang'</em>:1,
 160     ...
 161 };</code></pre></div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-parseFunctions"></a><b><a href="source/Date.html#prop-Date-parseFunctions">parseFunctions</a></b> : Object<div class="mdesc"><div class="short">An object hash in which each property is a date parsing function. The property name is the\r
 162 format string which that f...</div><div class="long"><p>An object hash in which each property is a date parsing function. The property name is the
 163 format string which that function parses.</p>
 164 <p>This object is automatically populated with date parsing functions as
 165 date formats are requested for Ext standard formatting strings.</p>
 166 <p>Custom parsing functions may be inserted into this object, keyed by a name which from then on
 167 may be used as a format string to <a href="output/Date.html#Date-parseDate" ext:member="parseDate" ext:cls="Date">parseDate</a>.<p>
 168 <p>Example:</p><pre><code>Date.parseFunctions[<em>'x-date-format'</em>] = myDateParser;</code></pre>
 169 <p>A parsing function should return a Date object, and is passed the following parameters:<div class="mdetail-params"><ul>
 170 <li><code>date</code> : String<div class="sub-desc">The date string to parse.</div></li>
 171 <li><code>strict</code> : Boolean<div class="sub-desc">True to validate date strings while parsing
 172 (i.e. prevent javascript Date "rollover") (The default must be false).
 173 Invalid date strings should return null when parsed.</div></li>
 174 </ul></div></p>
 175 <p>To enable Dates to also be <i>formatted</i> according to that format, a corresponding
 176 formatting function must be placed into the <a href="output/Date.html#Date-formatFunctions" ext:member="formatFunctions" ext:cls="Date">formatFunctions</a> property.</div></div></td><td class="msource">Date</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-useStrict"></a><b><a href="source/Date.html#prop-Date-useStrict">useStrict</a></b> : Boolean<div class="mdesc"><div class="short">Global flag which determines if strict date parsing should be used.\r
 177 Strict date parsing will not roll-over invalid da...</div><div class="long">Global flag which determines if strict date parsing should be used.
 178 Strict date parsing will not roll-over invalid dates, which is the
 179 default behaviour of javascript Date objects.
 180 (see <a href="output/Date.html#Date-parseDate" ext:member="parseDate" ext:cls="Date">parseDate</a> for more information)
 181 Defaults to <tt>false</tt>.</div></div></td><td class="msource">Date</td></tr></tbody></table><a id="Date-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-add"></a><b><a href="source/Date.html#method-Date-add">add</a></b>(&nbsp;<code>String&nbsp;interval</code>,&nbsp;<code>Number&nbsp;value</code>&nbsp;)\r
 182     :\r
 183                                         Date<div class="mdesc"><div class="short">Provides a convenient method for performing basic date arithmetic. This method\r
 184 does not modify the Date instance bein...</div><div class="long">Provides a convenient method for performing basic date arithmetic. This method
 185 does not modify the Date instance being called - it creates and returns
 186 a new Date instance containing the resulting date value.
 187 Examples:
 188 <pre><code><i>// Basic usage:</i>
 189 <b>var</b> dt = <b>new</b> Date(<em>'10/29/2006'</em>).add(Date.DAY, 5);
 190 document.write(dt); <i>//returns <em>'Fri Nov 03 2006 00:00:00'</em></i>
 191
 192 <i>// Negative values will be subtracted:</i>
 193 <b>var</b> dt2 = <b>new</b> Date(<em>'10/1/2006'</em>).add(Date.DAY, -5);
 194 document.write(dt2); <i>//returns <em>'Tue Sep 26 2006 00:00:00'</em></i>
 195
 196 <i>// You can even chain several calls together <b>in</b> one line:</i>
 197 <b>var</b> dt3 = <b>new</b> Date(<em>'10/1/2006'</em>).add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);
 198 document.write(dt3); <i>//returns <em>'Fri Oct 06 2006 07:30:00'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>interval</code> : String<div class="sub-desc">A valid date interval enum value.</div></li><li><code>value</code> : Number<div class="sub-desc">The amount to add to the current date.</div></li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc">The new Date instance.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-between"></a><b><a href="source/Date.html#method-Date-between">between</a></b>(&nbsp;<code>Date&nbsp;start</code>,&nbsp;<code>Date&nbsp;end</code>&nbsp;)\r
 199     :\r
 200                                         Boolean<div class="mdesc"><div class="short">Checks if this date falls on or between the given start and end dates.</div><div class="long">Checks if this date falls on or between the given start and end dates.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>start</code> : Date<div class="sub-desc">Start date</div></li><li><code>end</code> : Date<div class="sub-desc">End date</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">true if this date falls on or between the given start and end dates.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-clearTime"></a><b><a href="source/Date.html#method-Date-clearTime">clearTime</a></b>(&nbsp;<code>Boolean&nbsp;clone</code>&nbsp;)\r
 201     :\r
 202                                         Date<div class="mdesc"><div class="short">Attempts to clear all time information from this Date by setting the time to midnight of the same day,\r
 203 automatically ...</div><div class="long">Attempts to clear all time information from this Date by setting the time to midnight of the same day,
 204 automatically adjusting for Daylight Saving Time (DST) where applicable.
 205 (note: DST timezone information for the browser's host operating system is assumed to be up-to-date)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>clone</code> : Boolean<div class="sub-desc">true to create a clone of this date, clear the time and return it (defaults to false).</div></li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc">this or the clone.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-clone"></a><b><a href="source/Date.html#method-Date-clone">clone</a></b>()\r
 206     :\r
 207                                         Date<div class="mdesc"><div class="short">Creates and returns a new Date instance with the exact same date value as the called instance.\r
 208 Dates are copied and p...</div><div class="long">Creates and returns a new Date instance with the exact same date value as the called instance.
 209 Dates are copied and passed by reference, so if a copied date variable is modified later, the original
 210 variable will also be changed.  When the intention is to create a new variable that will not
 211 modify the original instance, you should create a clone.
 212 Example of correctly cloning a date:
 213 <pre><code><i>//wrong way:</i>
 214 <b>var</b> orig = <b>new</b> Date(<em>'10/1/2006'</em>);
 215 <b>var</b> copy = orig;
 216 copy.setDate(5);
 217 document.write(orig);  <i>//returns <em>'Thu Oct 05 2006'</em>!</i>
 218
 219 <i>//correct way:</i>
 220 <b>var</b> orig = <b>new</b> Date(<em>'10/1/2006'</em>);
 221 <b>var</b> copy = orig.clone();
 222 copy.setDate(5);
 223 document.write(orig);  <i>//returns <em>'Thu Oct 01 2006'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc">The new Date instance.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-format"></a><b><a href="source/Date.html#method-Date-format">format</a></b>(&nbsp;<code>String&nbsp;format</code>&nbsp;)\r
 224     :\r
 225                                         String<div class="mdesc"><div class="short">Formats a date given the supplied format string.</div><div class="long">Formats a date given the supplied format string.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>format</code> : String<div class="sub-desc">The format string.</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The formatted date.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getDayOfYear"></a><b><a href="source/Date.html#method-Date-getDayOfYear">getDayOfYear</a></b>()\r
 226     :\r
 227                                         Number<div class="mdesc"><div class="short">Get the numeric day number of the year, adjusted for leap year.</div><div class="long">Get the numeric day number of the year, adjusted for leap year.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">0 to 364 (365 in leap years).</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getDaysInMonth"></a><b><a href="source/Date.html#method-Date-getDaysInMonth">getDaysInMonth</a></b>()\r
 228     :\r
 229                                         Number<div class="mdesc"><div class="short">Get the number of days in the current month, adjusted for leap year.</div><div class="long">Get the number of days in the current month, adjusted for leap year.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The number of days in the month.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getElapsed"></a><b><a href="source/Ext-more.html#method-Date-getElapsed">getElapsed</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Date&nbsp;date</code>]</span>&nbsp;)\r
 230     :\r
 231                                         Number<div class="mdesc"><div class="short">Returns the number of milliseconds between this date and date</div><div class="long">Returns the number of milliseconds between this date and date<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>date</code> : Date<div class="sub-desc">(optional) Defaults to now</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The diff in milliseconds</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getFirstDateOfMonth"></a><b><a href="source/Date.html#method-Date-getFirstDateOfMonth">getFirstDateOfMonth</a></b>()\r
 232     :\r
 233                                         Date<div class="mdesc"><div class="short">Get the date of the first day of the month in which this date resides.</div><div class="long">Get the date of the first day of the month in which this date resides.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getFirstDayOfMonth"></a><b><a href="source/Date.html#method-Date-getFirstDayOfMonth">getFirstDayOfMonth</a></b>()\r
 234     :\r
 235                                         Number<div class="mdesc"><div class="short">Get the first day of the current month, adjusted for leap year.  The returned value\r
 236 is the numeric day index within t...</div><div class="long">Get the first day of the current month, adjusted for leap year.  The returned value
 237 is the numeric day index within the week (0-6) which can be used in conjunction with
 238 the <a href="output/Date.html#Date-monthNames" ext:member="monthNames" ext:cls="Date">monthNames</a> array to retrieve the textual day name.
 239 Example:
 240 <pre><code><b>var</b> dt = <b>new</b> Date(<em>'1/10/2007'</em>);
 241 document.write(Date.dayNames[dt.getFirstDayOfMonth()]); <i>//output: <em>'Monday'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The day number (0-6).</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getGMTOffset"></a><b><a href="source/Date.html#method-Date-getGMTOffset">getGMTOffset</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;colon</code>]</span>&nbsp;)\r
 242     :\r
 243                                         String<div class="mdesc"><div class="short">Get the offset from GMT of the current date (equivalent to the format specifier 'O').</div><div class="long">Get the offset from GMT of the current date (equivalent to the format specifier 'O').<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colon</code> : Boolean<div class="sub-desc">(optional) true to separate the hours and minutes with a colon (defaults to false).</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The 4-character offset string prefixed with + or - (e.g. '-0600').</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getLastDateOfMonth"></a><b><a href="source/Date.html#method-Date-getLastDateOfMonth">getLastDateOfMonth</a></b>()\r
 244     :\r
 245                                         Date<div class="mdesc"><div class="short">Get the date of the last day of the month in which this date resides.</div><div class="long">Get the date of the last day of the month in which this date resides.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getLastDayOfMonth"></a><b><a href="source/Date.html#method-Date-getLastDayOfMonth">getLastDayOfMonth</a></b>()\r
 246     :\r
 247                                         Number<div class="mdesc"><div class="short">Get the last day of the current month, adjusted for leap year.  The returned value\r
 248 is the numeric day index within th...</div><div class="long">Get the last day of the current month, adjusted for leap year.  The returned value
 249 is the numeric day index within the week (0-6) which can be used in conjunction with
 250 the <a href="output/Date.html#Date-monthNames" ext:member="monthNames" ext:cls="Date">monthNames</a> array to retrieve the textual day name.
 251 Example:
 252 <pre><code><b>var</b> dt = <b>new</b> Date(<em>'1/10/2007'</em>);
 253 document.write(Date.dayNames[dt.getLastDayOfMonth()]); <i>//output: <em>'Wednesday'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The day number (0-6).</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getMonthNumber"></a><b><a href="source/Date.html#method-Date-getMonthNumber">getMonthNumber</a></b>(&nbsp;<code>String&nbsp;name</code>&nbsp;)\r
 254     :\r
 255                                         Number<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Get the zero-based javascript month number for the given short/full month name.\r
 256 Override this function for internatio...</div><div class="long">&lt;static&gt;&nbsp;Get the zero-based javascript month number for the given short/full month name.
 257 Override this function for international dates.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>name</code> : String<div class="sub-desc">The short/full month name.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The zero-based javascript month number.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getShortDayName"></a><b><a href="source/Date.html#method-Date-getShortDayName">getShortDayName</a></b>(&nbsp;<code>Number&nbsp;day</code>&nbsp;)\r
 258     :\r
 259                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Get the short day name for the given day number.\r
 260 Override this function for international dates.</div><div class="long">&lt;static&gt;&nbsp;Get the short day name for the given day number.
 261 Override this function for international dates.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>day</code> : Number<div class="sub-desc">A zero-based javascript day number.</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The short day name.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getShortMonthName"></a><b><a href="source/Date.html#method-Date-getShortMonthName">getShortMonthName</a></b>(&nbsp;<code>Number&nbsp;month</code>&nbsp;)\r
 262     :\r
 263                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Get the short month name for the given month number.\r
 264 Override this function for international dates.</div><div class="long">&lt;static&gt;&nbsp;Get the short month name for the given month number.
 265 Override this function for international dates.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>month</code> : Number<div class="sub-desc">A zero-based javascript month number.</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The short month name.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getSuffix"></a><b><a href="source/Date.html#method-Date-getSuffix">getSuffix</a></b>()\r
 266     :\r
 267                                         String<div class="mdesc"><div class="short">Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').</div><div class="long">Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">'st, 'nd', 'rd' or 'th'.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getTimezone"></a><b><a href="source/Date.html#method-Date-getTimezone">getTimezone</a></b>()\r
 268     :\r
 269                                         String<div class="mdesc"><div class="short">Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').\r
 270 Note: The date string ret...</div><div class="long">Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').
 271 Note: The date string returned by the javascript Date object's toString() method varies
 272 between browsers (e.g. FF vs IE) and system region settings (e.g. IE in Asia vs IE in America).
 273 For a given date string e.g. "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)",
 274 getTimezone() first tries to get the timezone abbreviation from between a pair of parentheses
 275 (which may or may not be present), failing which it proceeds to get the timezone abbreviation
 276 from the GMT offset portion of the date string.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...).</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-getWeekOfYear"></a><b><a href="source/Date.html#method-Date-getWeekOfYear">getWeekOfYear</a></b>()\r
 277     :\r
 278                                         Number<div class="mdesc"><div class="short">Get the numeric ISO-8601 week number of the year.\r
 279 (equivalent to the format specifier 'W', but without a leading zero...</div><div class="long">Get the numeric ISO-8601 week number of the year.
 280 (equivalent to the format specifier 'W', but without a leading zero).<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">1 to 53</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-isDST"></a><b><a href="source/Date.html#method-Date-isDST">isDST</a></b>()\r
 281     :\r
 282                                         Boolean<div class="mdesc"><div class="short">Checks if the current date is affected by Daylight Saving Time (DST).</div><div class="long">Checks if the current date is affected by Daylight Saving Time (DST).<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the current date is affected by DST.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-isLeapYear"></a><b><a href="source/Date.html#method-Date-isLeapYear">isLeapYear</a></b>()\r
 283     :\r
 284                                         Boolean<div class="mdesc"><div class="short">Checks if the current date falls within a leap year.</div><div class="long">Checks if the current date falls within a leap year.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the current date falls within a leap year, false otherwise.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-isValid"></a><b><a href="source/Date.html#method-Date-isValid">isValid</a></b>(&nbsp;<code>Number&nbsp;year</code>,&nbsp;<code>Number&nbsp;month</code>,&nbsp;<code>Number&nbsp;day</code>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;hour</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;minute</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;second</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;millisecond</code>]</span>&nbsp;)\r
 285     :\r
 286                                         Boolean<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Checks if the passed Date parameters will cause a javascript Date "rollover".</div><div class="long">&lt;static&gt;&nbsp;Checks if the passed Date parameters will cause a javascript Date "rollover".<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>year</code> : Number<div class="sub-desc">4-digit year</div></li><li><code>month</code> : Number<div class="sub-desc">1-based month-of-year</div></li><li><code>day</code> : Number<div class="sub-desc">Day of month</div></li><li><code>hour</code> : Number<div class="sub-desc">(optional) Hour</div></li><li><code>minute</code> : Number<div class="sub-desc">(optional) Minute</div></li><li><code>second</code> : Number<div class="sub-desc">(optional) Second</div></li><li><code>millisecond</code> : Number<div class="sub-desc">(optional) Millisecond</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">true if the passed parameters do not cause a Date "rollover", false otherwise.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Date-parseDate"></a><b><a href="source/Date.html#method-Date-parseDate">parseDate</a></b>(&nbsp;<code>String&nbsp;input</code>,&nbsp;<code>String&nbsp;format</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;strict</code>]</span>&nbsp;)\r
 287     :\r
 288                                         Date<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Parses the passed string using the specified date format.\r
 289 Note that this function expects normal calendar dates, mean...</div><div class="long">&lt;static&gt;&nbsp;Parses the passed string using the specified date format.
 290 Note that this function expects normal calendar dates, meaning that months are 1-based (i.e. 1 = January).
 291 The <a href="output/Date.html#Date-defaults" ext:member="defaults" ext:cls="Date">defaults</a> hash will be used for any date value (i.e. year, month, day, hour, minute, second or millisecond)
 292 which cannot be found in the passed string. If a corresponding default date value has not been specified in the <a href="output/Date.html#Date-defaults" ext:member="defaults" ext:cls="Date">defaults</a> hash,
 293 the current date's year, month, day or DST-adjusted zero-hour time value will be used instead.
 294 Keep in mind that the input date string must precisely match the specified format string
 295 in order for the parse operation to be successful (failed parse operations return a null value).
 296 <p>Example:</p><pre><code><i>//dt = Fri May 25 2007 (current date)</i>
 297 <b>var</b> dt = <b>new</b> Date();
 298
 299 <i>//dt = Thu May 25 2006 (today&#39;s month/day <b>in</b> 2006)</i>
 300 dt = Date.parseDate(<em>"2006"</em>, <em>"Y"</em>);
 301
 302 <i>//dt = Sun Jan 15 2006 (all date parts specified)</i>
 303 dt = Date.parseDate(<em>"2006-01-15"</em>, <em>"Y-m-d"</em>);
 304
 305 <i>//dt = Sun Jan 15 2006 15:20:01</i>
 306 dt = Date.parseDate(<em>"2006-01-15 3:20:01 PM"</em>, <em>"Y-m-d g:i:s A"</em>);
 307
 308 <i>// attempt to parse Sun Feb 29 2006 03:20:01 <b>in</b> strict mode</i>
 309 dt = Date.parseDate(<em>"2006-02-29 03:20:01"</em>, <em>"Y-m-d H:i:s"</em>, true); <i>// returns null</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>input</code> : String<div class="sub-desc">The raw date string.</div></li><li><code>format</code> : String<div class="sub-desc">The expected date string format.</div></li><li><code>strict</code> : Boolean<div class="sub-desc">(optional) True to validate date strings while parsing (i.e. prevents javascript Date "rollover")
 310                         (defaults to false). Invalid date strings will return null when parsed.</div></li></ul><strong>Returns:</strong><ul><li><code>Date</code><div class="sub-desc">The parsed Date.</div></li></ul></div></div></div></td><td class="msource">Date</td></tr></tbody></table><a id="Date-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>