source: cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/Do.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/Do.html@5259
Revision 5259, 22.6 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: event  Do   (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>event&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_event.html">event</a>
20                 &gt; Do
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                        <code>static</code>
40                       
41                            Class <b>Do</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                        Allows for the insertion of methods that are executed before or after
57a specified method
58                    </div>
59
60
61                        <div class="section field details">
62                            <h3 id="properties">Properties</h3>
63                            <div class="content">
64                                    <div class="">
65                                    <h4><a name="property_objs">objs</a>
66                                        <code>- static object</code>
67                                    </h4>
68                                    <div class="detail">
69                                        <div class="description">
70                                            Cache of objects touched by the utility
71                                        </div>
72                                    </div>
73     
74                                       
75
76
77                                    <hr />
78                                    </div>
79
80
81                            </div>
82                        </div>
83
84
85                        <div class="section method details">
86                            <h3 id="methods">Methods</h3>
87                            <div class="content">
88                                    <div class="private">
89                                    <h4>
90                                        <a name="method__inject">_inject</a></h4>
91                                    <div class="detail">
92                                        <code>
93                                         private
94                                         static
95                                       
96                                        string
97                                            <strong>_inject</strong>
98                                           (
99                                               
100                                                       
101                                                         when
102                                                   
103                                               
104                                                        ,
105                                                         fn
106                                                   
107                                               
108                                                        ,
109                                                         obj
110                                                   
111                                               
112                                                        ,
113                                                         sFn
114                                                   
115                                               
116                                                        ,
117                                                         c
118                                                   
119                                               
120                                            )
121                                        </code>
122                                       
123                                        <div class="description">
124                                            Execute the supplied method after the specified function
125                                        </div>
126
127                                        <div class="description">
128
129                                                <dl>
130                                                    <dt>Parameters:</dt>
131                                                        <dd>
132                                                            <code>when &lt;string&gt;</code>
133                                                              before or after
134                                                        </dd>
135                                                        <dd>
136                                                            <code>fn &lt;Function&gt;</code>
137                                                              the function to execute
138                                                        </dd>
139                                                        <dd>
140                                                            <code>obj &lt;object&gt;</code>
141                                                             the object hosting the method to displace
142                                                        </dd>
143                                                        <dd>
144                                                            <code>sFn &lt;string&gt;</code>
145                                                              the name of the method to displace
146                                                        </dd>
147                                                        <dd>
148                                                            <code>c &lt;object&gt;</code>
149                                                             The execution context for fn
150                                                        </dd>
151                                                </dl>
152
153                                                <dl>
154                                                    <dt>Returns:
155                                                    <code>
156                                                        string
157                                                    </code></dt>
158                                                    <dd>handle for the subscription</dd>
159                                                </dl>
160
161
162             
163
164                                        </div>
165
166                                    </div>
167                                    <hr />
168                                    </div>
169                                    <div class="">
170                                    <h4>
171                                        <a name="method_after">after</a></h4>
172                                    <div class="detail">
173                                        <code>
174                                       
175                                         static
176                                       
177                                        string
178                                            <strong>after</strong>
179                                           (
180                                               
181                                                       
182                                                         fn
183                                                   
184                                               
185                                                        ,
186                                                         obj
187                                                   
188                                               
189                                                        ,
190                                                         sFn
191                                                   
192                                               
193                                                        ,
194                                                         c
195                                                   
196                                               
197                                            )
198                                        </code>
199                                       
200                                        <div class="description">
201                                            Execute the supplied method after the specified function
202                                        </div>
203
204                                        <div class="description">
205
206                                                <dl>
207                                                    <dt>Parameters:</dt>
208                                                        <dd>
209                                                            <code>fn &lt;Function&gt;</code>
210                                                              the function to execute
211                                                        </dd>
212                                                        <dd>
213                                                            <code>obj &lt;object&gt;</code>
214                                                             the object hosting the method to displace
215                                                        </dd>
216                                                        <dd>
217                                                            <code>sFn &lt;string&gt;</code>
218                                                              the name of the method to displace
219                                                        </dd>
220                                                        <dd>
221                                                            <code>c &lt;object&gt;</code>
222                                                             The execution context for fn
223                                                        </dd>
224                                                </dl>
225
226                                                <dl>
227                                                    <dt>Returns:
228                                                    <code>
229                                                        string
230                                                    </code></dt>
231                                                    <dd>handle for the subscription</dd>
232                                                </dl>
233
234
235             
236
237                                        </div>
238
239                                    </div>
240                                    <hr />
241                                    </div>
242                                    <div class="">
243                                    <h4>
244                                        <a name="method_before">before</a></h4>
245                                    <div class="detail">
246                                        <code>
247                                       
248                                         static
249                                       
250                                        string
251                                            <strong>before</strong>
252                                           (
253                                               
254                                                       
255                                                         fn
256                                                   
257                                               
258                                                        ,
259                                                         obj
260                                                   
261                                               
262                                                        ,
263                                                         sFn
264                                                   
265                                               
266                                                        ,
267                                                         c
268                                                   
269                                               
270                                            )
271                                        </code>
272                                       
273                                        <div class="description">
274                                            Execute the supplied method before the specified function
275                                        </div>
276
277                                        <div class="description">
278
279                                                <dl>
280                                                    <dt>Parameters:</dt>
281                                                        <dd>
282                                                            <code>fn &lt;Function&gt;</code>
283                                                              the function to execute
284                                                        </dd>
285                                                        <dd>
286                                                            <code>obj &lt;object&gt;</code>
287                                                             the object hosting the method to displace
288                                                        </dd>
289                                                        <dd>
290                                                            <code>sFn &lt;string&gt;</code>
291                                                              the name of the method to displace
292                                                        </dd>
293                                                        <dd>
294                                                            <code>c &lt;object&gt;</code>
295                                                             The execution context for fn
296                                                        </dd>
297                                                </dl>
298
299                                                <dl>
300                                                    <dt>Returns:
301                                                    <code>
302                                                        string
303                                                    </code></dt>
304                                                    <dd>handle for the subscription</dd>
305                                                </dl>
306
307
308             
309
310                                        </div>
311
312                                    </div>
313                                    <hr />
314                                    </div>
315                                    <div class="">
316                                    <h4>
317                                        <a name="method_detach">detach</a></h4>
318                                    <div class="detail">
319                                        <code>
320                                       
321                                       
322                                       
323                                        void
324                                            <strong>detach</strong>
325                                           (
326                                               
327                                                       
328                                                         sid
329                                                   
330                                               
331                                            )
332                                        </code>
333                                       
334                                        <div class="description">
335                                            Detach a before or after subscription
336                                        </div>
337
338                                        <div class="description">
339
340                                                <dl>
341                                                    <dt>Parameters:</dt>
342                                                        <dd>
343                                                            <code>sid &lt;string&gt;</code>
344                                                              the subscription handle
345                                                        </dd>
346                                                </dl>
347
348                                                <dl>
349                                                    <dt>Returns:
350                                                    <code>
351                                                        void
352                                                    </code></dt>
353                                                    <dd></dd>
354                                                </dl>
355
356
357             
358
359                                        </div>
360
361                                    </div>
362                                    <hr />
363                                    </div>
364                            </div>
365                        </div>
366
367
368
369
370
371
372
373                        </div>
374                </div>
375                <div class="yui-b">
376            <div class="nav">
377
378                    <div class="module">
379                        <h4>Modules</h4>
380                        <ul class="content">
381
382                                <li class=""><a href="module_anim.html">anim</a></li>
383
384                                <li class=""><a href="module_attribute.html">attribute</a></li>
385
386                                <li class=""><a href="module_base.html">base</a></li>
387
388                                <li class=""><a href="module_cookie.html">cookie</a></li>
389
390                                <li class=""><a href="module_dd.html">dd</a></li>
391
392                                <li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
393
394                                <li class=""><a href="module_dom.html">dom</a></li>
395
396                                <li class=""><a href="module_dump.html">dump</a></li>
397
398                                <li class="selected"><a href="module_event.html">event</a></li>
399
400                                <li class=""><a href="module_io.html">io</a></li>
401
402                                <li class=""><a href="module_json.html">json</a></li>
403
404                                <li class=""><a href="module_node.html">node</a></li>
405
406                                <li class=""><a href="module_oop.html">oop</a></li>
407
408                                <li class=""><a href="module_queue.html">queue</a></li>
409
410                                <li class=""><a href="module_substitute.html">substitute</a></li>
411
412                                <li class=""><a href="module_yui.html">yui</a></li>
413                        </ul>
414                    </div>
415
416                    <div class="module">
417                        <h4>Classes</h4>
418                        <ul class="content">
419                                <li class="selected"><a href="Do.html">Do</a></li>
420                                <li class=""><a href="Do.AlterArgs.html">Do.AlterArgs</a></li>
421                                <li class=""><a href="Do.AlterReturn.html">Do.AlterReturn</a></li>
422                                <li class=""><a href="Do.Error.html">Do.Error</a></li>
423                                <li class=""><a href="Do.Method.html">Do.Method</a></li>
424                                <li class=""><a href="Event.html">Event</a></li>
425                                <li class=""><a href="Event.Custom.html">Event.Custom</a></li>
426                                <li class=""><a href="Event.Facade.html">Event.Facade</a></li>
427                                <li class=""><a href="Event.Handle.html">Event.Handle</a></li>
428                                <li class=""><a href="Event.Subscriber.html">Event.Subscriber</a></li>
429                                <li class=""><a href="Event.Target.html">Event.Target</a></li>
430                        </ul>
431                    </div>
432
433                    <div class="module">
434                        <h4>Files</h4>
435                        <ul class="content">       
436                                <li class=""><a href="event-custom.js.html">event-custom.js</a></li>
437                                <li class=""><a href="event-do.js.html">event-do.js</a></li>
438                                <li class=""><a href="event-dom.js.html">event-dom.js</a></li>
439                                <li class=""><a href="event-facade.js.html">event-facade.js</a></li>
440                                <li class=""><a href="event-ready.js.html">event-ready.js</a></li>
441                                <li class=""><a href="event-target.js.html">event-target.js</a></li>
442                                <li class=""><a href="event.js.html">event.js</a></li>
443                        </ul>
444                    </div>
445
446                    <div class="module">
447                        <h4>Properties</h4>
448                        <ul class="content">       
449                                <li class=""><a href="#property_objs">objs</a>
450                                        <!--<code>&lt;object&gt;</code>-->
451                                </li>
452                        </ul>
453                    </div>
454
455                    <div class="module">
456                        <h4>Methods</h4>
457                        <ul class="content">       
458                                <li class="private"><!--<code>string</code>-->
459                                <a href="#method__inject">_inject</a>
460                                </li>
461                                <li class=""><!--<code>string</code>-->
462                                <a href="#method_after">after</a>
463                                </li>
464                                <li class=""><!--<code>string</code>-->
465                                <a href="#method_before">before</a>
466                                </li>
467                                <li class=""><!--<code>void</code>-->
468                                <a href="#method_detach">detach</a>
469                                </li>
470                        </ul>
471                    </div>
472
473
474
475            </div>
476                </div>
477        </div>
478        <div id="ft">
479        <hr />
480        Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
481        </div>
482</div>
483</body>
484</html>
Note: See TracBrowser for help on using the repository browser.