|
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 State.js (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>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 |
|
23 > State.js (source view) |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre> <span class="c">/**</span> |
|
51 <span class="c"> * The State class maintains state for a collection of named items, with </span> |
|
52 <span class="c"> * a varying number of properties defined.</span> |
|
53 <span class="c"> *</span> |
|
54 <span class="c"> * It avoids the need to create a separate class for the item, and separate instances </span> |
|
55 <span class="c"> * of these classes for each item, by storing the state in a 2 level hash table, </span> |
|
56 <span class="c"> * improving performance when the number of items is likely to be large.</span> |
|
57 <span class="c"> *</span> |
|
58 <span class="c"> * @constructor</span> |
|
59 <span class="c"> * @class State</span> |
|
60 <span class="c"> */</span> |
|
61 <span class="nx">Y</span><span class="o">.</span><span class="nx">State</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
62 <span class="c">/**</span> |
|
63 <span class="c"> * Hash of attributes</span> |
|
64 <span class="c"> * @property data</span> |
|
65 <span class="c"> */</span> |
|
66 <span class="k">this</span><span class="o">.</span><span class="nx">data</span> <span class="o">=</span> <span class="o">{};</span> |
|
67 <span class="o">};</span> |
|
68 |
|
69 <span class="nx">Y</span><span class="o">.</span><span class="nx">State</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span> |
|
70 |
|
71 <span class="c">/**</span> |
|
72 <span class="c"> * Adds a property to an item.</span> |
|
73 <span class="c"> *</span> |
|
74 <span class="c"> * @method add</span> |
|
75 <span class="c"> * @param name {String} The name of the item.</span> |
|
76 <span class="c"> * @param key {String} The name of the property.</span> |
|
77 <span class="c"> * @param val {Any} The value of the property.</span> |
|
78 <span class="c"> */</span> |
|
79 <span class="nx">add</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">key</span><span class="o">,</span> <span class="nx">val</span><span class="o">)</span> <span class="o">{</span> |
|
80 <span class="k">var</span> <span class="nx">d</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">data</span><span class="o">;</span> |
|
81 <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">=</span> <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">||</span> <span class="o">{};</span> |
|
82 <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">][</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="nx">val</span><span class="o">;</span> |
|
83 <span class="o">},</span> |
|
84 |
|
85 <span class="c">/**</span> |
|
86 <span class="c"> * Adds multiple properties to an item.</span> |
|
87 <span class="c"> *</span> |
|
88 <span class="c"> * @method addAll</span> |
|
89 <span class="c"> * @param name {String} The name of the item.</span> |
|
90 <span class="c"> * @param o {Object} A hash of property/value pairs.</span> |
|
91 <span class="c"> */</span> |
|
92 <span class="nx">addAll</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
93 <span class="k">var</span> <span class="nx">key</span><span class="o">;</span> |
|
94 <span class="k">for</span> <span class="o">(</span><span class="nx">key</span> <span class="k">in</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
95 <span class="k">if</span> <span class="o">(</span><span class="nx">o</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">key</span><span class="o">))</span> <span class="o">{</span> |
|
96 <span class="k">this</span><span class="o">.</span><span class="nx">add</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">key</span><span class="o">,</span> <span class="nx">o</span><span class="o">[</span><span class="nx">key</span><span class="o">]);</span> |
|
97 <span class="o">}</span> |
|
98 <span class="o">}</span> |
|
99 <span class="o">},</span> |
|
100 |
|
101 <span class="c">/**</span> |
|
102 <span class="c"> * Removes a property from an item.</span> |
|
103 <span class="c"> *</span> |
|
104 <span class="c"> * @method remove</span> |
|
105 <span class="c"> * @param name {String} The name of the item.</span> |
|
106 <span class="c"> * @param key {String} The property to remove.</span> |
|
107 <span class="c"> */</span> |
|
108 <span class="nx">remove</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">key</span><span class="o">)</span> <span class="o">{</span> |
|
109 <span class="k">var</span> <span class="nx">d</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">data</span><span class="o">;</span> |
|
110 <span class="k">if</span> <span class="o">(</span><span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">name</span> <span class="k">in</span> <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">]))</span> <span class="o">{</span> |
|
111 <span class="nx">delete</span> <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">][</span><span class="nx">name</span><span class="o">];</span> |
|
112 <span class="o">}</span> |
|
113 <span class="o">},</span> |
|
114 |
|
115 <span class="c">/**</span> |
|
116 <span class="c"> * Removes multiple properties from an item, or remove the item completely.</span> |
|
117 <span class="c"> *</span> |
|
118 <span class="c"> * @method removeAll</span> |
|
119 <span class="c"> * @param name {String} The name of the item.</span> |
|
120 <span class="c"> * @param o {Object|Array} Collection of properties to delete. If not provided, the entire item is removed.</span> |
|
121 <span class="c"> */</span> |
|
122 <span class="nx">removeAll</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
123 <span class="k">var</span> <span class="nx">d</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">data</span><span class="o">;</span> |
|
124 |
|
125 <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">o</span> <span class="o">||</span> <span class="nx">d</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nx">k</span><span class="o">)</span> <span class="o">{</span> |
|
126 <span class="k">if</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">k</span><span class="o">))</span> <span class="o">{</span> |
|
127 <span class="k">this</span><span class="o">.</span><span class="nx">remove</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">k</span><span class="o">);</span> |
|
128 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
129 <span class="k">this</span><span class="o">.</span><span class="nx">remove</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">v</span><span class="o">);</span> |
|
130 <span class="o">}</span> |
|
131 <span class="o">},</span> <span class="k">this</span><span class="o">);</span> |
|
132 <span class="o">},</span> |
|
133 |
|
134 <span class="c">/**</span> |
|
135 <span class="c"> * For a given item, returns the value of the property requested, or undefined if not found.</span> |
|
136 <span class="c"> *</span> |
|
137 <span class="c"> * @method get</span> |
|
138 <span class="c"> * @param name {String} The name of the item</span> |
|
139 <span class="c"> * @param key {String} Optional. The property value to retrieve.</span> |
|
140 <span class="c"> * @return {Any} The value of the supplied property.</span> |
|
141 <span class="c"> */</span> |
|
142 <span class="nx">get</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">key</span><span class="o">)</span> <span class="o">{</span> |
|
143 <span class="k">var</span> <span class="nx">d</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">data</span><span class="o">;</span> |
|
144 <span class="k">return</span> <span class="o">(</span><span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">]</span> <span class="o">&&</span> <span class="nx">name</span> <span class="k">in</span> <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">])</span> <span class="o">?</span> <span class="nx">d</span><span class="o">[</span><span class="nx">key</span><span class="o">][</span><span class="nx">name</span><span class="o">]</span> <span class="o">:</span> <span class="kc">undefined</span><span class="o">;</span> |
|
145 <span class="o">},</span> |
|
146 |
|
147 <span class="c">/**</span> |
|
148 <span class="c"> * For the given item, returns a disposable object with all of the</span> |
|
149 <span class="c"> * item's property/value pairs.</span> |
|
150 <span class="c"> *</span> |
|
151 <span class="c"> * @method getAll</span> |
|
152 <span class="c"> * @param name {String} The name of the item</span> |
|
153 <span class="c"> * @return {Object} An object with property/value pairs for the item.</span> |
|
154 <span class="c"> */</span> |
|
155 <span class="nx">getAll</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">{</span> |
|
156 <span class="k">var</span> <span class="nx">d</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">data</span><span class="o">,</span> <span class="nx">o</span><span class="o">;</span> |
|
157 |
|
158 <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">d</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nx">k</span><span class="o">)</span> <span class="o">{</span> |
|
159 <span class="k">if</span> <span class="o">(</span><span class="nx">name</span> <span class="k">in</span> <span class="nx">d</span><span class="o">[</span><span class="nx">k</span><span class="o">])</span> <span class="o">{</span> |
|
160 <span class="nx">o</span> <span class="o">=</span> <span class="nx">o</span> <span class="o">||</span> <span class="o">{};</span> |
|
161 <span class="nx">o</span><span class="o">[</span><span class="nx">k</span><span class="o">]</span> <span class="o">=</span> <span class="nx">v</span><span class="o">[</span><span class="nx">name</span><span class="o">];</span> |
|
162 <span class="o">}</span> |
|
163 <span class="o">},</span> <span class="k">this</span><span class="o">);</span> |
|
164 |
|
165 <span class="k">return</span> <span class="nx">o</span><span class="o">;</span> |
|
166 <span class="o">}</span> |
|
167 <span class="o">};</span> |
|
168 </pre></div> |
|
169 |
|
170 </div> |
|
171 </div> |
|
172 </div> |
|
173 <div class="yui-b"> |
|
174 <div class="nav"> |
|
175 |
|
176 <div id="moduleList" class="module"> |
|
177 <h4>Modules</h4> |
|
178 <ul class="content"> |
|
179 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
180 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
181 <li class="selected"><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
182 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
183 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
184 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
185 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
186 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
187 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
188 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
189 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
190 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
191 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
192 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
193 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
194 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
195 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
196 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
197 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
198 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
199 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
200 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
201 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
202 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
203 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
204 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
205 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
206 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
207 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
208 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
209 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
210 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
211 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
212 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
213 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
214 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
215 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
216 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
217 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
218 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
219 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
220 </ul> |
|
221 </div> |
|
222 |
|
223 <div id="classList" class="module"> |
|
224 <h4>Classes</h4> |
|
225 <ul class="content"> |
|
226 <li class=""><a href="Attribute.html" title="Attribute">Attribute</a></li> |
|
227 <li class=""><a href="State.html" title="State">State</a></li> |
|
228 </ul> |
|
229 </div> |
|
230 |
|
231 <div id="fileList" class="module"> |
|
232 <h4>Files</h4> |
|
233 <ul class="content"> |
|
234 <li class=""><a href="Attribute.js.html" title="Attribute.js">Attribute.js</a></li> |
|
235 <li class=""><a href="ComplexAttribute.js.html" title="ComplexAttribute.js">ComplexAttribute.js</a></li> |
|
236 <li class="selected"><a href="State.js.html" title="State.js">State.js</a></li> |
|
237 </ul> |
|
238 </div> |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 </div> |
|
245 </div> |
|
246 </div> |
|
247 <div id="ft"> |
|
248 <hr /> |
|
249 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
250 </div> |
|
251 </div> |
|
252 <script type="text/javascript"> |
|
253 ALL_YUI_PROPS = [{"access": "", "host": "State", "name": "add", "url": "State.html#method_add", "type": "method"}, {"access": "", "host": "State", "name": "addAll", "url": "State.html#method_addAll", "type": "method"}, {"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": "", "host": "State", "name": "data", "url": "State.html#property_data", "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": "", "host": "State", "name": "get", "url": "State.html#method_get", "type": "method"}, {"access": "", "host": "State", "name": "getAll", "url": "State.html#method_getAll", "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": "State", "name": "remove", "url": "State.html#method_remove", "type": "method"}, {"access": "", "host": "State", "name": "removeAll", "url": "State.html#method_removeAll", "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"}]; |
|
254 </script> |
|
255 </body> |
|
256 </html> |