pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Formatter.util</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 Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_pat.js.html#l446"><code>../lib/pat.js:446</code></a> </div> Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Utility functions.</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_concat">concat</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isArray">isArray</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isString">isString</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_pad">pad</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_padLeft">padLeft</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_padRight">padRight</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_toArray">toArray</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_concat" class="method item"> <h3 class="name"><code>concat</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>[n</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#l486"><code>../lib/pat.js:486</code></a> </p> </div> <div class="description"> <p>Concatenates the given argument n-1 times with itself and returns the resulting string.</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"> </div> </li> <li class="param"> <code class="param-name">[n</code> <span class="type">Number</span> <div class="param-description"> <p>= 1]</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_isArray" class="method item"> <h3 class="name"><code>isArray</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#l452"><code>../lib/pat.js:452</code></a> </p> </div> <div class="description"> <p>Returns true if the given arg is an Array, 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">Any</span> <div class="param-description"> </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_isString" class="method item"> <h3 class="name"><code>isString</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#l462"><code>../lib/pat.js:462</code></a> </p> </div> <div class="description"> <p>Returns true if the given arg is a String, 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">Any</span> <div class="param-description"> </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_pad" class="method item"> <h3 class="name"><code>pad</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>str</code> </li> <li class="arg"> <code>[ch</code> </li> <li class="arg"> <code>[len</code> </li> <li class="arg"> <code>[left</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#l499"><code>../lib/pat.js:499</code></a> </p> </div> <div class="description"> <p>Appends or prepends the given character to the given string until the resulting string has the specified length.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">str</code> <span class="type">String</span> <div class="param-description"> <p>Append or prepend to this string</p> </div> </li> <li class="param"> <code class="param-name">[ch</code> <span class="type">String</span> <div class="param-description"> <p>= ' '] Character to be appended or prepended</p> </div> </li> <li class="param"> <code class="param-name">[len</code> <span class="type">Number</span> <div class="param-description"> <p>= String(str).length] Length of the resulting string</p> </div> </li> <li class="param"> <code class="param-name">[left</code> <span class="type">Boolean</span> <div class="param-description"> <p>= false] Prepend if true, append otherwise</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_padLeft" class="method item"> <h3 class="name"><code>padLeft</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>str</code> </li> <li class="arg"> <code>[ch</code> </li> <li class="arg"> <code>[len</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#l521"><code>../lib/pat.js:521</code></a> </p> </div> <div class="description"> <p>Prepends the given character to the given string until the resulting string has the specified length.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">str</code> <span class="type">String</span> <div class="param-description"> <p>Prepend to this string</p> </div> </li> <li class="param"> <code class="param-name">[ch</code> <span class="type">String</span> <div class="param-description"> <p>= ' '] Character to be prepended</p> </div> </li> <li class="param"> <code class="param-name">[len</code> <span class="type">Number</span> <div class="param-description"> <p>= String(str).length] Length of the resulting string</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_padRight" class="method item"> <h3 class="name"><code>padRight</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>str</code> </li> <li class="arg"> <code>[ch</code> </li> <li class="arg"> <code>[len</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#l534"><code>../lib/pat.js:534</code></a> </p> </div> <div class="description"> <p>Appends the given character to the given string until the resulting string has the specified length.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">str</code> <span class="type">String</span> <div class="param-description"> <p>Append to this string</p> </div> </li> <li class="param"> <code class="param-name">[ch</code> <span class="type">String</span> <div class="param-description"> <p>= ' '] Character to be appended</p> </div> </li> <li class="param"> <code class="param-name">[len</code> <span class="type">Number</span> <div class="param-description"> <p>= String(str).length] Length of the resulting string</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_toArray" class="method item"> <h3 class="name"><code>toArray</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">Array</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l472"><code>../lib/pat.js:472</code></a> </p> </div> <div class="description"> <p>Returns the argument, a character array or an array of length 1 containing the argument depending whether the argument is an array, a string or any other value.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Any</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Array</span>: </div> </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>