|
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: cache Cache (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>cache <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_cache.html" title="cache">cache</a> |
|
22 > Cache |
|
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">Cache</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="Plugin.Base.html" title="Plugin.Base">Plugin.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="DataSourceCache.html"> |
|
63 <a href="DataSourceCache.html" property="yui:name" title="DataSourceCache">DataSourceCache</a> |
|
64 </span> |
|
65 </dd> |
|
66 </dl> |
|
67 |
|
68 |
|
69 |
|
70 <div class="summary description" property="yui:description"> |
|
71 Base class for the YUI Cache utility. |
|
72 </div> |
|
73 |
|
74 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
75 <h3 id="constructor">Constructor</h3> |
|
76 <div class="content"> |
|
77 <div class="detail"> |
|
78 <strong property="yui:name">Cache</strong> |
|
79 <code> |
|
80 ( |
|
81 ) |
|
82 </code> |
|
83 <div class="description"> |
|
84 |
|
85 |
|
86 </div> |
|
87 </div> |
|
88 </div> |
|
89 </div> |
|
90 |
|
91 <div rel="yui:properties" resource="#properties"> |
|
92 <div class="section field details"> |
|
93 <h3 id="properties">Properties</h3> |
|
94 <div class="content"> |
|
95 <div class="private" rel="yui:property" resource="#property__entries"> |
|
96 <h4><a name="property__entries" property="yui:name">_entries</a> |
|
97 - <code>private <span property="yui:type">Object[]</span></code> |
|
98 </h4> |
|
99 <div class="detail"> |
|
100 <div class="description" property="yui:description"> |
|
101 Array of request/response objects indexed chronologically. |
|
102 </div> |
|
103 </div> |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 <hr /> |
|
109 </div> |
|
110 <div class="" rel="yui:property" resource="#property_NAME"> |
|
111 <h4><a name="property_NAME" property="yui:name">NAME</a> |
|
112 - <code>static final <span property="yui:type">String</span></code> |
|
113 </h4> |
|
114 <div class="detail"> |
|
115 <div class="description" property="yui:description"> |
|
116 Class name. |
|
117 </div> |
|
118 </div> |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 <hr /> |
|
124 </div> |
|
125 <div class="" rel="yui:property" resource="#property_NS"> |
|
126 <h4><a name="property_NS" property="yui:name">NS</a> |
|
127 - <code>static final <span property="yui:type">String</span></code> |
|
128 </h4> |
|
129 <div class="detail"> |
|
130 <div class="description" property="yui:description"> |
|
131 The namespace for the plugin. This will be the property on the host which |
|
132 references the plugin instance. |
|
133 </div> |
|
134 </div> |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 <hr /> |
|
140 </div> |
|
141 </div> |
|
142 </div> |
|
143 |
|
144 <div rel="yui:inheritance"> |
|
145 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
146 <h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
147 <div class="content" rel="yui:properties"> |
|
148 <code> |
|
149 |
|
150 </code> |
|
151 </div> |
|
152 </div> |
|
153 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
154 <h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
155 <div class="content" rel="yui:properties"> |
|
156 <code> |
|
157 |
|
158 <span rel="yui:property" resource="Base.html#property_name"> |
|
159 <a class=" deprecated" href="Base.html#property_name" property="yui:name" title="name">name</a> |
|
160 </span> |
|
161 |
|
162 </code> |
|
163 </div> |
|
164 </div> |
|
165 <div class="section field inheritance" rel="yui:superclass" resource="Plugin.Base.html"> |
|
166 <h4>Properties inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4> |
|
167 <div class="content" rel="yui:properties"> |
|
168 <code> |
|
169 |
|
170 <span rel="yui:property" resource="Plugin.Base.html#property__handles"> |
|
171 <a class="private" href="Plugin.Base.html#property__handles" property="yui:name" title="_handles">_handles</a> |
|
172 </span> |
|
173 |
|
174 </code> |
|
175 </div> |
|
176 </div> |
|
177 </div> |
|
178 </div> |
|
179 |
|
180 <div rel="yui:methods" resource="#methods"> |
|
181 <div class="section method details"> |
|
182 <h3 id="methods">Methods</h3> |
|
183 <div class="content"> |
|
184 <div class="protected" rel="yui:method" resource="#method__defAddFn"> |
|
185 <h4> |
|
186 <a name="method__defAddFn">_defAddFn</a></h4> |
|
187 <div class="detail" > |
|
188 <code> |
|
189 protected |
|
190 |
|
191 |
|
192 void |
|
193 <strong property="yui:name">_defAddFn</strong> |
|
194 ( |
|
195 |
|
196 |
|
197 e |
|
198 |
|
199 |
|
200 ) |
|
201 </code> |
|
202 |
|
203 <div class="description" property="yui:description"> |
|
204 Adds entry to cache. |
|
205 </div> |
|
206 |
|
207 <div class="description"> |
|
208 |
|
209 <dl rel="yui:parameters"> |
|
210 <dt>Parameters:</dt> |
|
211 <dd rel="yui:parameter"> |
|
212 <code><span property="yui:name">e</span> |
|
213 <<span property="yui:type">Event.Facade</span>> |
|
214 </code> |
|
215 <span property="yui:description"> Event Facade with the following properties: |
|
216 <dl> |
|
217 <dt>entry (Object)</dt> <dd>The cached entry.</dd> |
|
218 </dl></span> |
|
219 </dd> |
|
220 </dl> |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 </div> |
|
227 |
|
228 </div> |
|
229 <hr /> |
|
230 </div> |
|
231 <div class="protected" rel="yui:method" resource="#method__defFlushFn"> |
|
232 <h4> |
|
233 <a name="method__defFlushFn">_defFlushFn</a></h4> |
|
234 <div class="detail" > |
|
235 <code> |
|
236 protected |
|
237 |
|
238 |
|
239 void |
|
240 <strong property="yui:name">_defFlushFn</strong> |
|
241 ( |
|
242 |
|
243 |
|
244 e |
|
245 |
|
246 |
|
247 ) |
|
248 </code> |
|
249 |
|
250 <div class="description" property="yui:description"> |
|
251 Flushes cache. |
|
252 </div> |
|
253 |
|
254 <div class="description"> |
|
255 |
|
256 <dl rel="yui:parameters"> |
|
257 <dt>Parameters:</dt> |
|
258 <dd rel="yui:parameter"> |
|
259 <code><span property="yui:name">e</span> |
|
260 <<span property="yui:type">Event.Facade</span>> |
|
261 </code> |
|
262 <span property="yui:description"> Event Facade object.</span> |
|
263 </dd> |
|
264 </dl> |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 |
|
270 </div> |
|
271 |
|
272 </div> |
|
273 <hr /> |
|
274 </div> |
|
275 <div class="protected" rel="yui:method" resource="#method__isMatch"> |
|
276 <h4> |
|
277 <a name="method__isMatch">_isMatch</a></h4> |
|
278 <div class="detail" > |
|
279 <code> |
|
280 protected |
|
281 |
|
282 |
|
283 Boolean |
|
284 <strong property="yui:name">_isMatch</strong> |
|
285 ( |
|
286 |
|
287 |
|
288 request |
|
289 |
|
290 |
|
291 , |
|
292 entry |
|
293 |
|
294 |
|
295 ) |
|
296 </code> |
|
297 |
|
298 <div class="description" property="yui:description"> |
|
299 Default overridable method compares current request with given cache entry. |
|
300 Returns true if current request matches the cached request, otherwise |
|
301 false. Implementers should override this method to customize the |
|
302 cache-matching algorithm. |
|
303 </div> |
|
304 |
|
305 <div class="description"> |
|
306 |
|
307 <dl rel="yui:parameters"> |
|
308 <dt>Parameters:</dt> |
|
309 <dd rel="yui:parameter"> |
|
310 <code><span property="yui:name">request</span> |
|
311 <<span property="yui:type">Object</span>> |
|
312 </code> |
|
313 <span property="yui:description"> Request object.</span> |
|
314 </dd> |
|
315 <dd rel="yui:parameter"> |
|
316 <code><span property="yui:name">entry</span> |
|
317 <<span property="yui:type">Object</span>> |
|
318 </code> |
|
319 <span property="yui:description"> Cached entry.</span> |
|
320 </dd> |
|
321 </dl> |
|
322 |
|
323 <dl> |
|
324 <dt>Returns: |
|
325 <code property="yui:return"> |
|
326 Boolean |
|
327 </code></dt> |
|
328 <dd property="yui:returnInfo">True if current request matches given cached request, false otherwise.</dd> |
|
329 </dl> |
|
330 |
|
331 |
|
332 |
|
333 |
|
334 </div> |
|
335 |
|
336 </div> |
|
337 <hr /> |
|
338 </div> |
|
339 <div class="" rel="yui:method" resource="#method_add"> |
|
340 <h4> |
|
341 <a name="method_add">add</a></h4> |
|
342 <div class="detail" > |
|
343 <code> |
|
344 |
|
345 |
|
346 |
|
347 void |
|
348 <strong property="yui:name">add</strong> |
|
349 ( |
|
350 |
|
351 |
|
352 request |
|
353 |
|
354 |
|
355 , |
|
356 response |
|
357 |
|
358 |
|
359 , |
|
360 payload |
|
361 |
|
362 |
|
363 ) |
|
364 </code> |
|
365 |
|
366 <div class="description" property="yui:description"> |
|
367 Adds a new entry to the cache of the format |
|
368 {request:request, response:response, payload:payload}. |
|
369 If cache is full, evicts the stalest entry before adding the new one. |
|
370 </div> |
|
371 |
|
372 <div class="description"> |
|
373 |
|
374 <dl rel="yui:parameters"> |
|
375 <dt>Parameters:</dt> |
|
376 <dd rel="yui:parameter"> |
|
377 <code><span property="yui:name">request</span> |
|
378 <<span property="yui:type">Object</span>> |
|
379 </code> |
|
380 <span property="yui:description"> Request value.</span> |
|
381 </dd> |
|
382 <dd rel="yui:parameter"> |
|
383 <code><span property="yui:name">response</span> |
|
384 <<span property="yui:type">Object</span>> |
|
385 </code> |
|
386 <span property="yui:description"> Response value.</span> |
|
387 </dd> |
|
388 <dd rel="yui:parameter"> |
|
389 <code><span property="yui:name">payload</span> |
|
390 <<span property="yui:type">Object</span>> |
|
391 </code> |
|
392 <span property="yui:description"> (optional) Arbitrary data payload.</span> |
|
393 </dd> |
|
394 </dl> |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 </div> |
|
401 |
|
402 </div> |
|
403 <hr /> |
|
404 </div> |
|
405 <div class="private" rel="yui:method" resource="#method_destructor"> |
|
406 <h4> |
|
407 <a name="method_destructor">destructor</a></h4> |
|
408 <div class="detail" > |
|
409 <code> |
|
410 private |
|
411 |
|
412 |
|
413 void |
|
414 <strong property="yui:name">destructor</strong> |
|
415 ( |
|
416 ) |
|
417 </code> |
|
418 |
|
419 <div class="description" property="yui:description"> |
|
420 Internal destroy() handler. |
|
421 </div> |
|
422 |
|
423 <div class="description"> |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 </div> |
|
431 |
|
432 </div> |
|
433 <hr /> |
|
434 </div> |
|
435 <div class="" rel="yui:method" resource="#method_flush"> |
|
436 <h4> |
|
437 <a name="method_flush">flush</a></h4> |
|
438 <div class="detail" > |
|
439 <code> |
|
440 |
|
441 |
|
442 |
|
443 void |
|
444 <strong property="yui:name">flush</strong> |
|
445 ( |
|
446 ) |
|
447 </code> |
|
448 |
|
449 <div class="description" property="yui:description"> |
|
450 Flushes cache. |
|
451 </div> |
|
452 |
|
453 <div class="description"> |
|
454 |
|
455 |
|
456 |
|
457 |
|
458 |
|
459 |
|
460 </div> |
|
461 |
|
462 </div> |
|
463 <hr /> |
|
464 </div> |
|
465 <div class="private" rel="yui:method" resource="#method_initializer"> |
|
466 <h4> |
|
467 <a name="method_initializer">initializer</a></h4> |
|
468 <div class="detail" > |
|
469 <code> |
|
470 private |
|
471 |
|
472 |
|
473 void |
|
474 <strong property="yui:name">initializer</strong> |
|
475 ( |
|
476 |
|
477 |
|
478 config |
|
479 |
|
480 |
|
481 ) |
|
482 </code> |
|
483 |
|
484 <div class="description" property="yui:description"> |
|
485 Internal init() handler. |
|
486 </div> |
|
487 |
|
488 <div class="description"> |
|
489 |
|
490 <dl rel="yui:parameters"> |
|
491 <dt>Parameters:</dt> |
|
492 <dd rel="yui:parameter"> |
|
493 <code><span property="yui:name">config</span> |
|
494 <<span property="yui:type">Object</span>> |
|
495 </code> |
|
496 <span property="yui:description"> Config object.</span> |
|
497 </dd> |
|
498 </dl> |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 |
|
504 </div> |
|
505 |
|
506 </div> |
|
507 <hr /> |
|
508 </div> |
|
509 <div class="" rel="yui:method" resource="#method_retrieve"> |
|
510 <h4> |
|
511 <a name="method_retrieve">retrieve</a></h4> |
|
512 <div class="detail" > |
|
513 <code> |
|
514 |
|
515 |
|
516 |
|
517 Object |
|
518 <strong property="yui:name">retrieve</strong> |
|
519 ( |
|
520 |
|
521 |
|
522 request |
|
523 |
|
524 |
|
525 ) |
|
526 </code> |
|
527 |
|
528 <div class="description" property="yui:description"> |
|
529 Retrieves cached entry for given request, if available, and refreshes |
|
530 entry in the cache. Returns null if there is no cache match. |
|
531 </div> |
|
532 |
|
533 <div class="description"> |
|
534 |
|
535 <dl rel="yui:parameters"> |
|
536 <dt>Parameters:</dt> |
|
537 <dd rel="yui:parameter"> |
|
538 <code><span property="yui:name">request</span> |
|
539 <<span property="yui:type">Object</span>> |
|
540 </code> |
|
541 <span property="yui:description"> Request object.</span> |
|
542 </dd> |
|
543 </dl> |
|
544 |
|
545 <dl> |
|
546 <dt>Returns: |
|
547 <code property="yui:return"> |
|
548 Object |
|
549 </code></dt> |
|
550 <dd property="yui:returnInfo">Cached entry object with the properties request, response, and payload, or null.</dd> |
|
551 </dl> |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 </div> |
|
557 |
|
558 </div> |
|
559 <hr /> |
|
560 </div> |
|
561 </div> |
|
562 </div> |
|
563 |
|
564 <div rel="yui:inheritance"> |
|
565 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
566 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
567 <div class="content" rel="yui:methods"> |
|
568 <code> |
|
569 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
570 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
571 </span> |
|
572 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
573 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
574 </span> |
|
575 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
576 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
577 </span> |
|
578 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
579 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
580 </span> |
|
581 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
582 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
583 </span> |
|
584 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
585 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
586 </span> |
|
587 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
588 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
589 </span> |
|
590 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
591 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
592 </span> |
|
593 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
594 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
595 </span> |
|
596 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
597 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
598 </span> |
|
599 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
600 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
601 </span> |
|
602 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
603 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
604 </span> |
|
605 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
606 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
607 </span> |
|
608 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
609 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
610 </span> |
|
611 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
612 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
613 </span> |
|
614 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
615 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
616 </span> |
|
617 </code> |
|
618 </div> |
|
619 </div> |
|
620 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
621 <h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
622 <div class="content" rel="yui:methods"> |
|
623 <code> |
|
624 <span rel="yui:method" resource="Attribute.html#method__addAttrs"> |
|
625 <a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span> |
|
626 </span> |
|
627 <span rel="yui:method" resource="Attribute.html#method__addLazyAttr"> |
|
628 <a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span> |
|
629 </span> |
|
630 <span rel="yui:method" resource="Attribute.html#method__defAttrChangeFn"> |
|
631 <a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span> |
|
632 </span> |
|
633 <span rel="yui:method" resource="Attribute.html#method__fireAttrChange"> |
|
634 <a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span> |
|
635 </span> |
|
636 <span rel="yui:method" resource="Attribute.html#method__getAttr"> |
|
637 <a class="protected" href="Attribute.html#method__getAttr" property="yui:name" title="_getAttr">_getAttr</a><span class="protected">,</span> |
|
638 </span> |
|
639 <span rel="yui:method" resource="Attribute.html#method__getAttrInitVal"> |
|
640 <a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span> |
|
641 </span> |
|
642 <span rel="yui:method" resource="Attribute.html#method__getAttrs"> |
|
643 <a class="protected" href="Attribute.html#method__getAttrs" property="yui:name" title="_getAttrs">_getAttrs</a><span class="protected">,</span> |
|
644 </span> |
|
645 <span rel="yui:method" resource="Attribute.html#method__getStateVal"> |
|
646 <a class="private" href="Attribute.html#method__getStateVal" property="yui:name" title="_getStateVal">_getStateVal</a><span class="private">,</span> |
|
647 </span> |
|
648 <span rel="yui:method" resource="Attribute.html#method__isLazyAttr"> |
|
649 <a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span> |
|
650 </span> |
|
651 <span rel="yui:method" resource="Attribute.html#method__normAttrVals"> |
|
652 <a class="private" href="Attribute.html#method__normAttrVals" property="yui:name" title="_normAttrVals">_normAttrVals</a><span class="private">,</span> |
|
653 </span> |
|
654 <span rel="yui:method" resource="Attribute.html#method__protectAttrs"> |
|
655 <a class="protected" href="Attribute.html#method__protectAttrs" property="yui:name" title="_protectAttrs">_protectAttrs</a><span class="protected">,</span> |
|
656 </span> |
|
657 <span rel="yui:method" resource="Attribute.html#method__set"> |
|
658 <a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span> |
|
659 </span> |
|
660 <span rel="yui:method" resource="Attribute.html#method__setAttr"> |
|
661 <a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span> |
|
662 </span> |
|
663 <span rel="yui:method" resource="Attribute.html#method__setAttrs"> |
|
664 <a class="protected" href="Attribute.html#method__setAttrs" property="yui:name" title="_setAttrs">_setAttrs</a><span class="protected">,</span> |
|
665 </span> |
|
666 <span rel="yui:method" resource="Attribute.html#method__setAttrVal"> |
|
667 <a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span> |
|
668 </span> |
|
669 <span rel="yui:method" resource="Attribute.html#method__setStateVal"> |
|
670 <a class="private" href="Attribute.html#method__setStateVal" property="yui:name" title="_setStateVal">_setStateVal</a><span class="private">,</span> |
|
671 </span> |
|
672 <span rel="yui:method" resource="Attribute.html#method_addAttr"> |
|
673 <a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span> |
|
674 </span> |
|
675 <span rel="yui:method" resource="Attribute.html#method_addAttrs"> |
|
676 <a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span> |
|
677 </span> |
|
678 <span rel="yui:method" resource="Attribute.html#method_attrAdded"> |
|
679 <a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span> |
|
680 </span> |
|
681 <span rel="yui:method" resource="Attribute.html#method_get"> |
|
682 <a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span> |
|
683 </span> |
|
684 <span rel="yui:method" resource="Attribute.html#method_getAttrs"> |
|
685 <a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span> |
|
686 </span> |
|
687 <span rel="yui:method" resource="Attribute.html#method_modifyAttr"> |
|
688 <a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span> |
|
689 </span> |
|
690 <span rel="yui:method" resource="Attribute.html#method_removeAttr"> |
|
691 <a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span> |
|
692 </span> |
|
693 <span rel="yui:method" resource="Attribute.html#method_reset"> |
|
694 <a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span> |
|
695 </span> |
|
696 <span rel="yui:method" resource="Attribute.html#method_set"> |
|
697 <a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span> |
|
698 </span> |
|
699 <span rel="yui:method" resource="Attribute.html#method_setAttrs"> |
|
700 <a class="" href="Attribute.html#method_setAttrs" property="yui:name" title="setAttrs">setAttrs</a> |
|
701 </span> |
|
702 </code> |
|
703 </div> |
|
704 </div> |
|
705 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
706 <h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
707 <div class="content" rel="yui:methods"> |
|
708 <code> |
|
709 <span rel="yui:method" resource="Base.html#method__aggregateAttrs"> |
|
710 <a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span> |
|
711 </span> |
|
712 <span rel="yui:method" resource="Base.html#method__defDestroyFn"> |
|
713 <a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span> |
|
714 </span> |
|
715 <span rel="yui:method" resource="Base.html#method__defInitFn"> |
|
716 <a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span> |
|
717 </span> |
|
718 <span rel="yui:method" resource="Base.html#method__destroyHierarchy"> |
|
719 <a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> |
|
720 </span> |
|
721 <span rel="yui:method" resource="Base.html#method__filterAttrCfs"> |
|
722 <a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span> |
|
723 </span> |
|
724 <span rel="yui:method" resource="Base.html#method__getAttrCfgs"> |
|
725 <a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span> |
|
726 </span> |
|
727 <span rel="yui:method" resource="Base.html#method__getClasses"> |
|
728 <a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span> |
|
729 </span> |
|
730 <span rel="yui:method" resource="Base.html#method__initHierarchy"> |
|
731 <a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span> |
|
732 </span> |
|
733 <span rel="yui:method" resource="Base.html#method__initHierarchyData"> |
|
734 <a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span> |
|
735 </span> |
|
736 <span rel="yui:method" resource="Base.html#method_destroy"> |
|
737 <a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
738 </span> |
|
739 <span rel="yui:method" resource="Base.html#method_init"> |
|
740 <a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
741 </span> |
|
742 <span rel="yui:method" resource="Base.html#method_toString"> |
|
743 <a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a> |
|
744 </span> |
|
745 </code> |
|
746 </div> |
|
747 </div> |
|
748 <div class="section field inheritance" rel="yui:superclass" resource="Plugin.Base.html"> |
|
749 <h4>Methods inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4> |
|
750 <div class="content" rel="yui:methods"> |
|
751 <code> |
|
752 <span rel="yui:method" resource="Plugin.Base.html#method_destructor"> |
|
753 <a class="" href="Plugin.Base.html#method_destructor" property="yui:name" title="destructor">destructor</a><span class="">,</span> |
|
754 </span> |
|
755 <span rel="yui:method" resource="Plugin.Base.html#method_doAfter"> |
|
756 <a class="" href="Plugin.Base.html#method_doAfter" property="yui:name" title="doAfter">doAfter</a><span class="">,</span> |
|
757 </span> |
|
758 <span rel="yui:method" resource="Plugin.Base.html#method_doBefore"> |
|
759 <a class="" href="Plugin.Base.html#method_doBefore" property="yui:name" title="doBefore">doBefore</a><span class="">,</span> |
|
760 </span> |
|
761 <span rel="yui:method" resource="Plugin.Base.html#method_initializer"> |
|
762 <a class="" href="Plugin.Base.html#method_initializer" property="yui:name" title="initializer">initializer</a> |
|
763 </span> |
|
764 </code> |
|
765 </div> |
|
766 </div> |
|
767 </div> |
|
768 </div> |
|
769 |
|
770 <div rel="yui:events" resource="#events"> |
|
771 <div class="section method details"> |
|
772 <h3 id="events">Events</h3> |
|
773 <div class="content"> |
|
774 <div class="" rel="yui:event" resource="#event_add"> |
|
775 <h4> |
|
776 <a name="event_add">add</a></h4> |
|
777 <div class="detail"> |
|
778 <code> |
|
779 |
|
780 |
|
781 |
|
782 <strong property="yui:name">add</strong> |
|
783 |
|
784 ( |
|
785 |
|
786 |
|
787 e |
|
788 |
|
789 |
|
790 ) |
|
791 |
|
792 </code> |
|
793 |
|
794 <div class="description" property="yui:description"> |
|
795 Fired when an entry is added. |
|
796 </div> |
|
797 |
|
798 <div class="description"> |
|
799 |
|
800 |
|
801 <dl rel="yui:parameters"> |
|
802 <dt>Parameters:</dt> |
|
803 <dd rel="yui:parameter"> |
|
804 <code><span property="yui:name">e</span> |
|
805 <<span property="yui:type">Event.Facade</span>> |
|
806 </code> |
|
807 <span property="yui:description"> Event Facade with the following properties: |
|
808 <dl> |
|
809 <dt>entry (Object)</dt> <dd>The cached entry.</dd> |
|
810 </dl></span> |
|
811 </dd> |
|
812 |
|
813 </dl> |
|
814 |
|
815 <div class="preventable"> |
|
816 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defAddFn. |
|
817 </div> |
|
818 |
|
819 </div> |
|
820 |
|
821 </div> |
|
822 <hr /> |
|
823 </div> |
|
824 <div class="" rel="yui:event" resource="#event_entriesChange"> |
|
825 <h4> |
|
826 <a name="event_entriesChange">entriesChange</a></h4> |
|
827 <div class="detail"> |
|
828 <code> |
|
829 |
|
830 |
|
831 |
|
832 <strong property="yui:name">entriesChange</strong> |
|
833 |
|
834 ( |
|
835 |
|
836 |
|
837 event |
|
838 |
|
839 |
|
840 ) |
|
841 |
|
842 </code> |
|
843 |
|
844 <div class="description" property="yui:description"> |
|
845 Fires when the value for the configuration attribute 'entries' 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. |
|
846 </div> |
|
847 |
|
848 <div class="description"> |
|
849 |
|
850 |
|
851 <dl rel="yui:parameters"> |
|
852 <dt>Parameters:</dt> |
|
853 <dd rel="yui:parameter"> |
|
854 <code><span property="yui:name">event</span> |
|
855 <<span property="yui:type">Event.Facade</span>> |
|
856 </code> |
|
857 <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> |
|
858 </dd> |
|
859 |
|
860 </dl> |
|
861 |
|
862 |
|
863 </div> |
|
864 |
|
865 </div> |
|
866 <hr /> |
|
867 </div> |
|
868 <div class="" rel="yui:event" resource="#event_flush"> |
|
869 <h4> |
|
870 <a name="event_flush">flush</a></h4> |
|
871 <div class="detail"> |
|
872 <code> |
|
873 |
|
874 |
|
875 |
|
876 <strong property="yui:name">flush</strong> |
|
877 |
|
878 ( |
|
879 |
|
880 |
|
881 e |
|
882 |
|
883 |
|
884 ) |
|
885 |
|
886 </code> |
|
887 |
|
888 <div class="description" property="yui:description"> |
|
889 Fired when the cache is flushed. |
|
890 </div> |
|
891 |
|
892 <div class="description"> |
|
893 |
|
894 |
|
895 <dl rel="yui:parameters"> |
|
896 <dt>Parameters:</dt> |
|
897 <dd rel="yui:parameter"> |
|
898 <code><span property="yui:name">e</span> |
|
899 <<span property="yui:type">Event.Facade</span>> |
|
900 </code> |
|
901 <span property="yui:description"> Event Facade object.</span> |
|
902 </dd> |
|
903 |
|
904 </dl> |
|
905 |
|
906 <div class="preventable"> |
|
907 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defFlushFn. |
|
908 </div> |
|
909 |
|
910 </div> |
|
911 |
|
912 </div> |
|
913 <hr /> |
|
914 </div> |
|
915 <div class="" rel="yui:event" resource="#event_maxChange"> |
|
916 <h4> |
|
917 <a name="event_maxChange">maxChange</a></h4> |
|
918 <div class="detail"> |
|
919 <code> |
|
920 |
|
921 |
|
922 |
|
923 <strong property="yui:name">maxChange</strong> |
|
924 |
|
925 ( |
|
926 |
|
927 |
|
928 event |
|
929 |
|
930 |
|
931 ) |
|
932 |
|
933 </code> |
|
934 |
|
935 <div class="description" property="yui:description"> |
|
936 Fires when the value for the configuration attribute 'max' 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. |
|
937 </div> |
|
938 |
|
939 <div class="description"> |
|
940 |
|
941 |
|
942 <dl rel="yui:parameters"> |
|
943 <dt>Parameters:</dt> |
|
944 <dd rel="yui:parameter"> |
|
945 <code><span property="yui:name">event</span> |
|
946 <<span property="yui:type">Event.Facade</span>> |
|
947 </code> |
|
948 <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> |
|
949 </dd> |
|
950 |
|
951 </dl> |
|
952 |
|
953 |
|
954 </div> |
|
955 |
|
956 </div> |
|
957 <hr /> |
|
958 </div> |
|
959 <div class="" rel="yui:event" resource="#event_request"> |
|
960 <h4> |
|
961 <a name="event_request">request</a></h4> |
|
962 <div class="detail"> |
|
963 <code> |
|
964 |
|
965 |
|
966 |
|
967 <strong property="yui:name">request</strong> |
|
968 |
|
969 ( |
|
970 |
|
971 |
|
972 e |
|
973 |
|
974 |
|
975 ) |
|
976 |
|
977 </code> |
|
978 |
|
979 <div class="description" property="yui:description"> |
|
980 Fired when an entry is requested from the cache. |
|
981 </div> |
|
982 |
|
983 <div class="description"> |
|
984 |
|
985 |
|
986 <dl rel="yui:parameters"> |
|
987 <dt>Parameters:</dt> |
|
988 <dd rel="yui:parameter"> |
|
989 <code><span property="yui:name">e</span> |
|
990 <<span property="yui:type">Event.Facade</span>> |
|
991 </code> |
|
992 <span property="yui:description"> Event Facade with the following properties: |
|
993 <dl> |
|
994 <dt>request (Object)</dt> <dd>The request object.</dd> |
|
995 </dl></span> |
|
996 </dd> |
|
997 |
|
998 </dl> |
|
999 |
|
1000 |
|
1001 </div> |
|
1002 |
|
1003 </div> |
|
1004 <hr /> |
|
1005 </div> |
|
1006 <div class="" rel="yui:event" resource="#event_retrieve"> |
|
1007 <h4> |
|
1008 <a name="event_retrieve">retrieve</a></h4> |
|
1009 <div class="detail"> |
|
1010 <code> |
|
1011 |
|
1012 |
|
1013 |
|
1014 <strong property="yui:name">retrieve</strong> |
|
1015 |
|
1016 ( |
|
1017 |
|
1018 |
|
1019 e |
|
1020 |
|
1021 |
|
1022 ) |
|
1023 |
|
1024 </code> |
|
1025 |
|
1026 <div class="description" property="yui:description"> |
|
1027 Fired when an entry is retrieved from the cache. |
|
1028 </div> |
|
1029 |
|
1030 <div class="description"> |
|
1031 |
|
1032 |
|
1033 <dl rel="yui:parameters"> |
|
1034 <dt>Parameters:</dt> |
|
1035 <dd rel="yui:parameter"> |
|
1036 <code><span property="yui:name">e</span> |
|
1037 <<span property="yui:type">Event.Facade</span>> |
|
1038 </code> |
|
1039 <span property="yui:description"> Event Facade with the following properties: |
|
1040 <dl> |
|
1041 <dt>entry (Object)</dt> <dd>The retrieved entry.</dd> |
|
1042 </dl></span> |
|
1043 </dd> |
|
1044 |
|
1045 </dl> |
|
1046 |
|
1047 |
|
1048 </div> |
|
1049 |
|
1050 </div> |
|
1051 <hr /> |
|
1052 </div> |
|
1053 <div class="" rel="yui:event" resource="#event_sizeChange"> |
|
1054 <h4> |
|
1055 <a name="event_sizeChange">sizeChange</a></h4> |
|
1056 <div class="detail"> |
|
1057 <code> |
|
1058 |
|
1059 |
|
1060 |
|
1061 <strong property="yui:name">sizeChange</strong> |
|
1062 |
|
1063 ( |
|
1064 |
|
1065 |
|
1066 event |
|
1067 |
|
1068 |
|
1069 ) |
|
1070 |
|
1071 </code> |
|
1072 |
|
1073 <div class="description" property="yui:description"> |
|
1074 Fires when the value for the configuration attribute 'size' 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. |
|
1075 </div> |
|
1076 |
|
1077 <div class="description"> |
|
1078 |
|
1079 |
|
1080 <dl rel="yui:parameters"> |
|
1081 <dt>Parameters:</dt> |
|
1082 <dd rel="yui:parameter"> |
|
1083 <code><span property="yui:name">event</span> |
|
1084 <<span property="yui:type">Event.Facade</span>> |
|
1085 </code> |
|
1086 <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> |
|
1087 </dd> |
|
1088 |
|
1089 </dl> |
|
1090 |
|
1091 |
|
1092 </div> |
|
1093 |
|
1094 </div> |
|
1095 <hr /> |
|
1096 </div> |
|
1097 <div class="" rel="yui:event" resource="#event_uniqueKeysChange"> |
|
1098 <h4> |
|
1099 <a name="event_uniqueKeysChange">uniqueKeysChange</a></h4> |
|
1100 <div class="detail"> |
|
1101 <code> |
|
1102 |
|
1103 |
|
1104 |
|
1105 <strong property="yui:name">uniqueKeysChange</strong> |
|
1106 |
|
1107 ( |
|
1108 |
|
1109 |
|
1110 event |
|
1111 |
|
1112 |
|
1113 ) |
|
1114 |
|
1115 </code> |
|
1116 |
|
1117 <div class="description" property="yui:description"> |
|
1118 Fires when the value for the configuration attribute 'uniqueKeys' 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. |
|
1119 </div> |
|
1120 |
|
1121 <div class="description"> |
|
1122 |
|
1123 |
|
1124 <dl rel="yui:parameters"> |
|
1125 <dt>Parameters:</dt> |
|
1126 <dd rel="yui:parameter"> |
|
1127 <code><span property="yui:name">event</span> |
|
1128 <<span property="yui:type">Event.Facade</span>> |
|
1129 </code> |
|
1130 <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> |
|
1131 </dd> |
|
1132 |
|
1133 </dl> |
|
1134 |
|
1135 |
|
1136 </div> |
|
1137 |
|
1138 </div> |
|
1139 <hr /> |
|
1140 </div> |
|
1141 </div> |
|
1142 </div> |
|
1143 |
|
1144 |
|
1145 <div rel="yui:inheritance"> |
|
1146 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
1147 <h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
1148 <div class="content" rel="yui:events"> |
|
1149 <code> |
|
1150 <span rel="yui:event" resource="Base.html#event_destroy"> |
|
1151 <a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
1152 </span> |
|
1153 <span rel="yui:event" resource="Base.html#event_destroyedChange"> |
|
1154 <a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span> |
|
1155 </span> |
|
1156 <span rel="yui:event" resource="Base.html#event_init"> |
|
1157 <a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
1158 </span> |
|
1159 <span rel="yui:event" resource="Base.html#event_initializedChange"> |
|
1160 <a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span> |
|
1161 </span> |
|
1162 |
|
1163 </code> |
|
1164 </div> |
|
1165 </div> |
|
1166 <div class="section field inheritance" rel="yui:superclass" resource="Plugin.Base.html"> |
|
1167 <h4>Events inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4> |
|
1168 <div class="content" rel="yui:events"> |
|
1169 <code> |
|
1170 <span rel="yui:event" resource="Plugin.Base.html#event_hostChange"> |
|
1171 <a class="" href="Plugin.Base.html#event_hostChange" property="yui:name" title="hostChange">hostChange</a><span class="">,</span> |
|
1172 </span> |
|
1173 |
|
1174 </code> |
|
1175 </div> |
|
1176 </div> |
|
1177 </div> |
|
1178 </div> |
|
1179 |
|
1180 <div rel="yui:attributes" resource="#configattributes"> |
|
1181 <div class="section field details"> |
|
1182 <h3 id="configattributes">Configuration Attributes</h3> |
|
1183 <div class="content"> |
|
1184 <div class="" rel="yui:attribute" resource="#config_entries"> |
|
1185 <h4><a name="config_entries">entries</a> |
|
1186 <code>- <span property="yui:type">Array</span></code> |
|
1187 </h4> |
|
1188 <div class="detail"> |
|
1189 <div class="description" property="yui:description"> |
|
1190 Cached entries. |
|
1191 </div> |
|
1192 </div> |
|
1193 |
|
1194 |
|
1195 |
|
1196 <hr /> |
|
1197 </div> |
|
1198 <div class="" rel="yui:attribute" resource="#config_max"> |
|
1199 <h4><a name="config_max">max</a> |
|
1200 <code>- <span property="yui:type">Number</span></code> |
|
1201 </h4> |
|
1202 <div class="detail"> |
|
1203 <div class="description" property="yui:description"> |
|
1204 Maximum number of entries the Cache can hold. |
|
1205 Set to 0 to turn off caching. |
|
1206 </div> |
|
1207 </div> |
|
1208 |
|
1209 |
|
1210 <div class="default"> |
|
1211 Default Value: 0 |
|
1212 </div> |
|
1213 |
|
1214 <hr /> |
|
1215 </div> |
|
1216 <div class="" rel="yui:attribute" resource="#config_size"> |
|
1217 <h4><a name="config_size">size</a> |
|
1218 <code>- <span property="yui:type">Number</span></code> |
|
1219 </h4> |
|
1220 <div class="detail"> |
|
1221 <div class="description" property="yui:description"> |
|
1222 Number of entries currently cached. |
|
1223 </div> |
|
1224 </div> |
|
1225 |
|
1226 |
|
1227 |
|
1228 <hr /> |
|
1229 </div> |
|
1230 <div class="" rel="yui:attribute" resource="#config_uniqueKeys"> |
|
1231 <h4><a name="config_uniqueKeys">uniqueKeys</a> |
|
1232 <code>- <span property="yui:type">Number</span></code> |
|
1233 </h4> |
|
1234 <div class="detail"> |
|
1235 <div class="description" property="yui:description"> |
|
1236 Validate uniqueness of stored keys. Default is false and |
|
1237 is more performant. |
|
1238 </div> |
|
1239 </div> |
|
1240 |
|
1241 |
|
1242 |
|
1243 <hr /> |
|
1244 </div> |
|
1245 |
|
1246 </div> |
|
1247 </div> |
|
1248 |
|
1249 <div rel="yui:inheritance"> |
|
1250 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
1251 <h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
1252 <div class="content" rel="yui:attributes"> |
|
1253 <code> |
|
1254 <span rel="yui:attribute" resource="Base.html#config_destroyed"> |
|
1255 <a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span> |
|
1256 </span> |
|
1257 <span rel="yui:attribute" resource="Base.html#config_initialized"> |
|
1258 <a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span> |
|
1259 </span> |
|
1260 |
|
1261 </code> |
|
1262 </div> |
|
1263 </div> |
|
1264 <div class="section field inheritance" rel="yui:superclass" resource="Plugin.Base.html"> |
|
1265 <h4>Configuration attributes inherited from <a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>:</h4> |
|
1266 <div class="content" rel="yui:attributes"> |
|
1267 <code> |
|
1268 <span rel="yui:attribute" resource="Plugin.Base.html#config_host"> |
|
1269 <a class="" href="Plugin.Base.html#config_host" property="yui:name" title="host">host</a><span class="">,</span> |
|
1270 </span> |
|
1271 |
|
1272 </code> |
|
1273 </div> |
|
1274 </div> |
|
1275 </div> |
|
1276 </div> |
|
1277 |
|
1278 </div> |
|
1279 </div> |
|
1280 <div class="yui-b"> |
|
1281 <div class="nav"> |
|
1282 |
|
1283 <div id="moduleList" class="module"> |
|
1284 <h4>Modules</h4> |
|
1285 <ul class="content"> |
|
1286 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1287 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
1288 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1289 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1290 <li class="selected"><a href="module_cache.html" title="cache">cache</a></li> |
|
1291 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1292 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1293 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1294 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1295 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1296 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1297 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1298 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1299 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1300 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1301 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1302 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1303 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1304 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1305 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1306 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1307 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1308 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1309 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1310 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1311 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1312 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1313 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1314 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1315 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1316 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
1317 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1318 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1319 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1320 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1321 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1322 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1323 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1324 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1325 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1326 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1327 </ul> |
|
1328 </div> |
|
1329 |
|
1330 <div id="classList" class="module"> |
|
1331 <h4>Classes</h4> |
|
1332 <ul class="content"> |
|
1333 <li class="selected"><a href="Cache.html" title="Cache">Cache</a></li> |
|
1334 </ul> |
|
1335 </div> |
|
1336 |
|
1337 <div id="fileList" class="module"> |
|
1338 <h4>Files</h4> |
|
1339 <ul class="content"> |
|
1340 <li class=""><a href="cache.js.html" title="cache.js">cache.js</a></li> |
|
1341 </ul> |
|
1342 </div> |
|
1343 |
|
1344 <div id="propertyList" class="module"> |
|
1345 <h4>Properties</h4> |
|
1346 <ul class="content"> |
|
1347 <li class="private"><a href="#property__entries" title="_entries">_entries</a></li> |
|
1348 <li class=""><a href="#property_NAME" title="NAME">NAME</a></li> |
|
1349 <li class=""><a href="#property_NS" title="NS">NS</a></li> |
|
1350 </ul> |
|
1351 </div> |
|
1352 |
|
1353 <div id="methodsList" class="module"> |
|
1354 <h4>Methods</h4> |
|
1355 <ul class="content"> |
|
1356 <li class="protected"><a href="#method__defAddFn" title="_defAddFn">_defAddFn</a></li> |
|
1357 <li class="protected"><a href="#method__defFlushFn" title="_defFlushFn">_defFlushFn</a></li> |
|
1358 <li class="protected"><a href="#method__isMatch" title="_isMatch">_isMatch</a></li> |
|
1359 <li class=""><a href="#method_add" title="add">add</a></li> |
|
1360 <li class="private"><a href="#method_destructor" title="destructor">destructor</a></li> |
|
1361 <li class=""><a href="#method_flush" title="flush">flush</a></li> |
|
1362 <li class="private"><a href="#method_initializer" title="initializer">initializer</a></li> |
|
1363 <li class=""><a href="#method_retrieve" title="retrieve">retrieve</a></li> |
|
1364 </ul> |
|
1365 </div> |
|
1366 |
|
1367 <div id="eventsList" class="module"> |
|
1368 <h4>Events</h4> |
|
1369 <ul class="content"> |
|
1370 <li class=""><a href="#event_add" title="add">add</a></li> |
|
1371 <li class=""><a href="#event_entriesChange" title="entriesChange">entriesChange</a></li> |
|
1372 <li class=""><a href="#event_flush" title="flush">flush</a></li> |
|
1373 <li class=""><a href="#event_maxChange" title="maxChange">maxChange</a></li> |
|
1374 <li class=""><a href="#event_request" title="request">request</a></li> |
|
1375 <li class=""><a href="#event_retrieve" title="retrieve">retrieve</a></li> |
|
1376 <li class=""><a href="#event_sizeChange" title="sizeChange">sizeChange</a></li> |
|
1377 <li class=""><a href="#event_uniqueKeysChange" title="uniqueKeysChange">uniqueKeysChange</a></li> |
|
1378 </ul> |
|
1379 </div> |
|
1380 |
|
1381 <div id="configList" class="module"> |
|
1382 <h4>Configuration Attributes</h4> |
|
1383 <ul class="content"> |
|
1384 <li class=""><a href="#config_entries" title="entries">entries</a></li> |
|
1385 <li class=""><a href="#config_max" title="max">max</a></li> |
|
1386 <li class=""><a href="#config_size" title="size">size</a></li> |
|
1387 <li class=""><a href="#config_uniqueKeys" title="uniqueKeys">uniqueKeys</a></li> |
|
1388 </ul> |
|
1389 </div> |
|
1390 |
|
1391 </div> |
|
1392 </div> |
|
1393 </div> |
|
1394 <div id="ft"> |
|
1395 <hr /> |
|
1396 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1397 </div> |
|
1398 </div> |
|
1399 <script type="text/javascript"> |
|
1400 ALL_YUI_PROPS = [{"access": "", "host": "Cache", "name": "add", "url": "Cache.html#method_add", "type": "method"}, {"access": "", "host": "Cache", "name": "add", "url": "Cache.html#event_add", "type": "event"}, {"access": "protected", "host": "Cache", "name": "_defAddFn", "url": "Cache.html#method__defAddFn", "type": "method"}, {"access": "protected", "host": "Cache", "name": "_defFlushFn", "url": "Cache.html#method__defFlushFn", "type": "method"}, {"access": "private", "host": "Cache", "name": "destructor", "url": "Cache.html#method_destructor", "type": "method"}, {"access": "private", "host": "Cache", "name": "_entries", "url": "Cache.html#property__entries", "type": "property"}, {"access": "", "host": "Cache", "name": "entries", "url": "Cache.html#config_entries", "type": "config"}, {"access": "", "host": "Cache", "name": "entriesChange", "url": "Cache.html#event_entriesChange", "type": "event"}, {"access": "", "host": "Cache", "name": "flush", "url": "Cache.html#method_flush", "type": "method"}, {"access": "", "host": "Cache", "name": "flush", "url": "Cache.html#event_flush", "type": "event"}, {"access": "private", "host": "Cache", "name": "initializer", "url": "Cache.html#method_initializer", "type": "method"}, {"access": "protected", "host": "Cache", "name": "_isMatch", "url": "Cache.html#method__isMatch", "type": "method"}, {"access": "", "host": "Cache", "name": "max", "url": "Cache.html#config_max", "type": "config"}, {"access": "", "host": "Cache", "name": "maxChange", "url": "Cache.html#event_maxChange", "type": "event"}, {"access": "", "host": "Cache", "name": "NAME", "url": "Cache.html#property_NAME", "type": "property"}, {"access": "", "host": "Cache", "name": "NS", "url": "Cache.html#property_NS", "type": "property"}, {"access": "", "host": "Cache", "name": "request", "url": "Cache.html#event_request", "type": "event"}, {"access": "", "host": "Cache", "name": "retrieve", "url": "Cache.html#method_retrieve", "type": "method"}, {"access": "", "host": "Cache", "name": "retrieve", "url": "Cache.html#event_retrieve", "type": "event"}, {"access": "", "host": "Cache", "name": "size", "url": "Cache.html#config_size", "type": "config"}, {"access": "", "host": "Cache", "name": "sizeChange", "url": "Cache.html#event_sizeChange", "type": "event"}, {"access": "", "host": "Cache", "name": "uniqueKeys", "url": "Cache.html#config_uniqueKeys", "type": "config"}, {"access": "", "host": "Cache", "name": "uniqueKeysChange", "url": "Cache.html#event_uniqueKeysChange", "type": "event"}]; |
|
1401 </script> |
|
1402 </body> |
|
1403 </html> |