source: cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/YUI~substitute.html @ 5259

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/YUI~substitute.html@5259
Revision 5259, 9.3 KB checked in by domlowe, 11 years ago (diff)

adding yui javascript

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2<html>
3<head>
4        <title>API: substitute  YUI~substitute   (YUI Library)</title>
5        <link rel="stylesheet" type="text/css" href="assets/api.css">
6    <script type="text/javascript" src="assets/api-js"></script>
7    <script type="text/javascript" src="assets/ac-js"></script>
8</head>
9
10<body id="yahoo-com">
11
12<div id="doc3" class="yui-t2">
13
14        <div id="hd">
15        <a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
16        <h3>substitute&nbsp; <span class="subtitle">3.0.0pr1</span></h3>
17        <p>
18        <a href="./index.html">Yahoo! UI Library</a> 
19            &gt; <a href="./module_substitute.html">substitute</a>
20                 &gt; YUI~substitute
21               
22            </p>
23
24
25        </div>
26
27        <div id="bd">
28                <div id="yui-main">
29                        <div class="yui-b">
30            <form name="yui-classopts-form">
31    <span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
32    <span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
33    <span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
34            </form>
35
36                    <h2>
37                       
38
39                       
40                       
41                            Class <b>YUI~substitute</b>
42                        <span class="extends">
43                        </span>
44
45                        <span class="extends">
46                        </span>
47                       
48                        </code>
49                    </h2>
50                    <!-- class tree goes here -->
51                   
52               
53 
54
55                    <div class="summary description">
56                        The following methods are added to the YUI instance
57                    </div>
58
59
60
61
62                        <div class="section method details">
63                            <h3 id="methods">Methods</h3>
64                            <div class="content">
65                                    <div class="">
66                                    <h4>
67                                        <a name="method_substitute">substitute</a></h4>
68                                    <div class="detail">
69                                        <code>
70                                       
71                                       
72                                       
73                                        string
74                                            <strong>substitute</strong>
75                                           (
76                                               
77                                                       
78                                                         s
79                                                   
80                                               
81                                                        ,
82                                                         o
83                                                   
84                                               
85                                                        ,
86                                                         f
87                                                   
88                                               
89                                            )
90                                        </code>
91                                       
92                                        <div class="description">
93                                            Does variable substitution on a string. It scans through the string
94looking for expressions enclosed in { } braces. If an expression
95is found, it is used a key on the object.  If there is a space in
96the key, the first word is used for the key and the rest is provided
97to an optional function to be used to programatically determine the
98value (the extra information might be used for this decision). If
99the value for the key in the object, or what is returned from the
100function has a string value, number value, or object value, it is
101substituted for the bracket expression and it repeats.  If this
102value is an object, it uses the Object's toString() if this has
103been overridden, otherwise it does a shallow dump of the key/value
104pairs if Y.dump is available (if dump isn't available, toString()
105is used).
106This method is included in the 'substitute' module.  It is not included
107in the YUI module.
108                                        </div>
109
110                                        <div class="description">
111
112                                                <dl>
113                                                    <dt>Parameters:</dt>
114                                                        <dd>
115                                                            <code>s &lt;string&gt;</code>
116                                                              The string that will be modified.
117                                                        </dd>
118                                                        <dd>
119                                                            <code>o &lt;object&gt;</code>
120                                                             An object containing the replacement values
121                                                        </dd>
122                                                        <dd>
123                                                            <code>f &lt;function&gt;</code>
124                                                              An optional function that can be used to
125process each match.  It receives the key,
126value, and any extra metadata included with
127the key inside of the braces.
128                                                        </dd>
129                                                </dl>
130
131                                                <dl>
132                                                    <dt>Returns:
133                                                    <code>
134                                                        string
135                                                    </code></dt>
136                                                    <dd>the substituted string</dd>
137                                                </dl>
138
139
140             
141
142                                        </div>
143
144                                    </div>
145                                    <hr />
146                                    </div>
147                            </div>
148                        </div>
149
150
151
152
153
154
155
156                        </div>
157                </div>
158                <div class="yui-b">
159            <div class="nav">
160
161                    <div class="module">
162                        <h4>Modules</h4>
163                        <ul class="content">
164
165                                <li class=""><a href="module_anim.html">anim</a></li>
166
167                                <li class=""><a href="module_attribute.html">attribute</a></li>
168
169                                <li class=""><a href="module_base.html">base</a></li>
170
171                                <li class=""><a href="module_cookie.html">cookie</a></li>
172
173                                <li class=""><a href="module_dd.html">dd</a></li>
174
175                                <li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
176
177                                <li class=""><a href="module_dom.html">dom</a></li>
178
179                                <li class=""><a href="module_dump.html">dump</a></li>
180
181                                <li class=""><a href="module_event.html">event</a></li>
182
183                                <li class=""><a href="module_io.html">io</a></li>
184
185                                <li class=""><a href="module_json.html">json</a></li>
186
187                                <li class=""><a href="module_node.html">node</a></li>
188
189                                <li class=""><a href="module_oop.html">oop</a></li>
190
191                                <li class=""><a href="module_queue.html">queue</a></li>
192
193                                <li class="selected"><a href="module_substitute.html">substitute</a></li>
194
195                                <li class=""><a href="module_yui.html">yui</a></li>
196                        </ul>
197                    </div>
198
199                    <div class="module">
200                        <h4>Classes</h4>
201                        <ul class="content">
202                                <li class="selected"><a href="YUI~substitute.html">YUI~substitute</a></li>
203                        </ul>
204                    </div>
205
206                    <div class="module">
207                        <h4>Files</h4>
208                        <ul class="content">       
209                                <li class=""><a href="substitute.js.html">substitute.js</a></li>
210                        </ul>
211                    </div>
212
213
214                    <div class="module">
215                        <h4>Methods</h4>
216                        <ul class="content">       
217                                <li class=""><!--<code>string</code>-->
218                                <a href="#method_substitute">substitute</a>
219                                </li>
220                        </ul>
221                    </div>
222
223
224
225            </div>
226                </div>
227        </div>
228        <div id="ft">
229        <hr />
230        Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
231        </div>
232</div>
233</body>
234</html>
Note: See TracBrowser for help on using the repository browser.