|
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 event-do.js (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 |
|
23 > event-do.js (source view) |
|
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 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="c">/**</span> |
|
51 <span class="c"> * Custom event engine, DOM event listener abstraction layer, synthetic DOM </span> |
|
52 <span class="c"> * events.</span> |
|
53 <span class="c"> * @module event-custom</span> |
|
54 <span class="c"> * @submodule event-custom-base</span> |
|
55 <span class="c"> */</span> |
|
56 <span class="o">(</span><span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
57 |
|
58 <span class="c">/**</span> |
|
59 <span class="c"> * Allows for the insertion of methods that are executed before or after</span> |
|
60 <span class="c"> * a specified method</span> |
|
61 <span class="c"> * @class Do</span> |
|
62 <span class="c"> * @static</span> |
|
63 <span class="c"> */</span> |
|
64 |
|
65 <span class="k">var</span> <span class="nx">BEFORE</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> |
|
66 <span class="nx">AFTER</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span> |
|
67 |
|
68 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span> <span class="o">=</span> <span class="o">{</span> |
|
69 |
|
70 <span class="c">/**</span> |
|
71 <span class="c"> * Cache of objects touched by the utility</span> |
|
72 <span class="c"> * @property objs</span> |
|
73 <span class="c"> * @static</span> |
|
74 <span class="c"> */</span> |
|
75 <span class="nx">objs</span><span class="o">:</span> <span class="o">{},</span> |
|
76 |
|
77 <span class="c">/**</span> |
|
78 <span class="c"> * Execute the supplied method before the specified function</span> |
|
79 <span class="c"> * @method before</span> |
|
80 <span class="c"> * @param fn {Function} the function to execute</span> |
|
81 <span class="c"> * @param obj the object hosting the method to displace</span> |
|
82 <span class="c"> * @param sFn {string} the name of the method to displace</span> |
|
83 <span class="c"> * @param c The execution context for fn</span> |
|
84 <span class="c"> * @return {string} handle for the subscription</span> |
|
85 <span class="c"> * @static</span> |
|
86 <span class="c"> */</span> |
|
87 <span class="nx">before</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
88 <span class="c">// Y.log('Do before: ' + sFn, 'info', 'event');</span> |
|
89 <span class="c"></span> <span class="k">var</span> <span class="nx">f</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">a</span><span class="o">;</span> |
|
90 <span class="k">if</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
91 <span class="nx">a</span> <span class="o">=</span> <span class="o">[</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">c</span><span class="o">].</span><span class="nx">concat</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">));</span> |
|
92 <span class="nx">f</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">rbind</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">Y</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
93 <span class="o">}</span> |
|
94 |
|
95 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_inject</span><span class="o">(</span><span class="nx">BEFORE</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span> |
|
96 <span class="o">},</span> |
|
97 |
|
98 <span class="c">/**</span> |
|
99 <span class="c"> * Execute the supplied method after the specified function</span> |
|
100 <span class="c"> * @method after</span> |
|
101 <span class="c"> * @param fn {Function} the function to execute</span> |
|
102 <span class="c"> * @param obj the object hosting the method to displace</span> |
|
103 <span class="c"> * @param sFn {string} the name of the method to displace</span> |
|
104 <span class="c"> * @param c The execution context for fn</span> |
|
105 <span class="c"> * @return {string} handle for the subscription</span> |
|
106 <span class="c"> * @static</span> |
|
107 <span class="c"> */</span> |
|
108 <span class="nx">after</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
109 <span class="k">var</span> <span class="nx">f</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">a</span><span class="o">;</span> |
|
110 <span class="k">if</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
111 <span class="nx">a</span> <span class="o">=</span> <span class="o">[</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">c</span><span class="o">].</span><span class="nx">concat</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">));</span> |
|
112 <span class="nx">f</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">rbind</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">Y</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
113 <span class="o">}</span> |
|
114 |
|
115 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_inject</span><span class="o">(</span><span class="nx">AFTER</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span> |
|
116 <span class="o">},</span> |
|
117 |
|
118 <span class="c">/**</span> |
|
119 <span class="c"> * Execute the supplied method after the specified function</span> |
|
120 <span class="c"> * @method _inject</span> |
|
121 <span class="c"> * @param when {string} before or after</span> |
|
122 <span class="c"> * @param fn {Function} the function to execute</span> |
|
123 <span class="c"> * @param obj the object hosting the method to displace</span> |
|
124 <span class="c"> * @param sFn {string} the name of the method to displace</span> |
|
125 <span class="c"> * @param c The execution context for fn</span> |
|
126 <span class="c"> * @return {string} handle for the subscription</span> |
|
127 <span class="c"> * @private</span> |
|
128 <span class="c"> * @static</span> |
|
129 <span class="c"> */</span> |
|
130 <span class="nx">_inject</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">when</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">)</span> <span class="o">{</span> |
|
131 |
|
132 <span class="c">// object id</span> |
|
133 <span class="c"></span> <span class="k">var</span> <span class="nx">id</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">stamp</span><span class="o">(</span><span class="nx">obj</span><span class="o">),</span> <span class="nx">o</span><span class="o">,</span> <span class="nx">sid</span><span class="o">;</span> |
|
134 |
|
135 <span class="k">if</span> <span class="o">(!</span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">])</span> <span class="o">{</span> |
|
136 <span class="c">// create a map entry for the obj if it doesn't exist</span> |
|
137 <span class="c"></span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">]</span> <span class="o">=</span> <span class="o">{};</span> |
|
138 <span class="o">}</span> |
|
139 |
|
140 <span class="nx">o</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">objs</span><span class="o">[</span><span class="nx">id</span><span class="o">];</span> |
|
141 |
|
142 <span class="k">if</span> <span class="o">(!</span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">])</span> <span class="o">{</span> |
|
143 <span class="c">// create a map entry for the method if it doesn't exist</span> |
|
144 <span class="c"></span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">(</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">);</span> |
|
145 |
|
146 <span class="c">// re-route the method to our wrapper</span> |
|
147 <span class="c"></span> <span class="nx">obj</span><span class="o">[</span><span class="nx">sFn</span><span class="o">]</span> <span class="o">=</span> |
|
148 <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
149 <span class="k">return</span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">].</span><span class="nx">exec</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">],</span> <span class="nx">arguments</span><span class="o">);</span> |
|
150 <span class="o">};</span> |
|
151 <span class="o">}</span> |
|
152 |
|
153 <span class="c">// subscriber id</span> |
|
154 <span class="c"></span> <span class="nx">sid</span> <span class="o">=</span> <span class="nx">id</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">stamp</span><span class="o">(</span><span class="nx">fn</span><span class="o">)</span> <span class="o">+</span> <span class="nx">sFn</span><span class="o">;</span> |
|
155 |
|
156 <span class="c">// register the callback</span> |
|
157 <span class="c"></span> <span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">].</span><span class="nx">register</span><span class="o">(</span><span class="nx">sid</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">when</span><span class="o">);</span> |
|
158 |
|
159 <span class="k">return</span> <span class="k">new</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">EventHandle</span><span class="o">(</span><span class="nx">o</span><span class="o">[</span><span class="nx">sFn</span><span class="o">],</span> <span class="nx">sid</span><span class="o">);</span> |
|
160 |
|
161 <span class="o">},</span> |
|
162 |
|
163 <span class="c">/**</span> |
|
164 <span class="c"> * Detach a before or after subscription</span> |
|
165 <span class="c"> * @method detach</span> |
|
166 <span class="c"> * @param handle {string} the subscription handle</span> |
|
167 <span class="c"> */</span> |
|
168 <span class="nx">detach</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">handle</span><span class="o">)</span> <span class="o">{</span> |
|
169 |
|
170 <span class="k">if</span> <span class="o">(</span><span class="nx">handle</span><span class="o">.</span><span class="nx">detach</span><span class="o">)</span> <span class="o">{</span> |
|
171 <span class="nx">handle</span><span class="o">.</span><span class="nx">detach</span><span class="o">();</span> |
|
172 <span class="o">}</span> |
|
173 |
|
174 <span class="o">},</span> |
|
175 |
|
176 <span class="nx">_unload</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">,</span> <span class="nx">me</span><span class="o">)</span> <span class="o">{</span> |
|
177 |
|
178 <span class="o">}</span> |
|
179 <span class="o">};</span> |
|
180 |
|
181 <span class="c">//////////////////////////////////////////////////////////////////////////</span> |
|
182 <span class="c"></span> |
|
183 <span class="c">/**</span> |
|
184 <span class="c"> * Wrapper for a displaced method with aop enabled</span> |
|
185 <span class="c"> * @class Do.Method</span> |
|
186 <span class="c"> * @constructor</span> |
|
187 <span class="c"> * @param obj The object to operate on</span> |
|
188 <span class="c"> * @param sFn The name of the method to displace</span> |
|
189 <span class="c"> */</span> |
|
190 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">)</span> <span class="o">{</span> |
|
191 <span class="k">this</span><span class="o">.</span><span class="nx">obj</span> <span class="o">=</span> <span class="nx">obj</span><span class="o">;</span> |
|
192 <span class="k">this</span><span class="o">.</span><span class="nx">methodName</span> <span class="o">=</span> <span class="nx">sFn</span><span class="o">;</span> |
|
193 <span class="k">this</span><span class="o">.</span><span class="nx">method</span> <span class="o">=</span> <span class="nx">obj</span><span class="o">[</span><span class="nx">sFn</span><span class="o">];</span> |
|
194 <span class="k">this</span><span class="o">.</span><span class="nx">before</span> <span class="o">=</span> <span class="o">{};</span> |
|
195 <span class="k">this</span><span class="o">.</span><span class="nx">after</span> <span class="o">=</span> <span class="o">{};</span> |
|
196 <span class="o">};</span> |
|
197 |
|
198 <span class="c">/**</span> |
|
199 <span class="c"> * Register a aop subscriber</span> |
|
200 <span class="c"> * @method register</span> |
|
201 <span class="c"> * @param sid {string} the subscriber id</span> |
|
202 <span class="c"> * @param fn {Function} the function to execute</span> |
|
203 <span class="c"> * @param when {string} when to execute the function</span> |
|
204 <span class="c"> */</span> |
|
205 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">register</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">sid</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">when</span><span class="o">)</span> <span class="o">{</span> |
|
206 <span class="k">if</span> <span class="o">(</span><span class="nx">when</span><span class="o">)</span> <span class="o">{</span> |
|
207 <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">[</span><span class="nx">sid</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">;</span> |
|
208 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
209 <span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">[</span><span class="nx">sid</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fn</span><span class="o">;</span> |
|
210 <span class="o">}</span> |
|
211 <span class="o">};</span> |
|
212 |
|
213 <span class="c">/**</span> |
|
214 <span class="c"> * Unregister a aop subscriber</span> |
|
215 <span class="c"> * @method delete</span> |
|
216 <span class="c"> * @param sid {string} the subscriber id</span> |
|
217 <span class="c"> * @param fn {Function} the function to execute</span> |
|
218 <span class="c"> * @param when {string} when to execute the function</span> |
|
219 <span class="c"> */</span> |
|
220 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">_delete</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">sid</span><span class="o">)</span> <span class="o">{</span> |
|
221 <span class="c">// Y.log('Y.Do._delete: ' + sid, 'info', 'Event');</span> |
|
222 <span class="c"></span> <span class="nx">delete</span> <span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">[</span><span class="nx">sid</span><span class="o">];</span> |
|
223 <span class="nx">delete</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">[</span><span class="nx">sid</span><span class="o">];</span> |
|
224 <span class="o">};</span> |
|
225 |
|
226 <span class="c">/**</span> |
|
227 <span class="c"> * Execute the wrapped method</span> |
|
228 <span class="c"> * @method exec</span> |
|
229 <span class="c"> */</span> |
|
230 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Method</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">exec</span> <span class="o">=</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
231 |
|
232 <span class="k">var</span> <span class="nx">args</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">),</span> |
|
233 <span class="nx">i</span><span class="o">,</span> <span class="nx">ret</span><span class="o">,</span> <span class="nx">newRet</span><span class="o">,</span> |
|
234 <span class="nx">bf</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">before</span><span class="o">,</span> |
|
235 <span class="nx">af</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">,</span> |
|
236 <span class="nx">prevented</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
237 |
|
238 <span class="c">// execute before</span> |
|
239 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="k">in</span> <span class="nx">bf</span><span class="o">)</span> <span class="o">{</span> |
|
240 <span class="k">if</span> <span class="o">(</span><span class="nx">bf</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">i</span><span class="o">))</span> <span class="o">{</span> |
|
241 <span class="nx">ret</span> <span class="o">=</span> <span class="nx">bf</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span> |
|
242 <span class="k">if</span> <span class="o">(</span><span class="nx">ret</span><span class="o">)</span> <span class="o">{</span> |
|
243 <span class="nx">switch</span> <span class="o">(</span><span class="nx">ret</span><span class="o">.</span><span class="nx">constructor</span><span class="o">)</span> <span class="o">{</span> |
|
244 <span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">:</span> |
|
245 <span class="k">return</span> <span class="nx">ret</span><span class="o">.</span><span class="nx">retVal</span><span class="o">;</span> |
|
246 <span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterArgs</span><span class="o">:</span> |
|
247 <span class="nx">args</span> <span class="o">=</span> <span class="nx">ret</span><span class="o">.</span><span class="nx">newArgs</span><span class="o">;</span> |
|
248 <span class="k">break</span><span class="o">;</span> |
|
249 <span class="nx">case</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Prevent</span><span class="o">:</span> |
|
250 <span class="nx">prevented</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
251 <span class="k">break</span><span class="o">;</span> |
|
252 <span class="nx">default</span><span class="o">:</span> |
|
253 <span class="o">}</span> |
|
254 <span class="o">}</span> |
|
255 <span class="o">}</span> |
|
256 <span class="o">}</span> |
|
257 |
|
258 <span class="c">// execute method</span> |
|
259 <span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="nx">prevented</span><span class="o">)</span> <span class="o">{</span> |
|
260 <span class="nx">ret</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">method</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span> |
|
261 <span class="o">}</span> |
|
262 |
|
263 <span class="c">// execute after methods.</span> |
|
264 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="k">in</span> <span class="nx">af</span><span class="o">)</span> <span class="o">{</span> |
|
265 <span class="k">if</span> <span class="o">(</span><span class="nx">af</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">i</span><span class="o">))</span> <span class="o">{</span> |
|
266 <span class="nx">newRet</span> <span class="o">=</span> <span class="nx">af</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">obj</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span> |
|
267 <span class="c">// Stop processing if a Halt object is returned</span> |
|
268 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">newRet</span> <span class="o">&&</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">constructor</span> <span class="o">==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">)</span> <span class="o">{</span> |
|
269 <span class="k">return</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">retVal</span><span class="o">;</span> |
|
270 <span class="c">// Check for a new return value</span> |
|
271 <span class="c"></span> <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">newRet</span> <span class="o">&&</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">constructor</span> <span class="o">==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterReturn</span><span class="o">)</span> <span class="o">{</span> |
|
272 <span class="nx">ret</span> <span class="o">=</span> <span class="nx">newRet</span><span class="o">.</span><span class="nx">newRetVal</span><span class="o">;</span> |
|
273 <span class="o">}</span> |
|
274 <span class="o">}</span> |
|
275 <span class="o">}</span> |
|
276 |
|
277 <span class="k">return</span> <span class="nx">ret</span><span class="o">;</span> |
|
278 <span class="o">};</span> |
|
279 |
|
280 <span class="c">//////////////////////////////////////////////////////////////////////////</span> |
|
281 <span class="c"></span> |
|
282 |
|
283 <span class="c">/**</span> |
|
284 <span class="c"> * Return an AlterArgs object when you want to change the arguments that</span> |
|
285 <span class="c"> * were passed into the function. An example would be a service that scrubs</span> |
|
286 <span class="c"> * out illegal characters prior to executing the core business logic.</span> |
|
287 <span class="c"> * @class Do.AlterArgs</span> |
|
288 <span class="c"> */</span> |
|
289 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterArgs</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">newArgs</span><span class="o">)</span> <span class="o">{</span> |
|
290 <span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span> |
|
291 <span class="k">this</span><span class="o">.</span><span class="nx">newArgs</span> <span class="o">=</span> <span class="nx">newArgs</span><span class="o">;</span> |
|
292 <span class="o">};</span> |
|
293 |
|
294 <span class="c">/**</span> |
|
295 <span class="c"> * Return an AlterReturn object when you want to change the result returned</span> |
|
296 <span class="c"> * from the core method to the caller</span> |
|
297 <span class="c"> * @class Do.AlterReturn</span> |
|
298 <span class="c"> */</span> |
|
299 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">AlterReturn</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">newRetVal</span><span class="o">)</span> <span class="o">{</span> |
|
300 <span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span> |
|
301 <span class="k">this</span><span class="o">.</span><span class="nx">newRetVal</span> <span class="o">=</span> <span class="nx">newRetVal</span><span class="o">;</span> |
|
302 <span class="o">};</span> |
|
303 |
|
304 <span class="c">/**</span> |
|
305 <span class="c"> * Return a Halt object when you want to terminate the execution</span> |
|
306 <span class="c"> * of all subsequent subscribers as well as the wrapped method</span> |
|
307 <span class="c"> * if it has not exectued yet.</span> |
|
308 <span class="c"> * @class Do.Halt</span> |
|
309 <span class="c"> */</span> |
|
310 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">retVal</span><span class="o">)</span> <span class="o">{</span> |
|
311 <span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span> |
|
312 <span class="k">this</span><span class="o">.</span><span class="nx">retVal</span> <span class="o">=</span> <span class="nx">retVal</span><span class="o">;</span> |
|
313 <span class="o">};</span> |
|
314 |
|
315 <span class="c">/**</span> |
|
316 <span class="c"> * Return a Prevent object when you want to prevent the wrapped function</span> |
|
317 <span class="c"> * from executing, but want the remaining listeners to execute</span> |
|
318 <span class="c"> * @class Do.Prevent</span> |
|
319 <span class="c"> */</span> |
|
320 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Prevent</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">)</span> <span class="o">{</span> |
|
321 <span class="k">this</span><span class="o">.</span><span class="nx">msg</span> <span class="o">=</span> <span class="nx">msg</span><span class="o">;</span> |
|
322 <span class="o">};</span> |
|
323 |
|
324 <span class="c">/**</span> |
|
325 <span class="c"> * Return an Error object when you want to terminate the execution</span> |
|
326 <span class="c"> * of all subsequent method calls.</span> |
|
327 <span class="c"> * @class Do.Error</span> |
|
328 <span class="c"> * @deprecated use Y.Do.Halt or Y.Do.Prevent</span> |
|
329 <span class="c"> */</span> |
|
330 <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nb">Error</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">Halt</span><span class="o">;</span> |
|
331 |
|
332 <span class="c">//////////////////////////////////////////////////////////////////////////</span> |
|
333 <span class="c"></span> |
|
334 <span class="c">// Y["Event"] && Y.Event.addListener(window, "unload", Y.Do._unload, Y.Do);</span> |
|
335 <span class="c"></span> |
|
336 <span class="o">})();</span> |
|
337 </pre></div> |
|
338 |
|
339 </div> |
|
340 </div> |
|
341 </div> |
|
342 <div class="yui-b"> |
|
343 <div class="nav"> |
|
344 |
|
345 <div id="moduleList" class="module"> |
|
346 <h4>Modules</h4> |
|
347 <ul class="content"> |
|
348 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
349 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
350 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
351 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
352 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
353 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
354 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
355 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
356 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
357 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
358 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
359 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
360 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
361 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
362 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
363 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
364 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
365 <li class="selected"><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
366 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
367 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
368 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
369 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
370 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
371 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
372 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
373 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
374 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
375 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
376 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
377 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
378 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
379 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
380 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
381 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
382 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
383 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
384 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
385 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
386 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
387 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
388 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
389 </ul> |
|
390 </div> |
|
391 |
|
392 <div id="classList" class="module"> |
|
393 <h4>Classes</h4> |
|
394 <ul class="content"> |
|
395 <li class=""><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li> |
|
396 <li class=""><a href="Do.html" title="Do">Do</a></li> |
|
397 <li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li> |
|
398 <li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li> |
|
399 <li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li> |
|
400 <li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li> |
|
401 <li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li> |
|
402 <li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li> |
|
403 <li class=""><a href="EventFacade.html" title="EventFacade">EventFacade</a></li> |
|
404 <li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li> |
|
405 <li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li> |
|
406 <li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li> |
|
407 </ul> |
|
408 </div> |
|
409 |
|
410 <div id="fileList" class="module"> |
|
411 <h4>Files</h4> |
|
412 <ul class="content"> |
|
413 <li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li> |
|
414 <li class="selected"><a href="event-do.js.html" title="event-do.js">event-do.js</a></li> |
|
415 <li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li> |
|
416 <li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li> |
|
417 <li class=""><a href="event.js.html" title="event.js">event.js</a></li> |
|
418 </ul> |
|
419 </div> |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 </div> |
|
426 </div> |
|
427 </div> |
|
428 <div id="ft"> |
|
429 <hr /> |
|
430 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
431 </div> |
|
432 </div> |
|
433 <script type="text/javascript"> |
|
434 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": "CustomEvent", "name": "after", "url": "CustomEvent.html#method_after", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "afters", "url": "CustomEvent.html#property_afters", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "applyConfig", "url": "CustomEvent.html#method_applyConfig", "type": "method"}, {"access": "", "host": "Subscriber", "name": "args", "url": "Subscriber.html#property_args", "type": "property"}, {"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": "CustomEvent", "name": "broadcast", "url": "CustomEvent.html#property_broadcast", "type": "property"}, {"access": "", "host": "EventTarget", "name": "bubble", "url": "EventTarget.html#method_bubble", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "bubbles", "url": "CustomEvent.html#property_bubbles", "type": "property"}, {"access": "", "host": "Subscriber", "name": "contains", "url": "Subscriber.html#method_contains", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "context", "url": "CustomEvent.html#property_context", "type": "property"}, {"access": "", "host": "Subscriber", "name": "context", "url": "Subscriber.html#property_context", "type": "property"}, {"access": "", "host": "EventFacade", "name": "currentTarget", "url": "EventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "defaultFn", "url": "CustomEvent.html#property_defaultFn", "type": "property"}, {"access": "", "host": "Do.Method", "name": "delete", "url": "Do.Method.html#method_delete", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_delete", "url": "CustomEvent.html#method__delete", "type": "method"}, {"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": "EventHandle", "name": "detach", "url": "EventHandle.html#method_detach", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detach", "url": "CustomEvent.html#method_detach", "type": "method"}, {"access": "", "host": "EventTarget", "name": "detachAll", "url": "EventTarget.html#method_detachAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "detachAll", "url": "CustomEvent.html#method_detachAll", "type": "method"}, {"access": "", "host": "EventFacade", "name": "details", "url": "EventFacade.html#property_details", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "emitFacade", "url": "CustomEvent.html#property_emitFacade", "type": "property"}, {"access": "", "host": "Subscriber", "name": "events", "url": "Subscriber.html#property_events", "type": "property"}, {"access": "", "host": "EventHandle", "name": "evt", "url": "EventHandle.html#property_evt", "type": "property"}, {"access": "", "host": "Do.Method", "name": "exec", "url": "Do.Method.html#method_exec", "type": "method"}, {"access": "", "host": "EventTarget", "name": "fire", "url": "EventTarget.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fire", "url": "CustomEvent.html#method_fire", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "fired", "url": "CustomEvent.html#property_fired", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "firedWith", "url": "CustomEvent.html#property_firedWith", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "fireOnce", "url": "CustomEvent.html#property_fireOnce", "type": "property"}, {"access": "", "host": "Subscriber", "name": "fn", "url": "Subscriber.html#property_fn", "type": "property"}, {"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": "", "host": "CustomEvent", "name": "halt", "url": "CustomEvent.html#method_halt", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "host", "url": "CustomEvent.html#property_host", "type": "property"}, {"access": "", "host": "Subscriber", "name": "id", "url": "Subscriber.html#property_id", "type": "property"}, {"access": "private", "host": "Do", "name": "_inject", "url": "Do.html#method__inject", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "log", "url": "CustomEvent.html#method_log", "type": "method"}, {"access": "private", "host": "CustomEvent", "name": "_notify", "url": "CustomEvent.html#method__notify", "type": "method"}, {"access": "", "host": "Subscriber", "name": "notify", "url": "Subscriber.html#method_notify", "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": "", "host": "CustomEvent", "name": "on", "url": "CustomEvent.html#method_on", "type": "method"}, {"access": "private", "host": "EventTarget", "name": "_parseType", "url": "EventTarget.html#method__parseType", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventable", "url": "CustomEvent.html#property_preventable", "type": "property"}, {"access": "", "host": "EventFacade", "name": "preventDefault", "url": "EventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "preventDefault", "url": "CustomEvent.html#method_preventDefault", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "prevented", "url": "CustomEvent.html#property_prevented", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "preventedFn", "url": "CustomEvent.html#property_preventedFn", "type": "property"}, {"access": "", "host": "EventTarget", "name": "publish", "url": "EventTarget.html#method_publish", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "queuable", "url": "CustomEvent.html#property_queuable", "type": "property"}, {"access": "", "host": "Do.Method", "name": "register", "url": "Do.Method.html#method_register", "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": "CustomEvent", "name": "signature", "url": "CustomEvent.html#property_signature", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "silent", "url": "CustomEvent.html#property_silent", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopImmediatePropagation", "url": "EventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopImmediatePropagation", "url": "CustomEvent.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopped", "url": "CustomEvent.html#property_stopped", "type": "property"}, {"access": "", "host": "CustomEvent", "name": "stoppedFn", "url": "CustomEvent.html#property_stoppedFn", "type": "property"}, {"access": "", "host": "EventFacade", "name": "stopPropagation", "url": "EventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "stopPropagation", "url": "CustomEvent.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "EventHandle", "name": "sub", "url": "EventHandle.html#property_sub", "type": "property"}, {"access": "", "host": "EventTarget", "name": "subscribe", "url": "EventTarget.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribe", "url": "CustomEvent.html#method_subscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "subscribers", "url": "CustomEvent.html#property_subscribers", "type": "property"}, {"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": "CustomEvent", "name": "type", "url": "CustomEvent.html#property_type", "type": "property"}, {"access": "", "host": "EventTarget", "name": "unsubscribe", "url": "EventTarget.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribe", "url": "CustomEvent.html#method_unsubscribe", "type": "method"}, {"access": "", "host": "EventTarget", "name": "unsubscribeAll", "url": "EventTarget.html#method_unsubscribeAll", "type": "method"}, {"access": "", "host": "CustomEvent", "name": "unsubscribeAll", "url": "CustomEvent.html#method_unsubscribeAll", "type": "method"}]; |
|
435 </script> |
|
436 </body> |
|
437 </html> |