1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - String</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#String-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#String-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#String-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#String-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Defined In:</td><td class="hd-info">
58 <tr><td class="label">Class:</td><td class="hd-info">String</td></tr>
66 <!-- ============================== class summary ========================== -->
67 <div class="description">
72 <!-- ============================== Class comment block... ========================== -->
74 <div class="comments">
75 <b>Class Comments / Notes</B> =>
76 <u onclick="parent.CommentDialog.showCommentId = 'String';">[Add Your comment/notes about this class]</u>
78 <iframe frameborder="0" id="comments-" style="border: none;width:100%;"
79 src="/blog.php/GtkDjsComments/String.html"></iframe>
84 <!-- ============================== config options ========================== -->
89 <div class="hr"></div>
90 <a id="String-configs"></a>
94 <table cellspacing="0" class="member-table">
95 <caption class="Empty">Config Options - Has None</caption>
109 <!-- ============================== public properties ==================== -->
113 <a id="String-props"></a>
119 <table cellspacing="0" class="member-table">
120 <caption class="Empty">Public Properties - Has None</caption>
126 <!-- ============================== methods summary / details ======================== -->
129 <a id="String-methods"></a>
130 <!-- constructor?? -->
137 <!-- then dynamics first -->
144 <table cellspacing="0" class="member-table">
145 <caption>Public Methods</caption>
147 <th class="sig-header" colspan="2">Method</th>
148 <th class="msource-header">Defined By</th>
158 <tr class="method-row config-row-alt0 expandable notInherited">
159 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="String-method-escape" name=".escape"></a>
164 <div class="fixedFont">
165 <span class="attributes">String.</span><b class="itemname">escape</b>
167 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>string</i></B>)
173 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
182 <div class="short">Escapes the passed string for ' and \</div>
188 Escapes the passed string for ' and \
195 <dl class="detailList">
196 <dt class="heading">Parameters:</dt>
199 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>string</b>
202 <dd>The string to escape</dd>
210 <dl class="detailList">
211 <dt class="heading">Returns:</dt>
213 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The escaped string</dd>
235 <tr class="method-row config-row-alt1 expandable notInherited">
236 <td class="micon"><a class="exi" href="#expand"> </a></td>
240 <a id="String-method-format" name=".format"></a>
241 <div class="fixedFont">
242 <span class="attributes">String.</span><b class="itemname">format</b>
244 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>string</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value1</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value2</i></B>)
250 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens.</div>
265 Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each<br/>token must be unique, and must increment in the format {0}, {1}, etc. Example usage:<br/><pre><code><br/>var cls = 'my-class', text = 'Some text';<br/>var s = String.format('<div class="{0}">{1}</div>', cls, text);<br/>// s now contains the string: '<div class="my-class">Some text</div>'<br/></code></pre>
272 <dl class="detailList">
273 <dt class="heading">Parameters:</dt>
276 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>string</b>
279 <dd>The tokenized string to be formatted</dd>
282 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value1</b>
285 <dd>The value to replace token {0}</dd>
288 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value2</b>
299 <dl class="detailList">
300 <dt class="heading">Returns:</dt>
302 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The formatted string</dd>
324 <tr class="method-row config-row-alt0 expandable notInherited">
325 <td class="micon"><a class="exi" href="#expand"> </a></td>
329 <a id="String-method-leftPad" name=".leftPad"></a>
330 <div class="fixedFont">
331 <span class="attributes">String.</span><b class="itemname">leftPad</b>
333 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>string</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>size</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>char</i></B>)
339 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
348 <div class="short">Pads the left side of a string with a specified character.</div>
354 Pads the left side of a string with a specified character. This is especially useful<br/>for normalizing number and date strings. Example usage:<br/><pre><code><br/>var s = String.leftPad('123', 5, '0');<br/>// s now contains the string: '00123'<br/></code></pre>
361 <dl class="detailList">
362 <dt class="heading">Parameters:</dt>
365 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>string</b>
368 <dd>The original string</dd>
371 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>size</b>
374 <dd>The total length of the output string</dd>
377 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>char</b>
380 <dd>(optional) The character with which to pad the original string (defaults to empty string " ")</dd>
388 <dl class="detailList">
389 <dt class="heading">Returns:</dt>
391 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The padded string</dd>
413 <tr class="method-row config-row-alt1 expandable notInherited">
414 <td class="micon"><a class="exi" href="#expand"> </a></td>
418 <a id="String-method-toggle" name=".toggle"></a>
419 <div class="fixedFont">
420 <span class="attributes"></span><b class="itemname">toggle</b>
422 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>other</i></B>)
428 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
437 <div class="short">Utility function that allows you to easily switch a string between two alternating values.</div>
443 Utility function that allows you to easily switch a string between two alternating values. The passed value<br/>is compared to the current string, and if they are equal, the other value that was passed in is returned. If<br/>they are already different, the first value passed in is returned. Note that this method returns the new value<br/>but does not change the current string.<br/><pre><code><br/>// alternate sort directions<br/>sort = sort.toggle('ASC', 'DESC');<br/><br/>// instead of conditional logic:<br/>sort = (sort == 'ASC' ? 'DESC' : 'ASC');<br/></code></pre>
450 <dl class="detailList">
451 <dt class="heading">Parameters:</dt>
454 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
457 <dd>The value to compare to the current string</dd>
460 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>other</b>
463 <dd>The new value to use if the string already equals the first value passed in</dd>
471 <dl class="detailList">
472 <dt class="heading">Returns:</dt>
474 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The new value</dd>
499 <!-- ============================== events summary / details ======================== -->
502 <a id="String-events"></a>
508 <table cellspacing="0" class="member-table">
509 <caption class="Empty">Events - Has None</caption>
520 <!-- ============================== footer ================================= -->
521 <div class="fineprint" style="clear:both">
523 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Sep 08 2016 17:36:02 GMT+0800 (HKT)
525 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>