commit extjs-2.2.1
[extjs.git] / docs / output / Ext.util.Format.html
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>
7         </div>
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>
14                     </table>
15         <div class="description">
16             *
17 Reusable data formatting functions<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
18         
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">
25             <tr>
26                 <th class="sig-header" colspan="2">Method</th>
27                 <th class="msource-header">Defined By</th>
28             </tr>
29                 <tr class="method-row expandable">\r
30         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
31         <td class="sig">\r
32         <a id="Ext.util.Format-capitalize"></a>\r
33             <b>capitalize</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">\r
34                         <div class="short">Converts the first character only of a string to upper case</div>\r
35             <div class="long">\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
40         <ul>\r
41             <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
42         </ul>\r
43     </div>\r
44                 </div>\r
45                         </div>\r
46         </td>\r
47         <td class="msource">Format</td>\r
48     </tr>\r
49         <tr class="method-row alt expandable">\r
50         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
51         <td class="sig">\r
52         <a id="Ext.util.Format-date"></a>\r
53             <b>date</b>(&nbsp;<code>String/Date value</code>, <span class="optional" title="Optional">[<code>String format</code>]</span>&nbsp;) : String            <div class="mdesc">\r
54                         <div class="short">Parse a value into a formatted date using the specified format pattern.</div>\r
55             <div class="long">\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
60         <ul>\r
61             <li><code>String</code><div class="sub-desc">The formatted date string</div></li>\r
62         </ul>\r
63     </div>\r
64                 </div>\r
65                         </div>\r
66         </td>\r
67         <td class="msource">Format</td>\r
68     </tr>\r
69         <tr class="method-row expandable">\r
70         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
71         <td class="sig">\r
72         <a id="Ext.util.Format-dateRenderer"></a>\r
73             <b>dateRenderer</b>(&nbsp;<code>String format</code>&nbsp;) : 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
75             <div class="long">\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
80         <ul>\r
81             <li><code>Function</code><div class="sub-desc">The date formatting function</div></li>\r
82         </ul>\r
83     </div>\r
84                 </div>\r
85                         </div>\r
86         </td>\r
87         <td class="msource">Format</td>\r
88     </tr>\r
89         <tr class="method-row alt expandable">\r
90         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
91         <td class="sig">\r
92         <a id="Ext.util.Format-defaultValue"></a>\r
93             <b>defaultValue</b>(&nbsp;<code>Mixed value</code>, <code>String defaultValue</code>&nbsp;) : 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
95             <div class="long">\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
100         <ul>\r
101             <li><code>String</code></li>\r
102         </ul>\r
103     </div>\r
104                 </div>\r
105                         </div>\r
106         </td>\r
107         <td class="msource">Format</td>\r
108     </tr>\r
109         <tr class="method-row expandable">\r
110         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
111         <td class="sig">\r
112         <a id="Ext.util.Format-ellipsis"></a>\r
113             <b>ellipsis</b>(&nbsp;<code>String value</code>, <code>Number length</code>&nbsp;) : 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
115             <div class="long">\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
120         <ul>\r
121             <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
122         </ul>\r
123     </div>\r
124                 </div>\r
125                         </div>\r
126         </td>\r
127         <td class="msource">Format</td>\r
128     </tr>\r
129         <tr class="method-row alt expandable">\r
130         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
131         <td class="sig">\r
132         <a id="Ext.util.Format-fileSize"></a>\r
133             <b>fileSize</b>(&nbsp;<code>Number/String size</code>&nbsp;) : String            <div class="mdesc">\r
134                         <div class="short">Simple format for a file size (xxx bytes, xxx KB, xxx MB)</div>\r
135             <div class="long">\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
140         <ul>\r
141             <li><code>String</code><div class="sub-desc">The formatted file size</div></li>\r
142         </ul>\r
143     </div>\r
144                 </div>\r
145                         </div>\r
146         </td>\r
147         <td class="msource">Format</td>\r
148     </tr>\r
149         <tr class="method-row expandable">\r
150         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
151         <td class="sig">\r
152         <a id="Ext.util.Format-htmlDecode"></a>\r
153             <b>htmlDecode</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">\r
154                         <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>\r
155             <div class="long">\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
160         <ul>\r
161             <li><code>String</code><div class="sub-desc">The decoded text</div></li>\r
162         </ul>\r
163     </div>\r
164                 </div>\r
165                         </div>\r
166         </td>\r
167         <td class="msource">Format</td>\r
168     </tr>\r
169         <tr class="method-row alt expandable">\r
170         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
171         <td class="sig">\r
172         <a id="Ext.util.Format-htmlEncode"></a>\r
173             <b>htmlEncode</b>(&nbsp;<code>String value</code>&nbsp;) : 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
175             <div class="long">\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
180         <ul>\r
181             <li><code>String</code><div class="sub-desc">The encoded text</div></li>\r
182         </ul>\r
183     </div>\r
184                 </div>\r
185                         </div>\r
186         </td>\r
187         <td class="msource">Format</td>\r
188     </tr>\r
189         <tr class="method-row expandable">\r
190         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
191         <td class="sig">\r
192         <a id="Ext.util.Format-lowercase"></a>\r
193             <b>lowercase</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">\r
194                         <div class="short">Converts a string to all lower case letters</div>\r
195             <div class="long">\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
200         <ul>\r
201             <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
202         </ul>\r
203     </div>\r
204                 </div>\r
205                         </div>\r
206         </td>\r
207         <td class="msource">Format</td>\r
208     </tr>\r
209         <tr class="method-row alt expandable">\r
210         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
211         <td class="sig">\r
212         <a id="Ext.util.Format-nl2br"></a>\r
213             <b>nl2br</b>(&nbsp;<code>String The</code>&nbsp;) : String            <div class="mdesc">\r
214                         <div class="short">Converts newline characters to the HTML tag &lt;br/></div>\r
215             <div class="long">\r
216                 Converts newline characters to the HTML tag &lt;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
220         <ul>\r
221             <li><code>String</code><div class="sub-desc">The string with embedded &lt;br/> tags in place of newlines.</div></li>\r
222         </ul>\r
223     </div>\r
224                 </div>\r
225                         </div>\r
226         </td>\r
227         <td class="msource">Format</td>\r
228     </tr>\r
229         <tr class="method-row expandable">\r
230         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
231         <td class="sig">\r
232         <a id="Ext.util.Format-stripScripts"></a>\r
233             <b>stripScripts</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">\r
234                         <div class="short">Strips all script tags</div>\r
235             <div class="long">\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
240         <ul>\r
241             <li><code>String</code><div class="sub-desc">The stripped text</div></li>\r
242         </ul>\r
243     </div>\r
244                 </div>\r
245                         </div>\r
246         </td>\r
247         <td class="msource">Format</td>\r
248     </tr>\r
249         <tr class="method-row alt expandable">\r
250         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
251         <td class="sig">\r
252         <a id="Ext.util.Format-stripTags"></a>\r
253             <b>stripTags</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">\r
254                         <div class="short">Strips all HTML tags</div>\r
255             <div class="long">\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
260         <ul>\r
261             <li><code>String</code><div class="sub-desc">The stripped text</div></li>\r
262         </ul>\r
263     </div>\r
264                 </div>\r
265                         </div>\r
266         </td>\r
267         <td class="msource">Format</td>\r
268     </tr>\r
269         <tr class="method-row expandable">\r
270         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
271         <td class="sig">\r
272         <a id="Ext.util.Format-substr"></a>\r
273             <b>substr</b>(&nbsp;<code>String value</code>, <code>Number start</code>, <code>Number length</code>&nbsp;) : String            <div class="mdesc">\r
274                         <div class="short">Returns a substring from within an original string</div>\r
275             <div class="long">\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
280         <ul>\r
281             <li><code>String</code><div class="sub-desc">The substring</div></li>\r
282         </ul>\r
283     </div>\r
284                 </div>\r
285                         </div>\r
286         </td>\r
287         <td class="msource">Format</td>\r
288     </tr>\r
289         <tr class="method-row alt expandable">\r
290         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
291         <td class="sig">\r
292         <a id="Ext.util.Format-trim"></a>\r
293             <b>trim</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">\r
294                         <div class="short">Trims any whitespace from either side of a string</div>\r
295             <div class="long">\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
300         <ul>\r
301             <li><code>String</code><div class="sub-desc">The trimmed text</div></li>\r
302         </ul>\r
303     </div>\r
304                 </div>\r
305                         </div>\r
306         </td>\r
307         <td class="msource">Format</td>\r
308     </tr>\r
309         <tr class="method-row expandable">\r
310         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
311         <td class="sig">\r
312         <a id="Ext.util.Format-undef"></a>\r
313             <b>undef</b>(&nbsp;<code>Mixed value</code>&nbsp;) : Mixed            <div class="mdesc">\r
314                         <div class="short">Checks a reference and converts it to empty string if it is undefined</div>\r
315             <div class="long">\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
320         <ul>\r
321             <li><code>Mixed</code><div class="sub-desc">Empty string if converted, otherwise the original value</div></li>\r
322         </ul>\r
323     </div>\r
324                 </div>\r
325                         </div>\r
326         </td>\r
327         <td class="msource">Format</td>\r
328     </tr>\r
329         <tr class="method-row alt expandable">\r
330         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
331         <td class="sig">\r
332         <a id="Ext.util.Format-uppercase"></a>\r
333             <b>uppercase</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">\r
334                         <div class="short">Converts a string to all upper case letters</div>\r
335             <div class="long">\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
340         <ul>\r
341             <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
342         </ul>\r
343     </div>\r
344                 </div>\r
345                         </div>\r
346         </td>\r
347         <td class="msource">Format</td>\r
348     </tr>\r
349         <tr class="method-row expandable">\r
350         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
351         <td class="sig">\r
352         <a id="Ext.util.Format-usMoney"></a>\r
353             <b>usMoney</b>(&nbsp;<code>Number/String value</code>&nbsp;) : String            <div class="mdesc">\r
354                         <div class="short">Format a number as US currency</div>\r
355             <div class="long">\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
360         <ul>\r
361             <li><code>String</code><div class="sub-desc">The formatted currency string</div></li>\r
362         </ul>\r
363     </div>\r
364                 </div>\r
365                         </div>\r
366         </td>\r
367         <td class="msource">Format</td>\r
368     </tr>\r
369             </table>
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>
373         </div>