Upgrade to ExtJS 3.1.0 - Released 12/16/2009

[extjs.git] / docs / output / String.html

diff --git a/docs/output/String.html b/docs/output/String.html
index 1be5823..0d7da2d 100644 (file)
--- a/docs/output/String.html
+++ b/docs/output/String.html
@@ -1,12 +1,12 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><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>&#13;<a class="inner-link" href="#String-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#String-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=String"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Ext.html#cls-String">String</a></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">Ext.js,&#13;Ext-more.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Ext.html#cls-String">String</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr><tr><td class="hd-info"></td></tr></table><div class="description">These functions are available on every 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"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-escape"></a><b><a href="source/Ext-more.html#method-String-escape">escape</a></b>(&nbsp;<code>String&nbsp;string</code>&nbsp;)\r
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/Ext.html#cls-String">String</a></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">Ext.js,&#13;Ext-more.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Ext.html#cls-String">String</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">These functions are available on every 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"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-escape"></a><b><a href="source/Ext-more.html#method-String-escape">escape</a></b>(&nbsp;<code>String&nbsp;string</code>&nbsp;)\r

     :\r
                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Escapes the passed string for ' and \</div><div class="long">&lt;static&gt;&nbsp;Escapes the passed string for ' and \<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>string</code> : String<div class="sub-desc">The string to escape</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The escaped string</div></li></ul></div></div></div></td><td class="msource">String</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-format"></a><b><a href="source/Ext.html#method-String-format">format</a></b>(&nbsp;<code>String&nbsp;string</code>,&nbsp;<code>String&nbsp;value1</code>,&nbsp;<code>String&nbsp;value2</code>&nbsp;)\r
     :\r
     :\r
                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Escapes the passed string for ' and \</div><div class="long">&lt;static&gt;&nbsp;Escapes the passed string for ' and \<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>string</code> : String<div class="sub-desc">The string to escape</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The escaped string</div></li></ul></div></div></div></td><td class="msource">String</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-format"></a><b><a href="source/Ext.html#method-String-format">format</a></b>(&nbsp;<code>String&nbsp;string</code>,&nbsp;<code>String&nbsp;value1</code>,&nbsp;<code>String&nbsp;value2</code>&nbsp;)\r
     :\r

-                                        String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens.  Each&#13;\r
-token...</div><div class="long">&lt;static&gt;&nbsp;Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens.  Each\r
-token must be unique, and must increment in the format {0}, {1}, etc.  Example usage:\r
-<pre><code><b>var</b> cls = <em>'my-class'</em>, text = <em>'Some text'</em>;\r
-<b>var</b> s = String.format(<em>'&lt;div class=<em>"{0}"</em>>{1}&lt;/div>'</em>, cls, text);\r
+                                        String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens.  Each\r
+token ...</div><div class="long">&lt;static&gt;&nbsp;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><b>var</b> cls = <em>'my-class'</em>, text = <em>'Some text'</em>;
+<b>var</b> s = String.format(<em>'&lt;div class=<em>"{0}"</em>>{1}&lt;/div>'</em>, cls, text);

 <i>// s now contains the string: <em>'&lt;div class=<em>"my-class"</em>>Some text&lt;/div>'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The formatted string</div></li></ul></div></div></div></td><td class="msource">String</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-leftPad"></a><b><a href="source/Ext-more.html#method-String-leftPad">leftPad</a></b>(&nbsp;<code>String&nbsp;string</code>,&nbsp;<code>Number&nbsp;size</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;char</code>]</span>&nbsp;)\r
     :\r
                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Pads the left side of a string with a specified character.  This is especially useful\r
 <i>// s now contains the string: <em>'&lt;div class=<em>"my-class"</em>>Some text&lt;/div>'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The formatted string</div></li></ul></div></div></div></td><td class="msource">String</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="String-leftPad"></a><b><a href="source/Ext-more.html#method-String-leftPad">leftPad</a></b>(&nbsp;<code>String&nbsp;string</code>,&nbsp;<code>Number&nbsp;size</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;char</code>]</span>&nbsp;)\r
     :\r
                                         String<div class="mdesc"><div class="short">&lt;static&gt;&nbsp;Pads the left side of a string with a specified character.  This is especially useful\r