Ext.util.Format.html
18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.util.Format-props"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.util.Format-methods"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.util.Format-events"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-event">Events</a>
<a class="bookmark" href="../docs/?class=Ext.util.Format"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-fav">Direct Link</a>
</div>
<h1>Class Ext.util.Format</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td class="hd-info">Ext.util</td></tr>
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/util/Format_wev8.js" target="_blank">Format_wev8.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">Format</td></tr>
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
</table>
<div class="description">
Reusable data formatting functions<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
<div class="hr"></div>
<a id="Ext.util.Format-props"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a id="Ext.util.Format-methods"></a>
<h2>Public Methods</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Method</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-capitalize"></a>
<b>capitalize</b>( <code>String value</code> ) : String <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The converted text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-date"></a>
<b>date</b>( <code>Mixed value</code>, <span class="optional" title="Optional">[<code>String format</code>]</span> ) : String <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. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : Mixed<div class="sub-desc">The value to format</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>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The formatted date string</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-dateRenderer"></a>
<b>dateRenderer</b>( <code>String format</code> ) : Function <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>format</code> : String<div class="sub-desc">Any valid date format string</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Function</code><div class="sub-desc">The date formatting function</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-defaultValue"></a>
<b>defaultValue</b>( <code>Mixed value</code>, <code>String defaultValue</code> ) : String <div class="mdesc">
<div class="short">Checks a reference and converts it to the default value if it's empty</div>
<div class="long">
Checks a reference and converts it to the default value if it's empty <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<strong>Returns:</strong>
<ul>
<li><code>String</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-ellipsis"></a>
<b>ellipsis</b>( <code>String value</code>, <code>Number length</code> ) : String <div class="mdesc">
<div class="short">Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length</div>
<div class="long">
Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The converted text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-fileSize"></a>
<b>fileSize</b>( <code>Number/String size</code> ) : String <div class="mdesc">
<div class="short">Simple format for a file size (xxx bytes, xxx KB, xxx MB)</div>
<div class="long">
Simple format for a file size (xxx bytes, xxx KB, xxx MB) <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>size</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The formatted file size</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-htmlDecode"></a>
<b>htmlDecode</b>( <code>String value</code> ) : String <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. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The string to decode</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The decoded text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-htmlEncode"></a>
<b>htmlEncode</b>( <code>String value</code> ) : String <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. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The string to encode</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The encoded text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-lowercase"></a>
<b>lowercase</b>( <code>String value</code> ) : String <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The converted text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-stripScripts"></a>
<b>stripScripts</b>( <code>Mixed value</code> ) : String <div class="mdesc">
<div class="short">Strips all script tags</div>
<div class="long">
Strips all script tags <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip script tags</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The stripped text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-stripTags"></a>
<b>stripTags</b>( <code>Mixed value</code> ) : String <div class="mdesc">
<div class="short">Strips all HTML tags</div>
<div class="long">
Strips all HTML tags <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip tags</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The stripped text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-substr"></a>
<b>substr</b>( <code>String value</code>, <code>Number start</code>, <code>Number length</code> ) : String <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The substring</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-trim"></a>
<b>trim</b>( <code>String value</code> ) : String <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The text to trim</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The trimmed text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-undef"></a>
<b>undef</b>( <code>Mixed value</code> ) : Mixed <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : Mixed<div class="sub-desc">Reference to check</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Mixed</code><div class="sub-desc">Empty string if converted, otherwise the original value</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-uppercase"></a>
<b>uppercase</b>( <code>String value</code> ) : String <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 <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The converted text</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.util.Format-usMoney"></a>
<b>usMoney</b>( <code>Number/String value</code> ) : String <div class="mdesc">
<div class="short">Format a number as US currency</div>
<div class="long">
Format a number as US currency <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>value</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>String</code><div class="sub-desc">The formatted currency string</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">Format</td>
</tr>
</table>
<a id="Ext.util.Format-events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
</div>