pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Formatter.util.date</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.5.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> <script src="http://yui.yahooapis.com/combo?3.5.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title=""></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: </em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/cultures.deAT.html">cultures.deAT</a></li> <li><a href="../classes/cultures.deDE.html">cultures.deDE</a></li> <li><a href="../classes/cultures.enUS.html">cultures.enUS</a></li> <li><a href="../classes/flavors.java.html">flavors.java</a></li> <li><a href="../classes/flavors.java.Formatter.html">flavors.java.Formatter</a></li> <li><a href="../classes/flavors.java.Formatter.number.html">flavors.java.Formatter.number</a></li> <li><a href="../classes/flavors.java.Formatter.number.localize.html">flavors.java.Formatter.number.localize</a></li> <li><a href="../classes/flavors.java.Formatter.util.html">flavors.java.Formatter.util</a></li> <li><a href="../classes/flavors.java.Parser.html">flavors.java.Parser</a></li> <li><a href="../classes/flavors.java.Scanner.html">flavors.java.Scanner</a></li> <li><a href="../classes/flavors.java.Scanner.tokenCategories.html">flavors.java.Scanner.tokenCategories</a></li> <li><a href="../classes/Formatter.html">Formatter</a></li> <li><a href="../classes/Formatter.date.html">Formatter.date</a></li> <li><a href="../classes/Formatter.number.html">Formatter.number</a></li> <li><a href="../classes/Formatter.util.html">Formatter.util</a></li> <li><a href="../classes/Formatter.util.date.html">Formatter.util.date</a></li> <li><a href="../classes/Formatter.util.number.html">Formatter.util.number</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/cultures.html">cultures</a></li> <li><a href="../modules/flavors.html">flavors</a></li> <li><a href="../modules/pat.html">pat</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>Formatter.util.date Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_pat.js.html#l662"><code>../lib/pat.js:662</code></a> </div> Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Date utility functions for the Gregorian calendar.</p> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_century">century</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_dayOfWeek">dayOfWeek</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_dayOfYear">dayOfYear</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_daysOfMonth">daysOfMonth</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_daysOfYear">daysOfYear</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_firstDayOfMonth">firstDayOfMonth</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_firstDayOfWeek">firstDayOfWeek</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_firstDayOfYear">firstDayOfYear</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isAM">isAM</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isLeapYear">isLeapYear</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isoWeek">isoWeek</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isPM">isPM</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_lastDayOfMonth">lastDayOfMonth</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_lastDayOfWeek">lastDayOfWeek</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_lastDayOfYear">lastDayOfYear</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_nthDayOfWeek">nthDayOfWeek</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_pastCenturies">pastCenturies</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_timestamp">timestamp</a> <span class="flag static">static</span> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property"> <a href="#property_MILLISECONDS_PER_DAY">MILLISECONDS_PER_DAY</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_MILLISECONDS_PER_HOUR">MILLISECONDS_PER_HOUR</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_MILLISECONDS_PER_WEEK">MILLISECONDS_PER_WEEK</a> <span class="flag static">static</span> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_century" class="method item"> <h3 class="name"><code>century</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l898"><code>../lib/pat.js:898</code></a> </p> </div> <div class="description"> <p>Returns the century specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_dayOfWeek" class="method item"> <h3 class="name"><code>dayOfWeek</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l741"><code>../lib/pat.js:741</code></a> </p> </div> <div class="description"> <p>Returns the culture-specific weekday of the given date. The first day of the week corresponds to 0, the last day to 6.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> <li class="param"> <code class="param-name">culture</code> <span class="type">Object</span> <div class="param-description"> <p>Culture information</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_dayOfYear" class="method item"> <h3 class="name"><code>dayOfYear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l753"><code>../lib/pat.js:753</code></a> </p> </div> <div class="description"> <p>Returns the day of the year specified by the given date. The first day of the year corresponds to 1.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_daysOfMonth" class="method item"> <h3 class="name"><code>daysOfMonth</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l706"><code>../lib/pat.js:706</code></a> </p> </div> <div class="description"> <p>Returns the number of days for the specified month.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_daysOfYear" class="method item"> <h3 class="name"><code>daysOfYear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l720"><code>../lib/pat.js:720</code></a> </p> </div> <div class="description"> <p>Returns the number of days for the specified year.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Date | Number</span> <div class="param-description"> <p>(Date is interpreted as a UTC value)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_firstDayOfMonth" class="method item"> <h3 class="name"><code>firstDayOfMonth</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l822"><code>../lib/pat.js:822</code></a> </p> </div> <div class="description"> <p>Returns a date representing the first day of the month specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_firstDayOfWeek" class="method item"> <h3 class="name"><code>firstDayOfWeek</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l798"><code>../lib/pat.js:798</code></a> </p> </div> <div class="description"> <p>Returns a date representing the first day of the week specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> <li class="param"> <code class="param-name">culture</code> <span class="type">Object</span> <div class="param-description"> <p>Culture information</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_firstDayOfYear" class="method item"> <h3 class="name"><code>firstDayOfYear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l848"><code>../lib/pat.js:848</code></a> </p> </div> <div class="description"> <p>Returns a date representing the first day of the specified year.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Date | Number</span> <div class="param-description"> <p>(Date is interpreted as a UTC value)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_isAM" class="method item"> <h3 class="name"><code>isAM</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l918"><code>../lib/pat.js:918</code></a> </p> </div> <div class="description"> <p>Returns true if the time specified by the given date is in the range [00:00, 12:00). Returns false otherwise.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: </div> </div> </div> <div id="method_isLeapYear" class="method item"> <h3 class="name"><code>isLeapYear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l730"><code>../lib/pat.js:730</code></a> </p> </div> <div class="description"> <p>Returns true if the specified year is a leap year, false otherwise.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Date | Number</span> <div class="param-description"> <p>(Date is interpreted as a UTC value)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: </div> </div> </div> <div id="method_isoWeek" class="method item"> <h3 class="name"><code>isoWeek</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l879"><code>../lib/pat.js:879</code></a> </p> </div> <div class="description"> <p>Returns the ISO-8601 week specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_isPM" class="method item"> <h3 class="name"><code>isPM</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l934"><code>../lib/pat.js:934</code></a> </p> </div> <div class="description"> <p>Returns true if the time specified by the given date is in the range [12:00, 00:00). Returns false otherwise.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: </div> </div> </div> <div id="method_lastDayOfMonth" class="method item"> <h3 class="name"><code>lastDayOfMonth</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l833"><code>../lib/pat.js:833</code></a> </p> </div> <div class="description"> <p>Returns a date representing the last day of the month specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_lastDayOfWeek" class="method item"> <h3 class="name"><code>lastDayOfWeek</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l810"><code>../lib/pat.js:810</code></a> </p> </div> <div class="description"> <p>Returns a date representing the first day of the week specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> <li class="param"> <code class="param-name">culture</code> <span class="type">Object</span> <div class="param-description"> <p>Culture information</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_lastDayOfYear" class="method item"> <h3 class="name"><code>lastDayOfYear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l862"><code>../lib/pat.js:862</code></a> </p> </div> <div class="description"> <p>Returns a date representing the last day of the specified year.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Date | Number</span> <div class="param-description"> <p>(Date is interpreted as a UTC value)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> </div> <div id="method_nthDayOfWeek" class="method item"> <h3 class="name"><code>nthDayOfWeek</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>date</code> </li> <li class="arg"> <code>culture</code> </li> <li class="arg"> <code>n</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Date</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l772"><code>../lib/pat.js:772</code></a> </p> </div> <div class="description"> <p>Returns a date representing the n-th day of the week specified by the given date.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">date</code> <span class="type">Date</span> <div class="param-description"> <p>Interpreted as a UTC value</p> </div> </li> <li class="param"> <code class="param-name">culture</code> <span class="type">Object</span> <div class="param-description"> <p>Culture information</p> </div> </li> <li class="param"> <code class="param-name">n</code> <span class="type">Number</span> <div class="param-description"> <p>In [0,6]</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Date</span>: </div> </div> <div class="example"> <h4>Example:</h4> <div class="example-content"> <pre class="code"><code class="prettyprint"> var d = new Date('2012-07-04T00:00Z'), //Wednesday c = { firstDayOfWeek: 1 }; //culture with Monday as first weekday Formatter.util.date.nthDayOfWeek( d, c, 0); //Date representing '2012-07-02T00:00' Formatter.util.date.nthDayOfWeek( d, c, 6); //Date representing '2012-07-08T00:00' </code></pre> </div> </div> </div> <div id="method_pastCenturies" class="method item"> <h3 class="name"><code>pastCenturies</code></h3> <div class="args"