<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Class TimeZone - Class TimeZone</title> <link href="faldoc.css" rel="stylesheet" type="text/css"/> <link href="tabs.css" rel="stylesheet" type="text/css"/> </head> <body class="faldoc_body"> <div class="navitop"> <div class="tabs"> <ul> <li><a href="./index.html"><span>Main</span></a></li> <li><a href="./pages.html"><span>Related pages</span></a></li> <li><a href="./groups.html"><span>Groups</span></a></li> <li><a href="./funset.html"><span>Function sets</span></a></li> <li><a href="./classes.html"><span>Classes</span></a></li> <li><a href="./objects.html"><span>Objects</span></a></li> <li><a href="./functions.html"><span>All functions</span></a></li> <li><a href="./globals.html"><span>Globals</span></a></li> </ul> </div> </div> <hr/> <h1 class="faldoc_title">Class TimeZone</h1> <p class="faldoc_brief">TimeZone enumeration and services. </p> <p class="faldoc_funcdecl"> <b>class</b> TimeZone </p> <p class="faldoc_brief"><a href="#more">more...</a></p> <h2 class="faldoc_title">Summary</h2> <table class="faldoc_list"> <tr><td><a href="#describe">describe()</a></td><td>Returns a descriptive string naming the required timezone. </td></tr> <tr><td><a href="#getDisplacement">getDisplacement()</a></td><td>Returns the distance in minutes from the GMT time of a given timezone </td></tr> <tr><td><a href="#getLocal">getLocal()</a></td><td>Return local time zone code. </td></tr> </table> <a name="more"><h2 class="faldoc_title">Detailed description</h2></a> <p class="faldoc_funcdecl"> <b>class</b> TimeZone </p> <table class="faldoc_function"> </table> <br/> <p class="item_brief">TimeZone enumeration and services. </p> <p class="faldoc_text">This class proves the list of managed timezones and various services needed to handle them. </p> <p class="faldoc_text">The enumerative part contains the following constants, representing west, east and some named timezones: </p> <ul> <li>local: Special local zone (unassigned, but relative to current location). </li><li>UTC or GMT </li><li>E1 to E12 (+1h to +12h) </li><li>W1 to W12 (-1h to -12h) </li><li>EDT </li><li>EST </li><li>CDT </li><li>CST </li><li>MDT </li><li>MST </li><li>PDT </li><li>PST </li><li>NFT </li><li>ACDT </li><li>ACST </li><li>HAT </li><li>NST </li><li>NONE: No/neutral/unknown timezone. </li> </ul> <h2 class="faldoc_title">Methods</h2> <h3 class="faldoc_funcname"><a name="describe">describe()</a></h3> <p class="item_brief">Returns a descriptive string naming the required timezone. </p> <p class="faldoc_funcdecl">TimeZone.describe( tz )</p> <table class="faldoc_function"> <tr><td class="faldoc_param">tz</td><td class="faldoc_paramdesc">A time zone code. </td></tr> <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A timezone name. </td></tr> </table> <p class="faldoc_text"><p class="faldoc_text">This static method, callable directly on the TimeZone class, returns a RFC 2822 compliant timezone name, given a timezone code. The "name" is in the format "+/-hhmm". </p> </p> <h3 class="faldoc_funcname"><a name="getDisplacement">getDisplacement()</a></h3> <p class="item_brief">Returns the distance in minutes from the GMT time of a given timezone </p> <p class="faldoc_funcdecl">TimeZone.getDisplacement( tz )</p> <table class="faldoc_function"> <tr><td class="faldoc_param">tz</td><td class="faldoc_paramdesc">A time zone code. </td></tr> <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A relative time distance in minutes. </td></tr> </table> <p class="faldoc_text"><p class="faldoc_text">This static method, callable directly on the TimeZone class, returns the time displacement of a determined time zone with respect to GMT. </p> </p> <h3 class="faldoc_funcname"><a name="getLocal">getLocal()</a></h3> <p class="item_brief">Return local time zone code. </p> <p class="faldoc_funcdecl">TimeZone.getLocal( )</p> <table class="faldoc_function"> <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A time zone code coresponding to the system local timezone. </td></tr> </table> <p class="faldoc_text"><p class="faldoc_text">To get a descriptive name of local timezone, use: </p> <pre class="faldoc_code"> TimeZone.describe( TimeZone.getLocal() ) </pre> </p> <hr/> <div class="navibottom"> <center> <a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a> </center> </div> </div> <div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div> </body> </html>