--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.util.Format</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.util.Format-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.util.Format-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.util.Format-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.util.Format-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.util.Format
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_util_Format.js.html">Roo/util/Format.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">Format</td></tr>
+
+
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ Reusable data formatting functions
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.util.Format';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.util" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.util.Format.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.util.Format-configs"></a>
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Config Options - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.util.Format-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.util.Format-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-capitalize" name=".capitalize"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">capitalize</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Converts the first character only of a string to upper case</div>
+
+
+
+ <div class="long">
+
+ Converts the first character only of a string to upper case
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The text to convert</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-date" name=".date"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">date</b>
+
+ (Mixed <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Parse a value into a formatted date using the specified format pattern.</div>
+
+
+
+ <div class="long">
+
+ Parse a value into a formatted date using the specified format pattern.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The value to format</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>format</b>
+
+ </dt>
+ <dd>(optional) Any valid date format string (defaults to 'm/d/Y')</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted date string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-dateRenderer" name=".dateRenderer"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">dateRenderer</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
+
+
+ :
+
+
+ <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>
+
+
+
+ <div class="long">
+
+ Returns a date rendering function that can be reused to apply a date format multiple times efficiently
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>format</b>
+
+ </dt>
+ <dd>Any valid date format string</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> The date formatting function</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-ellipsis" name=".ellipsis"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">ellipsis</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>length</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Truncate a string and add an ellipsis ('.</div>
+
+
+
+ <div class="long">
+
+ Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The string to truncate</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>length</b>
+
+ </dt>
+ <dd>The maximum length to allow before truncating</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-htmlDecode" name=".htmlDecode"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlDecode</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>
+
+
+
+ <div class="long">
+
+ Convert certain characters (&, <, >, and ') from their HTML character equivalents.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The string to decode</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The decoded text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-htmlEncode" name=".htmlEncode"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlEncode</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>
+
+
+
+ <div class="long">
+
+ Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The string to encode</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-lowercase" name=".lowercase"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">lowercase</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Converts a string to all lower case letters</div>
+
+
+
+ <div class="long">
+
+ Converts a string to all lower case letters
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The text to convert</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-number" name=".number"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">number</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>decimals</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>delimiter</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Format a number<br/>eventually this should probably emulate php's number_format</div>
+
+
+
+ <div class="long">
+
+ Format a number<br/>eventually this should probably emulate php's number_format
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
+
+ </dt>
+ <dd>The numeric value to format</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>decimals</b>
+
+ </dt>
+ <dd>number of decimal places</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>delimiter</b>
+
+ </dt>
+ <dd>for thousands (default comma)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-stripTags" name=".stripTags"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">stripTags</b>
+
+ (Mixed <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Strips all HTML tags</div>
+
+
+
+ <div class="long">
+
+ Strips all HTML tags
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The text from which to strip tags</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The stripped text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-substr" name=".substr"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">substr</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>start</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>length</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns a substring from within an original string</div>
+
+
+
+ <div class="long">
+
+ Returns a substring from within an original string
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The original text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>start</b>
+
+ </dt>
+ <dd>The start index of the substring</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>length</b>
+
+ </dt>
+ <dd>The length of the substring</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The substring</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-toFixed" name=".toFixed"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">toFixed</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">safer version of Math.toFixed.</div>
+
+
+
+ <div class="long">
+
+ safer version of Math.toFixed..??/
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
+
+ </dt>
+ <dd>The numeric value to format</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
+
+ </dt>
+ <dd>Decimal places</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-trim" name=".trim"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">trim</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Trims any whitespace from either side of a string</div>
+
+
+
+ <div class="long">
+
+ Trims any whitespace from either side of a string
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The text to trim</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The trimmed text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-undef" name=".undef"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">undef</b>
+
+ (Mixed <B><i>value</i></B>)
+
+
+ :
+
+
+ Mixed
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Checks a reference and converts it to empty string if it is undefined</div>
+
+
+
+ <div class="long">
+
+ Checks a reference and converts it to empty string if it is undefined
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>Reference to check</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">Mixed</span> Empty string if converted, otherwise the original value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-uppercase" name=".uppercase"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">uppercase</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Converts a string to all upper case letters</div>
+
+
+
+ <div class="long">
+
+ Converts a string to all upper case letters
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>The text to convert</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Format-method-usMoney" name=".usMoney"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.util.Format.</span><b class="itemname">usMoney</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>)
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Format a number as US currency</div>
+
+
+
+ <div class="long">
+
+ Format a number as US currency
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
+
+ </dt>
+ <dd>The numeric value to format</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.util.Format
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.util.Format-events"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Events - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>