1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.util.Format</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.util.Format-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.util.Format-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.util.Format-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.util.Format-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_util_Format.js.html">Roo/util/Format.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Format</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 Reusable data formatting functions
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.util.Format';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.util" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.util.Format.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.util.Format-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.util.Format-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.util.Format-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.util.Format-method-capitalize" name=".capitalize"></a>
168 <div class="fixedFont">
169 <span class="attributes">Roo.util.Format.</span><b class="itemname">capitalize</b>
171 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
177 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
186 <div class="short">Converts the first character only of a string to upper case</div>
192 Converts the first character only of a string to upper case
199 <dl class="detailList">
200 <dt class="heading">Parameters:</dt>
203 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
206 <dd>The text to convert</dd>
214 <dl class="detailList">
215 <dt class="heading">Returns:</dt>
217 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
239 <tr class="method-row config-row-alt1 expandable notInherited">
240 <td class="micon"><a class="exi" href="#expand"> </a></td>
244 <a id="Roo.util.Format-method-date" name=".date"></a>
245 <div class="fixedFont">
246 <span class="attributes">Roo.util.Format.</span><b class="itemname">date</b>
248 (Mixed <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
254 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
263 <div class="short">Parse a value into a formatted date using the specified format pattern.</div>
269 Parse a value into a formatted date using the specified format pattern.
276 <dl class="detailList">
277 <dt class="heading">Parameters:</dt>
280 <span class="fixedFont">Mixed</span> <b>value</b>
283 <dd>The value to format</dd>
286 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>format</b>
289 <dd>(optional) Any valid date format string (defaults to 'm/d/Y')</dd>
297 <dl class="detailList">
298 <dt class="heading">Returns:</dt>
300 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted date string</dd>
322 <tr class="method-row config-row-alt0 expandable notInherited">
323 <td class="micon"><a class="exi" href="#expand"> </a></td>
327 <a id="Roo.util.Format-method-dateRenderer" name=".dateRenderer"></a>
328 <div class="fixedFont">
329 <span class="attributes">Roo.util.Format.</span><b class="itemname">dateRenderer</b>
331 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
337 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
346 <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>
352 Returns a date rendering function that can be reused to apply a date format multiple times efficiently
359 <dl class="detailList">
360 <dt class="heading">Parameters:</dt>
363 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>format</b>
366 <dd>Any valid date format string</dd>
374 <dl class="detailList">
375 <dt class="heading">Returns:</dt>
377 <dd><span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> The date formatting function</dd>
399 <tr class="method-row config-row-alt1 expandable notInherited">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
404 <a id="Roo.util.Format-method-ellipsis" name=".ellipsis"></a>
405 <div class="fixedFont">
406 <span class="attributes">Roo.util.Format.</span><b class="itemname">ellipsis</b>
408 (<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>)
414 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
423 <div class="short">Truncate a string and add an ellipsis ('.</div>
429 Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length
436 <dl class="detailList">
437 <dt class="heading">Parameters:</dt>
440 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
443 <dd>The string to truncate</dd>
446 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>length</b>
449 <dd>The maximum length to allow before truncating</dd>
457 <dl class="detailList">
458 <dt class="heading">Returns:</dt>
460 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
482 <tr class="method-row config-row-alt0 expandable notInherited">
483 <td class="micon"><a class="exi" href="#expand"> </a></td>
487 <a id="Roo.util.Format-method-htmlDecode" name=".htmlDecode"></a>
488 <div class="fixedFont">
489 <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlDecode</b>
491 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
497 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
506 <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>
512 Convert certain characters (&, <, >, and ') from their HTML character equivalents.
519 <dl class="detailList">
520 <dt class="heading">Parameters:</dt>
523 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
526 <dd>The string to decode</dd>
534 <dl class="detailList">
535 <dt class="heading">Returns:</dt>
537 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The decoded text</dd>
559 <tr class="method-row config-row-alt1 expandable notInherited">
560 <td class="micon"><a class="exi" href="#expand"> </a></td>
564 <a id="Roo.util.Format-method-htmlEncode" name=".htmlEncode"></a>
565 <div class="fixedFont">
566 <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlEncode</b>
568 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
574 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
583 <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>
589 Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.
596 <dl class="detailList">
597 <dt class="heading">Parameters:</dt>
600 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
603 <dd>The string to encode</dd>
611 <dl class="detailList">
612 <dt class="heading">Returns:</dt>
614 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The encoded text</dd>
636 <tr class="method-row config-row-alt0 expandable notInherited">
637 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.util.Format-method-lowercase" name=".lowercase"></a>
642 <div class="fixedFont">
643 <span class="attributes">Roo.util.Format.</span><b class="itemname">lowercase</b>
645 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
651 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
660 <div class="short">Converts a string to all lower case letters</div>
666 Converts a string to all lower case letters
673 <dl class="detailList">
674 <dt class="heading">Parameters:</dt>
677 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
680 <dd>The text to convert</dd>
688 <dl class="detailList">
689 <dt class="heading">Returns:</dt>
691 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
713 <tr class="method-row config-row-alt1 expandable notInherited">
714 <td class="micon"><a class="exi" href="#expand"> </a></td>
718 <a id="Roo.util.Format-method-number" name=".number"></a>
719 <div class="fixedFont">
720 <span class="attributes">Roo.util.Format.</span><b class="itemname">number</b>
722 (<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>)
728 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
737 <div class="short">Format a number<br/>eventually this should probably emulate php's number_format</div>
743 Format a number<br/>eventually this should probably emulate php's number_format
750 <dl class="detailList">
751 <dt class="heading">Parameters:</dt>
754 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
757 <dd>The numeric value to format</dd>
760 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>decimals</b>
763 <dd>number of decimal places</dd>
766 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>delimiter</b>
769 <dd>for thousands (default comma)</dd>
777 <dl class="detailList">
778 <dt class="heading">Returns:</dt>
780 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
802 <tr class="method-row config-row-alt0 expandable notInherited">
803 <td class="micon"><a class="exi" href="#expand"> </a></td>
807 <a id="Roo.util.Format-method-stripTags" name=".stripTags"></a>
808 <div class="fixedFont">
809 <span class="attributes">Roo.util.Format.</span><b class="itemname">stripTags</b>
811 (Mixed <B><i>value</i></B>)
817 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
826 <div class="short">Strips all HTML tags</div>
839 <dl class="detailList">
840 <dt class="heading">Parameters:</dt>
843 <span class="fixedFont">Mixed</span> <b>value</b>
846 <dd>The text from which to strip tags</dd>
854 <dl class="detailList">
855 <dt class="heading">Returns:</dt>
857 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The stripped text</dd>
879 <tr class="method-row config-row-alt1 expandable notInherited">
880 <td class="micon"><a class="exi" href="#expand"> </a></td>
884 <a id="Roo.util.Format-method-substr" name=".substr"></a>
885 <div class="fixedFont">
886 <span class="attributes">Roo.util.Format.</span><b class="itemname">substr</b>
888 (<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>)
894 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
903 <div class="short">Returns a substring from within an original string</div>
909 Returns a substring from within an original string
916 <dl class="detailList">
917 <dt class="heading">Parameters:</dt>
920 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
923 <dd>The original text</dd>
926 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>start</b>
929 <dd>The start index of the substring</dd>
932 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>length</b>
935 <dd>The length of the substring</dd>
943 <dl class="detailList">
944 <dt class="heading">Returns:</dt>
946 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The substring</dd>
968 <tr class="method-row config-row-alt0 expandable notInherited">
969 <td class="micon"><a class="exi" href="#expand"> </a></td>
973 <a id="Roo.util.Format-method-toFixed" name=".toFixed"></a>
974 <div class="fixedFont">
975 <span class="attributes">Roo.util.Format.</span><b class="itemname">toFixed</b>
977 (<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>)
983 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
992 <div class="short">safer version of Math.toFixed.</div>
998 safer version of Math.toFixed..??/
1005 <dl class="detailList">
1006 <dt class="heading">Parameters:</dt>
1009 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
1012 <dd>The numeric value to format</dd>
1015 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
1018 <dd>Decimal places</dd>
1026 <dl class="detailList">
1027 <dt class="heading">Returns:</dt>
1029 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
1043 <td class="msource">
1051 <tr class="method-row config-row-alt1 expandable notInherited">
1052 <td class="micon"><a class="exi" href="#expand"> </a></td>
1056 <a id="Roo.util.Format-method-trim" name=".trim"></a>
1057 <div class="fixedFont">
1058 <span class="attributes">Roo.util.Format.</span><b class="itemname">trim</b>
1060 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
1066 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1075 <div class="short">Trims any whitespace from either side of a string</div>
1081 Trims any whitespace from either side of a string
1088 <dl class="detailList">
1089 <dt class="heading">Parameters:</dt>
1092 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
1095 <dd>The text to trim</dd>
1103 <dl class="detailList">
1104 <dt class="heading">Returns:</dt>
1106 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The trimmed text</dd>
1120 <td class="msource">
1128 <tr class="method-row config-row-alt0 expandable notInherited">
1129 <td class="micon"><a class="exi" href="#expand"> </a></td>
1133 <a id="Roo.util.Format-method-undef" name=".undef"></a>
1134 <div class="fixedFont">
1135 <span class="attributes">Roo.util.Format.</span><b class="itemname">undef</b>
1137 (Mixed <B><i>value</i></B>)
1152 <div class="short">Checks a reference and converts it to empty string if it is undefined</div>
1158 Checks a reference and converts it to empty string if it is undefined
1165 <dl class="detailList">
1166 <dt class="heading">Parameters:</dt>
1169 <span class="fixedFont">Mixed</span> <b>value</b>
1172 <dd>Reference to check</dd>
1180 <dl class="detailList">
1181 <dt class="heading">Returns:</dt>
1183 <dd><span class="fixedFont">Mixed</span> Empty string if converted, otherwise the original value</dd>
1197 <td class="msource">
1205 <tr class="method-row config-row-alt1 expandable notInherited">
1206 <td class="micon"><a class="exi" href="#expand"> </a></td>
1210 <a id="Roo.util.Format-method-uppercase" name=".uppercase"></a>
1211 <div class="fixedFont">
1212 <span class="attributes">Roo.util.Format.</span><b class="itemname">uppercase</b>
1214 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
1220 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1229 <div class="short">Converts a string to all upper case letters</div>
1235 Converts a string to all upper case letters
1242 <dl class="detailList">
1243 <dt class="heading">Parameters:</dt>
1246 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
1249 <dd>The text to convert</dd>
1257 <dl class="detailList">
1258 <dt class="heading">Returns:</dt>
1260 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The converted text</dd>
1274 <td class="msource">
1282 <tr class="method-row config-row-alt0 expandable notInherited">
1283 <td class="micon"><a class="exi" href="#expand"> </a></td>
1287 <a id="Roo.util.Format-method-usMoney" name=".usMoney"></a>
1288 <div class="fixedFont">
1289 <span class="attributes">Roo.util.Format.</span><b class="itemname">usMoney</b>
1291 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>)
1297 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1306 <div class="short">Format a number as US currency</div>
1312 Format a number as US currency
1319 <dl class="detailList">
1320 <dt class="heading">Parameters:</dt>
1323 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span> <b>value</b>
1326 <dd>The numeric value to format</dd>
1334 <dl class="detailList">
1335 <dt class="heading">Returns:</dt>
1337 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted currency string</dd>
1351 <td class="msource">
1362 <!-- ============================== events summary / details ======================== -->
1365 <a id="Roo.util.Format-events"></a>
1371 <table cellspacing="0" class="member-table">
1372 <caption class="Empty">Events - Has None</caption>
1383 <!-- ============================== footer ================================= -->
1384 <div class="fineprint" style="clear:both">
1386 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)
1388 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>