source: cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/Event.html @ 5259

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/Event.html@5259
Revision 5259, 74.9 KB checked in by domlowe, 11 years ago (diff)

adding yui javascript

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2<html>
3<head>
4        <title>API: event  Event   (YUI Library)</title>
5        <link rel="stylesheet" type="text/css" href="assets/api.css">
6    <script type="text/javascript" src="assets/api-js"></script>
7    <script type="text/javascript" src="assets/ac-js"></script>
8</head>
9
10<body id="yahoo-com">
11
12<div id="doc3" class="yui-t2">
13
14        <div id="hd">
15        <a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
16        <h3>event&nbsp; <span class="subtitle">3.0.0pr1</span></h3>
17        <p>
18        <a href="./index.html">Yahoo! UI Library</a> 
19            &gt; <a href="./module_event.html">event</a>
20                 &gt; Event
21               
22            </p>
23
24
25        </div>
26
27        <div id="bd">
28                <div id="yui-main">
29                        <div class="yui-b">
30            <form name="yui-classopts-form">
31    <span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
32    <span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
33    <span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
34            </form>
35
36                    <h2>
37                       
38
39                        <code>static</code>
40                       
41                            Class <b>Event</b>
42                        <span class="extends">
43                        </span>
44
45                        <span class="extends">
46                        </span>
47                       
48                        </code>
49                    </h2>
50                    <!-- class tree goes here -->
51                   
52               
53 
54
55                    <div class="summary description">
56                        The event utility provides functions to add and remove event listeners,
57event cleansing.  It also tries to automatically remove listeners it
58registers during the unload event.
59                    </div>
60
61
62                        <div class="section field details">
63                            <h3 id="properties">Properties</h3>
64                            <div class="content">
65                                    <div class="private">
66                                    <h4><a name="property__avail">_avail</a>
67                                        <code>- private static object</code>
68                                    </h4>
69                                    <div class="detail">
70                                        <div class="description">
71                                            onAvailable listeners
72                                        </div>
73                                    </div>
74     
75                                       
76
77
78                                    <hr />
79                                    </div>
80                                    <div class="private">
81                                    <h4><a name="property__dri">_dri</a>
82                                        <code>- private static object</code>
83                                    </h4>
84                                    <div class="detail">
85                                        <div class="description">
86                                            document readystate poll handle
87                                        </div>
88                                    </div>
89     
90                                       
91
92
93                                    <hr />
94                                    </div>
95                                    <div class="private">
96                                    <h4><a name="property__el_events">_el_events</a>
97                                        <code>- private static object</code>
98                                    </h4>
99                                    <div class="detail">
100                                        <div class="description">
101                                            Custom event wrapper map DOM events.  Key is
102Element uid stamp.  Each item is a hash of custom event
103wrappers as provided in the _wrappers collection.  This
104provides the infrastructure for getListeners.
105                                        </div>
106                                    </div>
107     
108                                       
109
110
111                                    <hr />
112                                    </div>
113                                    <div class="private">
114                                    <h4><a name="property__interval">_interval</a>
115                                        <code>- private static object</code>
116                                    </h4>
117                                    <div class="detail">
118                                        <div class="description">
119                                            poll handle
120                                        </div>
121                                    </div>
122     
123                                       
124
125
126                                    <hr />
127                                    </div>
128                                    <div class="private">
129                                    <h4><a name="property__retryCount">_retryCount</a>
130                                        <code>- private static object</code>
131                                    </h4>
132                                    <div class="detail">
133                                        <div class="description">
134                                            The number of times to poll after window.onload.  This number is
135increased if additional late-bound handlers are requested after
136the page load.
137                                        </div>
138                                    </div>
139     
140                                       
141
142
143                                    <hr />
144                                    </div>
145                                    <div class="private">
146                                    <h4><a name="property__wrappers">_wrappers</a>
147                                        <code>- private static Y.Event.Custom</code>
148                                    </h4>
149                                    <div class="detail">
150                                        <div class="description">
151                                            Custom event wrappers for DOM events.  Key is
152'event:' + Element uid stamp + event type
153                                        </div>
154                                    </div>
155     
156                                       
157
158
159                                    <hr />
160                                    </div>
161                                    <div class="">
162                                    <h4><a name="property_DOMReady">DOMReady</a>
163                                        <code>- static boolean</code>
164                                    </h4>
165                                    <div class="detail">
166                                        <div class="description">
167                                            True when the document is initially usable
168                                        </div>
169                                    </div>
170     
171                                       
172
173
174                                    <hr />
175                                    </div>
176                                    <div class="">
177                                    <h4><a name="property_lastError">lastError</a>
178                                        <code>- static Error</code>
179                                    </h4>
180                                    <div class="detail">
181                                        <div class="description">
182                                            addListener/removeListener can throw errors in unexpected scenarios.
183These errors are suppressed, the method returns false, and this property
184is set
185                                        </div>
186                                    </div>
187     
188                                       
189
190
191                                    <hr />
192                                    </div>
193                                    <div class="private">
194                                    <h4><a name="property_loadComplete">loadComplete</a>
195                                        <code>- private static boolean</code>
196                                    </h4>
197                                    <div class="detail">
198                                        <div class="description">
199                                            True after the onload event has fired
200                                        </div>
201                                    </div>
202     
203                                       
204
205
206                                    <hr />
207                                    </div>
208                                    <div class="">
209                                    <h4><a name="property_POLL_INTERVAL">POLL_INTERVAL</a>
210                                        <code>- static final int</code>
211                                    </h4>
212                                    <div class="detail">
213                                        <div class="description">
214                                            The poll interval in milliseconds
215                                        </div>
216                                    </div>
217     
218                                       
219
220
221                                    <hr />
222                                    </div>
223                                    <div class="">
224                                    <h4><a name="property_POLL_RETRYS">POLL_RETRYS</a>
225                                        <code>- static final int</code>
226                                    </h4>
227                                    <div class="detail">
228                                        <div class="description">
229                                            The number of times we should look for elements that are not
230in the DOM at the time the event is requested after the document
231has been loaded.  The default is 2000@amp;20 ms, so it will poll
232for 40 seconds or until all outstanding handlers are bound
233(whichever comes first).
234                                        </div>
235                                    </div>
236     
237                                       
238
239
240                                    <hr />
241                                    </div>
242                                    <div class="private">
243                                    <h4><a name="property_webkitKeymap">webkitKeymap</a>
244                                        <code>- private object</code>
245                                    </h4>
246                                    <div class="detail">
247                                        <div class="description">
248                                            webkit key remapping required for Safari < 3.1
249                                        </div>
250                                    </div>
251     
252                                       
253
254
255                                    <hr />
256                                    </div>
257
258
259                            </div>
260                        </div>
261
262
263                        <div class="section method details">
264                            <h3 id="methods">Methods</h3>
265                            <div class="content">
266                                    <div class="private">
267                                    <h4>
268                                        <a name="method__isValidCollection">_isValidCollection</a></h4>
269                                    <div class="detail">
270                                        <code>
271                                         private
272                                         static
273                                       
274                                        boolean
275                                            <strong>_isValidCollection</strong>
276                                           (
277                                               
278                                                       
279                                                         o
280                                                   
281                                               
282                                            )
283                                        </code>
284                                       
285                                        <div class="description">
286                                            We want to be able to use getElementsByTagName as a collection
287to attach a group of events to.  Unfortunately, different
288browsers return different types of collections.  This function
289tests to determine if the object is array-like.  It will also
290fail if the object is an array, but is empty.
291                                        </div>
292
293                                        <div class="description">
294
295                                                <dl>
296                                                    <dt>Parameters:</dt>
297                                                        <dd>
298                                                            <code>o &lt;object&gt;</code>
299                                                             the object to test
300                                                        </dd>
301                                                </dl>
302
303                                                <dl>
304                                                    <dt>Returns:
305                                                    <code>
306                                                        boolean
307                                                    </code></dt>
308                                                    <dd>true if the object is array-like and populated</dd>
309                                                </dl>
310
311
312             
313
314                                        </div>
315
316                                    </div>
317                                    <hr />
318                                    </div>
319                                    <div class="private">
320                                    <h4>
321                                        <a name="method__load">_load</a></h4>
322                                    <div class="detail">
323                                        <code>
324                                         private
325                                         static
326                                       
327                                        void
328                                            <strong>_load</strong>
329                                           (
330                                            )
331                                        </code>
332                                       
333                                        <div class="description">
334                                            hook up any deferred listeners
335                                        </div>
336
337                                        <div class="description">
338
339
340                                                <dl>
341                                                    <dt>Returns:
342                                                    <code>
343                                                        void
344                                                    </code></dt>
345                                                    <dd></dd>
346                                                </dl>
347
348
349             
350
351                                        </div>
352
353                                    </div>
354                                    <hr />
355                                    </div>
356                                    <div class="private">
357                                    <h4>
358                                        <a name="method__tryPreloadAttach">_tryPreloadAttach</a></h4>
359                                    <div class="detail">
360                                        <code>
361                                         private
362                                         static
363                                       
364                                        void
365                                            <strong>_tryPreloadAttach</strong>
366                                           (
367                                            )
368                                        </code>
369                                       
370                                        <div class="description">
371                                            Polling function that runs before the onload event fires,
372attempting to attach to DOM Nodes as soon as they are
373available
374                                        </div>
375
376                                        <div class="description">
377
378
379                                                <dl>
380                                                    <dt>Returns:
381                                                    <code>
382                                                        void
383                                                    </code></dt>
384                                                    <dd></dd>
385                                                </dl>
386
387
388             
389
390                                        </div>
391
392                                    </div>
393                                    <hr />
394                                    </div>
395                                    <div class="private">
396                                    <h4>
397                                        <a name="method__unload">_unload</a></h4>
398                                    <div class="detail">
399                                        <code>
400                                         private
401                                         static
402                                       
403                                        void
404                                            <strong>_unload</strong>
405                                           (
406                                            )
407                                        </code>
408                                       
409                                        <div class="description">
410                                            Removes all listeners registered by pe.event.  Called
411automatically during the unload event.
412                                        </div>
413
414                                        <div class="description">
415
416
417                                                <dl>
418                                                    <dt>Returns:
419                                                    <code>
420                                                        void
421                                                    </code></dt>
422                                                    <dd></dd>
423                                                </dl>
424
425
426             
427
428                                        </div>
429
430                                    </div>
431                                    <hr />
432                                    </div>
433                                    <div class=" deprecated">
434                                    <h4>
435                                        <a name="method_addListener">addListener</a></h4>
436                                    <div class="detail">
437                                        <code>
438                                       
439                                         static
440                                       
441                                        Boolean
442                                            <strong>addListener</strong>
443                                           (
444                                               
445                                                       
446                                                         el
447                                                   
448                                               
449                                                        ,
450                                                         type
451                                                   
452                                               
453                                                        ,
454                                                         fn
455                                                   
456                                               
457                                                        ,
458                                                         obj
459                                                   
460                                               
461                                                        ,
462                                                         args
463                                                   
464                                               
465                                            )
466                                        </code>
467                                       
468                                        <div class="description">
469                                            Appends an event handler
470                                        </div>
471
472                                        <div class="description">
473
474                                                <dl>
475                                                    <dt>Parameters:</dt>
476                                                        <dd>
477                                                            <code>el &lt;String|HTMLElement|Array|NodeList&gt;</code>
478                                                             An id, an element
479reference, or a collection of ids and/or elements to assign the
480listener to.
481                                                        </dd>
482                                                        <dd>
483                                                            <code>type &lt;String&gt;</code>
484                                                                 The type of event to append
485                                                        </dd>
486                                                        <dd>
487                                                            <code>fn &lt;Function&gt;</code>
488                                                                    The method the event invokes
489                                                        </dd>
490                                                        <dd>
491                                                            <code>obj &lt;Object&gt;</code>
492                                                                An arbitrary object that will be
493passed as a parameter to the handler
494                                                        </dd>
495                                                        <dd>
496                                                            <code>args &lt;Boolean|object&gt;</code>
497                                                             1..n ar
498                                                        </dd>
499                                                </dl>
500
501                                                <dl>
502                                                    <dt>Returns:
503                                                    <code>
504                                                        Boolean
505                                                    </code></dt>
506                                                    <dd>True if the action was successful or defered,
507false if one or more of the elements
508could not have the listener attached,
509or if the operation throws an exception.</dd>
510                                                </dl>
511
512
513             
514                                            <div class="deprecated">
515                                                <strong>Deprecated</strong> Use Y.on instead.  This will be removed in PR2
516                                            </div>       
517
518                                        </div>
519
520                                    </div>
521                                    <hr />
522                                    </div>
523                                    <div class="">
524                                    <h4>
525                                        <a name="method_generateId">generateId</a></h4>
526                                    <div class="detail">
527                                        <code>
528                                       
529                                         static
530                                       
531                                        string
532                                            <strong>generateId</strong>
533                                           (
534                                               
535                                                       
536                                                         el
537                                                   
538                                               
539                                            )
540                                        </code>
541                                       
542                                        <div class="description">
543                                            Generates an unique ID for the element if it does not already
544have one.
545                                        </div>
546
547                                        <div class="description">
548
549                                                <dl>
550                                                    <dt>Parameters:</dt>
551                                                        <dd>
552                                                            <code>el &lt;object&gt;</code>
553                                                             the element to create the id for
554                                                        </dd>
555                                                </dl>
556
557                                                <dl>
558                                                    <dt>Returns:
559                                                    <code>
560                                                        string
561                                                    </code></dt>
562                                                    <dd>the resulting id of the element</dd>
563                                                </dl>
564
565
566             
567
568                                        </div>
569
570                                    </div>
571                                    <hr />
572                                    </div>
573                                    <div class="">
574                                    <h4>
575                                        <a name="method_getEvent">getEvent</a></h4>
576                                    <div class="detail">
577                                        <code>
578                                       
579                                         static
580                                       
581                                        Event
582                                            <strong>getEvent</strong>
583                                           (
584                                               
585                                                       
586                                                         e
587                                                   
588                                               
589                                                        ,
590                                                         boundEl
591                                                   
592                                               
593                                            )
594                                        </code>
595                                       
596                                        <div class="description">
597                                            Finds the event in the window object, the caller's arguments, or
598in the arguments of another method in the callstack.  This is
599executed automatically for events registered through the event
600manager, so the implementer should not normally need to execute
601this function at all.
602                                        </div>
603
604                                        <div class="description">
605
606                                                <dl>
607                                                    <dt>Parameters:</dt>
608                                                        <dd>
609                                                            <code>e &lt;Event&gt;</code>
610                                                             the event parameter from the handler
611                                                        </dd>
612                                                        <dd>
613                                                            <code>boundEl &lt;HTMLElement&gt;</code>
614                                                             the element the listener is attached to
615                                                        </dd>
616                                                </dl>
617
618                                                <dl>
619                                                    <dt>Returns:
620                                                    <code>
621                                                        Event
622                                                    </code></dt>
623                                                    <dd>the event</dd>
624                                                </dl>
625
626
627             
628
629                                        </div>
630
631                                    </div>
632                                    <hr />
633                                    </div>
634                                    <div class="">
635                                    <h4>
636                                        <a name="method_getListeners">getListeners</a></h4>
637                                    <div class="detail">
638                                        <code>
639                                       
640                                         static
641                                       
642                                        Y.Custom.Event
643                                            <strong>getListeners</strong>
644                                           (
645                                               
646                                                       
647                                                         el
648                                                   
649                                               
650                                                        ,
651                                                         type
652                                                   
653                                               
654                                            )
655                                        </code>
656                                       
657                                        <div class="description">
658                                            Returns all listeners attached to the given element via addListener.
659Optionally, you can specify a specific type of event to return.
660                                        </div>
661
662                                        <div class="description">
663
664                                                <dl>
665                                                    <dt>Parameters:</dt>
666                                                        <dd>
667                                                            <code>el &lt;HTMLElement|string&gt;</code>
668                                                              the element or element id to inspect
669                                                        </dd>
670                                                        <dd>
671                                                            <code>type &lt;string&gt;</code>
672                                                              optional type of listener to return. If
673left out, all listeners will be returned
674                                                        </dd>
675                                                </dl>
676
677                                                <dl>
678                                                    <dt>Returns:
679                                                    <code>
680                                                        Y.Custom.Event
681                                                    </code></dt>
682                                                    <dd>the custom event wrapper for the DOM event(s)</dd>
683                                                </dl>
684
685
686             
687
688                                        </div>
689
690                                    </div>
691                                    <hr />
692                                    </div>
693                                    <div class="private">
694                                    <h4>
695                                        <a name="method_nativeAdd">nativeAdd</a></h4>
696                                    <div class="detail">
697                                        <code>
698                                         private
699                                         static
700                                       
701                                        void
702                                            <strong>nativeAdd</strong>
703                                           (
704                                               
705                                                       
706                                                         el
707                                                   
708                                               
709                                                        ,
710                                                         type
711                                                   
712                                               
713                                                        ,
714                                                         fn
715                                                   
716                                               
717                                                        ,
718                                                         capture
719                                                   
720                                               
721                                            )
722                                        </code>
723                                       
724                                        <div class="description">
725                                            Adds a DOM event directly without the caching, cleanup, context adj, etc
726                                        </div>
727
728                                        <div class="description">
729
730                                                <dl>
731                                                    <dt>Parameters:</dt>
732                                                        <dd>
733                                                            <code>el &lt;HTMLElement&gt;</code>
734                                                                  the element to bind the handler to
735                                                        </dd>
736                                                        <dd>
737                                                            <code>type &lt;string&gt;</code>
738                                                               the type of event handler
739                                                        </dd>
740                                                        <dd>
741                                                            <code>fn &lt;function&gt;</code>
742                                                                  the callback to invoke
743                                                        </dd>
744                                                        <dd>
745                                                            <code>capture &lt;boolen&gt;</code>
746                                                             capture or bubble phase
747                                                        </dd>
748                                                </dl>
749
750                                                <dl>
751                                                    <dt>Returns:
752                                                    <code>
753                                                        void
754                                                    </code></dt>
755                                                    <dd></dd>
756                                                </dl>
757
758
759             
760
761                                        </div>
762
763                                    </div>
764                                    <hr />
765                                    </div>
766                                    <div class="private">
767                                    <h4>
768                                        <a name="method_nativeRemove">nativeRemove</a></h4>
769                                    <div class="detail">
770                                        <code>
771                                         private
772                                         static
773                                       
774                                        void
775                                            <strong>nativeRemove</strong>
776                                           (
777                                               
778                                                       
779                                                         el
780                                                   
781                                               
782                                                        ,
783                                                         type
784                                                   
785                                               
786                                                        ,
787                                                         fn
788                                                   
789                                               
790                                                        ,
791                                                         capture
792                                                   
793                                               
794                                            )
795                                        </code>
796                                       
797                                        <div class="description">
798                                            Basic remove listener
799                                        </div>
800
801                                        <div class="description">
802
803                                                <dl>
804                                                    <dt>Parameters:</dt>
805                                                        <dd>
806                                                            <code>el &lt;HTMLElement&gt;</code>
807                                                                  the element to bind the handler to
808                                                        </dd>
809                                                        <dd>
810                                                            <code>type &lt;string&gt;</code>
811                                                               the type of event handler
812                                                        </dd>
813                                                        <dd>
814                                                            <code>fn &lt;function&gt;</code>
815                                                                  the callback to invoke
816                                                        </dd>
817                                                        <dd>
818                                                            <code>capture &lt;boolen&gt;</code>
819                                                             capture or bubble phase
820                                                        </dd>
821                                                </dl>
822
823                                                <dl>
824                                                    <dt>Returns:
825                                                    <code>
826                                                        void
827                                                    </code></dt>
828                                                    <dd></dd>
829                                                </dl>
830
831
832             
833
834                                        </div>
835
836                                    </div>
837                                    <hr />
838                                    </div>
839                                    <div class="">
840                                    <h4>
841                                        <a name="method_on">on</a></h4>
842                                    <div class="detail">
843                                        <code>
844                                       
845                                         static
846                                       
847                                        void
848                                            <strong>on</strong>
849                                           (
850                                            )
851                                        </code>
852                                       
853                                        <div class="description">
854                                            Y.Event.on is an alias for addListener
855                                        </div>
856
857                                        <div class="description">
858
859
860                                                <dl>
861                                                    <dt>Returns:
862                                                    <code>
863                                                        void
864                                                    </code></dt>
865                                                    <dd></dd>
866                                                </dl>
867
868
869             
870
871                                        </div>
872
873                                    </div>
874                                    <hr />
875                                    </div>
876                                    <div class=" deprecated">
877                                    <h4>
878                                        <a name="method_onAvailable">onAvailable</a></h4>
879                                    <div class="detail">
880                                        <code>
881                                       
882                                         static
883                                       
884                                        void
885                                            <strong>onAvailable</strong>
886                                           (
887                                               
888                                                       
889                                                         id
890                                                   
891                                               
892                                                        ,
893                                                         fn
894                                                   
895                                               
896                                                        ,
897                                                         p_obj
898                                                   
899                                               
900                                                        ,
901                                                         p_override
902                                                   
903                                               
904                                                        ,
905                                                         checkContent
906                                                   
907                                               
908                                            )
909                                        </code>
910                                       
911                                        <div class="description">
912                                            Executes the supplied callback when the item with the supplied
913id is found.  This is meant to be used to execute behavior as
914soon as possible as the page loads.  If you use this after the
915initial page load it will poll for a fixed time for the element.
916The number of times it will poll and the frequency are
917configurable.  By default it will poll for 10 seconds.
918<p>The callback is executed with a single parameter:
919the custom object parameter, if provided.</p>
920                                        </div>
921
922                                        <div class="description">
923
924                                                <dl>
925                                                    <dt>Parameters:</dt>
926                                                        <dd>
927                                                            <code>id &lt;string||string[]&gt;</code>
928                                                             the id of the element, or an array
929of ids to look for.
930                                                        </dd>
931                                                        <dd>
932                                                            <code>fn &lt;function&gt;</code>
933                                                             what to execute when the element is found.
934                                                        </dd>
935                                                        <dd>
936                                                            <code>p_obj &lt;object&gt;</code>
937                                                             an optional object to be passed back as
938a parameter to fn.
939                                                        </dd>
940                                                        <dd>
941                                                            <code>p_override &lt;boolean|object&gt;</code>
942                                                             If set to true, fn will execute
943in the context of p_obj, if set to an object it
944will execute in the context of that object
945                                                        </dd>
946                                                        <dd>
947                                                            <code>checkContent &lt;boolean&gt;</code>
948                                                              check child node readiness (onContentReady)
949                                                        </dd>
950                                                </dl>
951
952                                                <dl>
953                                                    <dt>Returns:
954                                                    <code>
955                                                        void
956                                                    </code></dt>
957                                                    <dd></dd>
958                                                </dl>
959
960
961             
962                                            <div class="deprecated">
963                                                <strong>Deprecated</strong> This will be replaced with a special Y.on custom event
964                                            </div>       
965
966                                        </div>
967
968                                    </div>
969                                    <hr />
970                                    </div>
971                                    <div class=" deprecated">
972                                    <h4>
973                                        <a name="method_onContentReady">onContentReady</a></h4>
974                                    <div class="detail">
975                                        <code>
976                                       
977                                         static
978                                       
979                                        void
980                                            <strong>onContentReady</strong>
981                                           (
982                                               
983                                                       
984                                                         id
985                                                   
986                                               
987                                                        ,
988                                                         fn
989                                                   
990                                               
991                                                        ,
992                                                         p_obj
993                                                   
994                                               
995                                                        ,
996                                                         p_override
997                                                   
998                                               
999                                            )
1000                                        </code>
1001                                       
1002                                        <div class="description">
1003                                            Works the same way as onAvailable, but additionally checks the
1004state of sibling elements to determine if the content of the
1005available element is safe to modify.
1006<p>The callback is executed with a single parameter:
1007the custom object parameter, if provided.</p>
1008                                        </div>
1009
1010                                        <div class="description">
1011
1012                                                <dl>
1013                                                    <dt>Parameters:</dt>
1014                                                        <dd>
1015                                                            <code>id &lt;string&gt;</code>
1016                                                             the id of the element to look for.
1017                                                        </dd>
1018                                                        <dd>
1019                                                            <code>fn &lt;function&gt;</code>
1020                                                             what to execute when the element is ready.
1021                                                        </dd>
1022                                                        <dd>
1023                                                            <code>p_obj &lt;object&gt;</code>
1024                                                             an optional object to be passed back as
1025a parameter to fn.
1026                                                        </dd>
1027                                                        <dd>
1028                                                            <code>p_override &lt;boolean|object&gt;</code>
1029                                                             If set to true, fn will execute
1030in the context of p_obj.  If an object, fn will
1031exectute in the context of that object
1032                                                        </dd>
1033                                                </dl>
1034
1035                                                <dl>
1036                                                    <dt>Returns:
1037                                                    <code>
1038                                                        void
1039                                                    </code></dt>
1040                                                    <dd></dd>
1041                                                </dl>
1042
1043
1044             
1045                                            <div class="deprecated">
1046                                                <strong>Deprecated</strong> This will be replaced with a special Y.on custom event
1047                                            </div>       
1048
1049                                        </div>
1050
1051                                    </div>
1052                                    <hr />
1053                                    </div>
1054                                    <div class=" deprecated">
1055                                    <h4>
1056                                        <a name="method_onDOMReady">onDOMReady</a></h4>
1057                                    <div class="detail">
1058                                        <code>
1059                                       
1060                                         static
1061                                       
1062                                        void
1063                                            <strong>onDOMReady</strong>
1064                                           (
1065                                               
1066                                                       
1067                                                         fn
1068                                                   
1069                                               
1070                                            )
1071                                        </code>
1072                                       
1073                                        <div class="description">
1074                                            Executes the supplied callback when the DOM is first usable.  This
1075will execute immediately if called after the DOMReady event has
1076fired.   @todo the DOMContentReady event does not fire when the
1077script is dynamically injected into the page.  This means the
1078DOMReady custom event will never fire in FireFox or Opera when the
1079library is injected.  It _will_ fire in Safari, and the IE
1080implementation would allow for us to fire it if the defered script
1081is not available.  We want this to behave the same in all browsers.
1082Is there a way to identify when the script has been injected
1083instead of included inline?  Is there a way to know whether the
1084window onload event has fired without having had a listener attached
1085to it when it did so?
1086<p>The callback is a Event.Custom, so the signature is:</p>
1087<p>type &lt;string&gt;, args &lt;array&gt;, customobject &lt;object&gt;</p>
1088<p>For DOMReady events, there are no fire argments, so the
1089signature is:</p>
1090<p>"DOMReady", [], obj</p>
1091                                        </div>
1092
1093                                        <div class="description">
1094
1095                                                <dl>
1096                                                    <dt>Parameters:</dt>
1097                                                        <dd>
1098                                                            <code>fn &lt;function&gt;</code>
1099                                                             what to execute when the element is found.
1100                                                        </dd>
1101                                                </dl>
1102
1103                                                <dl>
1104                                                    <dt>Returns:
1105                                                    <code>
1106                                                        void
1107                                                    </code></dt>
1108                                                    <dd></dd>
1109                                                </dl>
1110
1111
1112             
1113                                            <div class="deprecated">
1114                                                <strong>Deprecated</strong> Use Y.on('event:ready');
1115                                            </div>       
1116
1117                                        </div>
1118
1119                                    </div>
1120                                    <hr />
1121                                    </div>
1122                                    <div class="">
1123                                    <h4>
1124                                        <a name="method_purgeElement">purgeElement</a></h4>
1125                                    <div class="detail">
1126                                        <code>
1127                                       
1128                                         static
1129                                       
1130                                        void
1131                                            <strong>purgeElement</strong>
1132                                           (
1133                                               
1134                                                       
1135                                                         el
1136                                                   
1137                                               
1138                                                        ,
1139                                                         recurse
1140                                                   
1141                                               
1142                                                        ,
1143                                                         type
1144                                                   
1145                                               
1146                                            )
1147                                        </code>
1148                                       
1149                                        <div class="description">
1150                                            Removes all listeners attached to the given element via addListener.
1151Optionally, the node's children can also be purged.
1152Optionally, you can specify a specific type of event to remove.
1153                                        </div>
1154
1155                                        <div class="description">
1156
1157                                                <dl>
1158                                                    <dt>Parameters:</dt>
1159                                                        <dd>
1160                                                            <code>el &lt;HTMLElement&gt;</code>
1161                                                             the element to purge
1162                                                        </dd>
1163                                                        <dd>
1164                                                            <code>recurse &lt;boolean&gt;</code>
1165                                                             recursively purge this element's children
1166as well.  Use with caution.
1167                                                        </dd>
1168                                                        <dd>
1169                                                            <code>type &lt;string&gt;</code>
1170                                                             optional type of listener to purge. If
1171left out, all listeners will be removed
1172                                                        </dd>
1173                                                </dl>
1174
1175                                                <dl>
1176                                                    <dt>Returns:
1177                                                    <code>
1178                                                        void
1179                                                    </code></dt>
1180                                                    <dd></dd>
1181                                                </dl>
1182
1183
1184             
1185
1186                                        </div>
1187
1188                                    </div>
1189                                    <hr />
1190                                    </div>
1191                                    <div class="">
1192                                    <h4>
1193                                        <a name="method_removeListener">removeListener</a></h4>
1194                                    <div class="detail">
1195                                        <code>
1196                                       
1197                                         static
1198                                       
1199                                        boolean
1200                                            <strong>removeListener</strong>
1201                                           (
1202                                               
1203                                                       
1204                                                         el
1205                                                   
1206                                               
1207                                                        ,
1208                                                         type
1209                                                   
1210                                               
1211                                                        ,
1212                                                         fn
1213                                                   
1214                                               
1215                                            )
1216                                        </code>
1217                                       
1218                                        <div class="description">
1219                                            Removes an event listener.  Supports the signature the event was bound
1220with, but the preferred way to remove listeners is using the handle
1221that is returned when using Y.on
1222                                        </div>
1223
1224                                        <div class="description">
1225
1226                                                <dl>
1227                                                    <dt>Parameters:</dt>
1228                                                        <dd>
1229                                                            <code>el &lt;String|HTMLElement|Array|NodeList&gt;</code>
1230                                                             An id, an element
1231reference, or a collection of ids and/or elements to remove
1232the listener from.
1233                                                        </dd>
1234                                                        <dd>
1235                                                            <code>type &lt;String&gt;</code>
1236                                                             the type of event to remove.
1237                                                        </dd>
1238                                                        <dd>
1239                                                            <code>fn &lt;Function&gt;</code>
1240                                                             the method the event invokes.  If fn is
1241undefined, then all event handlers for the type of event are *  removed.
1242                                                        </dd>
1243                                                </dl>
1244
1245                                                <dl>
1246                                                    <dt>Returns:
1247                                                    <code>
1248                                                        boolean
1249                                                    </code></dt>
1250                                                    <dd>true if the unbind was successful, false *  otherwise.</dd>
1251                                                </dl>
1252
1253
1254             
1255
1256                                        </div>
1257
1258                                    </div>
1259                                    <hr />
1260                                    </div>
1261                                    <div class="private">
1262                                    <h4>
1263                                        <a name="method_resolve">resolve</a></h4>
1264                                    <div class="detail">
1265                                        <code>
1266                                         private
1267                                       
1268                                       
1269                                        void
1270                                            <strong>resolve</strong>
1271                                           (
1272                                            )
1273                                        </code>
1274                                       
1275                                        <div class="description">
1276                                            Returns a wrapped node.  Intended to be used on event targets,
1277so it will return the node's parent if the target is a text
1278node
1279                                        </div>
1280
1281                                        <div class="description">
1282
1283
1284                                                <dl>
1285                                                    <dt>Returns:
1286                                                    <code>
1287                                                        void
1288                                                    </code></dt>
1289                                                    <dd></dd>
1290                                                </dl>
1291
1292
1293             
1294
1295                                        </div>
1296
1297                                    </div>
1298                                    <hr />
1299                                    </div>
1300                                    <div class="private">
1301                                    <h4>
1302                                        <a name="method_startInterval">startInterval</a></h4>
1303                                    <div class="detail">
1304                                        <code>
1305                                         private
1306                                         static
1307                                       
1308                                        void
1309                                            <strong>startInterval</strong>
1310                                           (
1311                                            )
1312                                        </code>
1313                                       
1314                                        <div class="description">
1315                                           
1316                                        </div>
1317
1318                                        <div class="description">
1319
1320
1321                                                <dl>
1322                                                    <dt>Returns:
1323                                                    <code>
1324                                                        void
1325                                                    </code></dt>
1326                                                    <dd></dd>
1327                                                </dl>
1328
1329
1330             
1331
1332                                        </div>
1333
1334                                    </div>
1335                                    <hr />
1336                                    </div>
1337                            </div>
1338                        </div>
1339
1340
1341
1342
1343
1344
1345
1346                        </div>
1347                </div>
1348                <div class="yui-b">
1349            <div class="nav">
1350
1351                    <div class="module">
1352                        <h4>Modules</h4>
1353                        <ul class="content">
1354
1355                                <li class=""><a href="module_anim.html">anim</a></li>
1356
1357                                <li class=""><a href="module_attribute.html">attribute</a></li>
1358
1359                                <li class=""><a href="module_base.html">base</a></li>
1360
1361                                <li class=""><a href="module_cookie.html">cookie</a></li>
1362
1363                                <li class=""><a href="module_dd.html">dd</a></li>
1364
1365                                <li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
1366
1367                                <li class=""><a href="module_dom.html">dom</a></li>
1368
1369                                <li class=""><a href="module_dump.html">dump</a></li>
1370
1371                                <li class="selected"><a href="module_event.html">event</a></li>
1372
1373                                <li class=""><a href="module_io.html">io</a></li>
1374
1375                                <li class=""><a href="module_json.html">json</a></li>
1376
1377                                <li class=""><a href="module_node.html">node</a></li>
1378
1379                                <li class=""><a href="module_oop.html">oop</a></li>
1380
1381                                <li class=""><a href="module_queue.html">queue</a></li>
1382
1383                                <li class=""><a href="module_substitute.html">substitute</a></li>
1384
1385                                <li class=""><a href="module_yui.html">yui</a></li>
1386                        </ul>
1387                    </div>
1388
1389                    <div class="module">
1390                        <h4>Classes</h4>
1391                        <ul class="content">
1392                                <li class=""><a href="Do.html">Do</a></li>
1393                                <li class=""><a href="Do.AlterArgs.html">Do.AlterArgs</a></li>
1394                                <li class=""><a href="Do.AlterReturn.html">Do.AlterReturn</a></li>
1395                                <li class=""><a href="Do.Error.html">Do.Error</a></li>
1396                                <li class=""><a href="Do.Method.html">Do.Method</a></li>
1397                                <li class="selected"><a href="Event.html">Event</a></li>
1398                                <li class=""><a href="Event.Custom.html">Event.Custom</a></li>
1399                                <li class=""><a href="Event.Facade.html">Event.Facade</a></li>
1400                                <li class=""><a href="Event.Handle.html">Event.Handle</a></li>
1401                                <li class=""><a href="Event.Subscriber.html">Event.Subscriber</a></li>
1402                                <li class=""><a href="Event.Target.html">Event.Target</a></li>
1403                        </ul>
1404                    </div>
1405
1406                    <div class="module">
1407                        <h4>Files</h4>
1408                        <ul class="content">       
1409                                <li class=""><a href="event-custom.js.html">event-custom.js</a></li>
1410                                <li class=""><a href="event-do.js.html">event-do.js</a></li>
1411                                <li class=""><a href="event-dom.js.html">event-dom.js</a></li>
1412                                <li class=""><a href="event-facade.js.html">event-facade.js</a></li>
1413                                <li class=""><a href="event-ready.js.html">event-ready.js</a></li>
1414                                <li class=""><a href="event-target.js.html">event-target.js</a></li>
1415                                <li class=""><a href="event.js.html">event.js</a></li>
1416                        </ul>
1417                    </div>
1418
1419                    <div class="module">
1420                        <h4>Properties</h4>
1421                        <ul class="content">       
1422                                <li class="private"><a href="#property__avail">_avail</a>
1423                                        <!--<code>&lt;object&gt;</code>-->
1424                                </li>
1425                                <li class="private"><a href="#property__dri">_dri</a>
1426                                        <!--<code>&lt;object&gt;</code>-->
1427                                </li>
1428                                <li class="private"><a href="#property__el_events">_el_events</a>
1429                                        <!--<code>&lt;object&gt;</code>-->
1430                                </li>
1431                                <li class="private"><a href="#property__interval">_interval</a>
1432                                        <!--<code>&lt;object&gt;</code>-->
1433                                </li>
1434                                <li class="private"><a href="#property__retryCount">_retryCount</a>
1435                                        <!--<code>&lt;object&gt;</code>-->
1436                                </li>
1437                                <li class="private"><a href="#property__wrappers">_wrappers</a>
1438                                        <!--<code>&lt;object&gt;</code>-->
1439                                </li>
1440                                <li class=""><a href="#property_DOMReady">DOMReady</a>
1441                                        <!--<code>&lt;object&gt;</code>-->
1442                                </li>
1443                                <li class=""><a href="#property_lastError">lastError</a>
1444                                        <!--<code>&lt;object&gt;</code>-->
1445                                </li>
1446                                <li class="private"><a href="#property_loadComplete">loadComplete</a>
1447                                        <!--<code>&lt;object&gt;</code>-->
1448                                </li>
1449                                <li class=""><a href="#property_POLL_INTERVAL">POLL_INTERVAL</a>
1450                                        <!--<code>&lt;object&gt;</code>-->
1451                                </li>
1452                                <li class=""><a href="#property_POLL_RETRYS">POLL_RETRYS</a>
1453                                        <!--<code>&lt;object&gt;</code>-->
1454                                </li>
1455                                <li class="private"><a href="#property_webkitKeymap">webkitKeymap</a>
1456                                        <!--<code>&lt;object&gt;</code>-->
1457                                </li>
1458                        </ul>
1459                    </div>
1460
1461                    <div class="module">
1462                        <h4>Methods</h4>
1463                        <ul class="content">       
1464                                <li class="private"><!--<code>boolean</code>-->
1465                                <a href="#method__isValidCollection">_isValidCollection</a>
1466                                </li>
1467                                <li class="private"><!--<code>void</code>-->
1468                                <a href="#method__load">_load</a>
1469                                </li>
1470                                <li class="private"><!--<code>void</code>-->
1471                                <a href="#method__tryPreloadAttach">_tryPreloadAttach</a>
1472                                </li>
1473                                <li class="private"><!--<code>void</code>-->
1474                                <a href="#method__unload">_unload</a>
1475                                </li>
1476                                <li class=" deprecated"><!--<code>Boolean</code>-->
1477                                <a href="#method_addListener">addListener</a>
1478                                </li>
1479                                <li class=""><!--<code>string</code>-->
1480                                <a href="#method_generateId">generateId</a>
1481                                </li>
1482                                <li class=""><!--<code>Event</code>-->
1483                                <a href="#method_getEvent">getEvent</a>
1484                                </li>
1485                                <li class=""><!--<code>Y.Custom.Event</code>-->
1486                                <a href="#method_getListeners">getListeners</a>
1487                                </li>
1488                                <li class="private"><!--<code>void</code>-->
1489                                <a href="#method_nativeAdd">nativeAdd</a>
1490                                </li>
1491                                <li class="private"><!--<code>void</code>-->
1492                                <a href="#method_nativeRemove">nativeRemove</a>
1493                                </li>
1494                                <li class=""><!--<code>void</code>-->
1495                                <a href="#method_on">on</a>
1496                                </li>
1497                                <li class=" deprecated"><!--<code>void</code>-->
1498                                <a href="#method_onAvailable">onAvailable</a>
1499                                </li>
1500                                <li class=" deprecated"><!--<code>void</code>-->
1501                                <a href="#method_onContentReady">onContentReady</a>
1502                                </li>
1503                                <li class=" deprecated"><!--<code>void</code>-->
1504                                <a href="#method_onDOMReady">onDOMReady</a>
1505                                </li>
1506                                <li class=""><!--<code>void</code>-->
1507                                <a href="#method_purgeElement">purgeElement</a>
1508                                </li>
1509                                <li class=""><!--<code>boolean</code>-->
1510                                <a href="#method_removeListener">removeListener</a>
1511                                </li>
1512                                <li class="private"><!--<code>void</code>-->
1513                                <a href="#method_resolve">resolve</a>
1514                                </li>
1515                                <li class="private"><!--<code>void</code>-->
1516                                <a href="#method_startInterval">startInterval</a>
1517                                </li>
1518                        </ul>
1519                    </div>
1520
1521
1522
1523            </div>
1524                </div>
1525        </div>
1526        <div id="ft">
1527        <hr />
1528        Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
1529        </div>
1530</div>
1531</body>
1532</html>
Note: See TracBrowser for help on using the repository browser.