| changeset 0 | 40c8f766c9b8 |
| -1:000000000000 | 0:40c8f766c9b8 |
|---|---|
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 available.js (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>event <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.html" title="event">event</a> |
|
22 |
|
23 > available.js (source view) |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="c">/**</span> |
|
51 <span class="c"> * DOM event listener abstraction layer</span> |
|
52 <span class="c"> * @module event</span> |
|
53 <span class="c"> * @submodule event-base</span> |
|
54 <span class="c"> */</span> |
|
55 |
|
56 <span class="c">/**</span> |
|
57 <span class="c"> * Executes the callback as soon as the specified element </span> |
|
58 <span class="c"> * is detected in the DOM.</span> |
|
59 <span class="c"> * @event available</span> |
|
60 <span class="c"> * @param type {string} 'available'</span> |
|
61 <span class="c"> * @param fn {function} the callback function to execute.</span> |
|
62 <span class="c"> * @param el {string|HTMLElement|collection} the element(s) to attach</span> |
|
63 <span class="c"> * @param context optional argument that specifies what 'this' refers to.</span> |
|
64 <span class="c"> * @param args* 0..n additional arguments to pass on to the callback function.</span> |
|
65 <span class="c"> * These arguments will be added after the event object.</span> |
|
66 <span class="c"> * @return {EventHandle} the detach handle</span> |
|
67 <span class="c"> * @for YUI</span> |
|
68 <span class="c"> */</span> |
|
69 <span class="nx">Y</span><span class="o">.</span><span class="nx">Env</span><span class="o">.</span><span class="nx">evt</span><span class="o">.</span><span class="nx">plugins</span><span class="o">.</span><span class="nx">available</span> <span class="o">=</span> <span class="o">{</span> |
|
70 <span class="nx">on</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">type</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">id</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
71 <span class="k">var</span> <span class="nx">a</span> <span class="o">=</span> <span class="nx">arguments</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">4</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span> <span class="o">:</span> <span class="o">[];</span> |
|
72 <span class="k">return</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Event</span><span class="o">.</span><span class="nx">onAvailable</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">Event</span><span class="o">,</span> <span class="nx">id</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">o</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
73 <span class="o">}</span> |
|
74 <span class="o">};</span> |
|
75 |
|
76 <span class="c">/**</span> |
|
77 <span class="c"> * Executes the callback as soon as the specified element </span> |
|
78 <span class="c"> * is detected in the DOM with a nextSibling property</span> |
|
79 <span class="c"> * (indicating that the element's children are available)</span> |
|
80 <span class="c"> * @event contentready</span> |
|
81 <span class="c"> * @param type {string} 'contentready'</span> |
|
82 <span class="c"> * @param fn {function} the callback function to execute.</span> |
|
83 <span class="c"> * @param el {string|HTMLElement|collection} the element(s) to attach</span> |
|
84 <span class="c"> * @param context optional argument that specifies what 'this' refers to.</span> |
|
85 <span class="c"> * @param args* 0..n additional arguments to pass on to the callback function.</span> |
|
86 <span class="c"> * These arguments will be added after the event object.</span> |
|
87 <span class="c"> * @return {EventHandle} the detach handle</span> |
|
88 <span class="c"> * @for YUI</span> |
|
89 <span class="c"> */</span> |
|
90 <span class="nx">Y</span><span class="o">.</span><span class="nx">Env</span><span class="o">.</span><span class="nx">evt</span><span class="o">.</span><span class="nx">plugins</span><span class="o">.</span><span class="nx">contentready</span> <span class="o">=</span> <span class="o">{</span> |
|
91 <span class="nx">on</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">type</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">id</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
92 <span class="k">var</span> <span class="nx">a</span> <span class="o">=</span> <span class="nx">arguments</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">4</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">4</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span> <span class="o">:</span> <span class="o">[];</span> |
|
93 <span class="k">return</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Event</span><span class="o">.</span><span class="nx">onContentReady</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">Event</span><span class="o">,</span> <span class="nx">id</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">o</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
94 <span class="o">}</span> |
|
95 <span class="o">};</span> |
|
96 </pre></div> |
|
97 |
|
98 </div> |
|
99 </div> |
|
100 </div> |
|
101 <div class="yui-b"> |
|
102 <div class="nav"> |
|
103 |
|
104 <div id="moduleList" class="module"> |
|
105 <h4>Modules</h4> |
|
106 <ul class="content"> |
|
107 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
108 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
109 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
110 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
111 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
112 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
113 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
114 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
115 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
116 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
117 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
118 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
119 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
120 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
121 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
122 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
123 <li class="selected"><a href="module_event.html" title="event">event</a></li> |
|
124 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
125 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
126 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
127 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
128 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
129 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
130 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
131 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
132 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
133 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
134 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
135 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
136 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
137 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
138 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
139 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
140 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
141 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
142 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
143 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
144 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
145 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
146 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
147 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
148 </ul> |
|
149 </div> |
|
150 |
|
151 <div id="classList" class="module"> |
|
152 <h4>Classes</h4> |
|
153 <ul class="content"> |
|
154 <li class=""><a href="DOMEventFacade.html" title="DOMEventFacade">DOMEventFacade</a></li> |
|
155 <li class=""><a href="Event.html" title="Event">Event</a></li> |
|
156 </ul> |
|
157 </div> |
|
158 |
|
159 <div id="fileList" class="module"> |
|
160 <h4>Files</h4> |
|
161 <ul class="content"> |
|
162 <li class="selected"><a href="available.js.html" title="available.js">available.js</a></li> |
|
163 <li class=""><a href="delegate.js.html" title="delegate.js">delegate.js</a></li> |
|
164 <li class=""><a href="event-dom.js.html" title="event-dom.js">event-dom.js</a></li> |
|
165 <li class=""><a href="event-facade-dom.js.html" title="event-facade-dom.js">event-facade-dom.js</a></li> |
|
166 <li class=""><a href="event-ready-base.js.html" title="event-ready-base.js">event-ready-base.js</a></li> |
|
167 <li class=""><a href="event-ready.js.html" title="event-ready.js">event-ready.js</a></li> |
|
168 <li class=""><a href="focusblur.js.html" title="focusblur.js">focusblur.js</a></li> |
|
169 <li class=""><a href="key.js.html" title="key.js">key.js</a></li> |
|
170 <li class=""><a href="mouseentermouseleave.js.html" title="mouseentermouseleave.js">mouseentermouseleave.js</a></li> |
|
171 <li class=""><a href="mousewheel.js.html" title="mousewheel.js">mousewheel.js</a></li> |
|
172 <li class=""><a href="resize-window.js.html" title="resize-window.js">resize-window.js</a></li> |
|
173 </ul> |
|
174 </div> |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 </div> |
|
181 </div> |
|
182 </div> |
|
183 <div id="ft"> |
|
184 <hr /> |
|
185 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
186 </div> |
|
187 </div> |
|
188 <script type="text/javascript"> |
|
189 ALL_YUI_PROPS = [{"access": "", "host": "Event", "name": "attach", "url": "Event.html#method_attach", "type": "method"}, {"access": "private", "host": "Event", "name": "_avail", "url": "Event.html#property__avail", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "button", "url": "DOMEventFacade.html#property_button", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "charCode", "url": "DOMEventFacade.html#property_charCode", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "currentTarget", "url": "DOMEventFacade.html#property_currentTarget", "type": "property"}, {"access": "", "host": "Event", "name": "detach", "url": "Event.html#method_detach", "type": "method"}, {"access": "", "host": "Event", "name": "DOMReady", "url": "Event.html#property_DOMReady", "type": "property"}, {"access": "private", "host": "Event", "name": "_dri", "url": "Event.html#property__dri", "type": "property"}, {"access": "private", "host": "Event", "name": "_el_events", "url": "Event.html#property__el_events", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "_event", "url": "DOMEventFacade.html#property__event", "type": "property"}, {"access": "", "host": "Event", "name": "generateId", "url": "Event.html#method_generateId", "type": "method"}, {"access": "", "host": "Event", "name": "getEvent", "url": "Event.html#method_getEvent", "type": "method"}, {"access": "", "host": "Event", "name": "getListeners", "url": "Event.html#method_getListeners", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "halt", "url": "DOMEventFacade.html#method_halt", "type": "method"}, {"access": "private", "host": "Event", "name": "_interval", "url": "Event.html#property__interval", "type": "property"}, {"access": "private", "host": "Event", "name": "_isValidCollection", "url": "Event.html#method__isValidCollection", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "keyCode", "url": "DOMEventFacade.html#property_keyCode", "type": "property"}, {"access": "", "host": "Event", "name": "lastError", "url": "Event.html#property_lastError", "type": "property"}, {"access": "private", "host": "Event", "name": "_load", "url": "Event.html#method__load", "type": "method"}, {"access": "private", "host": "Event", "name": "_loadComplete", "url": "Event.html#property__loadComplete", "type": "property"}, {"access": "private", "host": "Event", "name": "nativeAdd", "url": "Event.html#method_nativeAdd", "type": "method"}, {"access": "private", "host": "Event", "name": "nativeRemove", "url": "Event.html#method_nativeRemove", "type": "method"}, {"access": "", "host": "Event", "name": "onAvailable", "url": "Event.html#method_onAvailable", "type": "method"}, {"access": "", "host": "Event", "name": "onContentReady", "url": "Event.html#method_onContentReady", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "pageX", "url": "DOMEventFacade.html#property_pageX", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "pageY", "url": "DOMEventFacade.html#property_pageY", "type": "property"}, {"access": "private", "host": "Event", "name": "_poll", "url": "Event.html#method__poll", "type": "method"}, {"access": "", "host": "Event", "name": "POLL_INTERVAL", "url": "Event.html#property_POLL_INTERVAL", "type": "property"}, {"access": "", "host": "Event", "name": "POLL_RETRYS", "url": "Event.html#property_POLL_RETRYS", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "preventDefault", "url": "DOMEventFacade.html#method_preventDefault", "type": "method"}, {"access": "", "host": "Event", "name": "purgeElement", "url": "Event.html#method_purgeElement", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "relatedTarget", "url": "DOMEventFacade.html#property_relatedTarget", "type": "property"}, {"access": "private", "host": "DOMEventFacade", "name": "resolve", "url": "DOMEventFacade.html#method_resolve", "type": "method"}, {"access": "private", "host": "Event", "name": "_retryCount", "url": "Event.html#property__retryCount", "type": "property"}, {"access": "private", "host": "Event", "name": "startInterval", "url": "Event.html#method_startInterval", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "stopImmediatePropagation", "url": "DOMEventFacade.html#method_stopImmediatePropagation", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "stopPropagation", "url": "DOMEventFacade.html#method_stopPropagation", "type": "method"}, {"access": "", "host": "DOMEventFacade", "name": "target", "url": "DOMEventFacade.html#property_target", "type": "property"}, {"access": "private", "host": "Event", "name": "_unload", "url": "Event.html#method__unload", "type": "method"}, {"access": "private", "host": "DOMEventFacade", "name": "webkitKeymap", "url": "DOMEventFacade.html#property_webkitKeymap", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "wheelDelta", "url": "DOMEventFacade.html#property_wheelDelta", "type": "property"}, {"access": "", "host": "DOMEventFacade", "name": "which", "url": "DOMEventFacade.html#property_which", "type": "property"}, {"access": "private", "host": "Event", "name": "_wrappers", "url": "Event.html#property__wrappers", "type": "property"}]; |
|
190 </script> |
|
191 </body> |
|
192 </html> |