pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>flavors.java.Formatter.number.localize</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>flavors.java.Formatter.number.localize Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_flavors_java.js.html#l127"><code>../lib/flavors/java.js:127</code></a> </div> Module: <a href="../modules/flavors.html">flavors</a><br> Parent Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Java number localization algorithm.</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_decimalSeparator">decimalSeparator</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_digits">digits</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_groupingSeparator">groupingSeparator</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_localize">localize</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_localizeNumber">localizeNumber</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_sign">sign</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_ASCII_9 ASCII code for '9' (57)">ASCII_9 ASCII code for '9' (57)</a> </li> <li class="index-item property"> <a href="#property_ASCII_ZERO ASCII code for '0' (48)">ASCII_ZERO ASCII code for '0' (48)</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_decimalSeparator" class="method item"> <h3 class="name"><code>decimalSeparator</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"></span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l169"><code>../lib/flavors/java.js:169</code></a> </p> </div> <div class="description"> <p>Java number localization algorithm. If a decimal separator is present, a culture-specific decimal separator is substituted.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Array</span> <div class="param-description"> <p>Character array representing the Number to be localized</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"> undefined </div> </div> </div> <div id="method_digits" class="method item"> <h3 class="name"><code>digits</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"></span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l146"><code>../lib/flavors/java.js:146</code></a> </p> </div> <div class="description"> <p>Java number localization algorithm. Each digit character d in the string is replaced by a culture-specific digit computed relative to the current culture's zero digit z; that is d - '0' + z.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Array</span> <div class="param-description"> <p>Character array representing the Number to be localized</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> undefined </div> </div> </div> <div id="method_groupingSeparator" class="method item"> <h3 class="name"><code>groupingSeparator</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l185"><code>../lib/flavors/java.js:185</code></a> </p> </div> <div class="description"> <p>Java number localization algorithm. If the ',' ('\u002c') flag is given, then the culture-specific grouping separator is inserted by scanning the integer part of the string from least significant to most significant digits and inserting a separator at intervals defined by the culture's grouping size.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Array</span> <div class="param-description"> <p>Character array representing the Number to be localized</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> <div id="method_localize" class="method item"> <h3 class="name"><code>localize</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code>width</code> </li> <li class="arg"> <code>culture</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"></span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l209"><code>../lib/flavors/java.js:209</code></a> </p> </div> <div class="description"> <p>Java number localization algorithm. If the '0' flag is given, then the culture-specific zero digits are inserted after the sign character, if any, and before the first non-zero digit, until the length of the string is equal to the requested field width.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Array</span> <div class="param-description"> <p>Character array representing the Number to be localized</p> </div> </li> <li class="param"> <code class="param-name">width</code> <span class="type">Number</span> <div class="param-description"> <p>Length of the resulting string</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"> undefined </div> </div> </div> <div id="method_localizeNumber" class="method item"> <h3 class="name"><code>localizeNumber</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code>culture</code> </li> <li class="arg"> <code>width</code> </li> <li class="arg"> <code>options</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_flavors_java.js.html#l275"><code>../lib/flavors/java.js:275</code></a> </p> </div> <div class="description"> <p>Java localization algorithm for number strings.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">String</span> <div class="param-description"> <p>Number string to be localized</p> </div> </li> <li class="param"> <code class="param-name">culture</code> <span class="type">Object</span> <div class="param-description"> <p>Culture-specific information</p> </div> </li> <li class="param"> <code class="param-name">width</code> <span class="type">Number</span> <div class="param-description"> <p>The result's minimum width</p> </div> </li> <li class="param"> <code class="param-name">options</code> <span class="type">Object</span> <div class="param-description"> <p>Localization options (Options of a parsed token)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: The localized number string </div> </div> </div> <div id="method_sign" class="method item"> <h3 class="name"><code>sign</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code>opt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"></span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l240"><code>../lib/flavors/java.js:240</code></a> </p> </div> <div class="description"> <p>Java flavored number localization algorithm.</p> <p>If the value is negative and the '(' flag is given, then a '(' is prepended and a ')' is appended.</p> <p>If the value is negative and '(' flag is not given, then a '-' is prepended.</p> <p>If the '+' flag is given and the value is positive or zero, then a '+' will be prepended.</p> <p>If the ' ' flag is given and the value is positive or zero, then a ' ' will be prepended.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Array</span> <div class="param-description"> <p>Character array representing the Number to be localized</p> </div> </li> <li class="param"> <code class="param-name">opt</code> <span class="type">Object</span> <div class="param-description"> <p>Sign options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> undefined </div> </div> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property_ASCII_9 ASCII code for '9' (57)" class="property item"> <h3 class="name"><code>ASCII_9 ASCII code for '9' (57)</code></h3> <span class="type">Number</span> <span class="flag final">final</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l139"><code>../lib/flavors/java.js:139</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_ASCII_ZERO ASCII code for '0' (48)" class="property item"> <h3 class="name"><code>ASCII_ZERO ASCII code for '0' (48)</code></h3> <span class="type">Number</span> <span class="flag final">final</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l133"><code>../lib/flavors/java.js:133</code></a> </p> </div> <div class="description"> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>