|
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 EventFacade (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 > EventFacade |
|
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 |
|
50 |
|
51 Class <b property="yui:name">EventFacade</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 Wraps and protects a custom event for use when emitFacade is set to true. |
|
63 Requires the event-custom-complex module |
|
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_currentTarget"> |
|
72 <h4><a name="property_currentTarget" property="yui:name">currentTarget</a> |
|
73 - <code><span property="yui:type">Node</span></code> |
|
74 </h4> |
|
75 <div class="detail"> |
|
76 <div class="description" property="yui:description"> |
|
77 Node reference for the element that the listener was attached to. |
|
78 </div> |
|
79 </div> |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 <hr /> |
|
85 </div> |
|
86 <div class="" rel="yui:property" resource="#property_details"> |
|
87 <h4><a name="property_details" property="yui:name">details</a> |
|
88 - <code><span property="yui:type">Array</span></code> |
|
89 </h4> |
|
90 <div class="detail"> |
|
91 <div class="description" property="yui:description"> |
|
92 The arguments passed to fire |
|
93 </div> |
|
94 </div> |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 <hr /> |
|
100 </div> |
|
101 <div class="" rel="yui:property" resource="#property_relatedTarget"> |
|
102 <h4><a name="property_relatedTarget" property="yui:name">relatedTarget</a> |
|
103 - <code><span property="yui:type">Node</span></code> |
|
104 </h4> |
|
105 <div class="detail"> |
|
106 <div class="description" property="yui:description"> |
|
107 Node reference to the relatedTarget |
|
108 </div> |
|
109 </div> |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 <hr /> |
|
115 </div> |
|
116 <div class="" rel="yui:property" resource="#property_target"> |
|
117 <h4><a name="property_target" property="yui:name">target</a> |
|
118 - <code><span property="yui:type">Node</span></code> |
|
119 </h4> |
|
120 <div class="detail"> |
|
121 <div class="description" property="yui:description"> |
|
122 Node reference for the targeted eventtarget |
|
123 </div> |
|
124 </div> |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 <hr /> |
|
130 </div> |
|
131 <div class="" rel="yui:property" resource="#property_type"> |
|
132 <h4><a name="property_type" property="yui:name">type</a> |
|
133 - <code><span property="yui:type">string</span></code> |
|
134 </h4> |
|
135 <div class="detail"> |
|
136 <div class="description" property="yui:description"> |
|
137 The event type |
|
138 </div> |
|
139 </div> |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 <hr /> |
|
145 </div> |
|
146 </div> |
|
147 </div> |
|
148 |
|
149 </div> |
|
150 |
|
151 <div rel="yui:methods" resource="#methods"> |
|
152 <div class="section method details"> |
|
153 <h3 id="methods">Methods</h3> |
|
154 <div class="content"> |
|
155 <div class="" rel="yui:method" resource="#method_halt"> |
|
156 <h4> |
|
157 <a name="method_halt">halt</a></h4> |
|
158 <div class="detail" > |
|
159 <code> |
|
160 |
|
161 |
|
162 |
|
163 void |
|
164 <strong property="yui:name">halt</strong> |
|
165 ( |
|
166 |
|
167 |
|
168 immediate |
|
169 |
|
170 |
|
171 ) |
|
172 </code> |
|
173 |
|
174 <div class="description" property="yui:description"> |
|
175 Stops the event propagation and prevents the default |
|
176 event behavior. |
|
177 </div> |
|
178 |
|
179 <div class="description"> |
|
180 |
|
181 <dl rel="yui:parameters"> |
|
182 <dt>Parameters:</dt> |
|
183 <dd rel="yui:parameter"> |
|
184 <code><span property="yui:name">immediate</span> |
|
185 <<span property="yui:type">boolean</span>> |
|
186 </code> |
|
187 <span property="yui:description"> if true additional listeners |
|
188 on the current target will not be executed</span> |
|
189 </dd> |
|
190 </dl> |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 </div> |
|
197 |
|
198 </div> |
|
199 <hr /> |
|
200 </div> |
|
201 <div class="" rel="yui:method" resource="#method_preventDefault"> |
|
202 <h4> |
|
203 <a name="method_preventDefault">preventDefault</a></h4> |
|
204 <div class="detail" > |
|
205 <code> |
|
206 |
|
207 |
|
208 |
|
209 void |
|
210 <strong property="yui:name">preventDefault</strong> |
|
211 ( |
|
212 ) |
|
213 </code> |
|
214 |
|
215 <div class="description" property="yui:description"> |
|
216 Prevents the event's default behavior |
|
217 </div> |
|
218 |
|
219 <div class="description"> |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 </div> |
|
227 |
|
228 </div> |
|
229 <hr /> |
|
230 </div> |
|
231 <div class="" rel="yui:method" resource="#method_stopImmediatePropagation"> |
|
232 <h4> |
|
233 <a name="method_stopImmediatePropagation">stopImmediatePropagation</a></h4> |
|
234 <div class="detail" > |
|
235 <code> |
|
236 |
|
237 |
|
238 |
|
239 void |
|
240 <strong property="yui:name">stopImmediatePropagation</strong> |
|
241 ( |
|
242 ) |
|
243 </code> |
|
244 |
|
245 <div class="description" property="yui:description"> |
|
246 Stops the propagation to the next bubble target and |
|
247 prevents any additional listeners from being exectued |
|
248 on the current target. |
|
249 </div> |
|
250 |
|
251 <div class="description"> |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 </div> |
|
259 |
|
260 </div> |
|
261 <hr /> |
|
262 </div> |
|
263 <div class="" rel="yui:method" resource="#method_stopPropagation"> |
|
264 <h4> |
|
265 <a name="method_stopPropagation">stopPropagation</a></h4> |
|
266 <div class="detail" > |
|
267 <code> |
|
268 |
|
269 |
|
270 |
|
271 void |
|
272 <strong property="yui:name">stopPropagation</strong> |
|
273 ( |
|
274 ) |
|
275 </code> |
|
276 |
|
277 <div class="description" property="yui:description"> |
|
278 Stops the propagation to the next bubble target |
|
279 </div> |
|
280 |
|
281 <div class="description"> |
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 </div> |
|
289 |
|
290 </div> |
|
291 <hr /> |
|
292 </div> |
|
293 </div> |
|
294 </div> |
|
295 |
|
296 </div> |
|
297 |
|
298 <div rel="yui:events" resource="#events"> |
|
299 |
|
300 |
|
301 </div> |
|
302 |
|
303 <div rel="yui:attributes" resource="#configattributes"> |
|
304 |
|
305 </div> |
|
306 |
|
307 </div> |
|
308 </div> |
|
309 <div class="yui-b"> |
|
310 <div class="nav"> |
|
311 |
|
312 <div id="moduleList" class="module"> |
|
313 <h4>Modules</h4> |
|
314 <ul class="content"> |
|
315 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
316 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
317 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
318 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
319 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
320 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
321 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
322 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
323 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
324 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
325 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
326 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
327 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
328 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
329 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
330 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
331 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
332 <li class="selected"><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
333 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
334 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
335 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
336 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
337 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
338 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
339 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
340 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
341 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
342 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
343 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
344 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
345 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
346 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
347 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
348 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
349 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
350 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
351 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
352 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
353 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
354 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
355 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
356 </ul> |
|
357 </div> |
|
358 |
|
359 <div id="classList" class="module"> |
|
360 <h4>Classes</h4> |
|
361 <ul class="content"> |
|
362 <li class=""><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li> |
|
363 <li class=""><a href="Do.html" title="Do">Do</a></li> |
|
364 <li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li> |
|
365 <li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li> |
|
366 <li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li> |
|
367 <li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li> |
|
368 <li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li> |
|
369 <li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li> |
|
370 <li class="selected"><a href="EventFacade.html" title="EventFacade">EventFacade</a></li> |
|
371 <li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li> |
|
372 <li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li> |
|
373 <li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li> |
|
374 </ul> |
|
375 </div> |
|
376 |
|
377 <div id="fileList" class="module"> |
|
378 <h4>Files</h4> |
|
379 <ul class="content"> |
|
380 <li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li> |
|
381 <li class=""><a href="event-do.js.html" title="event-do.js">event-do.js</a></li> |
|
382 <li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li> |
|
383 <li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li> |
|
384 <li class=""><a href="event.js.html" title="event.js">event.js</a></li> |
|
385 </ul> |
|
386 </div> |
|
387 |
|
388 <div id="propertyList" class="module"> |
|
389 <h4>Properties</h4> |
|
390 <ul class="content"> |
|
391 <li class=""><a href="#property_currentTarget" title="currentTarget">currentTarget</a></li> |
|
392 <li class=""><a href="#property_details" title="details">details</a></li> |
|
393 <li class=""><a href="#property_relatedTarget" title="relatedTarget">relatedTarget</a></li> |
|
394 <li class=""><a href="#property_target" title="target">target</a></li> |
|
395 <li class=""><a href="#property_type" title="type">type</a></li> |
|
396 </ul> |
|
397 </div> |
|
398 |
|
399 <div id="methodsList" class="module"> |
|
400 <h4>Methods</h4> |
|
401 <ul class="content"> |
|
402 <li class=""><a href="#method_halt" title="halt">halt</a></li> |
|
403 <li class=""><a href="#method_preventDefault" title="preventDefault">preventDefault</a></li> |
|
404 <li class=""><a href="#method_stopImmediatePropagation" title="stopImmediatePropagation">stopImmediatePropagation</a></li> |
|
405 <li class=""><a href="#method_stopPropagation" title="stopPropagation">stopPropagation</a></li> |
|
406 </ul> |
|
407 </div> |
|
408 |
|
409 |
|
410 |
|
411 </div> |
|
412 </div> |
|
413 </div> |
|
414 <div id="ft"> |
|
415 <hr /> |
|
416 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
417 </div> |
|
418 </div> |
|
419 <script type="text/javascript"> |
|
420 ALL_YUI_PROPS = [{"access": "", "host": "EventFacade", "name": "currentTarget", "url": "EventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "EventFacade", "name": "details", "url": "EventFacade.html#property_details", "type": "property"}, {"access": "", "host": "EventFacade", "name": "halt", "url": "EventFacade.html#method_halt", "type": "method"}, {"access": "", "host": "EventFacade", "name": "preventDefault", "url": "EventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "EventFacade", "name": "relatedTarget", "url": "EventFacade.html#property_relatedTarget", "type": "property"}, {"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": "EventFacade", "name": "target", "url": "EventFacade.html#property_target", "type": "property"}, {"access": "", "host": "EventFacade", "name": "type", "url": "EventFacade.html#property_type", "type": "property"}]; |
|
421 </script> |
|
422 </body> |
|
423 </html> |