|
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.Local (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.0b1</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.Local |
|
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.Local</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="Base.html" title="Base">Base</a> |
|
54 </span> |
|
55 |
|
56 </h2> |
|
57 <!-- class tree goes here --> |
|
58 |
|
59 <dl class="subclasses" rel="yui:subclasses"> |
|
60 <dt>Known Subclasses:</dt> |
|
61 <dd> |
|
62 <span rel="yui:subclass" resource="DataSource.Function.html"> |
|
63 <a href="DataSource.Function.html" property="yui:name" title="DataSource.Function">DataSource.Function</a> |
|
64 </span> |
|
65 <span rel="yui:subclass" resource="Pollable.html"> |
|
66 <a href="Pollable.html" property="yui:name" title="Pollable">Pollable</a> |
|
67 </span> |
|
68 <span rel="yui:subclass" resource="DataSource.Get.html"> |
|
69 <a href="DataSource.Get.html" property="yui:name" title="DataSource.Get">DataSource.Get</a> |
|
70 </span> |
|
71 <span rel="yui:subclass" resource="DataSource.IO.html"> |
|
72 <a href="DataSource.IO.html" property="yui:name" title="DataSource.IO">DataSource.IO</a> |
|
73 </span> |
|
74 </dd> |
|
75 </dl> |
|
76 |
|
77 |
|
78 |
|
79 <div class="summary description" property="yui:description"> |
|
80 Base class for the DataSource Utility. |
|
81 </div> |
|
82 |
|
83 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
84 <h3 id="constructor">Constructor</h3> |
|
85 <div class="content"> |
|
86 <div class="detail"> |
|
87 <strong property="yui:name">DataSource.Local</strong> |
|
88 <code> |
|
89 ( |
|
90 ) |
|
91 </code> |
|
92 <div class="description"> |
|
93 |
|
94 |
|
95 </div> |
|
96 </div> |
|
97 </div> |
|
98 </div> |
|
99 |
|
100 <div rel="yui:properties" resource="#properties"> |
|
101 <div class="section field details"> |
|
102 <h3 id="properties">Properties</h3> |
|
103 <div class="content"> |
|
104 <div class="private" rel="yui:property" resource="#property_DataSource._tId"> |
|
105 <h4><a name="property_DataSource._tId" property="yui:name">DataSource._tId</a> |
|
106 - <code>private static <span property="yui:type">Number</span></code> |
|
107 </h4> |
|
108 <div class="detail"> |
|
109 <div class="description" property="yui:description"> |
|
110 Global transaction counter. |
|
111 </div> |
|
112 </div> |
|
113 |
|
114 |
|
115 <div class="default" property="yui:defaultValue"> |
|
116 Default Value: 0 |
|
117 </div> |
|
118 |
|
119 |
|
120 <hr /> |
|
121 </div> |
|
122 <div class="" rel="yui:property" resource="#property_NAME"> |
|
123 <h4><a name="property_NAME" property="yui:name">NAME</a> |
|
124 - <code>static final <span property="yui:type">String</span></code> |
|
125 </h4> |
|
126 <div class="detail"> |
|
127 <div class="description" property="yui:description"> |
|
128 Class name. |
|
129 </div> |
|
130 </div> |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 <hr /> |
|
136 </div> |
|
137 </div> |
|
138 </div> |
|
139 |
|
140 <div rel="yui:inheritance"> |
|
141 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
142 <h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
143 <div class="content" rel="yui:properties"> |
|
144 <code> |
|
145 |
|
146 </code> |
|
147 </div> |
|
148 </div> |
|
149 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
150 <h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
151 <div class="content" rel="yui:properties"> |
|
152 <code> |
|
153 |
|
154 <span rel="yui:property" resource="Base.html#property_name"> |
|
155 <a class=" deprecated" href="Base.html#property_name" property="yui:name" title="name">name</a> |
|
156 </span> |
|
157 |
|
158 </code> |
|
159 </div> |
|
160 </div> |
|
161 </div> |
|
162 </div> |
|
163 |
|
164 <div rel="yui:methods" resource="#methods"> |
|
165 <div class="section method details"> |
|
166 <h3 id="methods">Methods</h3> |
|
167 <div class="content"> |
|
168 <div class="protected" rel="yui:method" resource="#method__defDataFn"> |
|
169 <h4> |
|
170 <a name="method__defDataFn">_defDataFn</a></h4> |
|
171 <div class="detail" > |
|
172 <code> |
|
173 protected |
|
174 |
|
175 |
|
176 void |
|
177 <strong property="yui:name">_defDataFn</strong> |
|
178 ( |
|
179 |
|
180 |
|
181 e |
|
182 |
|
183 |
|
184 ) |
|
185 </code> |
|
186 |
|
187 <div class="description" property="yui:description"> |
|
188 Normalizes raw data into a response that includes results and meta properties. |
|
189 </div> |
|
190 |
|
191 <div class="description"> |
|
192 |
|
193 <dl rel="yui:parameters"> |
|
194 <dt>Parameters:</dt> |
|
195 <dd rel="yui:parameter"> |
|
196 <code><span property="yui:name">e</span> |
|
197 <<span property="yui:type">Event.Facade</span>> |
|
198 </code> |
|
199 <span property="yui:description"> Event Facade with the following properties: |
|
200 <dl> |
|
201 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
202 <dt>request (Object)</dt> <dd>The request.</dd> |
|
203 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
204 <dl> |
|
205 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
206 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
207 </dl> |
|
208 </dd> |
|
209 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
210 <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
211 </dl></span> |
|
212 </dd> |
|
213 </dl> |
|
214 |
|
215 <dl> |
|
216 <dt>Returns: |
|
217 <code property="yui:return"> |
|
218 void |
|
219 </code></dt> |
|
220 <dd property="yui:returnInfo"></dd> |
|
221 </dl> |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 </div> |
|
227 |
|
228 </div> |
|
229 <hr /> |
|
230 </div> |
|
231 <div class="protected" rel="yui:method" resource="#method__defRequestFn"> |
|
232 <h4> |
|
233 <a name="method__defRequestFn">_defRequestFn</a></h4> |
|
234 <div class="detail" > |
|
235 <code> |
|
236 protected |
|
237 |
|
238 |
|
239 void |
|
240 <strong property="yui:name">_defRequestFn</strong> |
|
241 ( |
|
242 |
|
243 |
|
244 e |
|
245 |
|
246 |
|
247 ) |
|
248 </code> |
|
249 |
|
250 <div class="description" property="yui:description"> |
|
251 Manages request/response transaction. Must fire <code>response</code> |
|
252 event when response is received. This method should be implemented by |
|
253 subclasses to achieve more complex behavior such as accessing remote data. |
|
254 </div> |
|
255 |
|
256 <div class="description"> |
|
257 |
|
258 <dl rel="yui:parameters"> |
|
259 <dt>Parameters:</dt> |
|
260 <dd rel="yui:parameter"> |
|
261 <code><span property="yui:name">e</span> |
|
262 <<span property="yui:type">Event.Facade</span>> |
|
263 </code> |
|
264 <span property="yui:description"> Event Facadewith the following properties: |
|
265 <dl> |
|
266 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
267 <dt>request (Object)</dt> <dd>The request.</dd> |
|
268 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
269 <dl> |
|
270 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
271 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
272 </dl> |
|
273 </dd> |
|
274 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
275 </dl></span> |
|
276 </dd> |
|
277 </dl> |
|
278 |
|
279 <dl> |
|
280 <dt>Returns: |
|
281 <code property="yui:return"> |
|
282 void |
|
283 </code></dt> |
|
284 <dd property="yui:returnInfo"></dd> |
|
285 </dl> |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 </div> |
|
291 |
|
292 </div> |
|
293 <hr /> |
|
294 </div> |
|
295 <div class="protected" rel="yui:method" resource="#method__defResponseFn"> |
|
296 <h4> |
|
297 <a name="method__defResponseFn">_defResponseFn</a></h4> |
|
298 <div class="detail" > |
|
299 <code> |
|
300 protected |
|
301 |
|
302 |
|
303 void |
|
304 <strong property="yui:name">_defResponseFn</strong> |
|
305 ( |
|
306 |
|
307 |
|
308 e |
|
309 |
|
310 |
|
311 ) |
|
312 </code> |
|
313 |
|
314 <div class="description" property="yui:description"> |
|
315 Sends data as a normalized response to callback. |
|
316 </div> |
|
317 |
|
318 <div class="description"> |
|
319 |
|
320 <dl rel="yui:parameters"> |
|
321 <dt>Parameters:</dt> |
|
322 <dd rel="yui:parameter"> |
|
323 <code><span property="yui:name">e</span> |
|
324 <<span property="yui:type">Event.Facade</span>> |
|
325 </code> |
|
326 <span property="yui:description"> Event Facade with the following properties: |
|
327 <dl> |
|
328 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
329 <dt>request (Object)</dt> <dd>The request.</dd> |
|
330 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
331 <dl> |
|
332 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
333 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
334 </dl> |
|
335 </dd> |
|
336 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
337 <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
338 <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
339 <dl> |
|
340 <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
341 <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
342 <dt>error (Boolean)</dt> <dd>Error flag.</dd> |
|
343 </dl> |
|
344 </dd> |
|
345 </dl></span> |
|
346 </dd> |
|
347 </dl> |
|
348 |
|
349 <dl> |
|
350 <dt>Returns: |
|
351 <code property="yui:return"> |
|
352 void |
|
353 </code></dt> |
|
354 <dd property="yui:returnInfo"></dd> |
|
355 </dl> |
|
356 |
|
357 |
|
358 |
|
359 |
|
360 </div> |
|
361 |
|
362 </div> |
|
363 <hr /> |
|
364 </div> |
|
365 <div class="private" rel="yui:method" resource="#method__initEvents"> |
|
366 <h4> |
|
367 <a name="method__initEvents">_initEvents</a></h4> |
|
368 <div class="detail" > |
|
369 <code> |
|
370 private |
|
371 |
|
372 |
|
373 void |
|
374 <strong property="yui:name">_initEvents</strong> |
|
375 ( |
|
376 ) |
|
377 </code> |
|
378 |
|
379 <div class="description" property="yui:description"> |
|
380 This method creates all the events for this module. |
|
381 </div> |
|
382 |
|
383 <div class="description"> |
|
384 |
|
385 |
|
386 <dl> |
|
387 <dt>Returns: |
|
388 <code property="yui:return"> |
|
389 void |
|
390 </code></dt> |
|
391 <dd property="yui:returnInfo"></dd> |
|
392 </dl> |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 </div> |
|
398 |
|
399 </div> |
|
400 <hr /> |
|
401 </div> |
|
402 <div class="" rel="yui:method" resource="#method_DataSource.issueCallback"> |
|
403 <h4> |
|
404 <a name="method_DataSource.issueCallback">DataSource.issueCallback</a></h4> |
|
405 <div class="detail" > |
|
406 <code> |
|
407 |
|
408 static |
|
409 |
|
410 void |
|
411 <strong property="yui:name">DataSource.issueCallback</strong> |
|
412 ( |
|
413 |
|
414 |
|
415 callback |
|
416 |
|
417 |
|
418 , |
|
419 params |
|
420 |
|
421 |
|
422 , |
|
423 error |
|
424 |
|
425 |
|
426 ) |
|
427 </code> |
|
428 |
|
429 <div class="description" property="yui:description"> |
|
430 Executes a given callback. The third param determines whether to execute |
|
431 </div> |
|
432 |
|
433 <div class="description"> |
|
434 |
|
435 <dl rel="yui:parameters"> |
|
436 <dt>Parameters:</dt> |
|
437 <dd rel="yui:parameter"> |
|
438 <code><span property="yui:name">callback</span> |
|
439 <<span property="yui:type">Object</span>> |
|
440 </code> |
|
441 <span property="yui:description"> The callback object.</span> |
|
442 </dd> |
|
443 <dd rel="yui:parameter"> |
|
444 <code><span property="yui:name">params</span> |
|
445 <<span property="yui:type">Array</span>> |
|
446 </code> |
|
447 <span property="yui:description"> params to be passed to the callback method</span> |
|
448 </dd> |
|
449 <dd rel="yui:parameter"> |
|
450 <code><span property="yui:name">error</span> |
|
451 <<span property="yui:type">Boolean</span>> |
|
452 </code> |
|
453 <span property="yui:description"> whether an error occurred</span> |
|
454 </dd> |
|
455 </dl> |
|
456 |
|
457 <dl> |
|
458 <dt>Returns: |
|
459 <code property="yui:return"> |
|
460 void |
|
461 </code></dt> |
|
462 <dd property="yui:returnInfo"></dd> |
|
463 </dl> |
|
464 |
|
465 |
|
466 |
|
467 |
|
468 </div> |
|
469 |
|
470 </div> |
|
471 <hr /> |
|
472 </div> |
|
473 <div class="private" rel="yui:method" resource="#method_initializer"> |
|
474 <h4> |
|
475 <a name="method_initializer">initializer</a></h4> |
|
476 <div class="detail" > |
|
477 <code> |
|
478 private |
|
479 |
|
480 |
|
481 void |
|
482 <strong property="yui:name">initializer</strong> |
|
483 ( |
|
484 |
|
485 |
|
486 config |
|
487 |
|
488 |
|
489 ) |
|
490 </code> |
|
491 |
|
492 <div class="description" property="yui:description"> |
|
493 Internal init() handler. |
|
494 </div> |
|
495 |
|
496 <div class="description"> |
|
497 |
|
498 <dl rel="yui:parameters"> |
|
499 <dt>Parameters:</dt> |
|
500 <dd rel="yui:parameter"> |
|
501 <code><span property="yui:name">config</span> |
|
502 <<span property="yui:type">Object</span>> |
|
503 </code> |
|
504 <span property="yui:description"> Config object.</span> |
|
505 </dd> |
|
506 </dl> |
|
507 |
|
508 <dl> |
|
509 <dt>Returns: |
|
510 <code property="yui:return"> |
|
511 void |
|
512 </code></dt> |
|
513 <dd property="yui:returnInfo"></dd> |
|
514 </dl> |
|
515 |
|
516 |
|
517 |
|
518 |
|
519 </div> |
|
520 |
|
521 </div> |
|
522 <hr /> |
|
523 </div> |
|
524 <div class="" rel="yui:method" resource="#method_sendRequest"> |
|
525 <h4> |
|
526 <a name="method_sendRequest">sendRequest</a></h4> |
|
527 <div class="detail" > |
|
528 <code> |
|
529 |
|
530 |
|
531 |
|
532 Number |
|
533 <strong property="yui:name">sendRequest</strong> |
|
534 ( |
|
535 |
|
536 |
|
537 request |
|
538 |
|
539 |
|
540 , |
|
541 callback |
|
542 |
|
543 |
|
544 , |
|
545 cfg |
|
546 |
|
547 |
|
548 ) |
|
549 </code> |
|
550 |
|
551 <div class="description" property="yui:description"> |
|
552 Generates a unique transaction ID and fires <code>request</code> event. |
|
553 </div> |
|
554 |
|
555 <div class="description"> |
|
556 |
|
557 <dl rel="yui:parameters"> |
|
558 <dt>Parameters:</dt> |
|
559 <dd rel="yui:parameter"> |
|
560 <code><span property="yui:name">request</span> |
|
561 <<span property="yui:type">Object</span>> |
|
562 </code> |
|
563 <span property="yui:description"> Request.</span> |
|
564 </dd> |
|
565 <dd rel="yui:parameter"> |
|
566 <code><span property="yui:name">callback</span> |
|
567 <<span property="yui:type">Object</span>> |
|
568 </code> |
|
569 <span property="yui:description"> An object literal with the following properties: |
|
570 <dl> |
|
571 <dt><code>success</code></dt> |
|
572 <dd>The function to call when the data is ready.</dd> |
|
573 <dt><code>failure</code></dt> |
|
574 <dd>The function to call upon a response failure condition.</dd> |
|
575 <dt><code>argument</code></dt> |
|
576 <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd> |
|
577 </dl></span> |
|
578 </dd> |
|
579 <dd rel="yui:parameter"> |
|
580 <code><span property="yui:name">cfg</span> |
|
581 <<span property="yui:type">Object</span>> |
|
582 </code> |
|
583 <span property="yui:description"> Configuration object</span> |
|
584 </dd> |
|
585 </dl> |
|
586 |
|
587 <dl> |
|
588 <dt>Returns: |
|
589 <code property="yui:return"> |
|
590 Number |
|
591 </code></dt> |
|
592 <dd property="yui:returnInfo">Transaction ID.</dd> |
|
593 </dl> |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 </div> |
|
599 |
|
600 </div> |
|
601 <hr /> |
|
602 </div> |
|
603 </div> |
|
604 </div> |
|
605 |
|
606 <div rel="yui:inheritance"> |
|
607 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
608 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
609 <div class="content" rel="yui:methods"> |
|
610 <code> |
|
611 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
612 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
613 </span> |
|
614 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
615 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
616 </span> |
|
617 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
618 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
619 </span> |
|
620 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
621 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
622 </span> |
|
623 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
624 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
625 </span> |
|
626 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
627 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
628 </span> |
|
629 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
630 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
631 </span> |
|
632 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
633 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
634 </span> |
|
635 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
636 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
637 </span> |
|
638 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
639 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
640 </span> |
|
641 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
642 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
643 </span> |
|
644 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
645 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
646 </span> |
|
647 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
648 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
649 </span> |
|
650 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
651 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
652 </span> |
|
653 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
654 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
655 </span> |
|
656 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
657 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
658 </span> |
|
659 </code> |
|
660 </div> |
|
661 </div> |
|
662 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
663 <h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
664 <div class="content" rel="yui:methods"> |
|
665 <code> |
|
666 <span rel="yui:method" resource="Attribute.html#method__addAttrs"> |
|
667 <a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span> |
|
668 </span> |
|
669 <span rel="yui:method" resource="Attribute.html#method__addLazyAttr"> |
|
670 <a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span> |
|
671 </span> |
|
672 <span rel="yui:method" resource="Attribute.html#method__defAttrChangeFn"> |
|
673 <a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span> |
|
674 </span> |
|
675 <span rel="yui:method" resource="Attribute.html#method__fireAttrChange"> |
|
676 <a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span> |
|
677 </span> |
|
678 <span rel="yui:method" resource="Attribute.html#method__getAttrInitVal"> |
|
679 <a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span> |
|
680 </span> |
|
681 <span rel="yui:method" resource="Attribute.html#method__isLazyAttr"> |
|
682 <a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span> |
|
683 </span> |
|
684 <span rel="yui:method" resource="Attribute.html#method__set"> |
|
685 <a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span> |
|
686 </span> |
|
687 <span rel="yui:method" resource="Attribute.html#method__setAttr"> |
|
688 <a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span> |
|
689 </span> |
|
690 <span rel="yui:method" resource="Attribute.html#method__setAttrVal"> |
|
691 <a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span> |
|
692 </span> |
|
693 <span rel="yui:method" resource="Attribute.html#method__splitAttrVals"> |
|
694 <a class="private" href="Attribute.html#method__splitAttrVals" property="yui:name" title="_splitAttrVals">_splitAttrVals</a><span class="private">,</span> |
|
695 </span> |
|
696 <span rel="yui:method" resource="Attribute.html#method_addAttr"> |
|
697 <a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span> |
|
698 </span> |
|
699 <span rel="yui:method" resource="Attribute.html#method_addAttrs"> |
|
700 <a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span> |
|
701 </span> |
|
702 <span rel="yui:method" resource="Attribute.html#method_attrAdded"> |
|
703 <a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span> |
|
704 </span> |
|
705 <span rel="yui:method" resource="Attribute.html#method_get"> |
|
706 <a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span> |
|
707 </span> |
|
708 <span rel="yui:method" resource="Attribute.html#method_getAttrs"> |
|
709 <a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span> |
|
710 </span> |
|
711 <span rel="yui:method" resource="Attribute.html#method_modifyAttr"> |
|
712 <a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span> |
|
713 </span> |
|
714 <span rel="yui:method" resource="Attribute.html#method_removeAttr"> |
|
715 <a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span> |
|
716 </span> |
|
717 <span rel="yui:method" resource="Attribute.html#method_reset"> |
|
718 <a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span> |
|
719 </span> |
|
720 <span rel="yui:method" resource="Attribute.html#method_set"> |
|
721 <a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span> |
|
722 </span> |
|
723 <span rel="yui:method" resource="Attribute.html#method_setAttrs"> |
|
724 <a class="" href="Attribute.html#method_setAttrs" property="yui:name" title="setAttrs">setAttrs</a> |
|
725 </span> |
|
726 </code> |
|
727 </div> |
|
728 </div> |
|
729 <div class="section field inheritance" rel="yui:superclass" resource="Plugin.Host.html"> |
|
730 <h4>Methods inherited from <a href="Plugin.Host.html" property="yui:name" title="Plugin.Host">Plugin.Host</a>:</h4> |
|
731 <div class="content" rel="yui:methods"> |
|
732 <code> |
|
733 <span rel="yui:method" resource="Plugin.Host.html#method__destroyPlugins"> |
|
734 <a class="private" href="Plugin.Host.html#method__destroyPlugins" property="yui:name" title="_destroyPlugins">_destroyPlugins</a><span class="private">,</span> |
|
735 </span> |
|
736 <span rel="yui:method" resource="Plugin.Host.html#method__initPlugins"> |
|
737 <a class="private" href="Plugin.Host.html#method__initPlugins" property="yui:name" title="_initPlugins">_initPlugins</a><span class="private">,</span> |
|
738 </span> |
|
739 <span rel="yui:method" resource="Plugin.Host.html#method__plug"> |
|
740 <a class="private" href="Plugin.Host.html#method__plug" property="yui:name" title="_plug">_plug</a><span class="private">,</span> |
|
741 </span> |
|
742 <span rel="yui:method" resource="Plugin.Host.html#method__unplug"> |
|
743 <a class="private" href="Plugin.Host.html#method__unplug" property="yui:name" title="_unplug">_unplug</a><span class="private">,</span> |
|
744 </span> |
|
745 <span rel="yui:method" resource="Plugin.Host.html#method_hasPlugin"> |
|
746 <a class="" href="Plugin.Host.html#method_hasPlugin" property="yui:name" title="hasPlugin">hasPlugin</a><span class="">,</span> |
|
747 </span> |
|
748 <span rel="yui:method" resource="Plugin.Host.html#method_plug"> |
|
749 <a class="" href="Plugin.Host.html#method_plug" property="yui:name" title="plug">plug</a><span class="">,</span> |
|
750 </span> |
|
751 <span rel="yui:method" resource="Plugin.Host.html#method_unplug"> |
|
752 <a class="" href="Plugin.Host.html#method_unplug" property="yui:name" title="unplug">unplug</a> |
|
753 </span> |
|
754 </code> |
|
755 </div> |
|
756 </div> |
|
757 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
758 <h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
759 <div class="content" rel="yui:methods"> |
|
760 <code> |
|
761 <span rel="yui:method" resource="Base.html#method__aggregateAttrs"> |
|
762 <a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span> |
|
763 </span> |
|
764 <span rel="yui:method" resource="Base.html#method__defDestroyFn"> |
|
765 <a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span> |
|
766 </span> |
|
767 <span rel="yui:method" resource="Base.html#method__defInitFn"> |
|
768 <a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span> |
|
769 </span> |
|
770 <span rel="yui:method" resource="Base.html#method__destroyHierarchy"> |
|
771 <a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> |
|
772 </span> |
|
773 <span rel="yui:method" resource="Base.html#method__filterAttrCfs"> |
|
774 <a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span> |
|
775 </span> |
|
776 <span rel="yui:method" resource="Base.html#method__getAttrCfgs"> |
|
777 <a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span> |
|
778 </span> |
|
779 <span rel="yui:method" resource="Base.html#method__getClasses"> |
|
780 <a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span> |
|
781 </span> |
|
782 <span rel="yui:method" resource="Base.html#method__initHierarchy"> |
|
783 <a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span> |
|
784 </span> |
|
785 <span rel="yui:method" resource="Base.html#method__initHierarchyData"> |
|
786 <a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span> |
|
787 </span> |
|
788 <span rel="yui:method" resource="Base.html#method_destroy"> |
|
789 <a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
790 </span> |
|
791 <span rel="yui:method" resource="Base.html#method_init"> |
|
792 <a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
793 </span> |
|
794 <span rel="yui:method" resource="Base.html#method_toString"> |
|
795 <a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a> |
|
796 </span> |
|
797 </code> |
|
798 </div> |
|
799 </div> |
|
800 </div> |
|
801 </div> |
|
802 |
|
803 <div rel="yui:events" resource="#events"> |
|
804 <div class="section method details"> |
|
805 <h3 id="events">Events</h3> |
|
806 <div class="content"> |
|
807 <div class="" rel="yui:event" resource="#event_data"> |
|
808 <h4> |
|
809 <a name="event_data">data</a></h4> |
|
810 <div class="detail"> |
|
811 <code> |
|
812 |
|
813 |
|
814 |
|
815 <strong property="yui:name">data</strong> |
|
816 |
|
817 ( |
|
818 |
|
819 |
|
820 e |
|
821 |
|
822 |
|
823 ) |
|
824 |
|
825 </code> |
|
826 |
|
827 <div class="description" property="yui:description"> |
|
828 Fired when raw data is received. |
|
829 </div> |
|
830 |
|
831 <div class="description"> |
|
832 |
|
833 |
|
834 <dl rel="yui:parameters"> |
|
835 <dt>Parameters:</dt> |
|
836 <dd rel="yui:parameter"> |
|
837 <code><span property="yui:name">e</span> |
|
838 <<span property="yui:type">Event.Facade</span>> |
|
839 </code> |
|
840 <span property="yui:description"> Event Facade with the following properties: |
|
841 <dl> |
|
842 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
843 <dt>request (Object)</dt> <dd>The request.</dd> |
|
844 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
845 <dl> |
|
846 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
847 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
848 </dl> |
|
849 </dd> |
|
850 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
851 <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
852 </dl></span> |
|
853 </dd> |
|
854 |
|
855 </dl> |
|
856 |
|
857 <div class="preventable"> |
|
858 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defDataFn. |
|
859 </div> |
|
860 |
|
861 </div> |
|
862 |
|
863 </div> |
|
864 <hr /> |
|
865 </div> |
|
866 <div class="" rel="yui:event" resource="#event_error"> |
|
867 <h4> |
|
868 <a name="event_error">error</a></h4> |
|
869 <div class="detail"> |
|
870 <code> |
|
871 |
|
872 |
|
873 |
|
874 <strong property="yui:name">error</strong> |
|
875 |
|
876 ( |
|
877 |
|
878 |
|
879 e |
|
880 |
|
881 |
|
882 ) |
|
883 |
|
884 </code> |
|
885 |
|
886 <div class="description" property="yui:description"> |
|
887 Fired when an error is encountered. |
|
888 </div> |
|
889 |
|
890 <div class="description"> |
|
891 |
|
892 |
|
893 <dl rel="yui:parameters"> |
|
894 <dt>Parameters:</dt> |
|
895 <dd rel="yui:parameter"> |
|
896 <code><span property="yui:name">e</span> |
|
897 <<span property="yui:type">Event.Facade</span>> |
|
898 </code> |
|
899 <span property="yui:description"> Event Facade with the following properties: |
|
900 <dl> |
|
901 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
902 <dt>request (Object)</dt> <dd>The request.</dd> |
|
903 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
904 <dl> |
|
905 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
906 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
907 </dl> |
|
908 </dd> |
|
909 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
910 <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
911 <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
912 <dl> |
|
913 <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
914 <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
915 <dt>error (Object)</dt> <dd>Error object.</dd> |
|
916 </dl> |
|
917 </dd> |
|
918 </dl></span> |
|
919 </dd> |
|
920 |
|
921 </dl> |
|
922 |
|
923 |
|
924 </div> |
|
925 |
|
926 </div> |
|
927 <hr /> |
|
928 </div> |
|
929 <div class="" rel="yui:event" resource="#event_request"> |
|
930 <h4> |
|
931 <a name="event_request">request</a></h4> |
|
932 <div class="detail"> |
|
933 <code> |
|
934 |
|
935 |
|
936 |
|
937 <strong property="yui:name">request</strong> |
|
938 |
|
939 ( |
|
940 |
|
941 |
|
942 e |
|
943 |
|
944 |
|
945 ) |
|
946 |
|
947 </code> |
|
948 |
|
949 <div class="description" property="yui:description"> |
|
950 Fired when a data request is received. |
|
951 </div> |
|
952 |
|
953 <div class="description"> |
|
954 |
|
955 |
|
956 <dl rel="yui:parameters"> |
|
957 <dt>Parameters:</dt> |
|
958 <dd rel="yui:parameter"> |
|
959 <code><span property="yui:name">e</span> |
|
960 <<span property="yui:type">Event.Facade</span>> |
|
961 </code> |
|
962 <span property="yui:description"> Event Facade with the following properties: |
|
963 <dl> |
|
964 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
965 <dt>request (Object)</dt> <dd>The request.</dd> |
|
966 <dt>callback (Object)</dt> <dd>The callback object.</dd> |
|
967 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
968 </dl></span> |
|
969 </dd> |
|
970 |
|
971 </dl> |
|
972 |
|
973 <div class="preventable"> |
|
974 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defRequestFn. |
|
975 </div> |
|
976 |
|
977 </div> |
|
978 |
|
979 </div> |
|
980 <hr /> |
|
981 </div> |
|
982 <div class="" rel="yui:event" resource="#event_response"> |
|
983 <h4> |
|
984 <a name="event_response">response</a></h4> |
|
985 <div class="detail"> |
|
986 <code> |
|
987 |
|
988 |
|
989 |
|
990 <strong property="yui:name">response</strong> |
|
991 |
|
992 ( |
|
993 |
|
994 |
|
995 e |
|
996 |
|
997 |
|
998 ) |
|
999 |
|
1000 </code> |
|
1001 |
|
1002 <div class="description" property="yui:description"> |
|
1003 Fired when response is returned. |
|
1004 </div> |
|
1005 |
|
1006 <div class="description"> |
|
1007 |
|
1008 |
|
1009 <dl rel="yui:parameters"> |
|
1010 <dt>Parameters:</dt> |
|
1011 <dd rel="yui:parameter"> |
|
1012 <code><span property="yui:name">e</span> |
|
1013 <<span property="yui:type">Event.Facade</span>> |
|
1014 </code> |
|
1015 <span property="yui:description"> Event Facade with the following properties: |
|
1016 <dl> |
|
1017 <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
1018 <dt>request (Object)</dt> <dd>The request.</dd> |
|
1019 <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
1020 <dl> |
|
1021 <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
1022 <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
1023 </dl> |
|
1024 </dd> |
|
1025 <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
1026 <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
1027 <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
1028 <dl> |
|
1029 <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
1030 <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
1031 <dt>error (Boolean)</dt> <dd>Error flag.</dd> |
|
1032 </dl> |
|
1033 </dd> |
|
1034 </dl></span> |
|
1035 </dd> |
|
1036 |
|
1037 </dl> |
|
1038 |
|
1039 <div class="preventable"> |
|
1040 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defResponseFn. |
|
1041 </div> |
|
1042 |
|
1043 </div> |
|
1044 |
|
1045 </div> |
|
1046 <hr /> |
|
1047 </div> |
|
1048 <div class="" rel="yui:event" resource="#event_sourceChange"> |
|
1049 <h4> |
|
1050 <a name="event_sourceChange">sourceChange</a></h4> |
|
1051 <div class="detail"> |
|
1052 <code> |
|
1053 |
|
1054 |
|
1055 |
|
1056 <strong property="yui:name">sourceChange</strong> |
|
1057 |
|
1058 ( |
|
1059 |
|
1060 |
|
1061 event |
|
1062 |
|
1063 |
|
1064 ) |
|
1065 |
|
1066 </code> |
|
1067 |
|
1068 <div class="description" property="yui:description"> |
|
1069 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. |
|
1070 </div> |
|
1071 |
|
1072 <div class="description"> |
|
1073 |
|
1074 |
|
1075 <dl rel="yui:parameters"> |
|
1076 <dt>Parameters:</dt> |
|
1077 <dd rel="yui:parameter"> |
|
1078 <code><span property="yui:name">event</span> |
|
1079 <<span property="yui:type">Event.Facade</span>> |
|
1080 </code> |
|
1081 <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> |
|
1082 </dd> |
|
1083 |
|
1084 </dl> |
|
1085 |
|
1086 |
|
1087 </div> |
|
1088 |
|
1089 </div> |
|
1090 <hr /> |
|
1091 </div> |
|
1092 </div> |
|
1093 </div> |
|
1094 |
|
1095 |
|
1096 <div rel="yui:inheritance"> |
|
1097 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
1098 <h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
1099 <div class="content" rel="yui:events"> |
|
1100 <code> |
|
1101 <span rel="yui:event" resource="Base.html#event_destroy"> |
|
1102 <a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
1103 </span> |
|
1104 <span rel="yui:event" resource="Base.html#event_destroyedChange"> |
|
1105 <a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span> |
|
1106 </span> |
|
1107 <span rel="yui:event" resource="Base.html#event_init"> |
|
1108 <a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
1109 </span> |
|
1110 <span rel="yui:event" resource="Base.html#event_initializedChange"> |
|
1111 <a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span> |
|
1112 </span> |
|
1113 |
|
1114 </code> |
|
1115 </div> |
|
1116 </div> |
|
1117 </div> |
|
1118 </div> |
|
1119 |
|
1120 <div rel="yui:attributes" resource="#configattributes"> |
|
1121 <div class="section field details"> |
|
1122 <h3 id="configattributes">Configuration Attributes</h3> |
|
1123 <div class="content"> |
|
1124 <div class="" rel="yui:attribute" resource="#config_source"> |
|
1125 <h4><a name="config_source">source</a> |
|
1126 <code>- <span property="yui:type">MIXED</span></code> |
|
1127 </h4> |
|
1128 <div class="detail"> |
|
1129 <div class="description" property="yui:description"> |
|
1130 Pointer to live data. |
|
1131 </div> |
|
1132 </div> |
|
1133 |
|
1134 |
|
1135 <div class="default"> |
|
1136 Default Value: null |
|
1137 </div> |
|
1138 |
|
1139 <hr /> |
|
1140 </div> |
|
1141 |
|
1142 </div> |
|
1143 </div> |
|
1144 |
|
1145 <div rel="yui:inheritance"> |
|
1146 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
1147 <h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
1148 <div class="content" rel="yui:attributes"> |
|
1149 <code> |
|
1150 <span rel="yui:attribute" resource="Base.html#config_destroyed"> |
|
1151 <a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span> |
|
1152 </span> |
|
1153 <span rel="yui:attribute" resource="Base.html#config_initialized"> |
|
1154 <a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span> |
|
1155 </span> |
|
1156 |
|
1157 </code> |
|
1158 </div> |
|
1159 </div> |
|
1160 </div> |
|
1161 </div> |
|
1162 |
|
1163 </div> |
|
1164 </div> |
|
1165 <div class="yui-b"> |
|
1166 <div class="nav"> |
|
1167 |
|
1168 <div id="moduleList" class="module"> |
|
1169 <h4>Modules</h4> |
|
1170 <ul class="content"> |
|
1171 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1172 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1173 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1174 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
1175 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1176 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1177 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1178 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1179 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1180 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1181 <li class="selected"><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1182 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1183 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1184 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1185 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1186 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1187 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1188 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1189 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1190 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1191 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1192 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1193 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1194 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1195 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1196 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1197 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1198 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1199 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1200 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
1201 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1202 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1203 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1204 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1205 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1206 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1207 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1208 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1209 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1210 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1211 </ul> |
|
1212 </div> |
|
1213 |
|
1214 <div id="classList" class="module"> |
|
1215 <h4>Classes</h4> |
|
1216 <ul class="content"> |
|
1217 <li class=""><a href="DataSource.Function.html" title="DataSource.Function">DataSource.Function</a></li> |
|
1218 <li class=""><a href="DataSource.Get.html" title="DataSource.Get">DataSource.Get</a></li> |
|
1219 <li class=""><a href="DataSource.IO.html" title="DataSource.IO">DataSource.IO</a></li> |
|
1220 <li class="selected"><a href="DataSource.Local.html" title="DataSource.Local">DataSource.Local</a></li> |
|
1221 <li class=""><a href="DataSourceArraySchema.html" title="DataSourceArraySchema">DataSourceArraySchema</a></li> |
|
1222 <li class=""><a href="DataSourceCache.html" title="DataSourceCache">DataSourceCache</a></li> |
|
1223 <li class=""><a href="DataSourceJSONSchema.html" title="DataSourceJSONSchema">DataSourceJSONSchema</a></li> |
|
1224 <li class=""><a href="DataSourceTextSchema.html" title="DataSourceTextSchema">DataSourceTextSchema</a></li> |
|
1225 <li class=""><a href="DataSourceXMLSchema.html" title="DataSourceXMLSchema">DataSourceXMLSchema</a></li> |
|
1226 <li class=""><a href="Pollable.html" title="Pollable">Pollable</a></li> |
|
1227 </ul> |
|
1228 </div> |
|
1229 |
|
1230 <div id="fileList" class="module"> |
|
1231 <h4>Files</h4> |
|
1232 <ul class="content"> |
|
1233 <li class=""><a href="datasource-arrayschema.js.html" title="datasource-arrayschema.js">datasource-arrayschema.js</a></li> |
|
1234 <li class=""><a href="datasource-cache.js.html" title="datasource-cache.js">datasource-cache.js</a></li> |
|
1235 <li class=""><a href="datasource-function.js.html" title="datasource-function.js">datasource-function.js</a></li> |
|
1236 <li class=""><a href="datasource-get.js.html" title="datasource-get.js">datasource-get.js</a></li> |
|
1237 <li class=""><a href="datasource-io.js.html" title="datasource-io.js">datasource-io.js</a></li> |
|
1238 <li class=""><a href="datasource-jsonschema.js.html" title="datasource-jsonschema.js">datasource-jsonschema.js</a></li> |
|
1239 <li class=""><a href="datasource-local.js.html" title="datasource-local.js">datasource-local.js</a></li> |
|
1240 <li class=""><a href="datasource-polling.js.html" title="datasource-polling.js">datasource-polling.js</a></li> |
|
1241 <li class=""><a href="datasource-textschema.js.html" title="datasource-textschema.js">datasource-textschema.js</a></li> |
|
1242 <li class=""><a href="datasource-xmlschema.js.html" title="datasource-xmlschema.js">datasource-xmlschema.js</a></li> |
|
1243 </ul> |
|
1244 </div> |
|
1245 |
|
1246 <div id="propertyList" class="module"> |
|
1247 <h4>Properties</h4> |
|
1248 <ul class="content"> |
|
1249 <li class="private"><a href="#property_DataSource._tId" title="DataSource._tId">DataSource._tId</a></li> |
|
1250 <li class=""><a href="#property_NAME" title="NAME">NAME</a></li> |
|
1251 </ul> |
|
1252 </div> |
|
1253 |
|
1254 <div id="methodsList" class="module"> |
|
1255 <h4>Methods</h4> |
|
1256 <ul class="content"> |
|
1257 <li class="protected"><a href="#method__defDataFn" title="_defDataFn">_defDataFn</a></li> |
|
1258 <li class="protected"><a href="#method__defRequestFn" title="_defRequestFn">_defRequestFn</a></li> |
|
1259 <li class="protected"><a href="#method__defResponseFn" title="_defResponseFn">_defResponseFn</a></li> |
|
1260 <li class="private"><a href="#method__initEvents" title="_initEvents">_initEvents</a></li> |
|
1261 <li class=""><a href="#method_DataSource.issueCallback" title="DataSource.issueCallback">DataSource.issueCallback</a></li> |
|
1262 <li class="private"><a href="#method_initializer" title="initializer">initializer</a></li> |
|
1263 <li class=""><a href="#method_sendRequest" title="sendRequest">sendRequest</a></li> |
|
1264 </ul> |
|
1265 </div> |
|
1266 |
|
1267 <div id="eventsList" class="module"> |
|
1268 <h4>Events</h4> |
|
1269 <ul class="content"> |
|
1270 <li class=""><a href="#event_data" title="data">data</a></li> |
|
1271 <li class=""><a href="#event_error" title="error">error</a></li> |
|
1272 <li class=""><a href="#event_request" title="request">request</a></li> |
|
1273 <li class=""><a href="#event_response" title="response">response</a></li> |
|
1274 <li class=""><a href="#event_sourceChange" title="sourceChange">sourceChange</a></li> |
|
1275 </ul> |
|
1276 </div> |
|
1277 |
|
1278 <div id="configList" class="module"> |
|
1279 <h4>Configuration Attributes</h4> |
|
1280 <ul class="content"> |
|
1281 <li class=""><a href="#config_source" title="source">source</a></li> |
|
1282 </ul> |
|
1283 </div> |
|
1284 |
|
1285 </div> |
|
1286 </div> |
|
1287 </div> |
|
1288 <div id="ft"> |
|
1289 <hr /> |
|
1290 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1291 </div> |
|
1292 </div> |
|
1293 <script type="text/javascript"> |
|
1294 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": "protected", "host": "DataSourceArraySchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceArraySchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceXMLSchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceXMLSchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "protected", "host": "DataSourceJSONSchema", "name": "_beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "url": "DataSourceJSONSchema.html#method__beforeDefDataFn\n<dl>\n<dt>tId (Number)<\/dt> <dd>Unique transaction ID.<\/dd>\n<dt>request (Object)<\/dt> <dd>The request.<\/dd>\n<dt>callback (Object)<\/dt> <dd>The callback object with the following properties:\n<dl>\n<dt>success (Function)<\/dt> <dd>Success handler.<\/dd>\n<dt>failure (Function)<\/dt> <dd>Failure handler.<\/dd>\n<\/dl>\n<\/dd>\n<dt>data (Object)<\/dt> <dd>Raw data.<\/dd>\n<\/dl>", "type": "method"}, {"access": "", "host": "DataSource.Get", "name": "callbacks", "url": "DataSource.Get.html#property_callbacks", "type": "property"}, {"access": "", "host": "Pollable", "name": "clearAllIntervals", "url": "Pollable.html#method_clearAllIntervals", "type": "method"}, {"access": "", "host": "Pollable", "name": "clearInterval", "url": "Pollable.html#method_clearInterval", "type": "method"}, {"access": "", "host": "DataSource.Local", "name": "data", "url": "DataSource.Local.html#event_data", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "DataSource.issueCallback", "url": "DataSource.Local.html#method_DataSource.issueCallback", "type": "method"}, {"access": "private", "host": "DataSource.Local", "name": "DataSource._tId", "url": "DataSource.Local.html#property_DataSource._tId", "type": "property"}, {"access": "protected", "host": "DataSource.Local", "name": "_defDataFn", "url": "DataSource.Local.html#method__defDataFn", "type": "method"}, {"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": "protected", "host": "DataSource.IO", "name": "_defRequestFn", "url": "DataSource.IO.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Local", "name": "_defRequestFn", "url": "DataSource.Local.html#method__defRequestFn", "type": "method"}, {"access": "protected", "host": "DataSource.Local", "name": "_defResponseFn", "url": "DataSource.Local.html#method__defResponseFn", "type": "method"}, {"access": "", "host": "DataSource.Local", "name": "error", "url": "DataSource.Local.html#event_error", "type": "event"}, {"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": "private", "host": "DataSource.Local", "name": "_initEvents", "url": "DataSource.Local.html#method__initEvents", "type": "method"}, {"access": "private", "host": "DataSourceArraySchema", "name": "initializer", "url": "DataSourceArraySchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceXMLSchema", "name": "initializer", "url": "DataSourceXMLSchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSourceJSONSchema", "name": "initializer", "url": "DataSourceJSONSchema.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSource.IO", "name": "initializer", "url": "DataSource.IO.html#method_initializer", "type": "method"}, {"access": "private", "host": "DataSource.Local", "name": "initializer", "url": "DataSource.Local.html#method_initializer", "type": "method"}, {"access": "private", "host": "Pollable", "name": "_intervals", "url": "Pollable.html#property__intervals", "type": "property"}, {"access": "", "host": "DataSource.IO", "name": "io", "url": "DataSource.IO.html#config_io", "type": "config"}, {"access": "", "host": "DataSource.IO", "name": "ioChange", "url": "DataSource.IO.html#event_ioChange", "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": "DataSourceArraySchema", "name": "NAME", "url": "DataSourceArraySchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceXMLSchema", "name": "NAME", "url": "DataSourceXMLSchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceJSONSchema", "name": "NAME", "url": "DataSourceJSONSchema.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.IO", "name": "NAME", "url": "DataSource.IO.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSource.Local", "name": "NAME", "url": "DataSource.Local.html#property_NAME", "type": "property"}, {"access": "", "host": "DataSourceArraySchema", "name": "NS", "url": "DataSourceArraySchema.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceXMLSchema", "name": "NS", "url": "DataSourceXMLSchema.html#property_NS", "type": "property"}, {"access": "", "host": "DataSourceJSONSchema", "name": "NS", "url": "DataSourceJSONSchema.html#property_NS", "type": "property"}, {"access": "private", "host": "DataSource.IO", "name": "_queue", "url": "DataSource.IO.html#property__queue", "type": "property"}, {"access": "", "host": "DataSource.Local", "name": "request", "url": "DataSource.Local.html#event_request", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "response", "url": "DataSource.Local.html#event_response", "type": "event"}, {"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.Local", "name": "sendRequest", "url": "DataSource.Local.html#method_sendRequest", "type": "method"}, {"access": "", "host": "Pollable", "name": "setInterval", "url": "Pollable.html#method_setInterval", "type": "method"}, {"access": "", "host": "DataSource.Function", "name": "source", "url": "DataSource.Function.html#config_source", "type": "config"}, {"access": "", "host": "DataSource.Local", "name": "source", "url": "DataSource.Local.html#config_source", "type": "config"}, {"access": "", "host": "DataSource.Function", "name": "sourceChange", "url": "DataSource.Function.html#event_sourceChange", "type": "event"}, {"access": "", "host": "DataSource.Local", "name": "sourceChange", "url": "DataSource.Local.html#event_sourceChange", "type": "event"}, {"access": "private", "host": "DataSource.Get", "name": "_tId", "url": "DataSource.Get.html#property__tId", "type": "property"}]; |
|
1295 </script> |
|
1296 </body> |
|
1297 </html> |