pat
Version:
Formats data described by format strings
1,122 lines (502 loc) • 26.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Formatter</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 Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/.._lib_pat.js.html#l231"><code>../lib/pat.js:231</code></a>
</div>
Module: <a href="../modules/pat.html">pat</a>
</div>
<div class="box intro">
<p>Allocates a new formatter with the specified options.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Formatter" class="method item">
<h3 class="name"><code>Formatter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l231"><code>../lib/pat.js:231</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>:
</div>
</div>
</div>
</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_format">format</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_format">format</a>
</li>
<li class="index-item method">
<a href="#method_options">options</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_options">options</a>
</li>
<li class="index-item method">
<a href="#method_reset">reset</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_validateCulture">validateCulture</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_defaultOptions">defaultOptions</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_format" class="method item">
<h3 class="name"><code>format</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fstr</code>
</li>
<li class="arg">
<code class="optional">[data]</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#l348"><code>../lib/pat.js:348</code></a>
</p>
</div>
<div class="description">
<p>Formats the given arguments described by the given formatstring.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fstr</code>
<span class="type">String</span>
<div class="param-description">
<p>Format string</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[data]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
<div class="param-description">
<p>Data to be formatted</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
Formatted data
</div>
</div>
</div>
<div id="method_format" class="method item">
<h3 class="name"><code>format</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fstr</code>
</li>
<li class="arg">
<code class="optional">[data]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l423"><code>../lib/pat.js:423</code></a>
</p>
</div>
<div class="description">
<p>Formats the given arguments described by the given formatstring.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fstr</code>
<span class="type">String</span>
<div class="param-description">
<p>Format string</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[data]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
<div class="param-description">
<p>Data to be formatted</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
Formatted data
</div>
</div>
</div>
<div id="method_options" class="method item">
<h3 class="name"><code>options</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a> | Object</span>
</span>
<span class="flag static">static</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l324"><code>../lib/pat.js:324</code></a>
</p>
</div>
<div class="description">
<p>Sets the Formatter options or returns them if called without an argument.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Formatter options:</p>
<pre><code> {
path: './',
flavorId: 'flavorId',
cultureId: 'cultureId',
lineSeparator: '\n'
}
</code></pre>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a> | Object</span>:
<pre><code> Formatter if called as setter, Formatter options if called as getter
</code></pre>
</div>
</div>
</div>
<div id="method_options" class="method item">
<h3 class="name"><code>options</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l360"><code>../lib/pat.js:360</code></a>
</p>
</div>
<div class="description">
<p>Sets this Formatter's options or returns them if called without an
argument.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Formatter options:</p>
<pre><code> {
path: './',
flavorId: 'flavorId',
cultureId: 'cultureId',
lineSeparator: '\n'
}
</code></pre>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
This Formatter's options if called as a getter, <code>this</code>
if called as a setter
</div>
</div>
</div>
<div id="method_reset" class="method item">
<h3 class="name"><code>reset</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>
</span>
<span class="flag static">static</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l250"><code>../lib/pat.js:250</code></a>
</p>
</div>
<div class="description">
<p>Resets the Formatter.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>:
</div>
</div>
</div>
<div id="method_validateCulture" class="method item">
<h3 class="name"><code>validateCulture</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>culture</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>
</span>
<span class="flag static">static</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l261"><code>../lib/pat.js:261</code></a>
</p>
</div>
<div class="description">
<p>Tests if the given argument represents a valid culture object.
Throws an error if it is not valid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">culture</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Formatter.html" class="crosslink">Formatter</a></span>:
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_defaultOptions" class="property item">
<h3 class="name"><code>defaultOptions</code></h3>
<span class="type">Object</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_pat.js.html#l241"><code>../lib/pat.js:241</code></a>
</p>
</div>
<div class="description">
<p>Default options for a new Formatter.
Overwrite this property if you intend to allocate several formatters with
default options different to those initially specified by this module.</p>
</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>