Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

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