|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: event-custom Do (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>event-custom <span class="subtitle">3.0.0</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_event-custom.html" title="event-custom">event-custom</a> |
|
22 > Do |
|
23 |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <h2> |
|
47 |
|
48 |
|
49 <code>static</code> |
|
50 |
|
51 Class <b property="yui:name">Do</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 </h2> |
|
56 <!-- class tree goes here --> |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 <div class="summary description" property="yui:description"> |
|
62 Allows for the insertion of methods that are executed before or after |
|
63 a specified method |
|
64 </div> |
|
65 |
|
66 |
|
67 <div rel="yui:properties" resource="#properties"> |
|
68 <div class="section field details"> |
|
69 <h3 id="properties">Properties</h3> |
|
70 <div class="content"> |
|
71 <div class="" rel="yui:property" resource="#property_objs"> |
|
72 <h4><a name="property_objs" property="yui:name">objs</a> |
|
73 - <code>static <span property="yui:type">object</span></code> |
|
74 </h4> |
|
75 <div class="detail"> |
|
76 <div class="description" property="yui:description"> |
|
77 Cache of objects touched by the utility |
|
78 </div> |
|
79 </div> |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 <hr /> |
|
85 </div> |
|
86 </div> |
|
87 </div> |
|
88 |
|
89 </div> |
|
90 |
|
91 <div rel="yui:methods" resource="#methods"> |
|
92 <div class="section method details"> |
|
93 <h3 id="methods">Methods</h3> |
|
94 <div class="content"> |
|
95 <div class="private" rel="yui:method" resource="#method__inject"> |
|
96 <h4> |
|
97 <a name="method__inject">_inject</a></h4> |
|
98 <div class="detail" > |
|
99 <code> |
|
100 private |
|
101 static |
|
102 |
|
103 string |
|
104 <strong property="yui:name">_inject</strong> |
|
105 ( |
|
106 |
|
107 |
|
108 when |
|
109 |
|
110 |
|
111 , |
|
112 fn |
|
113 |
|
114 |
|
115 , |
|
116 obj |
|
117 |
|
118 |
|
119 , |
|
120 sFn |
|
121 |
|
122 |
|
123 , |
|
124 c |
|
125 |
|
126 |
|
127 ) |
|
128 </code> |
|
129 |
|
130 <div class="description" property="yui:description"> |
|
131 Execute the supplied method after the specified function |
|
132 </div> |
|
133 |
|
134 <div class="description"> |
|
135 |
|
136 <dl rel="yui:parameters"> |
|
137 <dt>Parameters:</dt> |
|
138 <dd rel="yui:parameter"> |
|
139 <code><span property="yui:name">when</span> |
|
140 <<span property="yui:type">string</span>> |
|
141 </code> |
|
142 <span property="yui:description"> before or after</span> |
|
143 </dd> |
|
144 <dd rel="yui:parameter"> |
|
145 <code><span property="yui:name">fn</span> |
|
146 <<span property="yui:type">Function</span>> |
|
147 </code> |
|
148 <span property="yui:description"> the function to execute</span> |
|
149 </dd> |
|
150 <dd rel="yui:parameter"> |
|
151 <code><span property="yui:name">obj</span> |
|
152 <<span property="yui:type">object</span>> |
|
153 </code> |
|
154 <span property="yui:description"> the object hosting the method to displace</span> |
|
155 </dd> |
|
156 <dd rel="yui:parameter"> |
|
157 <code><span property="yui:name">sFn</span> |
|
158 <<span property="yui:type">string</span>> |
|
159 </code> |
|
160 <span property="yui:description"> the name of the method to displace</span> |
|
161 </dd> |
|
162 <dd rel="yui:parameter"> |
|
163 <code><span property="yui:name">c</span> |
|
164 <<span property="yui:type">object</span>> |
|
165 </code> |
|
166 <span property="yui:description"> The execution context for fn</span> |
|
167 </dd> |
|
168 </dl> |
|
169 |
|
170 <dl> |
|
171 <dt>Returns: |
|
172 <code property="yui:return"> |
|
173 string |
|
174 </code></dt> |
|
175 <dd property="yui:returnInfo">handle for the subscription</dd> |
|
176 </dl> |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 </div> |
|
182 |
|
183 </div> |
|
184 <hr /> |
|
185 </div> |
|
186 <div class="" rel="yui:method" resource="#method_after"> |
|
187 <h4> |
|
188 <a name="method_after">after</a></h4> |
|
189 <div class="detail" > |
|
190 <code> |
|
191 |
|
192 static |
|
193 |
|
194 string |
|
195 <strong property="yui:name">after</strong> |
|
196 ( |
|
197 |
|
198 |
|
199 fn |
|
200 |
|
201 |
|
202 , |
|
203 obj |
|
204 |
|
205 |
|
206 , |
|
207 sFn |
|
208 |
|
209 |
|
210 , |
|
211 c |
|
212 |
|
213 |
|
214 ) |
|
215 </code> |
|
216 |
|
217 <div class="description" property="yui:description"> |
|
218 Execute the supplied method after the specified function |
|
219 </div> |
|
220 |
|
221 <div class="description"> |
|
222 |
|
223 <dl rel="yui:parameters"> |
|
224 <dt>Parameters:</dt> |
|
225 <dd rel="yui:parameter"> |
|
226 <code><span property="yui:name">fn</span> |
|
227 <<span property="yui:type">Function</span>> |
|
228 </code> |
|
229 <span property="yui:description"> the function to execute</span> |
|
230 </dd> |
|
231 <dd rel="yui:parameter"> |
|
232 <code><span property="yui:name">obj</span> |
|
233 <<span property="yui:type">object</span>> |
|
234 </code> |
|
235 <span property="yui:description"> the object hosting the method to displace</span> |
|
236 </dd> |
|
237 <dd rel="yui:parameter"> |
|
238 <code><span property="yui:name">sFn</span> |
|
239 <<span property="yui:type">string</span>> |
|
240 </code> |
|
241 <span property="yui:description"> the name of the method to displace</span> |
|
242 </dd> |
|
243 <dd rel="yui:parameter"> |
|
244 <code><span property="yui:name">c</span> |
|
245 <<span property="yui:type">object</span>> |
|
246 </code> |
|
247 <span property="yui:description"> The execution context for fn</span> |
|
248 </dd> |
|
249 </dl> |
|
250 |
|
251 <dl> |
|
252 <dt>Returns: |
|
253 <code property="yui:return"> |
|
254 string |
|
255 </code></dt> |
|
256 <dd property="yui:returnInfo">handle for the subscription</dd> |
|
257 </dl> |
|
258 |
|
259 |
|
260 |
|
261 |
|
262 </div> |
|
263 |
|
264 </div> |
|
265 <hr /> |
|
266 </div> |
|
267 <div class="" rel="yui:method" resource="#method_before"> |
|
268 <h4> |
|
269 <a name="method_before">before</a></h4> |
|
270 <div class="detail" > |
|
271 <code> |
|
272 |
|
273 static |
|
274 |
|
275 string |
|
276 <strong property="yui:name">before</strong> |
|
277 ( |
|
278 |
|
279 |
|
280 fn |
|
281 |
|
282 |
|
283 , |
|
284 obj |
|
285 |
|
286 |
|
287 , |
|
288 sFn |
|
289 |
|
290 |
|
291 , |
|
292 c |
|
293 |
|
294 |
|
295 ) |
|
296 </code> |
|
297 |
|
298 <div class="description" property="yui:description"> |
|
299 Execute the supplied method before the specified function |
|
300 </div> |
|
301 |
|
302 <div class="description"> |
|
303 |
|
304 <dl rel="yui:parameters"> |
|
305 <dt>Parameters:</dt> |
|
306 <dd rel="yui:parameter"> |
|
307 <code><span property="yui:name">fn</span> |
|
308 <<span property="yui:type">Function</span>> |
|
309 </code> |
|
310 <span property="yui:description"> the function to execute</span> |
|
311 </dd> |
|
312 <dd rel="yui:parameter"> |
|
313 <code><span property="yui:name">obj</span> |
|
314 <<span property="yui:type">object</span>> |
|
315 </code> |
|
316 <span property="yui:description"> the object hosting the method to displace</span> |
|
317 </dd> |
|
318 <dd rel="yui:parameter"> |
|
319 <code><span property="yui:name">sFn</span> |
|
320 <<span property="yui:type">string</span>> |
|
321 </code> |
|
322 <span property="yui:description"> the name of the method to displace</span> |
|
323 </dd> |
|
324 <dd rel="yui:parameter"> |
|
325 <code><span property="yui:name">c</span> |
|
326 <<span property="yui:type">object</span>> |
|
327 </code> |
|
328 <span property="yui:description"> The execution context for fn</span> |
|
329 </dd> |
|
330 </dl> |
|
331 |
|
332 <dl> |
|
333 <dt>Returns: |
|
334 <code property="yui:return"> |
|
335 string |
|
336 </code></dt> |
|
337 <dd property="yui:returnInfo">handle for the subscription</dd> |
|
338 </dl> |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 </div> |
|
344 |
|
345 </div> |
|
346 <hr /> |
|
347 </div> |
|
348 <div class="" rel="yui:method" resource="#method_detach"> |
|
349 <h4> |
|
350 <a name="method_detach">detach</a></h4> |
|
351 <div class="detail" > |
|
352 <code> |
|
353 |
|
354 |
|
355 |
|
356 void |
|
357 <strong property="yui:name">detach</strong> |
|
358 ( |
|
359 |
|
360 |
|
361 handle |
|
362 |
|
363 |
|
364 ) |
|
365 </code> |
|
366 |
|
367 <div class="description" property="yui:description"> |
|
368 Detach a before or after subscription |
|
369 </div> |
|
370 |
|
371 <div class="description"> |
|
372 |
|
373 <dl rel="yui:parameters"> |
|
374 <dt>Parameters:</dt> |
|
375 <dd rel="yui:parameter"> |
|
376 <code><span property="yui:name">handle</span> |
|
377 <<span property="yui:type">string</span>> |
|
378 </code> |
|
379 <span property="yui:description"> the subscription handle</span> |
|
380 </dd> |
|
381 </dl> |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 |
|
387 </div> |
|
388 |
|
389 </div> |
|
390 <hr /> |
|
391 </div> |
|
392 </div> |
|
393 </div> |
|
394 |
|
395 </div> |
|
396 |
|
397 <div rel="yui:events" resource="#events"> |
|
398 |
|
399 |
|
400 </div> |
|
401 |
|
402 <div rel="yui:attributes" resource="#configattributes"> |
|
403 |
|
404 </div> |
|
405 |
|
406 </div> |
|
407 </div> |
|
408 <div class="yui-b"> |
|
409 <div class="nav"> |
|
410 |
|
411 <div id="moduleList" class="module"> |
|
412 <h4>Modules</h4> |
|
413 <ul class="content"> |
|
414 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
415 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
416 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
417 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
418 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
419 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
420 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
421 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
422 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
423 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
424 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
425 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
426 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
427 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
428 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
429 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
430 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
431 <li class="selected"><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
432 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
433 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
434 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
435 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
436 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
437 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
438 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
439 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
440 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
441 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
442 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
443 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
444 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
445 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
446 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
447 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
448 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
449 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
450 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
451 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
452 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
453 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
454 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
455 </ul> |
|
456 </div> |
|
457 |
|
458 <div id="classList" class="module"> |
|
459 <h4>Classes</h4> |
|
460 <ul class="content"> |
|
461 <li class=""><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li> |
|
462 <li class="selected"><a href="Do.html" title="Do">Do</a></li> |
|
463 <li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li> |
|
464 <li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li> |
|
465 <li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li> |
|
466 <li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li> |
|
467 <li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li> |
|
468 <li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li> |
|
469 <li class=""><a href="EventFacade.html" title="EventFacade">EventFacade</a></li> |
|
470 <li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li> |
|
471 <li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li> |
|
472 <li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li> |
|
473 </ul> |
|
474 </div> |
|
475 |
|
476 <div id="fileList" class="module"> |
|
477 <h4>Files</h4> |
|
478 <ul class="content"> |
|
479 <li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li> |
|
480 <li class=""><a href="event-do.js.html" title="event-do.js">event-do.js</a></li> |
|
481 <li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li> |
|
482 <li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li> |
|
483 <li class=""><a href="event.js.html" title="event.js">event.js</a></li> |
|
484 </ul> |
|
485 </div> |
|
486 |
|
487 <div id="propertyList" class="module"> |
|
488 <h4>Properties</h4> |
|
489 <ul class="content"> |
|
490 <li class=""><a href="#property_objs" title="objs">objs</a></li> |
|
491 </ul> |
|
492 </div> |
|
493 |
|
494 <div id="methodsList" class="module"> |
|
495 <h4>Methods</h4> |
|
496 <ul class="content"> |
|
497 <li class="private"><a href="#method__inject" title="_inject">_inject</a></li> |
|
498 <li class=""><a href="#method_after" title="after">after</a></li> |
|
499 <li class=""><a href="#method_before" title="before">before</a></li> |
|
500 <li class=""><a href="#method_detach" title="detach">detach</a></li> |
|
501 </ul> |
|
502 </div> |
|
503 |
|
504 |
|
505 |
|
506 </div> |
|
507 </div> |
|
508 </div> |
|
509 <div id="ft"> |
|
510 <hr /> |
|
511 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
512 </div> |
|
513 </div> |
|
514 <script type="text/javascript"> |
|
515 ALL_YUI_PROPS = [{"access": "", "host": "EventTarget", "name": "addTarget", "url": "EventTarget.html#method_addTarget", "type": "method"}, {"access": "", "host": "EventTarget", "name": "after", "url": "EventTarget.html#method_after", "type": "method"}, {"access": "", "host": "Do", "name": "after", "url": "Do.html#method_after", "type": "method"}, {"access": "", "host": "EventTarget", "name": "before", "url": "EventTarget.html#method_before", "type": "method"}, {"access": "", "host": "Do", "name": "before", "url": "Do.html#method_before", "type": "method"}, {"access": "", "host": "EventTarget", "name": "bubble", "url": "EventTarget.html#method_bubble", "type": "method"}, {"access": "", "host": "EventFacade", "name": "currentTarget", "url": "EventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "EventTarget", "name": "detach", "url": "EventTarget.html#method_detach", "type": "method"}, {"access": "", "host": "Do", "name": "detach", "url": "Do.html#method_detach", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detachAll", "url": "EventTarget.html#method_detachAll", "type": "method"}, {"access": "", "host": "EventFacade", "name": "details", "url": "EventFacade.html#property_details", "type": "property"}, {"access": "", "host": "EventTarget", "name": "fire", "url": "EventTarget.html#method_fire", "type": "method"}, {"access": "", "host": "EventTarget", "name": "getEvent", "url": "EventTarget.html#method_getEvent", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_getType", "url": "EventTarget.html#method__getType", "type": "method"}, {"access": "", "host": "EventFacade", "name": "halt", "url": "EventFacade.html#method_halt", "type": "method"}, {"access": "private", "host": "Do", "name": "_inject", "url": "Do.html#method__inject", "type": "method"}, {"access": "", "host": "Do", "name": "objs", "url": "Do.html#property_objs", "type": "property"}, {"access": "", "host": "EventTarget", "name": "on", "url": "EventTarget.html#method_on", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_parseType", "url": "EventTarget.html#method__parseType", "type": "method"}, {"access": "", "host": "EventFacade", "name": "preventDefault", "url": "EventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "EventTarget", "name": "publish", "url": "EventTarget.html#method_publish", "type": "method"}, {"access": "", "host": "EventFacade", "name": "relatedTarget", "url": "EventFacade.html#property_relatedTarget", "type": "property"}, {"access": "", "host": "EventTarget", "name": "removeTarget", "url": "EventTarget.html#method_removeTarget", "type": "method"}, {"access": "", "host": "EventFacade", "name": "stopImmediatePropagation", "url": "EventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "EventFacade", "name": "stopPropagation", "url": "EventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "EventTarget", "name": "subscribe", "url": "EventTarget.html#method_subscribe", "type": "method"}, {"access": "", "host": "EventFacade", "name": "target", "url": "EventFacade.html#property_target", "type": "property"}, {"access": "", "host": "EventFacade", "name": "type", "url": "EventFacade.html#property_type", "type": "property"}, {"access": "", "host": "EventTarget", "name": "unsubscribe", "url": "EventTarget.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "EventTarget", "name": "unsubscribeAll", "url": "EventTarget.html#method_unsubscribeAll", "type": "method"}]; |
|
516 </script> |
|
517 </body> |
|
518 </html> |