+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.util.Format-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.util.Format-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.util.Format-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.util.Format"><img src="../resources/images/default/s.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="../src/Format.js" target="_blank">Format.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">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-capitalize"></a>\r
- <b>capitalize</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Converts the first character only of a string to upper case</div>\r
- <div class="long">\r
- Converts the first character only of a string to upper case <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-date"></a>\r
- <b>date</b>( <code>String/Date value</code>, <span class="optional" title="Optional">[<code>String format</code>]</span> ) : String <div class="mdesc">\r
- <div class="short">Parse a value into a formatted date using the specified format pattern.</div>\r
- <div class="long">\r
- Parse a value into a formatted date using the specified format pattern. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The formatted date string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-dateRenderer"></a>\r
- <b>dateRenderer</b>( <code>String format</code> ) : Function <div class="mdesc">\r
- <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>\r
- <div class="long">\r
- Returns a date rendering function that can be reused to apply a date format multiple times efficiently <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>format</code> : String<div class="sub-desc">Any valid date format string</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Function</code><div class="sub-desc">The date formatting function</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-defaultValue"></a>\r
- <b>defaultValue</b>( <code>Mixed value</code>, <code>String defaultValue</code> ) : String <div class="mdesc">\r
- <div class="short">Checks a reference and converts it to the default value if it's empty</div>\r
- <div class="long">\r
- Checks a reference and converts it to the default value if it's empty <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-ellipsis"></a>\r
- <b>ellipsis</b>( <code>String value</code>, <code>Number length</code> ) : String <div class="mdesc">\r
- <div class="short">Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length</div>\r
- <div class="long">\r
- Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-fileSize"></a>\r
- <b>fileSize</b>( <code>Number/String size</code> ) : String <div class="mdesc">\r
- <div class="short">Simple format for a file size (xxx bytes, xxx KB, xxx MB)</div>\r
- <div class="long">\r
- Simple format for a file size (xxx bytes, xxx KB, xxx MB) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>size</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The formatted file size</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-htmlDecode"></a>\r
- <b>htmlDecode</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>\r
- <div class="long">\r
- Convert certain characters (&, <, >, and ') from their HTML character equivalents. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The string to decode</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The decoded text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-htmlEncode"></a>\r
- <b>htmlEncode</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>\r
- <div class="long">\r
- Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The string to encode</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The encoded text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-lowercase"></a>\r
- <b>lowercase</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Converts a string to all lower case letters</div>\r
- <div class="long">\r
- Converts a string to all lower case letters <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-nl2br"></a>\r
- <b>nl2br</b>( <code>String The</code> ) : String <div class="mdesc">\r
- <div class="short">Converts newline characters to the HTML tag <br/></div>\r
- <div class="long">\r
- Converts newline characters to the HTML tag <br/> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>The</code> : String<div class="sub-desc">string value to format.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The string with embedded <br/> tags in place of newlines.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-stripScripts"></a>\r
- <b>stripScripts</b>( <code>Mixed value</code> ) : String <div class="mdesc">\r
- <div class="short">Strips all script tags</div>\r
- <div class="long">\r
- Strips all script tags <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip script tags</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The stripped text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-stripTags"></a>\r
- <b>stripTags</b>( <code>Mixed value</code> ) : String <div class="mdesc">\r
- <div class="short">Strips all HTML tags</div>\r
- <div class="long">\r
- Strips all HTML tags <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : Mixed<div class="sub-desc">The text from which to strip tags</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The stripped text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-substr"></a>\r
- <b>substr</b>( <code>String value</code>, <code>Number start</code>, <code>Number length</code> ) : String <div class="mdesc">\r
- <div class="short">Returns a substring from within an original string</div>\r
- <div class="long">\r
- Returns a substring from within an original string <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The substring</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-trim"></a>\r
- <b>trim</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Trims any whitespace from either side of a string</div>\r
- <div class="long">\r
- Trims any whitespace from either side of a string <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The text to trim</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The trimmed text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-undef"></a>\r
- <b>undef</b>( <code>Mixed value</code> ) : Mixed <div class="mdesc">\r
- <div class="short">Checks a reference and converts it to empty string if it is undefined</div>\r
- <div class="long">\r
- Checks a reference and converts it to empty string if it is undefined <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : Mixed<div class="sub-desc">Reference to check</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Mixed</code><div class="sub-desc">Empty string if converted, otherwise the original value</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-uppercase"></a>\r
- <b>uppercase</b>( <code>String value</code> ) : String <div class="mdesc">\r
- <div class="short">Converts a string to all upper case letters</div>\r
- <div class="long">\r
- Converts a string to all upper case letters <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The text to convert</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The converted text</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.util.Format-usMoney"></a>\r
- <b>usMoney</b>( <code>Number/String value</code> ) : String <div class="mdesc">\r
- <div class="short">Format a number as US currency</div>\r
- <div class="long">\r
- Format a number as US currency <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : Number/String<div class="sub-desc">The numeric value to format</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The formatted currency string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Format</td>\r
- </tr>\r
- </table>
- <a id="Ext.util.Format-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff