pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Formatter.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.date Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_pat.js.html#l1158"><code>../lib/pat.js:1158</code></a> </div> Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Functions ought to format date components.</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> </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_abbreviatedMonthName">abbreviatedMonthName</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_abbreviatedTimezone">abbreviatedTimezone</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_abbreviatedWeekdayName">abbreviatedWeekdayName</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_dayOfMonth">dayOfMonth</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_hours">hours</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_milliseconds">milliseconds</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_minutes">minutes</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_month">month</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_monthName">monthName</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_seconds">seconds</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_time">time</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_time12">time12</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_timeDesignator">timeDesignator</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_timezoneOffset">timezoneOffset</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_weekdayName">weekdayName</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_year">year</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_abbreviatedMonthName" class="method item"> <h3 class="name"><code>abbreviatedMonthName</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1274"><code>../lib/pat.js:1274</code></a> </p> </div> <div class="description"> <p>Returns the culture-specific abbreviated month name specfied 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">String</span>: </div> </div> </div> <div id="method_abbreviatedTimezone" class="method item"> <h3 class="name"><code>abbreviatedTimezone</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1391"><code>../lib/pat.js:1391</code></a> </p> </div> <div class="description"> <p>Returns a string representing the time zone abbreviation 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 date with the same timezone as provided by the host OS.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_abbreviatedWeekdayName" class="method item"> <h3 class="name"><code>abbreviatedWeekdayName</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1297"><code>../lib/pat.js:1297</code></a> </p> </div> <div class="description"> <p>Returns the culture-specific abbreviated weekday name specfied 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">String</span>: </div> </div> </div> <div id="method_dayOfMonth" class="method item"> <h3 class="name"><code>dayOfMonth</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>leadingZero</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1249"><code>../lib/pat.js:1249</code></a> </p> </div> <div class="description"> <p>Returns a string representing the 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> <li class="param"> <code class="param-name">leadingZero</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</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> <li class="arg"> <code>leadingZeros</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1222"><code>../lib/pat.js:1222</code></a> </p> </div> <div class="description"> <p>Returns a string representing the day of the year 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">leadingZeros</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_hours" class="method item"> <h3 class="name"><code>hours</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>leadingZero</code> </li> <li class="arg"> <code>h12</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1309"><code>../lib/pat.js:1309</code></a> </p> </div> <div class="description"> <p>Returns the formatted hours 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">leadingZero</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> <li class="param"> <code class="param-name">h12</code> <span class="type">Boolean</span> <div class="param-description"> <p>Hours in [1,12]?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_milliseconds" class="method item"> <h3 class="name"><code>milliseconds</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>leadingZeros</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1350"><code>../lib/pat.js:1350</code></a> </p> </div> <div class="description"> <p>Returns the formatted milliseconds 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">leadingZeros</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_minutes" class="method item"> <h3 class="name"><code>minutes</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>leadingZero</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1326"><code>../lib/pat.js:1326</code></a> </p> </div> <div class="description"> <p>Returns the formatted minutes 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">leadingZero</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_month" class="method item"> <h3 class="name"><code>month</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>leadingZero</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1236"><code>../lib/pat.js:1236</code></a> </p> </div> <div class="description"> <p>Returns a string representing 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> <li class="param"> <code class="param-name">leadingZero</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_monthName" class="method item"> <h3 class="name"><code>monthName</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1263"><code>../lib/pat.js:1263</code></a> </p> </div> <div class="description"> <p>Returns the culture-specific month name specfied 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">String</span>: </div> </div> </div> <div id="method_seconds" class="method item"> <h3 class="name"><code>seconds</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>leadingZero</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1338"><code>../lib/pat.js:1338</code></a> </p> </div> <div class="description"> <p>Returns the formatted seconds 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">leadingZero</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded result?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_time" class="method item"> <h3 class="name"><code>time</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>leadingZeros</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1404"><code>../lib/pat.js:1404</code></a> </p> </div> <div class="description"> <p>Returns a string representing the 24h time 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">leadingZeros</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded time components?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_time12" class="method item"> <h3 class="name"><code>time12</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>leadingZeros</code> </li> <li class="arg"> <code>designator</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1417"><code>../lib/pat.js:1417</code></a> </p> </div> <div class="description"> <p>Returns a string representing the 12h time 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">leadingZeros</code> <span class="type">Boolean</span> <div class="param-description"> <p>Zero padded time components?</p> </div> </li> <li class="param"> <code class="param-name">designator</code> <span class="type">Boolean</span> <div class="param-description"> <p>Including time designator (AM/PM)?</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: </div> </div> </div> <div id="method_timeDesignator" class="method item"> <h3 class="name"><code>timeDesignator</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l1365"><code>../lib/pat.js:1365</code></a> </p> </div> <div class="description"> <p>Returns a string representing the morning/afternoon designator for the time 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">String</span>: </div> </div> </div> <div id="method_timezoneOffset" class="method item"> <h3 class="name"><code>timezoneOffset</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">String</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pa