1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.util.Format-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.util.Format-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.util.Format-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="bookmark" href="../docs/?class=Ext.util.Format"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8 <h1>Class Ext.util.Format</h1>
9 <table cellspacing="0">
10 <tr><td class="label">Package:</td><td class="hd-info">Ext.util</td></tr>
11 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Format.js" target="_blank">Format.js</a></td></tr>
12 <tr><td class="label">Class:</td><td class="hd-info">Format</td></tr>
13 <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
15 <div class="description">
17 Reusable data formatting functions<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
19 <div class="hr"></div>
20 <a id="Ext.util.Format-props"></a>
21 <h2>Public Properties</h2>
22 <div class="no-members">This class has no public properties.</div> <a id="Ext.util.Format-methods"></a>
23 <h2>Public Methods</h2>
24 <table cellspacing="0" class="member-table">
26 <th class="sig-header" colspan="2">Method</th>
27 <th class="msource-header">Defined By</th>
29 <tr class="method-row expandable">
\r
30 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
32 <a id="Ext.util.Format-capitalize"></a>
\r
33 <b>capitalize</b>( <code>String value</code> ) : String <div class="mdesc">
\r
34 <div class="short">Converts the first character only of a string to upper case</div>
\r
36 Converts the first character only of a string to upper case <div class="mdetail-params">
\r
37 <strong>Parameters:</strong>
\r
38 <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
\r
39 <strong>Returns:</strong>
\r
41 <li><code>String</code><div class="sub-desc">The converted text</div></li>
\r
47 <td class="msource">Format</td>
\r
49 <tr class="method-row alt expandable">
\r
50 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
52 <a id="Ext.util.Format-date"></a>
\r
53 <b>date</b>( <code>String/Date value</code>, <span class="optional" title="Optional">[<code>String format</code>]</span> ) : String <div class="mdesc">
\r
54 <div class="short">Parse a value into a formatted date using the specified format pattern.</div>
\r
56 Parse a value into a formatted date using the specified format pattern. <div class="mdetail-params">
\r
57 <strong>Parameters:</strong>
\r
58 <ul><li><code>value</code> : String/Date<div class="sub-desc">The value to format (Strings must conform to the format expected by the javascript Date object's <a href="http://www.w3schools.com/jsref/jsref_parse.asp">parse()</a> method)</div></li><li><code>format</code> : String<div class="sub-desc">(optional) Any valid date format string (defaults to 'm/d/Y')</div></li> </ul>
\r
59 <strong>Returns:</strong>
\r
61 <li><code>String</code><div class="sub-desc">The formatted date string</div></li>
\r
67 <td class="msource">Format</td>
\r
69 <tr class="method-row expandable">
\r
70 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
72 <a id="Ext.util.Format-dateRenderer"></a>
\r
73 <b>dateRenderer</b>( <code>String format</code> ) : Function <div class="mdesc">
\r
74 <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>
\r
76 Returns a date rendering function that can be reused to apply a date format multiple times efficiently <div class="mdetail-params">
\r
77 <strong>Parameters:</strong>
\r
78 <ul><li><code>format</code> : String<div class="sub-desc">Any valid date format string</div></li> </ul>
\r
79 <strong>Returns:</strong>
\r
81 <li><code>Function</code><div class="sub-desc">The date formatting function</div></li>
\r
87 <td class="msource">Format</td>
\r
89 <tr class="method-row alt expandable">
\r
90 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
92 <a id="Ext.util.Format-defaultValue"></a>
\r
93 <b>defaultValue</b>( <code>Mixed value</code>, <code>String defaultValue</code> ) : String <div class="mdesc">
\r
94 <div class="short">Checks a reference and converts it to the default value if it's empty</div>
\r
96 Checks a reference and converts it to the default value if it's empty <div class="mdetail-params">
\r
97 <strong>Parameters:</strong>
\r
98 <ul><li><code>value</code> : Mixed<div class="sub-desc">Reference to check</div></li><li><code>defaultValue</code> : String<div class="sub-desc">The value to insert of it's undefined (defaults to "")</div></li> </ul>
\r
99 <strong>Returns:</strong>
\r
101 <li><code>String</code></li>
\r
107 <td class="msource">Format</td>
\r
109 <tr class="method-row expandable">
\r
110 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
112 <a id="Ext.util.Format-ellipsis"></a>
\r
113 <b>ellipsis</b>( <code>String value</code>, <code>Number length</code> ) : String <div class="mdesc">
\r
114 <div class="short">Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length</div>
\r
116 Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length <div class="mdetail-params">
\r
117 <strong>Parameters:</strong>
\r
118 <ul><li><code>value</code> : String<div class="sub-desc">The string to truncate</div></li><li><code>length</code> : Number<div class="sub-desc">The maximum length to allow before truncating</div></li> </ul>
\r
119 <strong>Returns:</strong>
\r
121 <li><code>String</code><div class="sub-desc">The converted text</div></li>
\r
127 <td class="msource">Format</td>
\r
129 <tr class="method-row alt expandable">
\r
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
132 <a id="Ext.util.Format-fileSize"></a>
\r
133 <b>fileSize</b>( <code>Number/String size</code> ) : String <div class="mdesc">
\r
134 <div class="short">Simple format for a file size (xxx bytes, xxx KB, xxx MB)</div>
\r
136 Simple format for a file size (xxx bytes, xxx KB, xxx MB) <div class="mdetail-params">
\r
137 <strong>Parameters:</strong>
\r
138 <ul><li><code>size</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>
\r
139 <strong>Returns:</strong>
\r
141 <li><code>String</code><div class="sub-desc">The formatted file size</div></li>
\r
147 <td class="msource">Format</td>
\r
149 <tr class="method-row expandable">
\r
150 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
152 <a id="Ext.util.Format-htmlDecode"></a>
\r
153 <b>htmlDecode</b>( <code>String value</code> ) : String <div class="mdesc">
\r
154 <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>
\r
156 Convert certain characters (&, <, >, and ') from their HTML character equivalents. <div class="mdetail-params">
\r
157 <strong>Parameters:</strong>
\r
158 <ul><li><code>value</code> : String<div class="sub-desc">The string to decode</div></li> </ul>
\r
159 <strong>Returns:</strong>
\r
161 <li><code>String</code><div class="sub-desc">The decoded text</div></li>
\r
167 <td class="msource">Format</td>
\r
169 <tr class="method-row alt expandable">
\r
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
172 <a id="Ext.util.Format-htmlEncode"></a>
\r
173 <b>htmlEncode</b>( <code>String value</code> ) : String <div class="mdesc">
\r
174 <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>
\r
176 Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. <div class="mdetail-params">
\r
177 <strong>Parameters:</strong>
\r
178 <ul><li><code>value</code> : String<div class="sub-desc">The string to encode</div></li> </ul>
\r
179 <strong>Returns:</strong>
\r
181 <li><code>String</code><div class="sub-desc">The encoded text</div></li>
\r
187 <td class="msource">Format</td>
\r
189 <tr class="method-row expandable">
\r
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
192 <a id="Ext.util.Format-lowercase"></a>
\r
193 <b>lowercase</b>( <code>String value</code> ) : String <div class="mdesc">
\r
194 <div class="short">Converts a string to all lower case letters</div>
\r
196 Converts a string to all lower case letters <div class="mdetail-params">
\r
197 <strong>Parameters:</strong>
\r
198 <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
\r
199 <strong>Returns:</strong>
\r
201 <li><code>String</code><div class="sub-desc">The converted text</div></li>
\r
207 <td class="msource">Format</td>
\r
209 <tr class="method-row alt expandable">
\r
210 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
212 <a id="Ext.util.Format-nl2br"></a>
\r
213 <b>nl2br</b>( <code>String The</code> ) : String <div class="mdesc">
\r
214 <div class="short">Converts newline characters to the HTML tag <br/></div>
\r
216 Converts newline characters to the HTML tag <br/> <div class="mdetail-params">
\r
217 <strong>Parameters:</strong>
\r
218 <ul><li><code>The</code> : String<div class="sub-desc">string value to format.</div></li> </ul>
\r
219 <strong>Returns:</strong>
\r
221 <li><code>String</code><div class="sub-desc">The string with embedded <br/> tags in place of newlines.</div></li>
\r
227 <td class="msource">Format</td>
\r
229 <tr class="method-row expandable">
\r
230 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
232 <a id="Ext.util.Format-stripScripts"></a>
\r
233 <b>stripScripts</b>( <code>Mixed value</code> ) : String <div class="mdesc">
\r
234 <div class="short">Strips all script tags</div>
\r
236 Strips all script tags <div class="mdetail-params">
\r
237 <strong>Parameters:</strong>
\r
238 <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip script tags</div></li> </ul>
\r
239 <strong>Returns:</strong>
\r
241 <li><code>String</code><div class="sub-desc">The stripped text</div></li>
\r
247 <td class="msource">Format</td>
\r
249 <tr class="method-row alt expandable">
\r
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
252 <a id="Ext.util.Format-stripTags"></a>
\r
253 <b>stripTags</b>( <code>Mixed value</code> ) : String <div class="mdesc">
\r
254 <div class="short">Strips all HTML tags</div>
\r
256 Strips all HTML tags <div class="mdetail-params">
\r
257 <strong>Parameters:</strong>
\r
258 <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip tags</div></li> </ul>
\r
259 <strong>Returns:</strong>
\r
261 <li><code>String</code><div class="sub-desc">The stripped text</div></li>
\r
267 <td class="msource">Format</td>
\r
269 <tr class="method-row expandable">
\r
270 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
272 <a id="Ext.util.Format-substr"></a>
\r
273 <b>substr</b>( <code>String value</code>, <code>Number start</code>, <code>Number length</code> ) : String <div class="mdesc">
\r
274 <div class="short">Returns a substring from within an original string</div>
\r
276 Returns a substring from within an original string <div class="mdetail-params">
\r
277 <strong>Parameters:</strong>
\r
278 <ul><li><code>value</code> : String<div class="sub-desc">The original text</div></li><li><code>start</code> : Number<div class="sub-desc">The start index of the substring</div></li><li><code>length</code> : Number<div class="sub-desc">The length of the substring</div></li> </ul>
\r
279 <strong>Returns:</strong>
\r
281 <li><code>String</code><div class="sub-desc">The substring</div></li>
\r
287 <td class="msource">Format</td>
\r
289 <tr class="method-row alt expandable">
\r
290 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
292 <a id="Ext.util.Format-trim"></a>
\r
293 <b>trim</b>( <code>String value</code> ) : String <div class="mdesc">
\r
294 <div class="short">Trims any whitespace from either side of a string</div>
\r
296 Trims any whitespace from either side of a string <div class="mdetail-params">
\r
297 <strong>Parameters:</strong>
\r
298 <ul><li><code>value</code> : String<div class="sub-desc">The text to trim</div></li> </ul>
\r
299 <strong>Returns:</strong>
\r
301 <li><code>String</code><div class="sub-desc">The trimmed text</div></li>
\r
307 <td class="msource">Format</td>
\r
309 <tr class="method-row expandable">
\r
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
312 <a id="Ext.util.Format-undef"></a>
\r
313 <b>undef</b>( <code>Mixed value</code> ) : Mixed <div class="mdesc">
\r
314 <div class="short">Checks a reference and converts it to empty string if it is undefined</div>
\r
316 Checks a reference and converts it to empty string if it is undefined <div class="mdetail-params">
\r
317 <strong>Parameters:</strong>
\r
318 <ul><li><code>value</code> : Mixed<div class="sub-desc">Reference to check</div></li> </ul>
\r
319 <strong>Returns:</strong>
\r
321 <li><code>Mixed</code><div class="sub-desc">Empty string if converted, otherwise the original value</div></li>
\r
327 <td class="msource">Format</td>
\r
329 <tr class="method-row alt expandable">
\r
330 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
332 <a id="Ext.util.Format-uppercase"></a>
\r
333 <b>uppercase</b>( <code>String value</code> ) : String <div class="mdesc">
\r
334 <div class="short">Converts a string to all upper case letters</div>
\r
336 Converts a string to all upper case letters <div class="mdetail-params">
\r
337 <strong>Parameters:</strong>
\r
338 <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
\r
339 <strong>Returns:</strong>
\r
341 <li><code>String</code><div class="sub-desc">The converted text</div></li>
\r
347 <td class="msource">Format</td>
\r
349 <tr class="method-row expandable">
\r
350 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
352 <a id="Ext.util.Format-usMoney"></a>
\r
353 <b>usMoney</b>( <code>Number/String value</code> ) : String <div class="mdesc">
\r
354 <div class="short">Format a number as US currency</div>
\r
356 Format a number as US currency <div class="mdetail-params">
\r
357 <strong>Parameters:</strong>
\r
358 <ul><li><code>value</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>
\r
359 <strong>Returns:</strong>
\r
361 <li><code>String</code><div class="sub-desc">The formatted currency string</div></li>
\r
367 <td class="msource">Format</td>
\r
370 <a id="Ext.util.Format-events"></a>
371 <h2>Public Events</h2>
372 <div class="no-members">This class has no public events.</div>