|
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: attribute Attribute (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>attribute <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_attribute.html" title="attribute">attribute</a> |
|
22 > Attribute |
|
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">Attribute</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 <span class="extends" rel="yui:extends"> |
|
56 - uses |
|
57 |
|
58 <span rel="extend" resource="EventTarget.html"> |
|
59 <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a> |
|
60 </span> |
|
61 |
|
62 |
|
63 </span> |
|
64 </h2> |
|
65 <!-- class tree goes here --> |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 <div class="summary description" property="yui:description"> |
|
71 <p> |
|
72 Attribute provides configurable attribute support along with attribute change events. It is designed to be |
|
73 augmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state, |
|
74 along with attribute change events. |
|
75 </p> |
|
76 <p>For example, attributes added to the host can be configured:</p> |
|
77 <ul> |
|
78 <li>As read only.</li> |
|
79 <li>As write once.</li> |
|
80 <li>With a setter function, which can be used to manipulate |
|
81 values passed to Attribute's <a href="#method_set">set</a> method, before they are stored.</li> |
|
82 <li>With a getter function, which can be used to manipulate stored values, |
|
83 before they are returned by Attribute's <a href="#method_get">get</a> method.</li> |
|
84 <li>With a validator function, to validate values before they are stored.</li> |
|
85 </ul> |
|
86 <p>See the <a href="#method_addAttr">addAttr</a> method, for the complete set of configuration |
|
87 options available for attributes</p>. |
|
88 <p><strong>NOTE:</strong> Most implementations will be better off extending the <a href="Base.html">Base</a> class, |
|
89 instead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration |
|
90 of attributes for derived classes, accounting for values passed into the constructor.</p> |
|
91 </div> |
|
92 |
|
93 |
|
94 <div rel="yui:properties" resource="#properties"> |
|
95 <div class="section field details"> |
|
96 <h3 id="properties">Properties</h3> |
|
97 <div class="content"> |
|
98 <div class="protected" rel="yui:property" resource="#property_Attribute._ATTR_CFG"> |
|
99 <h4><a name="property_Attribute._ATTR_CFG" property="yui:name">Attribute._ATTR_CFG</a> |
|
100 - <code>protected static <span property="yui:type">Array</span></code> |
|
101 </h4> |
|
102 <div class="detail"> |
|
103 <div class="description" property="yui:description"> |
|
104 The list of properties which can be configured for |
|
105 each attribute (e.g. setter, getter, writeOnce etc.). |
|
106 This property is used internally as a whitelist for faster |
|
107 Y.mix operations. |
|
108 </div> |
|
109 </div> |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 <hr /> |
|
115 </div> |
|
116 <div class="" rel="yui:property" resource="#property_Attribute.INVALID_VALUE"> |
|
117 <h4><a name="property_Attribute.INVALID_VALUE" property="yui:name">Attribute.INVALID_VALUE</a> |
|
118 - <code>static final <span property="yui:type">Object</span></code> |
|
119 </h4> |
|
120 <div class="detail"> |
|
121 <div class="description" property="yui:description"> |
|
122 <p>The value to return from an attribute setter in order to prevent the set from going through.</p> |
|
123 <p>You can return this value from your setter if you wish to combine validator and setter |
|
124 functionality into a single setter function, which either returns the massaged value to be stored or |
|
125 Attribute.INVALID_VALUE to prevent invalid values from being stored.</p> |
|
126 </div> |
|
127 </div> |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 <hr /> |
|
133 </div> |
|
134 </div> |
|
135 </div> |
|
136 |
|
137 </div> |
|
138 |
|
139 <div rel="yui:methods" resource="#methods"> |
|
140 <div class="section method details"> |
|
141 <h3 id="methods">Methods</h3> |
|
142 <div class="content"> |
|
143 <div class="private" rel="yui:method" resource="#method__addAttrs"> |
|
144 <h4> |
|
145 <a name="method__addAttrs">_addAttrs</a></h4> |
|
146 <div class="detail" > |
|
147 <code> |
|
148 private |
|
149 |
|
150 |
|
151 void |
|
152 <strong property="yui:name">_addAttrs</strong> |
|
153 ( |
|
154 |
|
155 |
|
156 cfgs |
|
157 |
|
158 |
|
159 , |
|
160 values |
|
161 |
|
162 |
|
163 , |
|
164 lazy |
|
165 |
|
166 |
|
167 ) |
|
168 </code> |
|
169 |
|
170 <div class="description" property="yui:description"> |
|
171 Implementation behind the public addAttrs method. |
|
172 This method is invoked directly by get if it encounters a scenario |
|
173 in which an attribute's valueFn attempts to obtain the |
|
174 value an attribute in the same group of attributes, which has not yet |
|
175 been added (on demand initialization). |
|
176 </div> |
|
177 |
|
178 <div class="description"> |
|
179 |
|
180 <dl rel="yui:parameters"> |
|
181 <dt>Parameters:</dt> |
|
182 <dd rel="yui:parameter"> |
|
183 <code><span property="yui:name">cfgs</span> |
|
184 <<span property="yui:type">Object</span>> |
|
185 </code> |
|
186 <span property="yui:description"> An object with attribute name/configuration pairs.</span> |
|
187 </dd> |
|
188 <dd rel="yui:parameter"> |
|
189 <code><span property="yui:name">values</span> |
|
190 <<span property="yui:type">Object</span>> |
|
191 </code> |
|
192 <span property="yui:description"> An object with attribute name/value pairs, defining the initial values to apply. |
|
193 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</span> |
|
194 </dd> |
|
195 <dd rel="yui:parameter"> |
|
196 <code><span property="yui:name">lazy</span> |
|
197 <<span property="yui:type">boolean</span>> |
|
198 </code> |
|
199 <span property="yui:description"> Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
200 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
201 See <a href="#method_addAttr">addAttr</a>.</span> |
|
202 </dd> |
|
203 </dl> |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 </div> |
|
210 |
|
211 </div> |
|
212 <hr /> |
|
213 </div> |
|
214 <div class="private" rel="yui:method" resource="#method__addLazyAttr"> |
|
215 <h4> |
|
216 <a name="method__addLazyAttr">_addLazyAttr</a></h4> |
|
217 <div class="detail" > |
|
218 <code> |
|
219 private |
|
220 |
|
221 |
|
222 void |
|
223 <strong property="yui:name">_addLazyAttr</strong> |
|
224 ( |
|
225 |
|
226 |
|
227 name |
|
228 |
|
229 |
|
230 ) |
|
231 </code> |
|
232 |
|
233 <div class="description" property="yui:description"> |
|
234 Finishes initializing an attribute which has been lazily added. |
|
235 </div> |
|
236 |
|
237 <div class="description"> |
|
238 |
|
239 <dl rel="yui:parameters"> |
|
240 <dt>Parameters:</dt> |
|
241 <dd rel="yui:parameter"> |
|
242 <code><span property="yui:name">name</span> |
|
243 <<span property="yui:type">Object</span>> |
|
244 </code> |
|
245 <span property="yui:description"> The name of the attribute</span> |
|
246 </dd> |
|
247 </dl> |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 </div> |
|
254 |
|
255 </div> |
|
256 <hr /> |
|
257 </div> |
|
258 <div class="private" rel="yui:method" resource="#method__defAttrChangeFn"> |
|
259 <h4> |
|
260 <a name="method__defAttrChangeFn">_defAttrChangeFn</a></h4> |
|
261 <div class="detail" > |
|
262 <code> |
|
263 private |
|
264 |
|
265 |
|
266 void |
|
267 <strong property="yui:name">_defAttrChangeFn</strong> |
|
268 ( |
|
269 |
|
270 |
|
271 e |
|
272 |
|
273 |
|
274 ) |
|
275 </code> |
|
276 |
|
277 <div class="description" property="yui:description"> |
|
278 Default function for attribute change events. |
|
279 </div> |
|
280 |
|
281 <div class="description"> |
|
282 |
|
283 <dl rel="yui:parameters"> |
|
284 <dt>Parameters:</dt> |
|
285 <dd rel="yui:parameter"> |
|
286 <code><span property="yui:name">e</span> |
|
287 <<span property="yui:type">EventFacade</span>> |
|
288 </code> |
|
289 <span property="yui:description"> The event object for attribute change events.</span> |
|
290 </dd> |
|
291 </dl> |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 </div> |
|
298 |
|
299 </div> |
|
300 <hr /> |
|
301 </div> |
|
302 <div class="private" rel="yui:method" resource="#method__fireAttrChange"> |
|
303 <h4> |
|
304 <a name="method__fireAttrChange">_fireAttrChange</a></h4> |
|
305 <div class="detail" > |
|
306 <code> |
|
307 private |
|
308 |
|
309 |
|
310 void |
|
311 <strong property="yui:name">_fireAttrChange</strong> |
|
312 ( |
|
313 |
|
314 |
|
315 attrName |
|
316 |
|
317 |
|
318 , |
|
319 subAttrName |
|
320 |
|
321 |
|
322 , |
|
323 currVal |
|
324 |
|
325 |
|
326 , |
|
327 newVal |
|
328 |
|
329 |
|
330 , |
|
331 opts |
|
332 |
|
333 |
|
334 ) |
|
335 </code> |
|
336 |
|
337 <div class="description" property="yui:description"> |
|
338 Utility method to help setup the event payload and fire the attribute change event. |
|
339 </div> |
|
340 |
|
341 <div class="description"> |
|
342 |
|
343 <dl rel="yui:parameters"> |
|
344 <dt>Parameters:</dt> |
|
345 <dd rel="yui:parameter"> |
|
346 <code><span property="yui:name">attrName</span> |
|
347 <<span property="yui:type">String</span>> |
|
348 </code> |
|
349 <span property="yui:description"> The name of the attribute</span> |
|
350 </dd> |
|
351 <dd rel="yui:parameter"> |
|
352 <code><span property="yui:name">subAttrName</span> |
|
353 <<span property="yui:type">String</span>> |
|
354 </code> |
|
355 <span property="yui:description"> The full path of the property being changed, |
|
356 if this is a sub-attribute value being change. Otherwise null.</span> |
|
357 </dd> |
|
358 <dd rel="yui:parameter"> |
|
359 <code><span property="yui:name">currVal</span> |
|
360 <<span property="yui:type">Any</span>> |
|
361 </code> |
|
362 <span property="yui:description"> The current value of the attribute</span> |
|
363 </dd> |
|
364 <dd rel="yui:parameter"> |
|
365 <code><span property="yui:name">newVal</span> |
|
366 <<span property="yui:type">Any</span>> |
|
367 </code> |
|
368 <span property="yui:description"> The new value of the attribute</span> |
|
369 </dd> |
|
370 <dd rel="yui:parameter"> |
|
371 <code><span property="yui:name">opts</span> |
|
372 <<span property="yui:type">Object</span>> |
|
373 </code> |
|
374 <span property="yui:description"> Any additional event data to mix into the attribute change event's event facade.</span> |
|
375 </dd> |
|
376 </dl> |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 |
|
382 </div> |
|
383 |
|
384 </div> |
|
385 <hr /> |
|
386 </div> |
|
387 <div class="protected" rel="yui:method" resource="#method__getAttr"> |
|
388 <h4> |
|
389 <a name="method__getAttr">_getAttr</a></h4> |
|
390 <div class="detail" > |
|
391 <code> |
|
392 protected |
|
393 |
|
394 |
|
395 Any |
|
396 <strong property="yui:name">_getAttr</strong> |
|
397 ( |
|
398 |
|
399 |
|
400 name |
|
401 |
|
402 |
|
403 ) |
|
404 </code> |
|
405 |
|
406 <div class="description" property="yui:description"> |
|
407 Provides the common implementation for the public get method, |
|
408 allowing Attribute hosts to over-ride either method. |
|
409 See <a href="#method_get">get</a> for argument details. |
|
410 </div> |
|
411 |
|
412 <div class="description"> |
|
413 |
|
414 <dl rel="yui:parameters"> |
|
415 <dt>Parameters:</dt> |
|
416 <dd rel="yui:parameter"> |
|
417 <code><span property="yui:name">name</span> |
|
418 <<span property="yui:type">String</span>> |
|
419 </code> |
|
420 <span property="yui:description"> The name of the attribute.</span> |
|
421 </dd> |
|
422 </dl> |
|
423 |
|
424 <dl> |
|
425 <dt>Returns: |
|
426 <code property="yui:return"> |
|
427 Any |
|
428 </code></dt> |
|
429 <dd property="yui:returnInfo">The value of the attribute.</dd> |
|
430 </dl> |
|
431 |
|
432 <div class="chainable"> |
|
433 <strong>Chainable:</strong> This method is chainable. |
|
434 </div> |
|
435 |
|
436 |
|
437 |
|
438 </div> |
|
439 |
|
440 </div> |
|
441 <hr /> |
|
442 </div> |
|
443 <div class="private" rel="yui:method" resource="#method__getAttrInitVal"> |
|
444 <h4> |
|
445 <a name="method__getAttrInitVal">_getAttrInitVal</a></h4> |
|
446 <div class="detail" > |
|
447 <code> |
|
448 private |
|
449 |
|
450 |
|
451 Any |
|
452 <strong property="yui:name">_getAttrInitVal</strong> |
|
453 ( |
|
454 |
|
455 |
|
456 attr |
|
457 |
|
458 |
|
459 , |
|
460 cfg |
|
461 |
|
462 |
|
463 , |
|
464 initValues |
|
465 |
|
466 |
|
467 ) |
|
468 </code> |
|
469 |
|
470 <div class="description" property="yui:description"> |
|
471 Returns the initial value of the given attribute from |
|
472 either the default configuration provided, or the |
|
473 over-ridden value if it exists in the set of initValues |
|
474 provided and the attribute is not read-only. |
|
475 </div> |
|
476 |
|
477 <div class="description"> |
|
478 |
|
479 <dl rel="yui:parameters"> |
|
480 <dt>Parameters:</dt> |
|
481 <dd rel="yui:parameter"> |
|
482 <code><span property="yui:name">attr</span> |
|
483 <<span property="yui:type">String</span>> |
|
484 </code> |
|
485 <span property="yui:description"> The name of the attribute</span> |
|
486 </dd> |
|
487 <dd rel="yui:parameter"> |
|
488 <code><span property="yui:name">cfg</span> |
|
489 <<span property="yui:type">Object</span>> |
|
490 </code> |
|
491 <span property="yui:description"> The attribute configuration object</span> |
|
492 </dd> |
|
493 <dd rel="yui:parameter"> |
|
494 <code><span property="yui:name">initValues</span> |
|
495 <<span property="yui:type">Object</span>> |
|
496 </code> |
|
497 <span property="yui:description"> The object with simple and complex attribute name/value pairs returned from _normAttrVals</span> |
|
498 </dd> |
|
499 </dl> |
|
500 |
|
501 <dl> |
|
502 <dt>Returns: |
|
503 <code property="yui:return"> |
|
504 Any |
|
505 </code></dt> |
|
506 <dd property="yui:returnInfo">The initial value of the attribute.</dd> |
|
507 </dl> |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 </div> |
|
513 |
|
514 </div> |
|
515 <hr /> |
|
516 </div> |
|
517 <div class="protected" rel="yui:method" resource="#method__getAttrs"> |
|
518 <h4> |
|
519 <a name="method__getAttrs">_getAttrs</a></h4> |
|
520 <div class="detail" > |
|
521 <code> |
|
522 protected |
|
523 |
|
524 |
|
525 Object |
|
526 <strong property="yui:name">_getAttrs</strong> |
|
527 ( |
|
528 |
|
529 |
|
530 attrs |
|
531 |
|
532 |
|
533 ) |
|
534 </code> |
|
535 |
|
536 <div class="description" property="yui:description"> |
|
537 Implementation behind the public getAttrs method, to get multiple attribute values. |
|
538 </div> |
|
539 |
|
540 <div class="description"> |
|
541 |
|
542 <dl rel="yui:parameters"> |
|
543 <dt>Parameters:</dt> |
|
544 <dd rel="yui:parameter"> |
|
545 <code><span property="yui:name">attrs</span> |
|
546 <<span property="yui:type">Array | boolean</span>> |
|
547 </code> |
|
548 <span property="yui:description"> Optional. An array of attribute names. If omitted, all attribute values are |
|
549 returned. If set to true, all attributes modified from their initial values are returned.</span> |
|
550 </dd> |
|
551 </dl> |
|
552 |
|
553 <dl> |
|
554 <dt>Returns: |
|
555 <code property="yui:return"> |
|
556 Object |
|
557 </code></dt> |
|
558 <dd property="yui:returnInfo">An object with attribute name/value pairs.</dd> |
|
559 </dl> |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 </div> |
|
565 |
|
566 </div> |
|
567 <hr /> |
|
568 </div> |
|
569 <div class="private" rel="yui:method" resource="#method__getStateVal"> |
|
570 <h4> |
|
571 <a name="method__getStateVal">_getStateVal</a></h4> |
|
572 <div class="detail" > |
|
573 <code> |
|
574 private |
|
575 |
|
576 |
|
577 Any |
|
578 <strong property="yui:name">_getStateVal</strong> |
|
579 ( |
|
580 |
|
581 |
|
582 name |
|
583 |
|
584 |
|
585 ) |
|
586 </code> |
|
587 |
|
588 <div class="description" property="yui:description"> |
|
589 Gets the stored value for the attribute, from either the |
|
590 internal state object, or the state proxy if it exits |
|
591 </div> |
|
592 |
|
593 <div class="description"> |
|
594 |
|
595 <dl rel="yui:parameters"> |
|
596 <dt>Parameters:</dt> |
|
597 <dd rel="yui:parameter"> |
|
598 <code><span property="yui:name">name</span> |
|
599 <<span property="yui:type">String</span>> |
|
600 </code> |
|
601 <span property="yui:description"> The name of the attribute</span> |
|
602 </dd> |
|
603 </dl> |
|
604 |
|
605 <dl> |
|
606 <dt>Returns: |
|
607 <code property="yui:return"> |
|
608 Any |
|
609 </code></dt> |
|
610 <dd property="yui:returnInfo">The stored value of the attribute</dd> |
|
611 </dl> |
|
612 |
|
613 |
|
614 |
|
615 |
|
616 </div> |
|
617 |
|
618 </div> |
|
619 <hr /> |
|
620 </div> |
|
621 <div class="private" rel="yui:method" resource="#method__isLazyAttr"> |
|
622 <h4> |
|
623 <a name="method__isLazyAttr">_isLazyAttr</a></h4> |
|
624 <div class="detail" > |
|
625 <code> |
|
626 private |
|
627 |
|
628 |
|
629 boolean |
|
630 <strong property="yui:name">_isLazyAttr</strong> |
|
631 ( |
|
632 |
|
633 |
|
634 name |
|
635 |
|
636 |
|
637 ) |
|
638 </code> |
|
639 |
|
640 <div class="description" property="yui:description"> |
|
641 Checks whether or not the attribute is one which has been |
|
642 added lazily and still requires initialization. |
|
643 </div> |
|
644 |
|
645 <div class="description"> |
|
646 |
|
647 <dl rel="yui:parameters"> |
|
648 <dt>Parameters:</dt> |
|
649 <dd rel="yui:parameter"> |
|
650 <code><span property="yui:name">name</span> |
|
651 <<span property="yui:type">String</span>> |
|
652 </code> |
|
653 <span property="yui:description"> The name of the attribute</span> |
|
654 </dd> |
|
655 </dl> |
|
656 |
|
657 <dl> |
|
658 <dt>Returns: |
|
659 <code property="yui:return"> |
|
660 boolean |
|
661 </code></dt> |
|
662 <dd property="yui:returnInfo">true if it's a lazily added attribute, false otherwise.</dd> |
|
663 </dl> |
|
664 |
|
665 |
|
666 |
|
667 |
|
668 </div> |
|
669 |
|
670 </div> |
|
671 <hr /> |
|
672 </div> |
|
673 <div class="private" rel="yui:method" resource="#method__normAttrVals"> |
|
674 <h4> |
|
675 <a name="method__normAttrVals">_normAttrVals</a></h4> |
|
676 <div class="detail" > |
|
677 <code> |
|
678 private |
|
679 |
|
680 |
|
681 Object |
|
682 <strong property="yui:name">_normAttrVals</strong> |
|
683 ( |
|
684 |
|
685 |
|
686 valueHash |
|
687 |
|
688 |
|
689 ) |
|
690 </code> |
|
691 |
|
692 <div class="description" property="yui:description"> |
|
693 Utility method to split out simple attribute name/value pairs ("x") |
|
694 from complex attribute name/value pairs ("x.y.z"), so that complex |
|
695 attributes can be keyed by the top level attribute name. |
|
696 </div> |
|
697 |
|
698 <div class="description"> |
|
699 |
|
700 <dl rel="yui:parameters"> |
|
701 <dt>Parameters:</dt> |
|
702 <dd rel="yui:parameter"> |
|
703 <code><span property="yui:name">valueHash</span> |
|
704 <<span property="yui:type">Object</span>> |
|
705 </code> |
|
706 <span property="yui:description"> An object with attribute name/value pairs</span> |
|
707 </dd> |
|
708 </dl> |
|
709 |
|
710 <dl> |
|
711 <dt>Returns: |
|
712 <code property="yui:return"> |
|
713 Object |
|
714 </code></dt> |
|
715 <dd property="yui:returnInfo">An object literal with 2 properties - "simple" and "complex", |
|
716 containing simple and complex attribute values respectively keyed |
|
717 by the top level attribute name, or null, if valueHash is falsey.</dd> |
|
718 </dl> |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 </div> |
|
724 |
|
725 </div> |
|
726 <hr /> |
|
727 </div> |
|
728 <div class="protected" rel="yui:method" resource="#method__protectAttrs"> |
|
729 <h4> |
|
730 <a name="method__protectAttrs">_protectAttrs</a></h4> |
|
731 <div class="detail" > |
|
732 <code> |
|
733 protected |
|
734 |
|
735 |
|
736 Object |
|
737 <strong property="yui:name">_protectAttrs</strong> |
|
738 ( |
|
739 |
|
740 |
|
741 attrs |
|
742 |
|
743 |
|
744 ) |
|
745 </code> |
|
746 |
|
747 <div class="description" property="yui:description"> |
|
748 Utility method to protect an attribute configuration |
|
749 hash, by merging the entire object and the individual |
|
750 attr config objects. |
|
751 </div> |
|
752 |
|
753 <div class="description"> |
|
754 |
|
755 <dl rel="yui:parameters"> |
|
756 <dt>Parameters:</dt> |
|
757 <dd rel="yui:parameter"> |
|
758 <code><span property="yui:name">attrs</span> |
|
759 <<span property="yui:type">Object</span>> |
|
760 </code> |
|
761 <span property="yui:description"> A hash of attribute to configuration object pairs.</span> |
|
762 </dd> |
|
763 </dl> |
|
764 |
|
765 <dl> |
|
766 <dt>Returns: |
|
767 <code property="yui:return"> |
|
768 Object |
|
769 </code></dt> |
|
770 <dd property="yui:returnInfo">A protected version of the attrs argument.</dd> |
|
771 </dl> |
|
772 |
|
773 |
|
774 |
|
775 |
|
776 </div> |
|
777 |
|
778 </div> |
|
779 <hr /> |
|
780 </div> |
|
781 <div class="protected" rel="yui:method" resource="#method__set"> |
|
782 <h4> |
|
783 <a name="method__set">_set</a></h4> |
|
784 <div class="detail" > |
|
785 <code> |
|
786 protected |
|
787 |
|
788 |
|
789 Object |
|
790 <strong property="yui:name">_set</strong> |
|
791 ( |
|
792 |
|
793 |
|
794 name |
|
795 |
|
796 |
|
797 , |
|
798 val |
|
799 |
|
800 |
|
801 , |
|
802 opts |
|
803 |
|
804 |
|
805 ) |
|
806 </code> |
|
807 |
|
808 <div class="description" property="yui:description"> |
|
809 Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details. |
|
810 </div> |
|
811 |
|
812 <div class="description"> |
|
813 |
|
814 <dl rel="yui:parameters"> |
|
815 <dt>Parameters:</dt> |
|
816 <dd rel="yui:parameter"> |
|
817 <code><span property="yui:name">name</span> |
|
818 <<span property="yui:type">String</span>> |
|
819 </code> |
|
820 <span property="yui:description"> The name of the attribute.</span> |
|
821 </dd> |
|
822 <dd rel="yui:parameter"> |
|
823 <code><span property="yui:name">val</span> |
|
824 <<span property="yui:type">Any</span>> |
|
825 </code> |
|
826 <span property="yui:description"> The value to set the attribute to.</span> |
|
827 </dd> |
|
828 <dd rel="yui:parameter"> |
|
829 <code><span property="yui:name">opts</span> |
|
830 <<span property="yui:type">Object</span>> |
|
831 </code> |
|
832 <span property="yui:description"> (Optional) Optional event data to be mixed into |
|
833 the event facade passed to subscribers of the attribute's change event.</span> |
|
834 </dd> |
|
835 </dl> |
|
836 |
|
837 <dl> |
|
838 <dt>Returns: |
|
839 <code property="yui:return"> |
|
840 Object |
|
841 </code></dt> |
|
842 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
843 </dl> |
|
844 |
|
845 <div class="chainable"> |
|
846 <strong>Chainable:</strong> This method is chainable. |
|
847 </div> |
|
848 |
|
849 |
|
850 |
|
851 </div> |
|
852 |
|
853 </div> |
|
854 <hr /> |
|
855 </div> |
|
856 <div class="protected" rel="yui:method" resource="#method__setAttr"> |
|
857 <h4> |
|
858 <a name="method__setAttr">_setAttr</a></h4> |
|
859 <div class="detail" > |
|
860 <code> |
|
861 protected |
|
862 |
|
863 |
|
864 Object |
|
865 <strong property="yui:name">_setAttr</strong> |
|
866 ( |
|
867 |
|
868 |
|
869 name |
|
870 |
|
871 |
|
872 , |
|
873 value |
|
874 |
|
875 |
|
876 , |
|
877 opts |
|
878 |
|
879 |
|
880 , |
|
881 force |
|
882 |
|
883 |
|
884 ) |
|
885 </code> |
|
886 |
|
887 <div class="description" property="yui:description"> |
|
888 Provides the common implementation for the public set and protected _set methods. |
|
889 See <a href="#method_set">set</a> for argument details. |
|
890 </div> |
|
891 |
|
892 <div class="description"> |
|
893 |
|
894 <dl rel="yui:parameters"> |
|
895 <dt>Parameters:</dt> |
|
896 <dd rel="yui:parameter"> |
|
897 <code><span property="yui:name">name</span> |
|
898 <<span property="yui:type">String</span>> |
|
899 </code> |
|
900 <span property="yui:description"> The name of the attribute.</span> |
|
901 </dd> |
|
902 <dd rel="yui:parameter"> |
|
903 <code><span property="yui:name">value</span> |
|
904 <<span property="yui:type">Any</span>> |
|
905 </code> |
|
906 <span property="yui:description"> The value to set the attribute to.</span> |
|
907 </dd> |
|
908 <dd rel="yui:parameter"> |
|
909 <code><span property="yui:name">opts</span> |
|
910 <<span property="yui:type">Object</span>> |
|
911 </code> |
|
912 <span property="yui:description"> (Optional) Optional event data to be mixed into |
|
913 the event facade passed to subscribers of the attribute's change event.</span> |
|
914 </dd> |
|
915 <dd rel="yui:parameter"> |
|
916 <code><span property="yui:name">force</span> |
|
917 <<span property="yui:type">boolean</span>> |
|
918 </code> |
|
919 <span property="yui:description"> If true, allows the caller to set values for |
|
920 readOnly or writeOnce attributes which have already been set.</span> |
|
921 </dd> |
|
922 </dl> |
|
923 |
|
924 <dl> |
|
925 <dt>Returns: |
|
926 <code property="yui:return"> |
|
927 Object |
|
928 </code></dt> |
|
929 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
930 </dl> |
|
931 |
|
932 <div class="chainable"> |
|
933 <strong>Chainable:</strong> This method is chainable. |
|
934 </div> |
|
935 |
|
936 |
|
937 |
|
938 </div> |
|
939 |
|
940 </div> |
|
941 <hr /> |
|
942 </div> |
|
943 <div class="protected" rel="yui:method" resource="#method__setAttrs"> |
|
944 <h4> |
|
945 <a name="method__setAttrs">_setAttrs</a></h4> |
|
946 <div class="detail" > |
|
947 <code> |
|
948 protected |
|
949 |
|
950 |
|
951 Object |
|
952 <strong property="yui:name">_setAttrs</strong> |
|
953 ( |
|
954 |
|
955 |
|
956 attrs |
|
957 |
|
958 |
|
959 ) |
|
960 </code> |
|
961 |
|
962 <div class="description" property="yui:description"> |
|
963 Implementation behind the public setAttrs method, to set multiple attribute values. |
|
964 </div> |
|
965 |
|
966 <div class="description"> |
|
967 |
|
968 <dl rel="yui:parameters"> |
|
969 <dt>Parameters:</dt> |
|
970 <dd rel="yui:parameter"> |
|
971 <code><span property="yui:name">attrs</span> |
|
972 <<span property="yui:type">Object</span>> |
|
973 </code> |
|
974 <span property="yui:description"> An object with attributes name/value pairs.</span> |
|
975 </dd> |
|
976 </dl> |
|
977 |
|
978 <dl> |
|
979 <dt>Returns: |
|
980 <code property="yui:return"> |
|
981 Object |
|
982 </code></dt> |
|
983 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
984 </dl> |
|
985 |
|
986 <div class="chainable"> |
|
987 <strong>Chainable:</strong> This method is chainable. |
|
988 </div> |
|
989 |
|
990 |
|
991 |
|
992 </div> |
|
993 |
|
994 </div> |
|
995 <hr /> |
|
996 </div> |
|
997 <div class="private" rel="yui:method" resource="#method__setAttrVal"> |
|
998 <h4> |
|
999 <a name="method__setAttrVal">_setAttrVal</a></h4> |
|
1000 <div class="detail" > |
|
1001 <code> |
|
1002 private |
|
1003 |
|
1004 |
|
1005 booolean |
|
1006 <strong property="yui:name">_setAttrVal</strong> |
|
1007 ( |
|
1008 |
|
1009 |
|
1010 attrName |
|
1011 |
|
1012 |
|
1013 , |
|
1014 subAttrName |
|
1015 |
|
1016 |
|
1017 , |
|
1018 prevVal |
|
1019 |
|
1020 |
|
1021 , |
|
1022 newVal |
|
1023 |
|
1024 |
|
1025 ) |
|
1026 </code> |
|
1027 |
|
1028 <div class="description" property="yui:description"> |
|
1029 Updates the stored value of the attribute in the privately held State object, |
|
1030 if validation and setter passes. |
|
1031 </div> |
|
1032 |
|
1033 <div class="description"> |
|
1034 |
|
1035 <dl rel="yui:parameters"> |
|
1036 <dt>Parameters:</dt> |
|
1037 <dd rel="yui:parameter"> |
|
1038 <code><span property="yui:name">attrName</span> |
|
1039 <<span property="yui:type">String</span>> |
|
1040 </code> |
|
1041 <span property="yui:description"> The attribute name.</span> |
|
1042 </dd> |
|
1043 <dd rel="yui:parameter"> |
|
1044 <code><span property="yui:name">subAttrName</span> |
|
1045 <<span property="yui:type">String</span>> |
|
1046 </code> |
|
1047 <span property="yui:description"> The sub-attribute name, if setting a sub-attribute property ("x.y.z").</span> |
|
1048 </dd> |
|
1049 <dd rel="yui:parameter"> |
|
1050 <code><span property="yui:name">prevVal</span> |
|
1051 <<span property="yui:type">Any</span>> |
|
1052 </code> |
|
1053 <span property="yui:description"> The currently stored value of the attribute.</span> |
|
1054 </dd> |
|
1055 <dd rel="yui:parameter"> |
|
1056 <code><span property="yui:name">newVal</span> |
|
1057 <<span property="yui:type">Any</span>> |
|
1058 </code> |
|
1059 <span property="yui:description"> The value which is going to be stored.</span> |
|
1060 </dd> |
|
1061 </dl> |
|
1062 |
|
1063 <dl> |
|
1064 <dt>Returns: |
|
1065 <code property="yui:return"> |
|
1066 booolean |
|
1067 </code></dt> |
|
1068 <dd property="yui:returnInfo">true if the new attribute value was stored, false if not.</dd> |
|
1069 </dl> |
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 </div> |
|
1075 |
|
1076 </div> |
|
1077 <hr /> |
|
1078 </div> |
|
1079 <div class="private" rel="yui:method" resource="#method__setStateVal"> |
|
1080 <h4> |
|
1081 <a name="method__setStateVal">_setStateVal</a></h4> |
|
1082 <div class="detail" > |
|
1083 <code> |
|
1084 private |
|
1085 |
|
1086 |
|
1087 void |
|
1088 <strong property="yui:name">_setStateVal</strong> |
|
1089 ( |
|
1090 |
|
1091 |
|
1092 name |
|
1093 |
|
1094 |
|
1095 , |
|
1096 value |
|
1097 |
|
1098 |
|
1099 ) |
|
1100 </code> |
|
1101 |
|
1102 <div class="description" property="yui:description"> |
|
1103 Sets the stored value for the attribute, in either the |
|
1104 internal state object, or the state proxy if it exits |
|
1105 </div> |
|
1106 |
|
1107 <div class="description"> |
|
1108 |
|
1109 <dl rel="yui:parameters"> |
|
1110 <dt>Parameters:</dt> |
|
1111 <dd rel="yui:parameter"> |
|
1112 <code><span property="yui:name">name</span> |
|
1113 <<span property="yui:type">String</span>> |
|
1114 </code> |
|
1115 <span property="yui:description"> The name of the attribute</span> |
|
1116 </dd> |
|
1117 <dd rel="yui:parameter"> |
|
1118 <code><span property="yui:name">value</span> |
|
1119 <<span property="yui:type">Any</span>> |
|
1120 </code> |
|
1121 <span property="yui:description"> The value of the attribute</span> |
|
1122 </dd> |
|
1123 </dl> |
|
1124 |
|
1125 |
|
1126 |
|
1127 |
|
1128 |
|
1129 </div> |
|
1130 |
|
1131 </div> |
|
1132 <hr /> |
|
1133 </div> |
|
1134 <div class="" rel="yui:method" resource="#method_addAttr"> |
|
1135 <h4> |
|
1136 <a name="method_addAttr">addAttr</a></h4> |
|
1137 <div class="detail" > |
|
1138 <code> |
|
1139 |
|
1140 |
|
1141 |
|
1142 Object |
|
1143 <strong property="yui:name">addAttr</strong> |
|
1144 ( |
|
1145 |
|
1146 |
|
1147 name |
|
1148 |
|
1149 |
|
1150 , |
|
1151 config |
|
1152 |
|
1153 |
|
1154 , |
|
1155 lazy |
|
1156 |
|
1157 |
|
1158 ) |
|
1159 </code> |
|
1160 |
|
1161 <div class="description" property="yui:description"> |
|
1162 <p> |
|
1163 Adds an attribute with the provided configuration to the host object. |
|
1164 </p> |
|
1165 <p> |
|
1166 The config argument object supports the following properties: |
|
1167 </p> |
|
1168 <dl> |
|
1169 <dt>value <Any></dt> |
|
1170 <dd>The initial value to set on the attribute</dd> |
|
1171 <dt>valueFn <Function></dt> |
|
1172 <dd>A function, which will return the initial value to set on the attribute. This is useful |
|
1173 for cases where the attribute configuration is defined statically, but needs to |
|
1174 reference the host instance ("this") to obtain an initial value. |
|
1175 If defined, this precedence over the value property.</dd> |
|
1176 <dt>readOnly <boolean></dt> |
|
1177 <dd>Whether or not the attribute is read only. Attributes having readOnly set to true |
|
1178 cannot be modified by invoking the set method.</dd> |
|
1179 <dt>writeOnce <boolean></dt> |
|
1180 <dd>Whether or not the attribute is "write once". Attributes having writeOnce set to true, |
|
1181 can only have their values set once, be it through the default configuration, |
|
1182 constructor configuration arguments, or by invoking set.</dd> |
|
1183 <dt>setter <Function></dt> |
|
1184 <dd>The setter function used to massage or normalize the value passed to the set method for the attribute. |
|
1185 The value returned by the setter will be the final stored value. Returning |
|
1186 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent |
|
1187 the value from being stored.</dd> |
|
1188 <dt>getter <Function></dt> |
|
1189 <dd>The getter function used to massage or normalize the value returned by the get method for the attribute. |
|
1190 The value returned by the getter function is the value which will be returned to the user when they |
|
1191 invoke get.</dd> |
|
1192 <dt>validator <Function></dt> |
|
1193 <dd>The validator function invoked prior to setting the stored value. Returning |
|
1194 false from the validator function will prevent the value from being stored.</dd> |
|
1195 <dt>broadcast <int></dt> |
|
1196 <dd>If and how attribute change events for this attribute should be broadcast. See CustomEvent's <a href="CustomEvent.html#property_broadcast">broadcast</a> property for |
|
1197 valid values. By default attribute change events are not broadcast.</dd> |
|
1198 <dt>lazyAdd <boolean></dt> |
|
1199 <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. |
|
1200 This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through |
|
1201 the <a href="#method_addAttrs">addAttrs</a> method.</dd> |
|
1202 </dl> |
|
1203 <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with |
|
1204 the context ("this") set to the host object.</p> |
|
1205 <p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.</p> |
|
1206 </div> |
|
1207 |
|
1208 <div class="description"> |
|
1209 |
|
1210 <dl rel="yui:parameters"> |
|
1211 <dt>Parameters:</dt> |
|
1212 <dd rel="yui:parameter"> |
|
1213 <code><span property="yui:name">name</span> |
|
1214 <<span property="yui:type">String</span>> |
|
1215 </code> |
|
1216 <span property="yui:description"> The name of the attribute.</span> |
|
1217 </dd> |
|
1218 <dd rel="yui:parameter"> |
|
1219 <code><span property="yui:name">config</span> |
|
1220 <<span property="yui:type">Object</span>> |
|
1221 </code> |
|
1222 <span property="yui:description"> An object with attribute configuration property/value pairs, specifying the configuration for the attribute. |
|
1223 <p> |
|
1224 <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need |
|
1225 to protect the original values, you will need to merge the object. |
|
1226 </p></span> |
|
1227 </dd> |
|
1228 <dd rel="yui:parameter"> |
|
1229 <code><span property="yui:name">lazy</span> |
|
1230 <<span property="yui:type">boolean</span>> |
|
1231 </code> |
|
1232 <span property="yui:description"> (optional) Whether or not to add this attribute lazily (on the first call to get/set).</span> |
|
1233 </dd> |
|
1234 </dl> |
|
1235 |
|
1236 <dl> |
|
1237 <dt>Returns: |
|
1238 <code property="yui:return"> |
|
1239 Object |
|
1240 </code></dt> |
|
1241 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
1242 </dl> |
|
1243 |
|
1244 <div class="chainable"> |
|
1245 <strong>Chainable:</strong> This method is chainable. |
|
1246 </div> |
|
1247 |
|
1248 |
|
1249 |
|
1250 </div> |
|
1251 |
|
1252 </div> |
|
1253 <hr /> |
|
1254 </div> |
|
1255 <div class="" rel="yui:method" resource="#method_addAttrs"> |
|
1256 <h4> |
|
1257 <a name="method_addAttrs">addAttrs</a></h4> |
|
1258 <div class="detail" > |
|
1259 <code> |
|
1260 |
|
1261 |
|
1262 |
|
1263 Object |
|
1264 <strong property="yui:name">addAttrs</strong> |
|
1265 ( |
|
1266 |
|
1267 |
|
1268 cfgs |
|
1269 |
|
1270 |
|
1271 , |
|
1272 values |
|
1273 |
|
1274 |
|
1275 , |
|
1276 lazy |
|
1277 |
|
1278 |
|
1279 ) |
|
1280 </code> |
|
1281 |
|
1282 <div class="description" property="yui:description"> |
|
1283 Configures a group of attributes, and sets initial values. |
|
1284 <p> |
|
1285 <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. |
|
1286 The caller is responsible for merging/cloning the configuration object if required. |
|
1287 </p> |
|
1288 </div> |
|
1289 |
|
1290 <div class="description"> |
|
1291 |
|
1292 <dl rel="yui:parameters"> |
|
1293 <dt>Parameters:</dt> |
|
1294 <dd rel="yui:parameter"> |
|
1295 <code><span property="yui:name">cfgs</span> |
|
1296 <<span property="yui:type">Object</span>> |
|
1297 </code> |
|
1298 <span property="yui:description"> An object with attribute name/configuration pairs.</span> |
|
1299 </dd> |
|
1300 <dd rel="yui:parameter"> |
|
1301 <code><span property="yui:name">values</span> |
|
1302 <<span property="yui:type">Object</span>> |
|
1303 </code> |
|
1304 <span property="yui:description"> An object with attribute name/value pairs, defining the initial values to apply. |
|
1305 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</span> |
|
1306 </dd> |
|
1307 <dd rel="yui:parameter"> |
|
1308 <code><span property="yui:name">lazy</span> |
|
1309 <<span property="yui:type">boolean</span>> |
|
1310 </code> |
|
1311 <span property="yui:description"> Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
1312 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
1313 See <a href="#method_addAttr">addAttr</a>.</span> |
|
1314 </dd> |
|
1315 </dl> |
|
1316 |
|
1317 <dl> |
|
1318 <dt>Returns: |
|
1319 <code property="yui:return"> |
|
1320 Object |
|
1321 </code></dt> |
|
1322 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
1323 </dl> |
|
1324 |
|
1325 <div class="chainable"> |
|
1326 <strong>Chainable:</strong> This method is chainable. |
|
1327 </div> |
|
1328 |
|
1329 |
|
1330 |
|
1331 </div> |
|
1332 |
|
1333 </div> |
|
1334 <hr /> |
|
1335 </div> |
|
1336 <div class="" rel="yui:method" resource="#method_attrAdded"> |
|
1337 <h4> |
|
1338 <a name="method_attrAdded">attrAdded</a></h4> |
|
1339 <div class="detail" > |
|
1340 <code> |
|
1341 |
|
1342 |
|
1343 |
|
1344 boolean |
|
1345 <strong property="yui:name">attrAdded</strong> |
|
1346 ( |
|
1347 |
|
1348 |
|
1349 name |
|
1350 |
|
1351 |
|
1352 ) |
|
1353 </code> |
|
1354 |
|
1355 <div class="description" property="yui:description"> |
|
1356 Checks if the given attribute has been added to the host |
|
1357 </div> |
|
1358 |
|
1359 <div class="description"> |
|
1360 |
|
1361 <dl rel="yui:parameters"> |
|
1362 <dt>Parameters:</dt> |
|
1363 <dd rel="yui:parameter"> |
|
1364 <code><span property="yui:name">name</span> |
|
1365 <<span property="yui:type">String</span>> |
|
1366 </code> |
|
1367 <span property="yui:description"> The name of the attribute to check.</span> |
|
1368 </dd> |
|
1369 </dl> |
|
1370 |
|
1371 <dl> |
|
1372 <dt>Returns: |
|
1373 <code property="yui:return"> |
|
1374 boolean |
|
1375 </code></dt> |
|
1376 <dd property="yui:returnInfo">true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.</dd> |
|
1377 </dl> |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 </div> |
|
1383 |
|
1384 </div> |
|
1385 <hr /> |
|
1386 </div> |
|
1387 <div class="" rel="yui:method" resource="#method_get"> |
|
1388 <h4> |
|
1389 <a name="method_get">get</a></h4> |
|
1390 <div class="detail" > |
|
1391 <code> |
|
1392 |
|
1393 |
|
1394 |
|
1395 Any |
|
1396 <strong property="yui:name">get</strong> |
|
1397 ( |
|
1398 |
|
1399 |
|
1400 name |
|
1401 |
|
1402 |
|
1403 ) |
|
1404 </code> |
|
1405 |
|
1406 <div class="description" property="yui:description"> |
|
1407 Returns the current value of the attribute. If the attribute |
|
1408 has been configured with a 'getter' function, this method will delegate |
|
1409 to the 'getter' to obtain the value of the attribute. |
|
1410 </div> |
|
1411 |
|
1412 <div class="description"> |
|
1413 |
|
1414 <dl rel="yui:parameters"> |
|
1415 <dt>Parameters:</dt> |
|
1416 <dd rel="yui:parameter"> |
|
1417 <code><span property="yui:name">name</span> |
|
1418 <<span property="yui:type">String</span>> |
|
1419 </code> |
|
1420 <span property="yui:description"> The name of the attribute. If the value of the attribute is an Object, |
|
1421 dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</span> |
|
1422 </dd> |
|
1423 </dl> |
|
1424 |
|
1425 <dl> |
|
1426 <dt>Returns: |
|
1427 <code property="yui:return"> |
|
1428 Any |
|
1429 </code></dt> |
|
1430 <dd property="yui:returnInfo">The value of the attribute</dd> |
|
1431 </dl> |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 </div> |
|
1437 |
|
1438 </div> |
|
1439 <hr /> |
|
1440 </div> |
|
1441 <div class="" rel="yui:method" resource="#method_getAttrs"> |
|
1442 <h4> |
|
1443 <a name="method_getAttrs">getAttrs</a></h4> |
|
1444 <div class="detail" > |
|
1445 <code> |
|
1446 |
|
1447 |
|
1448 |
|
1449 Object |
|
1450 <strong property="yui:name">getAttrs</strong> |
|
1451 ( |
|
1452 |
|
1453 |
|
1454 attrs |
|
1455 |
|
1456 |
|
1457 ) |
|
1458 </code> |
|
1459 |
|
1460 <div class="description" property="yui:description"> |
|
1461 Gets multiple attribute values. |
|
1462 </div> |
|
1463 |
|
1464 <div class="description"> |
|
1465 |
|
1466 <dl rel="yui:parameters"> |
|
1467 <dt>Parameters:</dt> |
|
1468 <dd rel="yui:parameter"> |
|
1469 <code><span property="yui:name">attrs</span> |
|
1470 <<span property="yui:type">Array | boolean</span>> |
|
1471 </code> |
|
1472 <span property="yui:description"> Optional. An array of attribute names. If omitted, all attribute values are |
|
1473 returned. If set to true, all attributes modified from their initial values are returned.</span> |
|
1474 </dd> |
|
1475 </dl> |
|
1476 |
|
1477 <dl> |
|
1478 <dt>Returns: |
|
1479 <code property="yui:return"> |
|
1480 Object |
|
1481 </code></dt> |
|
1482 <dd property="yui:returnInfo">An object with attribute name/value pairs.</dd> |
|
1483 </dl> |
|
1484 |
|
1485 |
|
1486 |
|
1487 |
|
1488 </div> |
|
1489 |
|
1490 </div> |
|
1491 <hr /> |
|
1492 </div> |
|
1493 <div class="" rel="yui:method" resource="#method_modifyAttr"> |
|
1494 <h4> |
|
1495 <a name="method_modifyAttr">modifyAttr</a></h4> |
|
1496 <div class="detail" > |
|
1497 <code> |
|
1498 |
|
1499 |
|
1500 |
|
1501 void |
|
1502 <strong property="yui:name">modifyAttr</strong> |
|
1503 ( |
|
1504 |
|
1505 |
|
1506 name |
|
1507 |
|
1508 |
|
1509 , |
|
1510 config |
|
1511 |
|
1512 |
|
1513 ) |
|
1514 </code> |
|
1515 |
|
1516 <div class="description" property="yui:description"> |
|
1517 Updates the configuration of an attribute which has already been added. |
|
1518 <p> |
|
1519 The properties which can be modified through this interface are limited |
|
1520 to the following subset of attributes, which can be safely modified |
|
1521 after a value has already been set on the attribute: readOnly, writeOnce, |
|
1522 broadcast and getter. |
|
1523 </p> |
|
1524 </div> |
|
1525 |
|
1526 <div class="description"> |
|
1527 |
|
1528 <dl rel="yui:parameters"> |
|
1529 <dt>Parameters:</dt> |
|
1530 <dd rel="yui:parameter"> |
|
1531 <code><span property="yui:name">name</span> |
|
1532 <<span property="yui:type">String</span>> |
|
1533 </code> |
|
1534 <span property="yui:description"> The name of the attribute whose configuration is to be updated.</span> |
|
1535 </dd> |
|
1536 <dd rel="yui:parameter"> |
|
1537 <code><span property="yui:name">config</span> |
|
1538 <<span property="yui:type">Object</span>> |
|
1539 </code> |
|
1540 <span property="yui:description"> An object with configuration property/value pairs, specifying the configuration properties to modify.</span> |
|
1541 </dd> |
|
1542 </dl> |
|
1543 |
|
1544 |
|
1545 |
|
1546 |
|
1547 |
|
1548 </div> |
|
1549 |
|
1550 </div> |
|
1551 <hr /> |
|
1552 </div> |
|
1553 <div class="" rel="yui:method" resource="#method_removeAttr"> |
|
1554 <h4> |
|
1555 <a name="method_removeAttr">removeAttr</a></h4> |
|
1556 <div class="detail" > |
|
1557 <code> |
|
1558 |
|
1559 |
|
1560 |
|
1561 void |
|
1562 <strong property="yui:name">removeAttr</strong> |
|
1563 ( |
|
1564 |
|
1565 |
|
1566 name |
|
1567 |
|
1568 |
|
1569 ) |
|
1570 </code> |
|
1571 |
|
1572 <div class="description" property="yui:description"> |
|
1573 Removes an attribute from the host object |
|
1574 </div> |
|
1575 |
|
1576 <div class="description"> |
|
1577 |
|
1578 <dl rel="yui:parameters"> |
|
1579 <dt>Parameters:</dt> |
|
1580 <dd rel="yui:parameter"> |
|
1581 <code><span property="yui:name">name</span> |
|
1582 <<span property="yui:type">String</span>> |
|
1583 </code> |
|
1584 <span property="yui:description"> The name of the attribute to be removed.</span> |
|
1585 </dd> |
|
1586 </dl> |
|
1587 |
|
1588 |
|
1589 |
|
1590 |
|
1591 |
|
1592 </div> |
|
1593 |
|
1594 </div> |
|
1595 <hr /> |
|
1596 </div> |
|
1597 <div class="" rel="yui:method" resource="#method_reset"> |
|
1598 <h4> |
|
1599 <a name="method_reset">reset</a></h4> |
|
1600 <div class="detail" > |
|
1601 <code> |
|
1602 |
|
1603 |
|
1604 |
|
1605 Object |
|
1606 <strong property="yui:name">reset</strong> |
|
1607 ( |
|
1608 |
|
1609 |
|
1610 name |
|
1611 |
|
1612 |
|
1613 ) |
|
1614 </code> |
|
1615 |
|
1616 <div class="description" property="yui:description"> |
|
1617 Resets the attribute (or all attributes) to its initial value, as long as |
|
1618 the attribute is not readOnly, or writeOnce. |
|
1619 </div> |
|
1620 |
|
1621 <div class="description"> |
|
1622 |
|
1623 <dl rel="yui:parameters"> |
|
1624 <dt>Parameters:</dt> |
|
1625 <dd rel="yui:parameter"> |
|
1626 <code><span property="yui:name">name</span> |
|
1627 <<span property="yui:type">String</span>> |
|
1628 </code> |
|
1629 <span property="yui:description"> Optional. The name of the attribute to reset. If omitted, all attributes are reset.</span> |
|
1630 </dd> |
|
1631 </dl> |
|
1632 |
|
1633 <dl> |
|
1634 <dt>Returns: |
|
1635 <code property="yui:return"> |
|
1636 Object |
|
1637 </code></dt> |
|
1638 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
1639 </dl> |
|
1640 |
|
1641 <div class="chainable"> |
|
1642 <strong>Chainable:</strong> This method is chainable. |
|
1643 </div> |
|
1644 |
|
1645 |
|
1646 |
|
1647 </div> |
|
1648 |
|
1649 </div> |
|
1650 <hr /> |
|
1651 </div> |
|
1652 <div class="" rel="yui:method" resource="#method_set"> |
|
1653 <h4> |
|
1654 <a name="method_set">set</a></h4> |
|
1655 <div class="detail" > |
|
1656 <code> |
|
1657 |
|
1658 |
|
1659 |
|
1660 Object |
|
1661 <strong property="yui:name">set</strong> |
|
1662 ( |
|
1663 |
|
1664 |
|
1665 name |
|
1666 |
|
1667 |
|
1668 , |
|
1669 value |
|
1670 |
|
1671 |
|
1672 , |
|
1673 opts |
|
1674 |
|
1675 |
|
1676 ) |
|
1677 </code> |
|
1678 |
|
1679 <div class="description" property="yui:description"> |
|
1680 Sets the value of an attribute. |
|
1681 </div> |
|
1682 |
|
1683 <div class="description"> |
|
1684 |
|
1685 <dl rel="yui:parameters"> |
|
1686 <dt>Parameters:</dt> |
|
1687 <dd rel="yui:parameter"> |
|
1688 <code><span property="yui:name">name</span> |
|
1689 <<span property="yui:type">String</span>> |
|
1690 </code> |
|
1691 <span property="yui:description"> The name of the attribute. If the |
|
1692 current value of the attribute is an Object, dot notation can be used |
|
1693 to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</span> |
|
1694 </dd> |
|
1695 <dd rel="yui:parameter"> |
|
1696 <code><span property="yui:name">value</span> |
|
1697 <<span property="yui:type">Any</span>> |
|
1698 </code> |
|
1699 <span property="yui:description"> The value to set the attribute to.</span> |
|
1700 </dd> |
|
1701 <dd rel="yui:parameter"> |
|
1702 <code><span property="yui:name">opts</span> |
|
1703 <<span property="yui:type">Object</span>> |
|
1704 </code> |
|
1705 <span property="yui:description"> (Optional) Optional event data to be mixed into |
|
1706 the event facade passed to subscribers of the attribute's change event. This |
|
1707 can be used as a flexible way to identify the source of a call to set, allowing |
|
1708 the developer to distinguish between set called internally by the host, vs. |
|
1709 set called externally by the application developer.</span> |
|
1710 </dd> |
|
1711 </dl> |
|
1712 |
|
1713 <dl> |
|
1714 <dt>Returns: |
|
1715 <code property="yui:return"> |
|
1716 Object |
|
1717 </code></dt> |
|
1718 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
1719 </dl> |
|
1720 |
|
1721 <div class="chainable"> |
|
1722 <strong>Chainable:</strong> This method is chainable. |
|
1723 </div> |
|
1724 |
|
1725 |
|
1726 |
|
1727 </div> |
|
1728 |
|
1729 </div> |
|
1730 <hr /> |
|
1731 </div> |
|
1732 <div class="" rel="yui:method" resource="#method_setAttrs"> |
|
1733 <h4> |
|
1734 <a name="method_setAttrs">setAttrs</a></h4> |
|
1735 <div class="detail" > |
|
1736 <code> |
|
1737 |
|
1738 |
|
1739 |
|
1740 Object |
|
1741 <strong property="yui:name">setAttrs</strong> |
|
1742 ( |
|
1743 |
|
1744 |
|
1745 attrs |
|
1746 |
|
1747 |
|
1748 ) |
|
1749 </code> |
|
1750 |
|
1751 <div class="description" property="yui:description"> |
|
1752 Sets multiple attribute values. |
|
1753 </div> |
|
1754 |
|
1755 <div class="description"> |
|
1756 |
|
1757 <dl rel="yui:parameters"> |
|
1758 <dt>Parameters:</dt> |
|
1759 <dd rel="yui:parameter"> |
|
1760 <code><span property="yui:name">attrs</span> |
|
1761 <<span property="yui:type">Object</span>> |
|
1762 </code> |
|
1763 <span property="yui:description"> An object with attributes name/value pairs.</span> |
|
1764 </dd> |
|
1765 </dl> |
|
1766 |
|
1767 <dl> |
|
1768 <dt>Returns: |
|
1769 <code property="yui:return"> |
|
1770 Object |
|
1771 </code></dt> |
|
1772 <dd property="yui:returnInfo">A reference to the host object.</dd> |
|
1773 </dl> |
|
1774 |
|
1775 <div class="chainable"> |
|
1776 <strong>Chainable:</strong> This method is chainable. |
|
1777 </div> |
|
1778 |
|
1779 |
|
1780 |
|
1781 </div> |
|
1782 |
|
1783 </div> |
|
1784 <hr /> |
|
1785 </div> |
|
1786 </div> |
|
1787 </div> |
|
1788 |
|
1789 <div rel="yui:inheritance"> |
|
1790 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
1791 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
1792 <div class="content" rel="yui:methods"> |
|
1793 <code> |
|
1794 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
1795 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
1796 </span> |
|
1797 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
1798 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
1799 </span> |
|
1800 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
1801 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
1802 </span> |
|
1803 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
1804 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
1805 </span> |
|
1806 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
1807 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
1808 </span> |
|
1809 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
1810 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
1811 </span> |
|
1812 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
1813 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
1814 </span> |
|
1815 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
1816 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
1817 </span> |
|
1818 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
1819 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
1820 </span> |
|
1821 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
1822 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
1823 </span> |
|
1824 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
1825 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
1826 </span> |
|
1827 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
1828 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
1829 </span> |
|
1830 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
1831 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
1832 </span> |
|
1833 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
1834 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
1835 </span> |
|
1836 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
1837 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
1838 </span> |
|
1839 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
1840 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
1841 </span> |
|
1842 </code> |
|
1843 </div> |
|
1844 </div> |
|
1845 </div> |
|
1846 </div> |
|
1847 |
|
1848 <div rel="yui:events" resource="#events"> |
|
1849 |
|
1850 |
|
1851 </div> |
|
1852 |
|
1853 <div rel="yui:attributes" resource="#configattributes"> |
|
1854 |
|
1855 </div> |
|
1856 |
|
1857 </div> |
|
1858 </div> |
|
1859 <div class="yui-b"> |
|
1860 <div class="nav"> |
|
1861 |
|
1862 <div id="moduleList" class="module"> |
|
1863 <h4>Modules</h4> |
|
1864 <ul class="content"> |
|
1865 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1866 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
1867 <li class="selected"><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1868 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1869 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
1870 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1871 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1872 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1873 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1874 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1875 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1876 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1877 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1878 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1879 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1880 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1881 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1882 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1883 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1884 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1885 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1886 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1887 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1888 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1889 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1890 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1891 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1892 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1893 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1894 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1895 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
1896 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1897 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1898 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1899 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1900 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1901 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1902 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1903 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1904 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1905 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1906 </ul> |
|
1907 </div> |
|
1908 |
|
1909 <div id="classList" class="module"> |
|
1910 <h4>Classes</h4> |
|
1911 <ul class="content"> |
|
1912 <li class="selected"><a href="Attribute.html" title="Attribute">Attribute</a></li> |
|
1913 <li class=""><a href="State.html" title="State">State</a></li> |
|
1914 </ul> |
|
1915 </div> |
|
1916 |
|
1917 <div id="fileList" class="module"> |
|
1918 <h4>Files</h4> |
|
1919 <ul class="content"> |
|
1920 <li class=""><a href="Attribute.js.html" title="Attribute.js">Attribute.js</a></li> |
|
1921 <li class=""><a href="ComplexAttribute.js.html" title="ComplexAttribute.js">ComplexAttribute.js</a></li> |
|
1922 <li class=""><a href="State.js.html" title="State.js">State.js</a></li> |
|
1923 </ul> |
|
1924 </div> |
|
1925 |
|
1926 <div id="propertyList" class="module"> |
|
1927 <h4>Properties</h4> |
|
1928 <ul class="content"> |
|
1929 <li class="protected"><a href="#property_Attribute._ATTR_CFG" title="Attribute._ATTR_CFG">Attribute._ATTR_CFG</a></li> |
|
1930 <li class=""><a href="#property_Attribute.INVALID_VALUE" title="Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a></li> |
|
1931 </ul> |
|
1932 </div> |
|
1933 |
|
1934 <div id="methodsList" class="module"> |
|
1935 <h4>Methods</h4> |
|
1936 <ul class="content"> |
|
1937 <li class="private"><a href="#method__addAttrs" title="_addAttrs">_addAttrs</a></li> |
|
1938 <li class="private"><a href="#method__addLazyAttr" title="_addLazyAttr">_addLazyAttr</a></li> |
|
1939 <li class="private"><a href="#method__defAttrChangeFn" title="_defAttrChangeFn">_defAttrChangeFn</a></li> |
|
1940 <li class="private"><a href="#method__fireAttrChange" title="_fireAttrChange">_fireAttrChange</a></li> |
|
1941 <li class="protected"><a href="#method__getAttr" title="_getAttr">_getAttr</a></li> |
|
1942 <li class="private"><a href="#method__getAttrInitVal" title="_getAttrInitVal">_getAttrInitVal</a></li> |
|
1943 <li class="protected"><a href="#method__getAttrs" title="_getAttrs">_getAttrs</a></li> |
|
1944 <li class="private"><a href="#method__getStateVal" title="_getStateVal">_getStateVal</a></li> |
|
1945 <li class="private"><a href="#method__isLazyAttr" title="_isLazyAttr">_isLazyAttr</a></li> |
|
1946 <li class="private"><a href="#method__normAttrVals" title="_normAttrVals">_normAttrVals</a></li> |
|
1947 <li class="protected"><a href="#method__protectAttrs" title="_protectAttrs">_protectAttrs</a></li> |
|
1948 <li class="protected"><a href="#method__set" title="_set">_set</a></li> |
|
1949 <li class="protected"><a href="#method__setAttr" title="_setAttr">_setAttr</a></li> |
|
1950 <li class="protected"><a href="#method__setAttrs" title="_setAttrs">_setAttrs</a></li> |
|
1951 <li class="private"><a href="#method__setAttrVal" title="_setAttrVal">_setAttrVal</a></li> |
|
1952 <li class="private"><a href="#method__setStateVal" title="_setStateVal">_setStateVal</a></li> |
|
1953 <li class=""><a href="#method_addAttr" title="addAttr">addAttr</a></li> |
|
1954 <li class=""><a href="#method_addAttrs" title="addAttrs">addAttrs</a></li> |
|
1955 <li class=""><a href="#method_attrAdded" title="attrAdded">attrAdded</a></li> |
|
1956 <li class=""><a href="#method_get" title="get">get</a></li> |
|
1957 <li class=""><a href="#method_getAttrs" title="getAttrs">getAttrs</a></li> |
|
1958 <li class=""><a href="#method_modifyAttr" title="modifyAttr">modifyAttr</a></li> |
|
1959 <li class=""><a href="#method_removeAttr" title="removeAttr">removeAttr</a></li> |
|
1960 <li class=""><a href="#method_reset" title="reset">reset</a></li> |
|
1961 <li class=""><a href="#method_set" title="set">set</a></li> |
|
1962 <li class=""><a href="#method_setAttrs" title="setAttrs">setAttrs</a></li> |
|
1963 </ul> |
|
1964 </div> |
|
1965 |
|
1966 |
|
1967 |
|
1968 </div> |
|
1969 </div> |
|
1970 </div> |
|
1971 <div id="ft"> |
|
1972 <hr /> |
|
1973 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1974 </div> |
|
1975 </div> |
|
1976 <script type="text/javascript"> |
|
1977 ALL_YUI_PROPS = [{"access": "", "host": "Attribute", "name": "addAttr", "url": "Attribute.html#method_addAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_addAttrs", "url": "Attribute.html#method__addAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "addAttrs", "url": "Attribute.html#method_addAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_addLazyAttr", "url": "Attribute.html#method__addLazyAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "attrAdded", "url": "Attribute.html#method_attrAdded", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "Attribute._ATTR_CFG", "url": "Attribute.html#property_Attribute._ATTR_CFG", "type": "property"}, {"access": "", "host": "Attribute", "name": "Attribute.INVALID_VALUE", "url": "Attribute.html#property_Attribute.INVALID_VALUE", "type": "property"}, {"access": "private", "host": "Attribute", "name": "_defAttrChangeFn", "url": "Attribute.html#method__defAttrChangeFn", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_fireAttrChange", "url": "Attribute.html#method__fireAttrChange", "type": "method"}, {"access": "", "host": "Attribute", "name": "get", "url": "Attribute.html#method_get", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_getAttr", "url": "Attribute.html#method__getAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_getAttrInitVal", "url": "Attribute.html#method__getAttrInitVal", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_getAttrs", "url": "Attribute.html#method__getAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "getAttrs", "url": "Attribute.html#method_getAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_getStateVal", "url": "Attribute.html#method__getStateVal", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_isLazyAttr", "url": "Attribute.html#method__isLazyAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "modifyAttr", "url": "Attribute.html#method_modifyAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_normAttrVals", "url": "Attribute.html#method__normAttrVals", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_protectAttrs", "url": "Attribute.html#method__protectAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "removeAttr", "url": "Attribute.html#method_removeAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "reset", "url": "Attribute.html#method_reset", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_set", "url": "Attribute.html#method__set", "type": "method"}, {"access": "", "host": "Attribute", "name": "set", "url": "Attribute.html#method_set", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_setAttr", "url": "Attribute.html#method__setAttr", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_setAttrs", "url": "Attribute.html#method__setAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "setAttrs", "url": "Attribute.html#method_setAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_setAttrVal", "url": "Attribute.html#method__setAttrVal", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_setStateVal", "url": "Attribute.html#method__setStateVal", "type": "method"}]; |
|
1978 </script> |
|
1979 </body> |
|
1980 </html> |