+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#String-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#String-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#String-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=String"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class String</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Global</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Ext.js" target="_blank">Ext.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">String</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- These functions are available as static methods on the JavaScript String object. </div>
-
- <div class="hr"></div>
- <a id="String-props"></a>
- <h2>Public Properties</h2>
- <div class="no-members">This class has no public properties.</div> <a id="String-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="String-escape"></a>\r
- <b>escape</b>( <code>String string</code> ) : String <div class="mdesc">\r
- <div class="short"><static> Escapes the passed string for ' and \</div>\r
- <div class="long">\r
- <static> Escapes the passed string for ' and \ <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>string</code> : String<div class="sub-desc">The string to escape</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The escaped string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">String</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="String-format"></a>\r
- <b>format</b>( <code>String string</code>, <code>String value1</code>, <code>String value2</code> ) : String <div class="mdesc">\r
- <div class="short"><static> Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the token...</div>\r
- <div class="long">\r
- <static> Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each
-token must be unique, and must increment in the format {0}, {1}, etc. Example usage:
-<pre><code>var cls = <em>'my-class'</em>, text = <em>'Some text'</em>;
-<b>var</b> s = String.format(<em>'<div class="{0}">{1}</div>'</em>, cls, text);
-// s now contains the string: <em>'<div class="my-class">Some text</div>'</em></code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>string</code> : String<div class="sub-desc">The tokenized string to be formatted</div></li><li><code>value1</code> : String<div class="sub-desc">The value to replace token {0}</div></li><li><code>value2</code> : String<div class="sub-desc">Etc...</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The formatted string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">String</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="String-leftPad"></a>\r
- <b>leftPad</b>( <code>String string</code>, <code>Number size</code>, <span class="optional" title="Optional">[<code>String char</code>]</span> ) : String <div class="mdesc">\r
- <div class="short"><static> Pads the left side of a string with a specified character. This is especially useful
-for normalizing ...</div>\r
- <div class="long">\r
- <static> Pads the left side of a string with a specified character. This is especially useful
-for normalizing number and date strings. Example usage:
-<pre><code>var s = String.leftPad(<em>'123'</em>, 5, <em>'0'</em>);
-// s now contains the string: <em>'00123'</em></code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>string</code> : String<div class="sub-desc">The original string</div></li><li><code>size</code> : Number<div class="sub-desc">The total length of the output string</div></li><li><code>char</code> : String<div class="sub-desc">(optional) The character with which to pad the original string (defaults to empty string " ")</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The padded string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">String</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="String-toggle"></a>\r
- <b>toggle</b>( <code>String value</code>, <code>String other</code> ) : String <div class="mdesc">\r
- <div class="short">Utility function that allows you to easily switch a string between two alternating values. The passed value
-is compa...</div>\r
- <div class="long">\r
- Utility function that allows you to easily switch a string between two alternating values. The passed value
-is compared to the current string, and if they are equal, the other value that was passed in is returned. If
-they are already different, the first value passed in is returned. Note that this method returns the new value
-but does not change the current string.
-<pre><code><i>// alternate sort directions</i>
-sort = sort.toggle(<em>'ASC'</em>, <em>'DESC'</em>);
-
-<i>// instead of conditional logic:</i>
-sort = (sort == <em>'ASC'</em> ? <em>'DESC'</em> : <em>'ASC'</em>);</code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">The value to compare to the current string</div></li><li><code>other</code> : String<div class="sub-desc">The new value to use if the string already equals the first value passed in</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The new value</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">String</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="String-trim"></a>\r
- <b>trim</b>() : String <div class="mdesc">\r
- <div class="short">Trims whitespace from either end of a string, leaving spaces within the string intact. Example:
-var s = ' foo bar ...</div>\r
- <div class="long">\r
- Trims whitespace from either end of a string, leaving spaces within the string intact. Example:
-<pre><code>var s = <em>' foo bar '</em>;
-alert(<em>'-'</em> + s + <em>'-'</em>); <i>//alerts <em>"- foo bar -"</em></i>
-alert(<em>'-'</em> + s.trim() + <em>'-'</em>); //alerts <em>"-foo bar-"</em></code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The trimmed string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">String</td>\r
- </tr>\r
- </table>
- <a id="String-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