|
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: datasource DataSource.Function (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>datasource <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_datasource.html" title="datasource">datasource</a> |
|
22 > DataSource.Function |
|
23 |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <h2> |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 Class <b property="yui:name">DataSource.Function</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="DataSource.Local.html" title="DataSource.Local">DataSource.Local</a> |
|
54 </span> |
|
55 |
|
56 </h2> |
|
57 <!-- class tree goes here --> |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 <div class="summary description" property="yui:description"> |
|
63 Function subclass for the DataSource Utility. |
|
64 </div> |
|
65 |
|
66 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
67 <h3 id="constructor">Constructor</h3> |
|
68 <div class="content"> |
|
69 <div class="detail"> |
|
70 <strong property="yui:name">DataSource.Function</strong> |
|
71 <code> |
|
72 ( |
|
73 ) |
|
74 </code> |
|
75 <div class="description"> |
|
76 |
|
77 |
|
78 </div> |
|
79 </div> |
|
80 </div> |
|
81 </div> |
|
82 |
|
83 <div rel="yui:properties" resource="#properties"> |
|
84 <div class="section field details"> |
|
85 <h3 id="properties">Properties</h3> |
|
86 <div class="content"> |
|
87 <div class="" rel="yui:property" resource="#property_NAME"> |
|
88 <h4><a name="property_NAME" property="yui:name">NAME</a> |
|
89 - <code>static final <span property="yui:type">String</span></code> |
|
90 </h4> |
|
91 <div class="detail"> |
|
92 <div class="description" property="yui:description"> |
|
93 Class name. |
|
94 </div> |
|
95 </div> |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 <hr /> |
|
101 </div> |
|
102 </div> |
|
103 </div> |
|
104 |
|
105 <div rel="yui:inheritance"> |
|
106 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
107 <h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
108 <div class="content" rel="yui:properties"> |
|
109 <code> |
|
110 |
|
111 </code> |
|
112 </div> |
|
113 </div> |
|
114 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
115 <h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
116 <div class="content" rel="yui:properties"> |
|
117 <code> |
|
118 |
|
119 <span rel="yui:property" resource="Base.html#property_name"> |
|
120 <a class=" deprecated" href="Base.html#property_name" property="yui:name" title="name">name</a> |
|
121 </span> |
|
122 |
|
123 </code> |
|
124 </div> |
|
125 </div> |
|
126 <div class="section field inheritance" rel="yui:superclass" resource="DataSource.Local.html"> |
|
127 <h4>Properties inherited from <a href="DataSource.Local.html" property="yui:name" title="DataSource.Local">DataSource.Local</a>:</h4> |
|
128 <div class="content" rel="yui:properties"> |
|
129 <code> |
|
130 |
|
131 </code> |
|
132 </div> |
|
133 </div> |
|
134 </div> |
|
135 </div> |
|
136 |
|
137 <div rel="yui:methods" resource="#methods"> |
|
138 <div class="section method details"> |
|
139 <h3 id="methods">Methods</h3> |
|
140 <div class="content"> |
|
141 <div class="protected" rel="yui:method" resource="#method__defRequestFn"> |
|
142 <h4> |
|
143 <a name="method__defRequestFn">_defRequestFn</a></h4> |
|
144 <div class="detail" > |
|
145 <code> |
|
146 protected |
|
147 |
|
148 |
|
149 void |
|
150 <strong property="yui:name">_defRequestFn</strong> |
|
151 ( |
|
152 |
|
153 |
|
154 e |
|
155 |
|
156 |
|
157 ) |
|
158 </code> |
|
159 |
|
160 <div class="description" property="yui:description"> |
|
161 Passes query string to IO. Fires <code>response</code> event when |
|
162 response is received asynchronously. |
|
163 </div> |
|
164 |
|
165 <div class="description"> |
|
166 |
|
167 <dl rel="yui:parameters"> |
|
168 <dt>Parameters:</dt> |
|
169 <dd rel="yui:parameter"> |
|
170 <code><span property="yui:name">e</span> |
|
171 <<span property="yui:type">Event.Facade</span>> |
|
172 </code> |
|
173 <span property="yui:description"> Event Facade with the following properties: |
|
174 <dl> |
|
175 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
176 <dt>request (Object)</dt> <dd>The request.</dd> |
|
177 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
178 <dl> |
|
179 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
180 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
181 </dl> |
|
182 </dd> |
|
183 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
184 </dl></span> |
|
185 </dd> |
|
186 </dl> |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 </div> |
|
193 |
|
194 </div> |
|
195 <hr /> |
|
196 </div> |
|
197 </div> |
|
198 </div> |
|
199 |
|
200 <div rel="yui:inheritance"> |
|
201 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
202 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
203 <div class="content" rel="yui:methods"> |
|
204 <code> |
|
205 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
206 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
207 </span> |
|
208 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
209 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
210 </span> |
|
211 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
212 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
213 </span> |
|
214 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
215 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
216 </span> |
|
217 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
218 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
219 </span> |
|
220 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
221 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
222 </span> |
|
223 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
224 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
225 </span> |
|
226 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
227 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
228 </span> |
|
229 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
230 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
231 </span> |
|
232 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
233 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
234 </span> |
|
235 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
236 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
237 </span> |
|
238 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
239 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
240 </span> |
|
241 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
242 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
243 </span> |
|
244 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
245 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
246 </span> |
|
247 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
248 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
249 </span> |
|
250 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
251 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
252 </span> |
|
253 </code> |
|
254 </div> |
|
255 </div> |
|
256 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
257 <h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
258 <div class="content" rel="yui:methods"> |
|
259 <code> |
|
260 <span rel="yui:method" resource="Attribute.html#method__addAttrs"> |
|
261 <a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span> |
|
262 </span> |
|
263 <span rel="yui:method" resource="Attribute.html#method__addLazyAttr"> |
|
264 <a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span> |
|
265 </span> |
|
266 <span rel="yui:method" resource="Attribute.html#method__defAttrChangeFn"> |
|
267 <a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span> |
|
268 </span> |
|
269 <span rel="yui:method" resource="Attribute.html#method__fireAttrChange"> |
|
270 <a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span> |
|
271 </span> |
|
272 <span rel="yui:method" resource="Attribute.html#method__getAttr"> |
|
273 <a class="protected" href="Attribute.html#method__getAttr" property="yui:name" title="_getAttr">_getAttr</a><span class="protected">,</span> |
|
274 </span> |
|
275 <span rel="yui:method" resource="Attribute.html#method__getAttrInitVal"> |
|
276 <a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span> |
|
277 </span> |
|
278 <span rel="yui:method" resource="Attribute.html#method__getAttrs"> |
|
279 <a class="protected" href="Attribute.html#method__getAttrs" property="yui:name" title="_getAttrs">_getAttrs</a><span class="protected">,</span> |
|
280 </span> |
|
281 <span rel="yui:method" resource="Attribute.html#method__getStateVal"> |
|
282 <a class="private" href="Attribute.html#method__getStateVal" property="yui:name" title="_getStateVal">_getStateVal</a><span class="private">,</span> |
|
283 </span> |
|
284 <span rel="yui:method" resource="Attribute.html#method__isLazyAttr"> |
|
285 <a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span> |
|
286 </span> |
|
287 <span rel="yui:method" resource="Attribute.html#method__normAttrVals"> |
|
288 <a class="private" href="Attribute.html#method__normAttrVals" property="yui:name" title="_normAttrVals">_normAttrVals</a><span class="private">,</span> |
|
289 </span> |
|
290 <span rel="yui:method" resource="Attribute.html#method__protectAttrs"> |
|
291 <a class="protected" href="Attribute.html#method__protectAttrs" property="yui:name" title="_protectAttrs">_protectAttrs</a><span class="protected">,</span> |
|
292 </span> |
|
293 <span rel="yui:method" resource="Attribute.html#method__set"> |
|
294 <a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span> |
|
295 </span> |
|
296 <span rel="yui:method" resource="Attribute.html#method__setAttr"> |
|
297 <a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span> |
|
298 </span> |
|
299 <span rel="yui:method" resource="Attribute.html#method__setAttrs"> |
|
300 <a class="protected" href="Attribute.html#method__setAttrs" property="yui:name" title="_setAttrs">_setAttrs</a><span class="protected">,</span> |
|
301 </span> |
|
302 <span rel="yui:method" resource="Attribute.html#method__setAttrVal"> |
|
303 <a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span> |
|
304 </span> |
|
305 <span rel="yui:method" resource="Attribute.html#method__setStateVal"> |
|
306 <a class="private" href="Attribute.html#method__setStateVal" property="yui:name" title="_setStateVal">_setStateVal</a><span class="private">,</span> |
|
307 </span> |
|
308 <span rel="yui:method" resource="Attribute.html#method_addAttr"> |
|
309 <a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span> |
|
310 </span> |
|
311 <span rel="yui:method" resource="Attribute.html#method_addAttrs"> |
|
312 <a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span> |
|
313 </span> |
|
314 <span rel="yui:method" resource="Attribute.html#method_attrAdded"> |
|
315 <a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span> |
|
316 </span> |
|
317 <span rel="yui:method" resource="Attribute.html#method_get"> |
|
318 <a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span> |
|
319 </span> |
|
320 <span rel="yui:method" resource="Attribute.html#method_getAttrs"> |
|
321 <a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span> |
|
322 </span> |
|
323 <span rel="yui:method" resource="Attribute.html#method_modifyAttr"> |
|
324 <a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span> |
|
325 </span> |
|
326 <span rel="yui:method" resource="Attribute.html#method_removeAttr"> |
|
327 <a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span> |
|
328 </span> |
|
329 <span rel="yui:method" resource="Attribute.html#method_reset"> |
|
330 <a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span> |
|
331 </span> |
|
332 <span rel="yui:method" resource="Attribute.html#method_set"> |
|
333 <a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span> |
|
334 </span> |
|
335 <span rel="yui:method" resource="Attribute.html#method_setAttrs"> |
|
336 <a class="" href="Attribute.html#method_setAttrs" property="yui:name" title="setAttrs">setAttrs</a> |
|
337 </span> |
|
338 </code> |
|
339 </div> |
|
340 </div> |
|
341 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
342 <h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
343 <div class="content" rel="yui:methods"> |
|
344 <code> |
|
345 <span rel="yui:method" resource="Base.html#method__aggregateAttrs"> |
|
346 <a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span> |
|
347 </span> |
|
348 <span rel="yui:method" resource="Base.html#method__defDestroyFn"> |
|
349 <a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span> |
|
350 </span> |
|
351 <span rel="yui:method" resource="Base.html#method__defInitFn"> |
|
352 <a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span> |
|
353 </span> |
|
354 <span rel="yui:method" resource="Base.html#method__destroyHierarchy"> |
|
355 <a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> |
|
356 </span> |
|
357 <span rel="yui:method" resource="Base.html#method__filterAttrCfs"> |
|
358 <a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span> |
|
359 </span> |
|
360 <span rel="yui:method" resource="Base.html#method__getAttrCfgs"> |
|
361 <a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span> |
|
362 </span> |
|
363 <span rel="yui:method" resource="Base.html#method__getClasses"> |
|
364 <a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span> |
|
365 </span> |
|
366 <span rel="yui:method" resource="Base.html#method__initHierarchy"> |
|
367 <a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span> |
|
368 </span> |
|
369 <span rel="yui:method" resource="Base.html#method__initHierarchyData"> |
|
370 <a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span> |
|
371 </span> |
|
372 <span rel="yui:method" resource="Base.html#method_destroy"> |
|
373 <a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
374 </span> |
|
375 <span rel="yui:method" resource="Base.html#method_init"> |
|
376 <a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
377 </span> |
|
378 <span rel="yui:method" resource="Base.html#method_toString"> |
|
379 <a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a> |
|
380 </span> |
|
381 </code> |
|
382 </div> |
|
383 </div> |
|
384 <div class="section field inheritance" rel="yui:superclass" resource="DataSource.Local.html"> |
|
385 <h4>Methods inherited from <a href="DataSource.Local.html" property="yui:name" title="DataSource.Local">DataSource.Local</a>:</h4> |
|
386 <div class="content" rel="yui:methods"> |
|
387 <code> |
|
388 <span rel="yui:method" resource="DataSource.Local.html#method__defDataFn"> |
|
389 <a class="protected" href="DataSource.Local.html#method__defDataFn" property="yui:name" title="_defDataFn">_defDataFn</a><span class="protected">,</span> |
|
390 </span> |
|
391 <span rel="yui:method" resource="DataSource.Local.html#method__defRequestFn"> |
|
392 <a class="protected" href="DataSource.Local.html#method__defRequestFn" property="yui:name" title="_defRequestFn">_defRequestFn</a><span class="protected">,</span> |
|
393 </span> |
|
394 <span rel="yui:method" resource="DataSource.Local.html#method__defResponseFn"> |
|
395 <a class="protected" href="DataSource.Local.html#method__defResponseFn" property="yui:name" title="_defResponseFn">_defResponseFn</a><span class="protected">,</span> |
|
396 </span> |
|
397 <span rel="yui:method" resource="DataSource.Local.html#method__initEvents"> |
|
398 <a class="private" href="DataSource.Local.html#method__initEvents" property="yui:name" title="_initEvents">_initEvents</a><span class="private">,</span> |
|
399 </span> |
|
400 <span rel="yui:method" resource="DataSource.Local.html#method_initializer"> |
|
401 <a class="private" href="DataSource.Local.html#method_initializer" property="yui:name" title="initializer">initializer</a><span class="private">,</span> |
|
402 </span> |
|
403 <span rel="yui:method" resource="DataSource.Local.html#method_sendRequest"> |
|
404 <a class="" href="DataSource.Local.html#method_sendRequest" property="yui:name" title="sendRequest">sendRequest</a> |
|
405 </span> |
|
406 </code> |
|
407 </div> |
|
408 </div> |
|
409 </div> |
|
410 </div> |
|
411 |
|
412 <div rel="yui:events" resource="#events"> |
|
413 <div class="section method details"> |
|
414 <h3 id="events">Events</h3> |
|
415 <div class="content"> |
|
416 <div class="" rel="yui:event" resource="#event_sourceChange"> |
|
417 <h4> |
|
418 <a name="event_sourceChange">sourceChange</a></h4> |
|
419 <div class="detail"> |
|
420 <code> |
|
421 |
|
422 |
|
423 |
|
424 <strong property="yui:name">sourceChange</strong> |
|
425 |
|
426 ( |
|
427 |
|
428 |
|
429 event |
|
430 |
|
431 |
|
432 ) |
|
433 |
|
434 </code> |
|
435 |
|
436 <div class="description" property="yui:description"> |
|
437 Fires when the value for the configuration attribute 'source' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
438 </div> |
|
439 |
|
440 <div class="description"> |
|
441 |
|
442 |
|
443 <dl rel="yui:parameters"> |
|
444 <dt>Parameters:</dt> |
|
445 <dd rel="yui:parameter"> |
|
446 <code><span property="yui:name">event</span> |
|
447 <<span property="yui:type">Event.Facade</span>> |
|
448 </code> |
|
449 <span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
450 </dd> |
|
451 |
|
452 </dl> |
|
453 |
|
454 |
|
455 </div> |
|
456 |
|
457 </div> |
|
458 <hr /> |
|
459 </div> |
|
460 </div> |
|
461 </div> |
|
462 |
|
463 |
|
464 <div rel="yui:inheritance"> |
|
465 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
466 <h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
467 <div class="content" rel="yui:events"> |
|
468 <code> |
|
469 <span rel="yui:event" resource="Base.html#event_destroy"> |
|
470 <a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
471 </span> |
|
472 <span rel="yui:event" resource="Base.html#event_destroyedChange"> |
|
473 <a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span> |
|
474 </span> |
|
475 <span rel="yui:event" resource="Base.html#event_init"> |
|
476 <a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
477 </span> |
|
478 <span rel="yui:event" resource="Base.html#event_initializedChange"> |
|
479 <a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span> |
|
480 </span> |
|
481 |
|
482 </code> |
|
483 </div> |
|
484 </div> |
|
485 <div class="section field inheritance" rel="yui:superclass" resource="DataSource.Local.html"> |
|
486 <h4>Events inherited from <a href="DataSource.Local.html" property="yui:name" title="DataSource.Local">DataSource.Local</a>:</h4> |
|
487 <div class="content" rel="yui:events"> |
|
488 <code> |
|
489 <span rel="yui:event" resource="DataSource.Local.html#event_data"> |
|
490 <a class="" href="DataSource.Local.html#event_data" property="yui:name" title="data">data</a><span class="">,</span> |
|
491 </span> |
|
492 <span rel="yui:event" resource="DataSource.Local.html#event_error"> |
|
493 <a class="" href="DataSource.Local.html#event_error" property="yui:name" title="error">error</a><span class="">,</span> |
|
494 </span> |
|
495 <span rel="yui:event" resource="DataSource.Local.html#event_request"> |
|
496 <a class="" href="DataSource.Local.html#event_request" property="yui:name" title="request">request</a> |
|
497 </span> |
|
498 <span rel="yui:event" resource="DataSource.Local.html#event_response"> |
|
499 <a class="" href="DataSource.Local.html#event_response" property="yui:name" title="response">response</a> |
|
500 </span> |
|
501 <span rel="yui:event" resource="DataSource.Local.html#event_sourceChange"> |
|
502 <a class="" href="DataSource.Local.html#event_sourceChange" property="yui:name" title="sourceChange">sourceChange</a> |
|
503 </span> |
|
504 |
|
505 </code> |
|
506 </div> |
|
507 </div> |
|
508 </div> |
|
509 </div> |
|
510 |
|
511 <div rel="yui:attributes" resource="#configattributes"> |
|
512 <div class="section field details"> |
|
513 <h3 id="configattributes">Configuration Attributes</h3> |
|
514 <div class="content"> |
|
515 <div class="" rel="yui:attribute" resource="#config_source"> |
|
516 <h4><a name="config_source">source</a> |
|
517 <code>- <span property="yui:type">MIXED</span></code> |
|
518 </h4> |
|
519 <div class="detail"> |
|
520 <div class="description" property="yui:description"> |
|
521 Pointer to live data. |
|
522 </div> |
|
523 </div> |
|
524 |
|
525 |
|
526 <div class="default"> |
|
527 Default Value: null |
|
528 </div> |
|
529 |
|
530 <hr /> |
|
531 </div> |
|
532 |
|
533 </div> |
|
534 </div> |
|
535 |
|
536 <div rel="yui:inheritance"> |
|
537 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
538 <h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
539 <div class="content" rel="yui:attributes"> |
|
540 <code> |
|
541 <span rel="yui:attribute" resource="Base.html#config_destroyed"> |
|
542 <a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span> |
|
543 </span> |
|
544 <span rel="yui:attribute" resource="Base.html#config_initialized"> |
|
545 <a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span> |
|
546 </span> |
|
547 |
|
548 </code> |
|
549 </div> |
|
550 </div> |
|
551 <div class="section field inheritance" rel="yui:superclass" resource="DataSource.Local.html"> |
|
552 <h4>Configuration attributes inherited from <a href="DataSource.Local.html" property="yui:name" title="DataSource.Local">DataSource.Local</a>:</h4> |
|
553 <div class="content" rel="yui:attributes"> |
|
554 <code> |
|
555 <span rel="yui:attribute" resource="DataSource.Local.html#config_source"> |
|
556 <a class="" href="DataSource.Local.html#config_source" property="yui:name" title="source">source</a><span class="">,</span> |
|
557 </span> |
|
558 |
|
559 </code> |
|
560 </div> |
|
561 </div> |
|
562 </div> |
|
563 </div> |
|
564 |
|
565 </div> |
|
566 </div> |
|
567 <div class="yui-b"> |
|
568 <div class="nav"> |
|
569 |
|
570 <div id="moduleList" class="module"> |
|
571 <h4>Modules</h4> |
|
572 <ul class="content"> |
|
573 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
574 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
575 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
576 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
577 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
578 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
579 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
580 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
581 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
582 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
583 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
584 <li class="selected"><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
585 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
586 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
587 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
588 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
589 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
590 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
591 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
592 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
593 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
594 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
595 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
596 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
597 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
598 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
599 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
600 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
601 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
602 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
603 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
604 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
605 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
606 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
607 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
608 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
609 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
610 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
611 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
612 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
613 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
614 </ul> |
|
615 </div> |
|
616 |
|
617 <div id="classList" class="module"> |
|
618 <h4>Classes</h4> |
|
619 <ul class="content"> |
|
620 <li class="selected"><a href="DataSource.Function.html" title="DataSource.Function">DataSource.Function</a></li> |
|
621 <li class=""><a href="DataSource.Get.html" title="DataSource.Get">DataSource.Get</a></li> |
|
622 <li class=""><a href="DataSource.IO.html" title="DataSource.IO">DataSource.IO</a></li> |
|
623 <li class=""><a href="DataSource.Local.html" title="DataSource.Local">DataSource.Local</a></li> |
|
624 <li class=""><a href="DataSourceArraySchema.html" title="DataSourceArraySchema">DataSourceArraySchema</a></li> |
|
625 <li class=""><a href="DataSourceCache.html" title="DataSourceCache">DataSourceCache</a></li> |
|
626 <li class=""><a href="DataSourceJSONSchema.html" title="DataSourceJSONSchema">DataSourceJSONSchema</a></li> |
|
627 <li class=""><a href="DataSourceTextSchema.html" title="DataSourceTextSchema">DataSourceTextSchema</a></li> |
|
628 <li class=""><a href="DataSourceXMLSchema.html" title="DataSourceXMLSchema">DataSourceXMLSchema</a></li> |
|
629 <li class=""><a href="Pollable.html" title="Pollable">Pollable</a></li> |
|
630 </ul> |
|
631 </div> |
|
632 |
|
633 <div id="fileList" class="module"> |
|
634 <h4>Files</h4> |
|
635 <ul class="content"> |
|
636 <li class=""><a href="datasource-arrayschema.js.html" title="datasource-arrayschema.js">datasource-arrayschema.js</a></li> |
|
637 <li class=""><a href="datasource-cache.js.html" title="datasource-cache.js">datasource-cache.js</a></li> |
|
638 <li class=""><a href="datasource-function.js.html" title="datasource-function.js">datasource-function.js</a></li> |
|
639 <li class=""><a href="datasource-get.js.html" title="datasource-get.js">datasource-get.js</a></li> |
|
640 <li class=""><a href="datasource-io.js.html" title="datasource-io.js">datasource-io.js</a></li> |
|
641 <li class=""><a href="datasource-jsonschema.js.html" title="datasource-jsonschema.js">datasource-jsonschema.js</a></li> |
|
642 <li class=""><a href="datasource-local.js.html" title="datasource-local.js">datasource-local.js</a></li> |
|
643 <li class=""><a href="datasource-polling.js.html" title="datasource-polling.js">datasource-polling.js</a></li> |
|
644 <li class=""><a href="datasource-textschema.js.html" title="datasource-textschema.js">datasource-textschema.js</a></li> |
|
645 <li class=""><a href="datasource-xmlschema.js.html" title="datasource-xmlschema.js">datasource-xmlschema.js</a></li> |
|
646 </ul> |
|
647 </div> |
|
648 |
|
649 <div id="propertyList" class="module"> |
|
650 <h4>Properties</h4> |
|
651 <ul class="content"> |
|
652 <li class=""><a href="#property_NAME" title="NAME">NAME</a></li> |
|
653 </ul> |
|
654 </div> |
|
655 |
|
656 <div id="methodsList" class="module"> |
|
657 <h4>Methods</h4> |
|
658 <ul class="content"> |
|
659 <li class="protected"><a href="#method__defRequestFn" title="_defRequestFn">_defRequestFn</a></li> |
|
660 </ul> |
|
661 </div> |
|
662 |
|
663 <div id="eventsList" class="module"> |
|
664 <h4>Events</h4> |
|
665 <ul class="content"> |
|
666 <li class=""><a href="#event_sourceChange" title="sourceChange">sourceChange</a></li> |
|
667 </ul> |
|
668 </div> |
|
669 |
|
670 <div id="configList" class="module"> |
|
671 <h4>Configuration Attributes</h4> |
|
672 <ul class="content"> |
|
673 <li class=""><a href="#config_source" title="source">source</a></li> |
|
674 </ul> |
|
675 </div> |
|
676 |
|
677 </div> |
|
678 </div> |
|
679 </div> |
|
680 <div id="ft"> |
|
681 <hr /> |
|
682 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
683 </div> |
|
684 </div> |
|
685 <script type="text/javascript"> |
|
686 ALL_YUI_PROPS = [{"access": "", "host": "DataSource.Get", "name": "asyncMode", "url": "DataSource.Get.html#config_asyncMode", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "asyncModeChange", "url": "DataSource.Get.html#event_asyncModeChange", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "callbacks", "url": "DataSource.Get.html#property_callbacks", "type": "property"}, {"access": "protected", "host": "DataSource.Get", "name": "_defRequestFn", "url": "DataSource.Get.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Function", "name": "_defRequestFn", "url": "DataSource.Function.html#method__defRequestFn", "type": "method"}, {"access": "", "host": "DataSource.Get", "name": "generateRequestCallback", "url": "DataSource.Get.html#config_generateRequestCallback", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "generateRequestCallbackChange", "url": "DataSource.Get.html#event_generateRequestCallbackChange", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "get", "url": "DataSource.Get.html#config_get", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "getChange", "url": "DataSource.Get.html#event_getChange", "type": "event"}, {"access": "", "host": "DataSource.Get", "name": "NAME", "url": "DataSource.Get.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.Function", "name": "NAME", "url": "DataSource.Function.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.Get", "name": "scriptCallbackParam", "url": "DataSource.Get.html#config_scriptCallbackParam", "type": "config"}, {"access": "", "host": "DataSource.Get", "name": "scriptCallbackParamChange", "url": "DataSource.Get.html#event_scriptCallbackParamChange", "type": "event"}, {"access": "", "host": "DataSource.Function", "name": "source", "url": "DataSource.Function.html#config_source", "type": "config"}, {"access": "", "host": "DataSource.Function", "name": "sourceChange", "url": "DataSource.Function.html#event_sourceChange", "type": "event"}, {"access": "private", "host": "DataSource.Get", "name": "_tId", "url": "DataSource.Get.html#property__tId", "type": "property"}]; |
|
687 </script> |
|
688 </body> |
|
689 </html> |