|
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 CustomEvent (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 > CustomEvent |
|
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">CustomEvent</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 The CustomEvent class lets you define events for your application |
|
63 that can be subscribed to by one or more independent component. |
|
64 </div> |
|
65 |
|
66 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
67 <h3 id="constructor">Constructor</h3> |
|
68 <div class="content"> |
|
69 <div class="detail"> |
|
70 <strong property="yui:name">CustomEvent</strong> |
|
71 <code> |
|
72 ( |
|
73 |
|
74 |
|
75 |
|
76 type |
|
77 |
|
78 , |
|
79 o |
|
80 ) |
|
81 </code> |
|
82 <div class="description"> |
|
83 <dl rel="yui:parameters"> |
|
84 <dt>Parameters:</dt> |
|
85 <dd rel="yui:parameter"> |
|
86 <code><span property="yui:name">type</span> |
|
87 <<span property="yui:type">String</span>> |
|
88 </code> |
|
89 <span property="yui:description"> The type of event, which is passed to the callback |
|
90 when the event fires</span> |
|
91 </dd> |
|
92 <dd rel="yui:parameter"> |
|
93 <code><span property="yui:name">o</span> |
|
94 <<span property="yui:type">object</span>> |
|
95 </code> |
|
96 <span property="yui:description"> configuration object</span> |
|
97 </dd> |
|
98 </dl> |
|
99 |
|
100 |
|
101 </div> |
|
102 </div> |
|
103 </div> |
|
104 </div> |
|
105 |
|
106 <div rel="yui:properties" resource="#properties"> |
|
107 <div class="section field details"> |
|
108 <h3 id="properties">Properties</h3> |
|
109 <div class="content"> |
|
110 <div class="" rel="yui:property" resource="#property_afters"> |
|
111 <h4><a name="property_afters" property="yui:name">afters</a> |
|
112 - <code><span property="yui:type">Subscriber{}</span></code> |
|
113 </h4> |
|
114 <div class="detail"> |
|
115 <div class="description" property="yui:description"> |
|
116 'After' subscribers |
|
117 </div> |
|
118 </div> |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 <hr /> |
|
124 </div> |
|
125 <div class="" rel="yui:property" resource="#property_broadcast"> |
|
126 <h4><a name="property_broadcast" property="yui:name">broadcast</a> |
|
127 - <code><span property="yui:type">int</span></code> |
|
128 </h4> |
|
129 <div class="detail"> |
|
130 <div class="description" property="yui:description"> |
|
131 If 0, this event does not broadcast. If 1, the YUI instance is notified |
|
132 every time this event fires. If 2, the YUI instance and the YUI global |
|
133 (if event is enabled on the global) are notified every time this event |
|
134 fires. |
|
135 </div> |
|
136 </div> |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 <hr /> |
|
142 </div> |
|
143 <div class="" rel="yui:property" resource="#property_bubbles"> |
|
144 <h4><a name="property_bubbles" property="yui:name">bubbles</a> |
|
145 - <code><span property="yui:type">boolean</span></code> |
|
146 </h4> |
|
147 <div class="detail"> |
|
148 <div class="description" property="yui:description"> |
|
149 Specifies whether or not a subscriber can stop the event propagation |
|
150 via stopPropagation(), stopImmediatePropagation(), or halt() |
|
151 </div> |
|
152 </div> |
|
153 |
|
154 |
|
155 <div class="default" property="yui:defaultValue"> |
|
156 Default Value: true |
|
157 </div> |
|
158 |
|
159 |
|
160 <hr /> |
|
161 </div> |
|
162 <div class="" rel="yui:property" resource="#property_context"> |
|
163 <h4><a name="property_context" property="yui:name">context</a> |
|
164 - <code><span property="yui:type">object</span></code> |
|
165 </h4> |
|
166 <div class="detail"> |
|
167 <div class="description" property="yui:description"> |
|
168 The context the the event will fire from by default. Defaults to the YUI |
|
169 instance. |
|
170 </div> |
|
171 </div> |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 <hr /> |
|
177 </div> |
|
178 <div class="" rel="yui:property" resource="#property_defaultFn"> |
|
179 <h4><a name="property_defaultFn" property="yui:name">defaultFn</a> |
|
180 - <code><span property="yui:type">Function</span></code> |
|
181 </h4> |
|
182 <div class="detail"> |
|
183 <div class="description" property="yui:description"> |
|
184 The default function to execute after event listeners |
|
185 have fire, but only if the default action was not |
|
186 prevented. |
|
187 </div> |
|
188 </div> |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 <hr /> |
|
194 </div> |
|
195 <div class="" rel="yui:property" resource="#property_emitFacade"> |
|
196 <h4><a name="property_emitFacade" property="yui:name">emitFacade</a> |
|
197 - <code><span property="yui:type">boolean</span></code> |
|
198 </h4> |
|
199 <div class="detail"> |
|
200 <div class="description" property="yui:description"> |
|
201 If set to true, the custom event will deliver an EventFacade object |
|
202 that is similar to a DOM event object. |
|
203 </div> |
|
204 </div> |
|
205 |
|
206 |
|
207 <div class="default" property="yui:defaultValue"> |
|
208 Default Value: false |
|
209 </div> |
|
210 |
|
211 |
|
212 <hr /> |
|
213 </div> |
|
214 <div class="" rel="yui:property" resource="#property_fired"> |
|
215 <h4><a name="property_fired" property="yui:name">fired</a> |
|
216 - <code><span property="yui:type">boolean</span></code> |
|
217 </h4> |
|
218 <div class="detail"> |
|
219 <div class="description" property="yui:description"> |
|
220 This event has fired if true |
|
221 </div> |
|
222 </div> |
|
223 |
|
224 |
|
225 <div class="default" property="yui:defaultValue"> |
|
226 Default Value: false; |
|
227 </div> |
|
228 |
|
229 |
|
230 <hr /> |
|
231 </div> |
|
232 <div class="" rel="yui:property" resource="#property_firedWith"> |
|
233 <h4><a name="property_firedWith" property="yui:name">firedWith</a> |
|
234 - <code><span property="yui:type">Array</span></code> |
|
235 </h4> |
|
236 <div class="detail"> |
|
237 <div class="description" property="yui:description"> |
|
238 An array containing the arguments the custom event |
|
239 was last fired with. |
|
240 </div> |
|
241 </div> |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 <hr /> |
|
247 </div> |
|
248 <div class="" rel="yui:property" resource="#property_fireOnce"> |
|
249 <h4><a name="property_fireOnce" property="yui:name">fireOnce</a> |
|
250 - <code><span property="yui:type">boolean</span></code> |
|
251 </h4> |
|
252 <div class="detail"> |
|
253 <div class="description" property="yui:description"> |
|
254 This event should only fire one time if true, and if |
|
255 it has fired, any new subscribers should be notified |
|
256 immediately. |
|
257 </div> |
|
258 </div> |
|
259 |
|
260 |
|
261 <div class="default" property="yui:defaultValue"> |
|
262 Default Value: false; |
|
263 </div> |
|
264 |
|
265 |
|
266 <hr /> |
|
267 </div> |
|
268 <div class="" rel="yui:property" resource="#property_host"> |
|
269 <h4><a name="property_host" property="yui:name">host</a> |
|
270 - <code><span property="yui:type">EventTarget</span></code> |
|
271 </h4> |
|
272 <div class="detail"> |
|
273 <div class="description" property="yui:description"> |
|
274 Specifies the host for this custom event. This is used |
|
275 to enable event bubbling |
|
276 </div> |
|
277 </div> |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 <hr /> |
|
283 </div> |
|
284 <div class="" rel="yui:property" resource="#property_preventable"> |
|
285 <h4><a name="property_preventable" property="yui:name">preventable</a> |
|
286 - <code><span property="yui:type">boolean</span></code> |
|
287 </h4> |
|
288 <div class="detail"> |
|
289 <div class="description" property="yui:description"> |
|
290 Specifies whether or not this event's default function |
|
291 can be cancelled by a subscriber by executing preventDefault() |
|
292 on the event facade |
|
293 </div> |
|
294 </div> |
|
295 |
|
296 |
|
297 <div class="default" property="yui:defaultValue"> |
|
298 Default Value: true |
|
299 </div> |
|
300 |
|
301 |
|
302 <hr /> |
|
303 </div> |
|
304 <div class="" rel="yui:property" resource="#property_prevented"> |
|
305 <h4><a name="property_prevented" property="yui:name">prevented</a> |
|
306 - <code><span property="yui:type">int</span></code> |
|
307 </h4> |
|
308 <div class="detail"> |
|
309 <div class="description" property="yui:description"> |
|
310 Flag for preventDefault that is modified during fire(). |
|
311 if it is not 0, the default behavior for this event |
|
312 </div> |
|
313 </div> |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 <hr /> |
|
319 </div> |
|
320 <div class="" rel="yui:property" resource="#property_preventedFn"> |
|
321 <h4><a name="property_preventedFn" property="yui:name">preventedFn</a> |
|
322 - <code><span property="yui:type">Function</span></code> |
|
323 </h4> |
|
324 <div class="detail"> |
|
325 <div class="description" property="yui:description"> |
|
326 The function to execute if a subscriber calls |
|
327 preventDefault |
|
328 </div> |
|
329 </div> |
|
330 |
|
331 |
|
332 |
|
333 |
|
334 <hr /> |
|
335 </div> |
|
336 <div class="" rel="yui:property" resource="#property_queuable"> |
|
337 <h4><a name="property_queuable" property="yui:name">queuable</a> |
|
338 - <code><span property="yui:type">boolean</span></code> |
|
339 </h4> |
|
340 <div class="detail"> |
|
341 <div class="description" property="yui:description"> |
|
342 Specifies whether this event should be queued when the host is actively |
|
343 processing an event. This will effect exectution order of the callbacks |
|
344 for the various events. |
|
345 </div> |
|
346 </div> |
|
347 |
|
348 |
|
349 <div class="default" property="yui:defaultValue"> |
|
350 Default Value: false |
|
351 </div> |
|
352 |
|
353 |
|
354 <hr /> |
|
355 </div> |
|
356 <div class="" rel="yui:property" resource="#property_signature"> |
|
357 <h4><a name="property_signature" property="yui:name">signature</a> |
|
358 - <code><span property="yui:type">int</span></code> |
|
359 </h4> |
|
360 <div class="detail"> |
|
361 <div class="description" property="yui:description"> |
|
362 Supports multiple options for listener signatures in order to |
|
363 port YUI 2 apps. |
|
364 </div> |
|
365 </div> |
|
366 |
|
367 |
|
368 <div class="default" property="yui:defaultValue"> |
|
369 Default Value: 9 |
|
370 </div> |
|
371 |
|
372 |
|
373 <hr /> |
|
374 </div> |
|
375 <div class="" rel="yui:property" resource="#property_silent"> |
|
376 <h4><a name="property_silent" property="yui:name">silent</a> |
|
377 - <code><span property="yui:type">boolean</span></code> |
|
378 </h4> |
|
379 <div class="detail"> |
|
380 <div class="description" property="yui:description"> |
|
381 By default all custom events are logged in the debug build, set silent |
|
382 to true to disable debug outpu for this event. |
|
383 </div> |
|
384 </div> |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 <hr /> |
|
390 </div> |
|
391 <div class="" rel="yui:property" resource="#property_stopped"> |
|
392 <h4><a name="property_stopped" property="yui:name">stopped</a> |
|
393 - <code><span property="yui:type">int</span></code> |
|
394 </h4> |
|
395 <div class="detail"> |
|
396 <div class="description" property="yui:description"> |
|
397 Flag for stopPropagation that is modified during fire() |
|
398 1 means to stop propagation to bubble targets. 2 means |
|
399 to also stop additional subscribers on this target. |
|
400 </div> |
|
401 </div> |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 <hr /> |
|
407 </div> |
|
408 <div class="" rel="yui:property" resource="#property_stoppedFn"> |
|
409 <h4><a name="property_stoppedFn" property="yui:name">stoppedFn</a> |
|
410 - <code><span property="yui:type">Function</span></code> |
|
411 </h4> |
|
412 <div class="detail"> |
|
413 <div class="description" property="yui:description"> |
|
414 The function to execute if a subscriber calls |
|
415 stopPropagation or stopImmediatePropagation |
|
416 </div> |
|
417 </div> |
|
418 |
|
419 |
|
420 |
|
421 |
|
422 <hr /> |
|
423 </div> |
|
424 <div class="" rel="yui:property" resource="#property_subscribers"> |
|
425 <h4><a name="property_subscribers" property="yui:name">subscribers</a> |
|
426 - <code><span property="yui:type">Subscriber{}</span></code> |
|
427 </h4> |
|
428 <div class="detail"> |
|
429 <div class="description" property="yui:description"> |
|
430 The subscribers to this event |
|
431 </div> |
|
432 </div> |
|
433 |
|
434 |
|
435 |
|
436 |
|
437 <hr /> |
|
438 </div> |
|
439 <div class="" rel="yui:property" resource="#property_type"> |
|
440 <h4><a name="property_type" property="yui:name">type</a> |
|
441 - <code><span property="yui:type">string</span></code> |
|
442 </h4> |
|
443 <div class="detail"> |
|
444 <div class="description" property="yui:description"> |
|
445 The type of event, returned to subscribers when the event fires |
|
446 </div> |
|
447 </div> |
|
448 |
|
449 |
|
450 |
|
451 |
|
452 <hr /> |
|
453 </div> |
|
454 </div> |
|
455 </div> |
|
456 |
|
457 </div> |
|
458 |
|
459 <div rel="yui:methods" resource="#methods"> |
|
460 <div class="section method details"> |
|
461 <h3 id="methods">Methods</h3> |
|
462 <div class="content"> |
|
463 <div class="private" rel="yui:method" resource="#method__delete"> |
|
464 <h4> |
|
465 <a name="method__delete">_delete</a></h4> |
|
466 <div class="detail" > |
|
467 <code> |
|
468 private |
|
469 |
|
470 |
|
471 void |
|
472 <strong property="yui:name">_delete</strong> |
|
473 ( |
|
474 |
|
475 |
|
476 subscriber |
|
477 |
|
478 |
|
479 ) |
|
480 </code> |
|
481 |
|
482 <div class="description" property="yui:description"> |
|
483 |
|
484 </div> |
|
485 |
|
486 <div class="description"> |
|
487 |
|
488 <dl rel="yui:parameters"> |
|
489 <dt>Parameters:</dt> |
|
490 <dd rel="yui:parameter"> |
|
491 <code><span property="yui:name">subscriber</span> |
|
492 <<span property="yui:type">object</span>> |
|
493 </code> |
|
494 <span property="yui:description"> object</span> |
|
495 </dd> |
|
496 </dl> |
|
497 |
|
498 |
|
499 |
|
500 |
|
501 |
|
502 </div> |
|
503 |
|
504 </div> |
|
505 <hr /> |
|
506 </div> |
|
507 <div class="private" rel="yui:method" resource="#method__notify"> |
|
508 <h4> |
|
509 <a name="method__notify">_notify</a></h4> |
|
510 <div class="detail" > |
|
511 <code> |
|
512 private |
|
513 |
|
514 |
|
515 void |
|
516 <strong property="yui:name">_notify</strong> |
|
517 ( |
|
518 |
|
519 |
|
520 s |
|
521 |
|
522 |
|
523 , |
|
524 args |
|
525 |
|
526 |
|
527 ) |
|
528 </code> |
|
529 |
|
530 <div class="description" property="yui:description"> |
|
531 Notify a single subscriber |
|
532 </div> |
|
533 |
|
534 <div class="description"> |
|
535 |
|
536 <dl rel="yui:parameters"> |
|
537 <dt>Parameters:</dt> |
|
538 <dd rel="yui:parameter"> |
|
539 <code><span property="yui:name">s</span> |
|
540 <<span property="yui:type">Subscriber</span>> |
|
541 </code> |
|
542 <span property="yui:description"> the subscriber</span> |
|
543 </dd> |
|
544 <dd rel="yui:parameter"> |
|
545 <code><span property="yui:name">args</span> |
|
546 <<span property="yui:type">Array</span>> |
|
547 </code> |
|
548 <span property="yui:description"> the arguments array to apply to the listener</span> |
|
549 </dd> |
|
550 </dl> |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 </div> |
|
557 |
|
558 </div> |
|
559 <hr /> |
|
560 </div> |
|
561 <div class="" rel="yui:method" resource="#method_after"> |
|
562 <h4> |
|
563 <a name="method_after">after</a></h4> |
|
564 <div class="detail" > |
|
565 <code> |
|
566 |
|
567 |
|
568 |
|
569 EventHandle|EventTarget |
|
570 <strong property="yui:name">after</strong> |
|
571 ( |
|
572 |
|
573 |
|
574 fn |
|
575 |
|
576 |
|
577 ) |
|
578 </code> |
|
579 |
|
580 <div class="description" property="yui:description"> |
|
581 Listen for this event after the normal subscribers have been notified and |
|
582 the default behavior has been applied. If a normal subscriber prevents the |
|
583 default behavior, it also prevents after listeners from firing. |
|
584 </div> |
|
585 |
|
586 <div class="description"> |
|
587 |
|
588 <dl rel="yui:parameters"> |
|
589 <dt>Parameters:</dt> |
|
590 <dd rel="yui:parameter"> |
|
591 <code><span property="yui:name">fn</span> |
|
592 <<span property="yui:type">Function</span>> |
|
593 </code> |
|
594 <span property="yui:description"> The function to execute</span> |
|
595 </dd> |
|
596 </dl> |
|
597 |
|
598 <dl> |
|
599 <dt>Returns: |
|
600 <code property="yui:return"> |
|
601 EventHandle|EventTarget |
|
602 </code></dt> |
|
603 <dd property="yui:returnInfo">unsubscribe handle or a |
|
604 chainable event target depending on the 'chain' config.</dd> |
|
605 </dl> |
|
606 |
|
607 |
|
608 |
|
609 |
|
610 </div> |
|
611 |
|
612 </div> |
|
613 <hr /> |
|
614 </div> |
|
615 <div class="" rel="yui:method" resource="#method_applyConfig"> |
|
616 <h4> |
|
617 <a name="method_applyConfig">applyConfig</a></h4> |
|
618 <div class="detail" > |
|
619 <code> |
|
620 |
|
621 |
|
622 |
|
623 void |
|
624 <strong property="yui:name">applyConfig</strong> |
|
625 ( |
|
626 |
|
627 |
|
628 o |
|
629 |
|
630 |
|
631 , |
|
632 force |
|
633 |
|
634 |
|
635 ) |
|
636 </code> |
|
637 |
|
638 <div class="description" property="yui:description"> |
|
639 Apply configuration properties. Only applies the CONFIG whitelist |
|
640 </div> |
|
641 |
|
642 <div class="description"> |
|
643 |
|
644 <dl rel="yui:parameters"> |
|
645 <dt>Parameters:</dt> |
|
646 <dd rel="yui:parameter"> |
|
647 <code><span property="yui:name">o</span> |
|
648 <<span property="yui:type">object</span>> |
|
649 </code> |
|
650 <span property="yui:description"> hash of properties to apply</span> |
|
651 </dd> |
|
652 <dd rel="yui:parameter"> |
|
653 <code><span property="yui:name">force</span> |
|
654 <<span property="yui:type">boolean</span>> |
|
655 </code> |
|
656 <span property="yui:description"> if true, properties that exist on the event |
|
657 will be overwritten.</span> |
|
658 </dd> |
|
659 </dl> |
|
660 |
|
661 |
|
662 |
|
663 |
|
664 |
|
665 </div> |
|
666 |
|
667 </div> |
|
668 <hr /> |
|
669 </div> |
|
670 <div class="" rel="yui:method" resource="#method_detach"> |
|
671 <h4> |
|
672 <a name="method_detach">detach</a></h4> |
|
673 <div class="detail" > |
|
674 <code> |
|
675 |
|
676 |
|
677 |
|
678 int|EventTarget |
|
679 <strong property="yui:name">detach</strong> |
|
680 ( |
|
681 |
|
682 |
|
683 fn |
|
684 |
|
685 |
|
686 , |
|
687 context |
|
688 |
|
689 |
|
690 ) |
|
691 </code> |
|
692 |
|
693 <div class="description" property="yui:description"> |
|
694 Detach listeners. |
|
695 </div> |
|
696 |
|
697 <div class="description"> |
|
698 |
|
699 <dl rel="yui:parameters"> |
|
700 <dt>Parameters:</dt> |
|
701 <dd rel="yui:parameter"> |
|
702 <code><span property="yui:name">fn</span> |
|
703 <<span property="yui:type">Function</span>> |
|
704 </code> |
|
705 <span property="yui:description"> The subscribed function to remove, if not supplied |
|
706 all will be removed</span> |
|
707 </dd> |
|
708 <dd rel="yui:parameter"> |
|
709 <code><span property="yui:name">context</span> |
|
710 <<span property="yui:type">Object</span>> |
|
711 </code> |
|
712 <span property="yui:description"> The context object passed to subscribe.</span> |
|
713 </dd> |
|
714 </dl> |
|
715 |
|
716 <dl> |
|
717 <dt>Returns: |
|
718 <code property="yui:return"> |
|
719 int|EventTarget |
|
720 </code></dt> |
|
721 <dd property="yui:returnInfo">returns a chainable event target |
|
722 or the number of subscribers unsubscribed.</dd> |
|
723 </dl> |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 </div> |
|
729 |
|
730 </div> |
|
731 <hr /> |
|
732 </div> |
|
733 <div class="" rel="yui:method" resource="#method_detachAll"> |
|
734 <h4> |
|
735 <a name="method_detachAll">detachAll</a></h4> |
|
736 <div class="detail" > |
|
737 <code> |
|
738 |
|
739 |
|
740 |
|
741 int |
|
742 <strong property="yui:name">detachAll</strong> |
|
743 ( |
|
744 ) |
|
745 </code> |
|
746 |
|
747 <div class="description" property="yui:description"> |
|
748 Removes all listeners |
|
749 </div> |
|
750 |
|
751 <div class="description"> |
|
752 |
|
753 |
|
754 <dl> |
|
755 <dt>Returns: |
|
756 <code property="yui:return"> |
|
757 int |
|
758 </code></dt> |
|
759 <dd property="yui:returnInfo">The number of listeners unsubscribed</dd> |
|
760 </dl> |
|
761 |
|
762 |
|
763 |
|
764 |
|
765 </div> |
|
766 |
|
767 </div> |
|
768 <hr /> |
|
769 </div> |
|
770 <div class="" rel="yui:method" resource="#method_fire"> |
|
771 <h4> |
|
772 <a name="method_fire">fire</a></h4> |
|
773 <div class="detail" > |
|
774 <code> |
|
775 |
|
776 |
|
777 |
|
778 boolean |
|
779 <strong property="yui:name">fire</strong> |
|
780 ( |
|
781 |
|
782 |
|
783 arguments |
|
784 |
|
785 |
|
786 ) |
|
787 </code> |
|
788 |
|
789 <div class="description" property="yui:description"> |
|
790 Notifies the subscribers. The callback functions will be executed |
|
791 from the context specified when the event was created, and with the |
|
792 following parameters: |
|
793 <ul> |
|
794 <li>The type of event</li> |
|
795 <li>All of the arguments fire() was executed with as an array</li> |
|
796 <li>The custom object (if any) that was passed into the subscribe() |
|
797 method</li> |
|
798 </ul> |
|
799 </div> |
|
800 |
|
801 <div class="description"> |
|
802 |
|
803 <dl rel="yui:parameters"> |
|
804 <dt>Parameters:</dt> |
|
805 <dd rel="yui:parameter"> |
|
806 <code><span property="yui:name">arguments</span> |
|
807 <<span property="yui:type">Object*</span>> |
|
808 </code> |
|
809 <span property="yui:description"> an arbitrary set of parameters to pass to |
|
810 the handler.</span> |
|
811 </dd> |
|
812 </dl> |
|
813 |
|
814 <dl> |
|
815 <dt>Returns: |
|
816 <code property="yui:return"> |
|
817 boolean |
|
818 </code></dt> |
|
819 <dd property="yui:returnInfo">false if one of the subscribers returned false, |
|
820 true otherwise</dd> |
|
821 </dl> |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 </div> |
|
827 |
|
828 </div> |
|
829 <hr /> |
|
830 </div> |
|
831 <div class="" rel="yui:method" resource="#method_halt"> |
|
832 <h4> |
|
833 <a name="method_halt">halt</a></h4> |
|
834 <div class="detail" > |
|
835 <code> |
|
836 |
|
837 |
|
838 |
|
839 void |
|
840 <strong property="yui:name">halt</strong> |
|
841 ( |
|
842 |
|
843 |
|
844 immediate |
|
845 |
|
846 |
|
847 ) |
|
848 </code> |
|
849 |
|
850 <div class="description" property="yui:description"> |
|
851 Stops the event propagation and prevents the default |
|
852 event behavior. |
|
853 </div> |
|
854 |
|
855 <div class="description"> |
|
856 |
|
857 <dl rel="yui:parameters"> |
|
858 <dt>Parameters:</dt> |
|
859 <dd rel="yui:parameter"> |
|
860 <code><span property="yui:name">immediate</span> |
|
861 <<span property="yui:type">boolean</span>> |
|
862 </code> |
|
863 <span property="yui:description"> if true additional listeners |
|
864 on the current target will not be executed</span> |
|
865 </dd> |
|
866 </dl> |
|
867 |
|
868 |
|
869 |
|
870 |
|
871 |
|
872 </div> |
|
873 |
|
874 </div> |
|
875 <hr /> |
|
876 </div> |
|
877 <div class="" rel="yui:method" resource="#method_log"> |
|
878 <h4> |
|
879 <a name="method_log">log</a></h4> |
|
880 <div class="detail" > |
|
881 <code> |
|
882 |
|
883 |
|
884 |
|
885 void |
|
886 <strong property="yui:name">log</strong> |
|
887 ( |
|
888 |
|
889 |
|
890 msg |
|
891 |
|
892 |
|
893 , |
|
894 cat |
|
895 |
|
896 |
|
897 ) |
|
898 </code> |
|
899 |
|
900 <div class="description" property="yui:description"> |
|
901 Logger abstraction to centralize the application of the silent flag |
|
902 </div> |
|
903 |
|
904 <div class="description"> |
|
905 |
|
906 <dl rel="yui:parameters"> |
|
907 <dt>Parameters:</dt> |
|
908 <dd rel="yui:parameter"> |
|
909 <code><span property="yui:name">msg</span> |
|
910 <<span property="yui:type">string</span>> |
|
911 </code> |
|
912 <span property="yui:description"> message to log</span> |
|
913 </dd> |
|
914 <dd rel="yui:parameter"> |
|
915 <code><span property="yui:name">cat</span> |
|
916 <<span property="yui:type">string</span>> |
|
917 </code> |
|
918 <span property="yui:description"> log category</span> |
|
919 </dd> |
|
920 </dl> |
|
921 |
|
922 |
|
923 |
|
924 |
|
925 |
|
926 </div> |
|
927 |
|
928 </div> |
|
929 <hr /> |
|
930 </div> |
|
931 <div class="" rel="yui:method" resource="#method_on"> |
|
932 <h4> |
|
933 <a name="method_on">on</a></h4> |
|
934 <div class="detail" > |
|
935 <code> |
|
936 |
|
937 |
|
938 |
|
939 EventHandle|EventTarget |
|
940 <strong property="yui:name">on</strong> |
|
941 ( |
|
942 |
|
943 |
|
944 fn |
|
945 |
|
946 |
|
947 ) |
|
948 </code> |
|
949 |
|
950 <div class="description" property="yui:description"> |
|
951 Listen for this event |
|
952 </div> |
|
953 |
|
954 <div class="description"> |
|
955 |
|
956 <dl rel="yui:parameters"> |
|
957 <dt>Parameters:</dt> |
|
958 <dd rel="yui:parameter"> |
|
959 <code><span property="yui:name">fn</span> |
|
960 <<span property="yui:type">Function</span>> |
|
961 </code> |
|
962 <span property="yui:description"> The function to execute</span> |
|
963 </dd> |
|
964 </dl> |
|
965 |
|
966 <dl> |
|
967 <dt>Returns: |
|
968 <code property="yui:return"> |
|
969 EventHandle|EventTarget |
|
970 </code></dt> |
|
971 <dd property="yui:returnInfo">unsubscribe handle or a |
|
972 chainable event target depending on the 'chain' config.</dd> |
|
973 </dl> |
|
974 |
|
975 |
|
976 |
|
977 |
|
978 </div> |
|
979 |
|
980 </div> |
|
981 <hr /> |
|
982 </div> |
|
983 <div class="" rel="yui:method" resource="#method_preventDefault"> |
|
984 <h4> |
|
985 <a name="method_preventDefault">preventDefault</a></h4> |
|
986 <div class="detail" > |
|
987 <code> |
|
988 |
|
989 |
|
990 |
|
991 void |
|
992 <strong property="yui:name">preventDefault</strong> |
|
993 ( |
|
994 ) |
|
995 </code> |
|
996 |
|
997 <div class="description" property="yui:description"> |
|
998 Prevents the execution of this event's defaultFn |
|
999 </div> |
|
1000 |
|
1001 <div class="description"> |
|
1002 |
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 |
|
1008 </div> |
|
1009 |
|
1010 </div> |
|
1011 <hr /> |
|
1012 </div> |
|
1013 <div class="" rel="yui:method" resource="#method_stopImmediatePropagation"> |
|
1014 <h4> |
|
1015 <a name="method_stopImmediatePropagation">stopImmediatePropagation</a></h4> |
|
1016 <div class="detail" > |
|
1017 <code> |
|
1018 |
|
1019 |
|
1020 |
|
1021 void |
|
1022 <strong property="yui:name">stopImmediatePropagation</strong> |
|
1023 ( |
|
1024 ) |
|
1025 </code> |
|
1026 |
|
1027 <div class="description" property="yui:description"> |
|
1028 Stops propagation to bubble targets, and prevents any remaining |
|
1029 subscribers on the current target from executing. |
|
1030 </div> |
|
1031 |
|
1032 <div class="description"> |
|
1033 |
|
1034 |
|
1035 |
|
1036 |
|
1037 |
|
1038 |
|
1039 </div> |
|
1040 |
|
1041 </div> |
|
1042 <hr /> |
|
1043 </div> |
|
1044 <div class="" rel="yui:method" resource="#method_stopPropagation"> |
|
1045 <h4> |
|
1046 <a name="method_stopPropagation">stopPropagation</a></h4> |
|
1047 <div class="detail" > |
|
1048 <code> |
|
1049 |
|
1050 |
|
1051 |
|
1052 void |
|
1053 <strong property="yui:name">stopPropagation</strong> |
|
1054 ( |
|
1055 ) |
|
1056 </code> |
|
1057 |
|
1058 <div class="description" property="yui:description"> |
|
1059 Stop propagation to bubble targets |
|
1060 </div> |
|
1061 |
|
1062 <div class="description"> |
|
1063 |
|
1064 |
|
1065 |
|
1066 |
|
1067 |
|
1068 |
|
1069 </div> |
|
1070 |
|
1071 </div> |
|
1072 <hr /> |
|
1073 </div> |
|
1074 <div class=" deprecated" rel="yui:method" resource="#method_subscribe"> |
|
1075 <h4> |
|
1076 <a name="method_subscribe">subscribe</a></h4> |
|
1077 <div class="detail" > |
|
1078 <code> |
|
1079 |
|
1080 |
|
1081 |
|
1082 EventHandle|EventTarget |
|
1083 <strong property="yui:name">subscribe</strong> |
|
1084 ( |
|
1085 |
|
1086 |
|
1087 fn |
|
1088 |
|
1089 |
|
1090 ) |
|
1091 </code> |
|
1092 |
|
1093 <div class="description" property="yui:description"> |
|
1094 Listen for this event |
|
1095 </div> |
|
1096 |
|
1097 <div class="description"> |
|
1098 |
|
1099 <dl rel="yui:parameters"> |
|
1100 <dt>Parameters:</dt> |
|
1101 <dd rel="yui:parameter"> |
|
1102 <code><span property="yui:name">fn</span> |
|
1103 <<span property="yui:type">Function</span>> |
|
1104 </code> |
|
1105 <span property="yui:description"> The function to execute</span> |
|
1106 </dd> |
|
1107 </dl> |
|
1108 |
|
1109 <dl> |
|
1110 <dt>Returns: |
|
1111 <code property="yui:return"> |
|
1112 EventHandle|EventTarget |
|
1113 </code></dt> |
|
1114 <dd property="yui:returnInfo">unsubscribe handle or a |
|
1115 chainable event target depending on the 'chain' config.</dd> |
|
1116 </dl> |
|
1117 |
|
1118 |
|
1119 |
|
1120 <div class="deprecated"> |
|
1121 <strong>Deprecated</strong> use on |
|
1122 </div> |
|
1123 |
|
1124 </div> |
|
1125 |
|
1126 </div> |
|
1127 <hr /> |
|
1128 </div> |
|
1129 <div class=" deprecated" rel="yui:method" resource="#method_unsubscribe"> |
|
1130 <h4> |
|
1131 <a name="method_unsubscribe">unsubscribe</a></h4> |
|
1132 <div class="detail" > |
|
1133 <code> |
|
1134 |
|
1135 |
|
1136 |
|
1137 boolean|EventTarget |
|
1138 <strong property="yui:name">unsubscribe</strong> |
|
1139 ( |
|
1140 |
|
1141 |
|
1142 fn |
|
1143 |
|
1144 |
|
1145 , |
|
1146 context |
|
1147 |
|
1148 |
|
1149 ) |
|
1150 </code> |
|
1151 |
|
1152 <div class="description" property="yui:description"> |
|
1153 Detach listeners. |
|
1154 </div> |
|
1155 |
|
1156 <div class="description"> |
|
1157 |
|
1158 <dl rel="yui:parameters"> |
|
1159 <dt>Parameters:</dt> |
|
1160 <dd rel="yui:parameter"> |
|
1161 <code><span property="yui:name">fn</span> |
|
1162 <<span property="yui:type">Function</span>> |
|
1163 </code> |
|
1164 <span property="yui:description"> The subscribed function to remove, if not supplied |
|
1165 all will be removed</span> |
|
1166 </dd> |
|
1167 <dd rel="yui:parameter"> |
|
1168 <code><span property="yui:name">context</span> |
|
1169 <<span property="yui:type">Object</span>> |
|
1170 </code> |
|
1171 <span property="yui:description"> The context object passed to subscribe.</span> |
|
1172 </dd> |
|
1173 </dl> |
|
1174 |
|
1175 <dl> |
|
1176 <dt>Returns: |
|
1177 <code property="yui:return"> |
|
1178 boolean|EventTarget |
|
1179 </code></dt> |
|
1180 <dd property="yui:returnInfo">returns a chainable event target |
|
1181 or a boolean for legacy detach support.</dd> |
|
1182 </dl> |
|
1183 |
|
1184 |
|
1185 |
|
1186 <div class="deprecated"> |
|
1187 <strong>Deprecated</strong> use detach |
|
1188 </div> |
|
1189 |
|
1190 </div> |
|
1191 |
|
1192 </div> |
|
1193 <hr /> |
|
1194 </div> |
|
1195 <div class=" deprecated" rel="yui:method" resource="#method_unsubscribeAll"> |
|
1196 <h4> |
|
1197 <a name="method_unsubscribeAll">unsubscribeAll</a></h4> |
|
1198 <div class="detail" > |
|
1199 <code> |
|
1200 |
|
1201 |
|
1202 |
|
1203 int |
|
1204 <strong property="yui:name">unsubscribeAll</strong> |
|
1205 ( |
|
1206 ) |
|
1207 </code> |
|
1208 |
|
1209 <div class="description" property="yui:description"> |
|
1210 Removes all listeners |
|
1211 </div> |
|
1212 |
|
1213 <div class="description"> |
|
1214 |
|
1215 |
|
1216 <dl> |
|
1217 <dt>Returns: |
|
1218 <code property="yui:return"> |
|
1219 int |
|
1220 </code></dt> |
|
1221 <dd property="yui:returnInfo">The number of listeners unsubscribed</dd> |
|
1222 </dl> |
|
1223 |
|
1224 |
|
1225 |
|
1226 <div class="deprecated"> |
|
1227 <strong>Deprecated</strong> use detachAll |
|
1228 </div> |
|
1229 |
|
1230 </div> |
|
1231 |
|
1232 </div> |
|
1233 <hr /> |
|
1234 </div> |
|
1235 </div> |
|
1236 </div> |
|
1237 |
|
1238 </div> |
|
1239 |
|
1240 <div rel="yui:events" resource="#events"> |
|
1241 |
|
1242 |
|
1243 </div> |
|
1244 |
|
1245 <div rel="yui:attributes" resource="#configattributes"> |
|
1246 |
|
1247 </div> |
|
1248 |
|
1249 </div> |
|
1250 </div> |
|
1251 <div class="yui-b"> |
|
1252 <div class="nav"> |
|
1253 |
|
1254 <div id="moduleList" class="module"> |
|
1255 <h4>Modules</h4> |
|
1256 <ul class="content"> |
|
1257 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1258 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
1259 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1260 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1261 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
1262 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1263 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1264 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1265 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1266 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1267 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1268 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1269 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1270 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1271 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1272 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1273 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1274 <li class="selected"><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1275 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1276 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1277 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1278 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1279 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1280 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1281 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1282 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1283 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1284 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1285 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1286 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1287 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
1288 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1289 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1290 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1291 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1292 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1293 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1294 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1295 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1296 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1297 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1298 </ul> |
|
1299 </div> |
|
1300 |
|
1301 <div id="classList" class="module"> |
|
1302 <h4>Classes</h4> |
|
1303 <ul class="content"> |
|
1304 <li class="selected"><a href="CustomEvent.html" title="CustomEvent">CustomEvent</a></li> |
|
1305 <li class=""><a href="Do.html" title="Do">Do</a></li> |
|
1306 <li class=""><a href="Do.AlterArgs.html" title="Do.AlterArgs">Do.AlterArgs</a></li> |
|
1307 <li class=""><a href="Do.AlterReturn.html" title="Do.AlterReturn">Do.AlterReturn</a></li> |
|
1308 <li class=""><a href="Do.Error.html" title="Do.Error">Do.Error</a></li> |
|
1309 <li class=""><a href="Do.Halt.html" title="Do.Halt">Do.Halt</a></li> |
|
1310 <li class=""><a href="Do.Method.html" title="Do.Method">Do.Method</a></li> |
|
1311 <li class=""><a href="Do.Prevent.html" title="Do.Prevent">Do.Prevent</a></li> |
|
1312 <li class=""><a href="EventFacade.html" title="EventFacade">EventFacade</a></li> |
|
1313 <li class=""><a href="EventHandle.html" title="EventHandle">EventHandle</a></li> |
|
1314 <li class=""><a href="EventTarget.html" title="EventTarget">EventTarget</a></li> |
|
1315 <li class=""><a href="Subscriber.html" title="Subscriber">Subscriber</a></li> |
|
1316 </ul> |
|
1317 </div> |
|
1318 |
|
1319 <div id="fileList" class="module"> |
|
1320 <h4>Files</h4> |
|
1321 <ul class="content"> |
|
1322 <li class=""><a href="event-custom.js.html" title="event-custom.js">event-custom.js</a></li> |
|
1323 <li class=""><a href="event-do.js.html" title="event-do.js">event-do.js</a></li> |
|
1324 <li class=""><a href="event-facade.js.html" title="event-facade.js">event-facade.js</a></li> |
|
1325 <li class=""><a href="event-target.js.html" title="event-target.js">event-target.js</a></li> |
|
1326 <li class=""><a href="event.js.html" title="event.js">event.js</a></li> |
|
1327 </ul> |
|
1328 </div> |
|
1329 |
|
1330 <div id="propertyList" class="module"> |
|
1331 <h4>Properties</h4> |
|
1332 <ul class="content"> |
|
1333 <li class=""><a href="#property_afters" title="afters">afters</a></li> |
|
1334 <li class=""><a href="#property_broadcast" title="broadcast">broadcast</a></li> |
|
1335 <li class=""><a href="#property_bubbles" title="bubbles">bubbles</a></li> |
|
1336 <li class=""><a href="#property_context" title="context">context</a></li> |
|
1337 <li class=""><a href="#property_defaultFn" title="defaultFn">defaultFn</a></li> |
|
1338 <li class=""><a href="#property_emitFacade" title="emitFacade">emitFacade</a></li> |
|
1339 <li class=""><a href="#property_fired" title="fired">fired</a></li> |
|
1340 <li class=""><a href="#property_firedWith" title="firedWith">firedWith</a></li> |
|
1341 <li class=""><a href="#property_fireOnce" title="fireOnce">fireOnce</a></li> |
|
1342 <li class=""><a href="#property_host" title="host">host</a></li> |
|
1343 <li class=""><a href="#property_preventable" title="preventable">preventable</a></li> |
|
1344 <li class=""><a href="#property_prevented" title="prevented">prevented</a></li> |
|
1345 <li class=""><a href="#property_preventedFn" title="preventedFn">preventedFn</a></li> |
|
1346 <li class=""><a href="#property_queuable" title="queuable">queuable</a></li> |
|
1347 <li class=""><a href="#property_signature" title="signature">signature</a></li> |
|
1348 <li class=""><a href="#property_silent" title="silent">silent</a></li> |
|
1349 <li class=""><a href="#property_stopped" title="stopped">stopped</a></li> |
|
1350 <li class=""><a href="#property_stoppedFn" title="stoppedFn">stoppedFn</a></li> |
|
1351 <li class=""><a href="#property_subscribers" title="subscribers">subscribers</a></li> |
|
1352 <li class=""><a href="#property_type" title="type">type</a></li> |
|
1353 </ul> |
|
1354 </div> |
|
1355 |
|
1356 <div id="methodsList" class="module"> |
|
1357 <h4>Methods</h4> |
|
1358 <ul class="content"> |
|
1359 <li class="private"><a href="#method__delete" title="_delete">_delete</a></li> |
|
1360 <li class="private"><a href="#method__notify" title="_notify">_notify</a></li> |
|
1361 <li class=""><a href="#method_after" title="after">after</a></li> |
|
1362 <li class=""><a href="#method_applyConfig" title="applyConfig">applyConfig</a></li> |
|
1363 <li class=""><a href="#method_detach" title="detach">detach</a></li> |
|
1364 <li class=""><a href="#method_detachAll" title="detachAll">detachAll</a></li> |
|
1365 <li class=""><a href="#method_fire" title="fire">fire</a></li> |
|
1366 <li class=""><a href="#method_halt" title="halt">halt</a></li> |
|
1367 <li class=""><a href="#method_log" title="log">log</a></li> |
|
1368 <li class=""><a href="#method_on" title="on">on</a></li> |
|
1369 <li class=""><a href="#method_preventDefault" title="preventDefault">preventDefault</a></li> |
|
1370 <li class=""><a href="#method_stopImmediatePropagation" title="stopImmediatePropagation">stopImmediatePropagation</a></li> |
|
1371 <li class=""><a href="#method_stopPropagation" title="stopPropagation">stopPropagation</a></li> |
|
1372 <li class=" deprecated"><a href="#method_subscribe" title="subscribe">subscribe</a></li> |
|
1373 <li class=" deprecated"><a href="#method_unsubscribe" title="unsubscribe">unsubscribe</a></li> |
|
1374 <li class=" deprecated"><a href="#method_unsubscribeAll" title="unsubscribeAll">unsubscribeAll</a></li> |
|
1375 </ul> |
|
1376 </div> |
|
1377 |
|
1378 |
|
1379 |
|
1380 </div> |
|
1381 </div> |
|
1382 </div> |
|
1383 <div id="ft"> |
|
1384 <hr /> |
|
1385 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1386 </div> |
|
1387 </div> |
|
1388 <script type="text/javascript"> |
|
1389 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": "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": "CustomEvent", "name": "context", "url": "CustomEvent.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": "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": "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": "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": "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"}]; |
|
1390 </script> |
|
1391 </body> |
|
1392 </html> |