source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.util.Format.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 19.5 KB
Line 
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            *
17Reusable 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">
30        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
31        <td class="sig">
32        <a id="Ext.util.Format-capitalize"></a>
33            <b>capitalize</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
34                        <div class="short">Converts the first character only of a string to upper case</div>
35            <div class="long">
36                Converts the first character only of a string to upper case    <div class="mdetail-params">
37        <strong>Parameters:</strong>
38        <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li>        </ul>
39        <strong>Returns:</strong>
40        <ul>
41            <li><code>String</code><div class="sub-desc">The converted text</div></li>
42        </ul>
43    </div>
44                </div>
45                        </div>
46        </td>
47        <td class="msource">Format</td>
48    </tr>
49        <tr class="method-row alt expandable">
50        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
51        <td class="sig">
52        <a id="Ext.util.Format-date"></a>
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">
54                        <div class="short">Parse a value into a formatted date using the specified format pattern.</div>
55            <div class="long">
56                Parse a value into a formatted date using the specified format pattern.    <div class="mdetail-params">
57        <strong>Parameters:</strong>
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>
59        <strong>Returns:</strong>
60        <ul>
61            <li><code>String</code><div class="sub-desc">The formatted date string</div></li>
62        </ul>
63    </div>
64                </div>
65                        </div>
66        </td>
67        <td class="msource">Format</td>
68    </tr>
69        <tr class="method-row expandable">
70        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
71        <td class="sig">
72        <a id="Ext.util.Format-dateRenderer"></a>
73            <b>dateRenderer</b>(&nbsp;<code>String format</code>&nbsp;) : Function            <div class="mdesc">
74                        <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>
75            <div class="long">
76                Returns a date rendering function that can be reused to apply a date format multiple times efficiently    <div class="mdetail-params">
77        <strong>Parameters:</strong>
78        <ul><li><code>format</code> : String<div class="sub-desc">Any valid date format string</div></li>        </ul>
79        <strong>Returns:</strong>
80        <ul>
81            <li><code>Function</code><div class="sub-desc">The date formatting function</div></li>
82        </ul>
83    </div>
84                </div>
85                        </div>
86        </td>
87        <td class="msource">Format</td>
88    </tr>
89        <tr class="method-row alt expandable">
90        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
91        <td class="sig">
92        <a id="Ext.util.Format-defaultValue"></a>
93            <b>defaultValue</b>(&nbsp;<code>Mixed value</code>, <code>String defaultValue</code>&nbsp;) : String            <div class="mdesc">
94                        <div class="short">Checks a reference and converts it to the default value if it's empty</div>
95            <div class="long">
96                Checks a reference and converts it to the default value if it's empty    <div class="mdetail-params">
97        <strong>Parameters:</strong>
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>
99        <strong>Returns:</strong>
100        <ul>
101            <li><code>String</code></li>
102        </ul>
103    </div>
104                </div>
105                        </div>
106        </td>
107        <td class="msource">Format</td>
108    </tr>
109        <tr class="method-row expandable">
110        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
111        <td class="sig">
112        <a id="Ext.util.Format-ellipsis"></a>
113            <b>ellipsis</b>(&nbsp;<code>String value</code>, <code>Number length</code>&nbsp;) : String            <div class="mdesc">
114                        <div class="short">Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length</div>
115            <div class="long">
116                Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length    <div class="mdetail-params">
117        <strong>Parameters:</strong>
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>
119        <strong>Returns:</strong>
120        <ul>
121            <li><code>String</code><div class="sub-desc">The converted text</div></li>
122        </ul>
123    </div>
124                </div>
125                        </div>
126        </td>
127        <td class="msource">Format</td>
128    </tr>
129        <tr class="method-row alt expandable">
130        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
131        <td class="sig">
132        <a id="Ext.util.Format-fileSize"></a>
133            <b>fileSize</b>(&nbsp;<code>Number/String size</code>&nbsp;) : String            <div class="mdesc">
134                        <div class="short">Simple format for a file size (xxx bytes, xxx KB, xxx MB)</div>
135            <div class="long">
136                Simple format for a file size (xxx bytes, xxx KB, xxx MB)    <div class="mdetail-params">
137        <strong>Parameters:</strong>
138        <ul><li><code>size</code> : Number/String<div class="sub-desc">The numeric value to format</div></li>        </ul>
139        <strong>Returns:</strong>
140        <ul>
141            <li><code>String</code><div class="sub-desc">The formatted file size</div></li>
142        </ul>
143    </div>
144                </div>
145                        </div>
146        </td>
147        <td class="msource">Format</td>
148    </tr>
149        <tr class="method-row expandable">
150        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
151        <td class="sig">
152        <a id="Ext.util.Format-htmlDecode"></a>
153            <b>htmlDecode</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
154                        <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>
155            <div class="long">
156                Convert certain characters (&, <, >, and ') from their HTML character equivalents.    <div class="mdetail-params">
157        <strong>Parameters:</strong>
158        <ul><li><code>value</code> : String<div class="sub-desc">The string to decode</div></li>        </ul>
159        <strong>Returns:</strong>
160        <ul>
161            <li><code>String</code><div class="sub-desc">The decoded text</div></li>
162        </ul>
163    </div>
164                </div>
165                        </div>
166        </td>
167        <td class="msource">Format</td>
168    </tr>
169        <tr class="method-row alt expandable">
170        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
171        <td class="sig">
172        <a id="Ext.util.Format-htmlEncode"></a>
173            <b>htmlEncode</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
174                        <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>
175            <div class="long">
176                Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.    <div class="mdetail-params">
177        <strong>Parameters:</strong>
178        <ul><li><code>value</code> : String<div class="sub-desc">The string to encode</div></li>        </ul>
179        <strong>Returns:</strong>
180        <ul>
181            <li><code>String</code><div class="sub-desc">The encoded text</div></li>
182        </ul>
183    </div>
184                </div>
185                        </div>
186        </td>
187        <td class="msource">Format</td>
188    </tr>
189        <tr class="method-row expandable">
190        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
191        <td class="sig">
192        <a id="Ext.util.Format-lowercase"></a>
193            <b>lowercase</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
194                        <div class="short">Converts a string to all lower case letters</div>
195            <div class="long">
196                Converts a string to all lower case letters    <div class="mdetail-params">
197        <strong>Parameters:</strong>
198        <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li>        </ul>
199        <strong>Returns:</strong>
200        <ul>
201            <li><code>String</code><div class="sub-desc">The converted text</div></li>
202        </ul>
203    </div>
204                </div>
205                        </div>
206        </td>
207        <td class="msource">Format</td>
208    </tr>
209        <tr class="method-row alt expandable">
210        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
211        <td class="sig">
212        <a id="Ext.util.Format-nl2br"></a>
213            <b>nl2br</b>(&nbsp;<code>String The</code>&nbsp;) : String            <div class="mdesc">
214                        <div class="short">Converts newline characters to the HTML tag &lt;br/></div>
215            <div class="long">
216                Converts newline characters to the HTML tag &lt;br/>    <div class="mdetail-params">
217        <strong>Parameters:</strong>
218        <ul><li><code>The</code> : String<div class="sub-desc">string value to format.</div></li>        </ul>
219        <strong>Returns:</strong>
220        <ul>
221            <li><code>String</code><div class="sub-desc">The string with embedded &lt;br/> tags in place of newlines.</div></li>
222        </ul>
223    </div>
224                </div>
225                        </div>
226        </td>
227        <td class="msource">Format</td>
228    </tr>
229        <tr class="method-row expandable">
230        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
231        <td class="sig">
232        <a id="Ext.util.Format-stripScripts"></a>
233            <b>stripScripts</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">
234                        <div class="short">Strips all script tags</div>
235            <div class="long">
236                Strips all script tags    <div class="mdetail-params">
237        <strong>Parameters:</strong>
238        <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip script tags</div></li>        </ul>
239        <strong>Returns:</strong>
240        <ul>
241            <li><code>String</code><div class="sub-desc">The stripped text</div></li>
242        </ul>
243    </div>
244                </div>
245                        </div>
246        </td>
247        <td class="msource">Format</td>
248    </tr>
249        <tr class="method-row alt expandable">
250        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
251        <td class="sig">
252        <a id="Ext.util.Format-stripTags"></a>
253            <b>stripTags</b>(&nbsp;<code>Mixed value</code>&nbsp;) : String            <div class="mdesc">
254                        <div class="short">Strips all HTML tags</div>
255            <div class="long">
256                Strips all HTML tags    <div class="mdetail-params">
257        <strong>Parameters:</strong>
258        <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip tags</div></li>        </ul>
259        <strong>Returns:</strong>
260        <ul>
261            <li><code>String</code><div class="sub-desc">The stripped text</div></li>
262        </ul>
263    </div>
264                </div>
265                        </div>
266        </td>
267        <td class="msource">Format</td>
268    </tr>
269        <tr class="method-row expandable">
270        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
271        <td class="sig">
272        <a id="Ext.util.Format-substr"></a>
273            <b>substr</b>(&nbsp;<code>String value</code>, <code>Number start</code>, <code>Number length</code>&nbsp;) : String            <div class="mdesc">
274                        <div class="short">Returns a substring from within an original string</div>
275            <div class="long">
276                Returns a substring from within an original string    <div class="mdetail-params">
277        <strong>Parameters:</strong>
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>
279        <strong>Returns:</strong>
280        <ul>
281            <li><code>String</code><div class="sub-desc">The substring</div></li>
282        </ul>
283    </div>
284                </div>
285                        </div>
286        </td>
287        <td class="msource">Format</td>
288    </tr>
289        <tr class="method-row alt expandable">
290        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
291        <td class="sig">
292        <a id="Ext.util.Format-trim"></a>
293            <b>trim</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
294                        <div class="short">Trims any whitespace from either side of a string</div>
295            <div class="long">
296                Trims any whitespace from either side of a string    <div class="mdetail-params">
297        <strong>Parameters:</strong>
298        <ul><li><code>value</code> : String<div class="sub-desc">The text to trim</div></li>        </ul>
299        <strong>Returns:</strong>
300        <ul>
301            <li><code>String</code><div class="sub-desc">The trimmed text</div></li>
302        </ul>
303    </div>
304                </div>
305                        </div>
306        </td>
307        <td class="msource">Format</td>
308    </tr>
309        <tr class="method-row expandable">
310        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
311        <td class="sig">
312        <a id="Ext.util.Format-undef"></a>
313            <b>undef</b>(&nbsp;<code>Mixed value</code>&nbsp;) : Mixed            <div class="mdesc">
314                        <div class="short">Checks a reference and converts it to empty string if it is undefined</div>
315            <div class="long">
316                Checks a reference and converts it to empty string if it is undefined    <div class="mdetail-params">
317        <strong>Parameters:</strong>
318        <ul><li><code>value</code> : Mixed<div class="sub-desc">Reference to check</div></li>        </ul>
319        <strong>Returns:</strong>
320        <ul>
321            <li><code>Mixed</code><div class="sub-desc">Empty string if converted, otherwise the original value</div></li>
322        </ul>
323    </div>
324                </div>
325                        </div>
326        </td>
327        <td class="msource">Format</td>
328    </tr>
329        <tr class="method-row alt expandable">
330        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
331        <td class="sig">
332        <a id="Ext.util.Format-uppercase"></a>
333            <b>uppercase</b>(&nbsp;<code>String value</code>&nbsp;) : String            <div class="mdesc">
334                        <div class="short">Converts a string to all upper case letters</div>
335            <div class="long">
336                Converts a string to all upper case letters    <div class="mdetail-params">
337        <strong>Parameters:</strong>
338        <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li>        </ul>
339        <strong>Returns:</strong>
340        <ul>
341            <li><code>String</code><div class="sub-desc">The converted text</div></li>
342        </ul>
343    </div>
344                </div>
345                        </div>
346        </td>
347        <td class="msource">Format</td>
348    </tr>
349        <tr class="method-row expandable">
350        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
351        <td class="sig">
352        <a id="Ext.util.Format-usMoney"></a>
353            <b>usMoney</b>(&nbsp;<code>Number/String value</code>&nbsp;) : String            <div class="mdesc">
354                        <div class="short">Format a number as US currency</div>
355            <div class="long">
356                Format a number as US currency    <div class="mdetail-params">
357        <strong>Parameters:</strong>
358        <ul><li><code>value</code> : Number/String<div class="sub-desc">The numeric value to format</div></li>        </ul>
359        <strong>Returns:</strong>
360        <ul>
361            <li><code>String</code><div class="sub-desc">The formatted currency string</div></li>
362        </ul>
363    </div>
364                </div>
365                        </div>
366        </td>
367        <td class="msource">Format</td>
368    </tr>
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>
Note: See TracBrowser for help on using the repository browser.