|
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.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 > Attribute.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 attribute module provides an augmentable Attribute implementation, which </span> |
|
52 <span class="c"> * adds configurable attributes and attribute change events to the class being </span> |
|
53 <span class="c"> * augmented. It also provides a State class, which is used internally by Attribute,</span> |
|
54 <span class="c"> * but can also be used independently to provide a name/property/value data structure to</span> |
|
55 <span class="c"> * store state.</span> |
|
56 <span class="c"> *</span> |
|
57 <span class="c"> * @module attribute</span> |
|
58 <span class="c"> */</span> |
|
59 |
|
60 <span class="c">/**</span> |
|
61 <span class="c"> * The attribute-base submodule provides core attribute handling support, with everything</span> |
|
62 <span class="c"> * aside from complex attribute handling in the provider's constructor.</span> |
|
63 <span class="c"> *</span> |
|
64 <span class="c"> * @module attribute</span> |
|
65 <span class="c"> * @submodule attribute-base</span> |
|
66 <span class="c"> */</span> |
|
67 <span class="k">var</span> <span class="nx">O</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">,</span> |
|
68 <span class="nx">Lang</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> |
|
69 <span class="nx">EventTarget</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">EventTarget</span><span class="o">,</span> |
|
70 |
|
71 <span class="nx">DOT</span> <span class="o">=</span> <span class="s2">"."</span><span class="o">,</span> |
|
72 <span class="nx">CHANGE</span> <span class="o">=</span> <span class="s2">"Change"</span><span class="o">,</span> |
|
73 |
|
74 <span class="c">// Externally configurable props</span> |
|
75 <span class="c"></span> <span class="nx">GETTER</span> <span class="o">=</span> <span class="s2">"getter"</span><span class="o">,</span> |
|
76 <span class="nx">SETTER</span> <span class="o">=</span> <span class="s2">"setter"</span><span class="o">,</span> |
|
77 <span class="nx">READ_ONLY</span> <span class="o">=</span> <span class="s2">"readOnly"</span><span class="o">,</span> |
|
78 <span class="nx">WRITE_ONCE</span> <span class="o">=</span> <span class="s2">"writeOnce"</span><span class="o">,</span> |
|
79 <span class="nx">VALIDATOR</span> <span class="o">=</span> <span class="s2">"validator"</span><span class="o">,</span> |
|
80 <span class="nx">VALUE</span> <span class="o">=</span> <span class="s2">"value"</span><span class="o">,</span> |
|
81 <span class="nx">VALUE_FN</span> <span class="o">=</span> <span class="s2">"valueFn"</span><span class="o">,</span> |
|
82 <span class="nx">BROADCAST</span> <span class="o">=</span> <span class="s2">"broadcast"</span><span class="o">,</span> |
|
83 <span class="nx">LAZY_ADD</span> <span class="o">=</span> <span class="s2">"lazyAdd"</span><span class="o">,</span> |
|
84 <span class="nx">BYPASS_PROXY</span> <span class="o">=</span> <span class="s2">"_bypassProxy"</span><span class="o">,</span> |
|
85 |
|
86 <span class="c">// Used for internal state management</span> |
|
87 <span class="c"></span> <span class="nx">ADDED</span> <span class="o">=</span> <span class="s2">"added"</span><span class="o">,</span> |
|
88 <span class="nx">INITIALIZING</span> <span class="o">=</span> <span class="s2">"initializing"</span><span class="o">,</span> |
|
89 <span class="nx">INIT_VALUE</span> <span class="o">=</span> <span class="s2">"initValue"</span><span class="o">,</span> |
|
90 <span class="nx">PUBLISHED</span> <span class="o">=</span> <span class="s2">"published"</span><span class="o">,</span> |
|
91 <span class="nx">DEF_VALUE</span> <span class="o">=</span> <span class="s2">"defaultValue"</span><span class="o">,</span> |
|
92 <span class="nx">LAZY</span> <span class="o">=</span> <span class="s2">"lazy"</span><span class="o">,</span> |
|
93 <span class="nx">IS_LAZY_ADD</span> <span class="o">=</span> <span class="s2">"isLazyAdd"</span><span class="o">,</span> |
|
94 |
|
95 <span class="nx">INVALID_VALUE</span><span class="o">,</span> |
|
96 <span class="nx">MODIFIABLE</span> <span class="o">=</span> <span class="o">{};</span> |
|
97 |
|
98 <span class="c">// Properties which can be changed after the attribute has been added.</span> |
|
99 <span class="c"></span> <span class="nx">MODIFIABLE</span><span class="o">[</span><span class="nx">READ_ONLY</span><span class="o">]</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span> |
|
100 <span class="nx">MODIFIABLE</span><span class="o">[</span><span class="nx">WRITE_ONCE</span><span class="o">]</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span> |
|
101 <span class="nx">MODIFIABLE</span><span class="o">[</span><span class="nx">GETTER</span><span class="o">]</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span> |
|
102 <span class="nx">MODIFIABLE</span><span class="o">[</span><span class="nx">BROADCAST</span><span class="o">]</span> <span class="o">=</span> <span class="m">1</span><span class="o">;</span> |
|
103 |
|
104 <span class="c">/**</span> |
|
105 <span class="c"> * <p></span> |
|
106 <span class="c"> * Attribute provides configurable attribute support along with attribute change events. It is designed to be </span> |
|
107 <span class="c"> * augmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state, </span> |
|
108 <span class="c"> * along with attribute change events.</span> |
|
109 <span class="c"> * </p></span> |
|
110 <span class="c"> * <p>For example, attributes added to the host can be configured:</p></span> |
|
111 <span class="c"> * <ul></span> |
|
112 <span class="c"> * <li>As read only.</li></span> |
|
113 <span class="c"> * <li>As write once.</li></span> |
|
114 <span class="c"> * <li>With a setter function, which can be used to manipulate</span> |
|
115 <span class="c"> * values passed to Attribute's <a href="#method_set">set</a> method, before they are stored.</li></span> |
|
116 <span class="c"> * <li>With a getter function, which can be used to manipulate stored values,</span> |
|
117 <span class="c"> * before they are returned by Attribute's <a href="#method_get">get</a> method.</li></span> |
|
118 <span class="c"> * <li>With a validator function, to validate values before they are stored.</li></span> |
|
119 <span class="c"> * </ul></span> |
|
120 <span class="c"> *</span> |
|
121 <span class="c"> * <p>See the <a href="#method_addAttr">addAttr</a> method, for the complete set of configuration</span> |
|
122 <span class="c"> * options available for attributes</p>.</span> |
|
123 <span class="c"> *</span> |
|
124 <span class="c"> * <p><strong>NOTE:</strong> Most implementations will be better off extending the <a href="Base.html">Base</a> class, </span> |
|
125 <span class="c"> * instead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration </span> |
|
126 <span class="c"> * of attributes for derived classes, accounting for values passed into the constructor.</p></span> |
|
127 <span class="c"> *</span> |
|
128 <span class="c"> * @class Attribute</span> |
|
129 <span class="c"> * @uses EventTarget</span> |
|
130 <span class="c"> */</span> |
|
131 <span class="k">function</span> <span class="nx">Attribute</span><span class="o">()</span> <span class="o">{</span> |
|
132 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute constructor called'</span><span class="o">,</span> <span class="s1">'info'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
133 |
|
134 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
135 <span class="c"></span> <span class="nx">attrs</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">ATTRS</span><span class="o">,</span> |
|
136 <span class="nx">Base</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Base</span><span class="o">;</span> |
|
137 |
|
138 <span class="c">// Perf tweak - avoid creating event literals if not required.</span> |
|
139 <span class="c"></span> <span class="nx">host</span><span class="o">.</span><span class="nx">_ATTR_E_FACADE</span> <span class="o">=</span> <span class="o">{};</span> |
|
140 |
|
141 <span class="nx">EventTarget</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">host</span><span class="o">,</span> <span class="o">{</span><span class="nx">emitFacade</span><span class="o">:</span><span class="kc">true</span><span class="o">});</span> |
|
142 |
|
143 <span class="c">// _conf maintained for backwards compat</span> |
|
144 <span class="c"></span> <span class="nx">host</span><span class="o">.</span><span class="nx">_conf</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">State</span><span class="o">();</span> |
|
145 |
|
146 <span class="nx">host</span><span class="o">.</span><span class="nx">_stateProxy</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_stateProxy</span> <span class="o">||</span> <span class="kc">null</span><span class="o">;</span> |
|
147 <span class="nx">host</span><span class="o">.</span><span class="nx">_requireAddAttr</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_requireAddAttr</span> <span class="o">||</span> <span class="kc">false</span><span class="o">;</span> |
|
148 |
|
149 <span class="c">// ATTRS support for Node, which is not Base based</span> |
|
150 <span class="c"></span> <span class="k">if</span> <span class="o">(</span> <span class="nx">attrs</span> <span class="o">&&</span> <span class="o">!(</span><span class="nx">Base</span> <span class="o">&&</span> <span class="nx">host</span> <span class="k">instanceof</span> <span class="nx">Base</span><span class="o">))</span> <span class="o">{</span> |
|
151 <span class="nx">host</span><span class="o">.</span><span class="nx">addAttrs</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_protectAttrs</span><span class="o">(</span><span class="nx">attrs</span><span class="o">));</span> |
|
152 <span class="o">}</span> |
|
153 <span class="o">}</span> |
|
154 |
|
155 <span class="c">/**</span> |
|
156 <span class="c"> * <p>The value to return from an attribute setter in order to prevent the set from going through.</p></span> |
|
157 <span class="c"> *</span> |
|
158 <span class="c"> * <p>You can return this value from your setter if you wish to combine validator and setter </span> |
|
159 <span class="c"> * functionality into a single setter function, which either returns the massaged value to be stored or </span> |
|
160 <span class="c"> * Attribute.INVALID_VALUE to prevent invalid values from being stored.</p></span> |
|
161 <span class="c"> *</span> |
|
162 <span class="c"> * @property Attribute.INVALID_VALUE</span> |
|
163 <span class="c"> * @type Object</span> |
|
164 <span class="c"> * @static</span> |
|
165 <span class="c"> * @final</span> |
|
166 <span class="c"> */</span> |
|
167 <span class="nx">Attribute</span><span class="o">.</span><span class="nx">INVALID_VALUE</span> <span class="o">=</span> <span class="o">{};</span> |
|
168 <span class="nx">INVALID_VALUE</span> <span class="o">=</span> <span class="nx">Attribute</span><span class="o">.</span><span class="nx">INVALID_VALUE</span><span class="o">;</span> |
|
169 |
|
170 <span class="c">/**</span> |
|
171 <span class="c"> * The list of properties which can be configured for </span> |
|
172 <span class="c"> * each attribute (e.g. setter, getter, writeOnce etc.).</span> |
|
173 <span class="c"> *</span> |
|
174 <span class="c"> * This property is used internally as a whitelist for faster</span> |
|
175 <span class="c"> * Y.mix operations.</span> |
|
176 <span class="c"> *</span> |
|
177 <span class="c"> * @property Attribute._ATTR_CFG</span> |
|
178 <span class="c"> * @type Array</span> |
|
179 <span class="c"> * @static</span> |
|
180 <span class="c"> * @protected</span> |
|
181 <span class="c"> */</span> |
|
182 <span class="nx">Attribute</span><span class="o">.</span><span class="nx">_ATTR_CFG</span> <span class="o">=</span> <span class="o">[</span><span class="nx">SETTER</span><span class="o">,</span> <span class="nx">GETTER</span><span class="o">,</span> <span class="nx">VALIDATOR</span><span class="o">,</span> <span class="nx">VALUE</span><span class="o">,</span> <span class="nx">VALUE_FN</span><span class="o">,</span> <span class="nx">WRITE_ONCE</span><span class="o">,</span> <span class="nx">READ_ONLY</span><span class="o">,</span> <span class="nx">LAZY_ADD</span><span class="o">,</span> <span class="nx">BROADCAST</span><span class="o">,</span> <span class="nx">BYPASS_PROXY</span><span class="o">];</span> |
|
183 |
|
184 <span class="nx">Attribute</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span> |
|
185 <span class="c">/**</span> |
|
186 <span class="c"> * <p></span> |
|
187 <span class="c"> * Adds an attribute with the provided configuration to the host object.</span> |
|
188 <span class="c"> * </p></span> |
|
189 <span class="c"> * <p></span> |
|
190 <span class="c"> * The config argument object supports the following properties:</span> |
|
191 <span class="c"> * </p></span> |
|
192 <span class="c"> * </span> |
|
193 <span class="c"> * <dl></span> |
|
194 <span class="c"> * <dt>value &#60;Any&#62;</dt></span> |
|
195 <span class="c"> * <dd>The initial value to set on the attribute</dd></span> |
|
196 <span class="c"> *</span> |
|
197 <span class="c"> * <dt>valueFn &#60;Function&#62;</dt></span> |
|
198 <span class="c"> * <dd>A function, which will return the initial value to set on the attribute. This is useful</span> |
|
199 <span class="c"> * for cases where the attribute configuration is defined statically, but needs to </span> |
|
200 <span class="c"> * reference the host instance ("this") to obtain an initial value.</span> |
|
201 <span class="c"> * If defined, this precedence over the value property.</dd></span> |
|
202 <span class="c"> *</span> |
|
203 <span class="c"> * <dt>readOnly &#60;boolean&#62;</dt></span> |
|
204 <span class="c"> * <dd>Whether or not the attribute is read only. Attributes having readOnly set to true</span> |
|
205 <span class="c"> * cannot be modified by invoking the set method.</dd></span> |
|
206 <span class="c"> *</span> |
|
207 <span class="c"> * <dt>writeOnce &#60;boolean&#62;</dt></span> |
|
208 <span class="c"> * <dd>Whether or not the attribute is "write once". Attributes having writeOnce set to true, </span> |
|
209 <span class="c"> * can only have their values set once, be it through the default configuration, </span> |
|
210 <span class="c"> * constructor configuration arguments, or by invoking set.</dd></span> |
|
211 <span class="c"> *</span> |
|
212 <span class="c"> * <dt>setter &#60;Function&#62;</dt></span> |
|
213 <span class="c"> * <dd>The setter function used to massage or normalize the value passed to the set method for the attribute. </span> |
|
214 <span class="c"> * The value returned by the setter will be the final stored value. Returning</span> |
|
215 <span class="c"> * <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent</span> |
|
216 <span class="c"> * the value from being stored.</dd></span> |
|
217 <span class="c"> *</span> |
|
218 <span class="c"> * <dt>getter &#60;Function&#62;</dt></span> |
|
219 <span class="c"> * <dd>The getter function used to massage or normalize the value returned by the get method for the attribute.</span> |
|
220 <span class="c"> * The value returned by the getter function is the value which will be returned to the user when they </span> |
|
221 <span class="c"> * invoke get.</dd></span> |
|
222 <span class="c"> *</span> |
|
223 <span class="c"> * <dt>validator &#60;Function&#62;</dt></span> |
|
224 <span class="c"> * <dd>The validator function invoked prior to setting the stored value. Returning</span> |
|
225 <span class="c"> * false from the validator function will prevent the value from being stored.</dd></span> |
|
226 <span class="c"> * </span> |
|
227 <span class="c"> * <dt>broadcast &#60;int&#62;</dt></span> |
|
228 <span class="c"> * <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 </span> |
|
229 <span class="c"> * valid values. By default attribute change events are not broadcast.</dd></span> |
|
230 <span class="c"> *</span> |
|
231 <span class="c"> * <dt>lazyAdd &#60;boolean&#62;</dt></span> |
|
232 <span class="c"> * <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. </span> |
|
233 <span class="c"> * This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through </span> |
|
234 <span class="c"> * the <a href="#method_addAttrs">addAttrs</a> method.</dd></span> |
|
235 <span class="c"> *</span> |
|
236 <span class="c"> * </dl></span> |
|
237 <span class="c"> *</span> |
|
238 <span class="c"> * <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with</span> |
|
239 <span class="c"> * the context ("this") set to the host object.</p></span> |
|
240 <span class="c"> *</span> |
|
241 <span class="c"> * <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></span> |
|
242 <span class="c"> * </span> |
|
243 <span class="c"> * @method addAttr</span> |
|
244 <span class="c"> *</span> |
|
245 <span class="c"> * @param {String} name The name of the attribute.</span> |
|
246 <span class="c"> * @param {Object} config An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</span> |
|
247 <span class="c"> *</span> |
|
248 <span class="c"> * <p></span> |
|
249 <span class="c"> * <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need </span> |
|
250 <span class="c"> * to protect the original values, you will need to merge the object.</span> |
|
251 <span class="c"> * </p></span> |
|
252 <span class="c"> *</span> |
|
253 <span class="c"> * @param {boolean} lazy (optional) Whether or not to add this attribute lazily (on the first call to get/set). </span> |
|
254 <span class="c"> *</span> |
|
255 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
256 <span class="c"> *</span> |
|
257 <span class="c"> * @chainable</span> |
|
258 <span class="c"> */</span> |
|
259 <span class="nx">addAttr</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">config</span><span class="o">,</span> <span class="nx">lazy</span><span class="o">)</span> <span class="o">{</span> |
|
260 |
|
261 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Adding attribute: '</span> <span class="o">+</span> <span class="nx">name</span><span class="o">,</span> <span class="s1">'info'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
262 |
|
263 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
264 <span class="c"></span> <span class="nx">state</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
265 <span class="nx">value</span><span class="o">,</span> |
|
266 <span class="nx">hasValue</span><span class="o">;</span> |
|
267 |
|
268 <span class="nx">lazy</span> <span class="o">=</span> <span class="o">(</span><span class="nx">LAZY_ADD</span> <span class="k">in</span> <span class="nx">config</span><span class="o">)</span> <span class="o">?</span> <span class="nx">config</span><span class="o">[</span><span class="nx">LAZY_ADD</span><span class="o">]</span> <span class="o">:</span> <span class="nx">lazy</span><span class="o">;</span> |
|
269 |
|
270 <span class="k">if</span> <span class="o">(</span><span class="nx">lazy</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">host</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
271 <span class="nx">state</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">LAZY</span><span class="o">,</span> <span class="nx">config</span> <span class="o">||</span> <span class="o">{});</span> |
|
272 <span class="nx">state</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">ADDED</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
273 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
274 |
|
275 <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">IS_LAZY_ADD</span><span class="o">))</span> <span class="o">{</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute: '</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">' already exists. Cannot add it again without removing it first'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> <span class="o">}</span> |
|
276 |
|
277 <span class="k">if</span> <span class="o">(!</span><span class="nx">host</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">||</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">IS_LAZY_ADD</span><span class="o">))</span> <span class="o">{</span> |
|
278 |
|
279 <span class="nx">config</span> <span class="o">=</span> <span class="nx">config</span> <span class="o">||</span> <span class="o">{};</span> |
|
280 |
|
281 <span class="nx">hasValue</span> <span class="o">=</span> <span class="o">(</span><span class="nx">VALUE</span> <span class="k">in</span> <span class="nx">config</span><span class="o">);</span> |
|
282 |
|
283 <span class="k">if</span> <span class="o">(</span><span class="nx">config</span><span class="o">.</span><span class="nx">readOnly</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">hasValue</span><span class="o">)</span> <span class="o">{</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'readOnly attribute: '</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">', added without an initial value. Value will be set on initial call to set'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);}</span> |
|
284 |
|
285 <span class="k">if</span><span class="o">(</span><span class="nx">hasValue</span><span class="o">)</span> <span class="o">{</span> |
|
286 <span class="c">// We'll go through set, don't want to set value in _state directly</span> |
|
287 <span class="c"></span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">config</span><span class="o">.</span><span class="nx">value</span><span class="o">;</span> |
|
288 <span class="nx">delete</span> <span class="nx">config</span><span class="o">.</span><span class="nx">value</span><span class="o">;</span> |
|
289 <span class="o">}</span> |
|
290 |
|
291 <span class="nx">config</span><span class="o">.</span><span class="nx">added</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
292 <span class="nx">config</span><span class="o">.</span><span class="nx">initializing</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
293 |
|
294 <span class="nx">state</span><span class="o">.</span><span class="nx">addAll</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">config</span><span class="o">);</span> |
|
295 |
|
296 <span class="k">if</span> <span class="o">(</span><span class="nx">hasValue</span><span class="o">)</span> <span class="o">{</span> |
|
297 <span class="c">// Go through set, so that raw values get normalized/validated</span> |
|
298 <span class="c"></span> <span class="nx">host</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">value</span><span class="o">);</span> |
|
299 <span class="o">}</span> |
|
300 |
|
301 <span class="nx">state</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">INITIALIZING</span><span class="o">);</span> |
|
302 <span class="o">}</span> |
|
303 <span class="o">}</span> |
|
304 |
|
305 <span class="k">return</span> <span class="nx">host</span><span class="o">;</span> |
|
306 <span class="o">},</span> |
|
307 |
|
308 <span class="c">/**</span> |
|
309 <span class="c"> * Checks if the given attribute has been added to the host</span> |
|
310 <span class="c"> *</span> |
|
311 <span class="c"> * @method attrAdded</span> |
|
312 <span class="c"> * @param {String} name The name of the attribute to check.</span> |
|
313 <span class="c"> * @return {boolean} 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.</span> |
|
314 <span class="c"> */</span> |
|
315 <span class="nx">attrAdded</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> |
|
316 <span class="k">return</span> <span class="o">!!</span><span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">ADDED</span><span class="o">);</span> |
|
317 <span class="o">},</span> |
|
318 |
|
319 <span class="c">/**</span> |
|
320 <span class="c"> * Updates the configuration of an attribute which has already been added.</span> |
|
321 <span class="c"> * <p></span> |
|
322 <span class="c"> * The properties which can be modified through this interface are limited</span> |
|
323 <span class="c"> * to the following subset of attributes, which can be safely modified</span> |
|
324 <span class="c"> * after a value has already been set on the attribute: readOnly, writeOnce, </span> |
|
325 <span class="c"> * broadcast and getter.</span> |
|
326 <span class="c"> * </p></span> |
|
327 <span class="c"> * @method modifyAttr</span> |
|
328 <span class="c"> * @param {String} name The name of the attribute whose configuration is to be updated.</span> |
|
329 <span class="c"> * @param {Object} config An object with configuration property/value pairs, specifying the configuration properties to modify.</span> |
|
330 <span class="c"> */</span> |
|
331 <span class="nx">modifyAttr</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">config</span><span class="o">)</span> <span class="o">{</span> |
|
332 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
333 <span class="c"></span> <span class="nx">prop</span><span class="o">,</span> <span class="nx">state</span><span class="o">;</span> |
|
334 |
|
335 <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
336 |
|
337 <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_isLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
338 <span class="nx">host</span><span class="o">.</span><span class="nx">_addLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
339 <span class="o">}</span> |
|
340 |
|
341 <span class="nx">state</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">;</span> |
|
342 <span class="k">for</span> <span class="o">(</span><span class="nx">prop</span> <span class="k">in</span> <span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
343 <span class="k">if</span> <span class="o">(</span><span class="nx">MODIFIABLE</span><span class="o">[</span><span class="nx">prop</span><span class="o">]</span> <span class="o">&&</span> <span class="nx">config</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">prop</span><span class="o">))</span> <span class="o">{</span> |
|
344 <span class="nx">state</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">prop</span><span class="o">,</span> <span class="nx">config</span><span class="o">[</span><span class="nx">prop</span><span class="o">]);</span> |
|
345 |
|
346 <span class="c">// If we reconfigured broadcast, need to republish</span> |
|
347 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">prop</span> <span class="o">===</span> <span class="nx">BROADCAST</span><span class="o">)</span> <span class="o">{</span> |
|
348 <span class="nx">state</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">PUBLISHED</span><span class="o">);</span> |
|
349 <span class="o">}</span> |
|
350 <span class="o">}</span> |
|
351 <span class="o">}</span> |
|
352 <span class="o">}</span> |
|
353 |
|
354 <span class="k">if</span> <span class="o">(!</span><span class="nx">host</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span><span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute modifyAttr:'</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">' has not been added. Use addAttr to add the attribute'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);}</span> |
|
355 <span class="o">},</span> |
|
356 |
|
357 <span class="c">/**</span> |
|
358 <span class="c"> * Removes an attribute from the host object</span> |
|
359 <span class="c"> *</span> |
|
360 <span class="c"> * @method removeAttr</span> |
|
361 <span class="c"> * @param {String} name The name of the attribute to be removed.</span> |
|
362 <span class="c"> */</span> |
|
363 <span class="nx">removeAttr</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> |
|
364 <span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">removeAll</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
365 <span class="o">},</span> |
|
366 |
|
367 <span class="c">/**</span> |
|
368 <span class="c"> * Returns the current value of the attribute. If the attribute</span> |
|
369 <span class="c"> * has been configured with a 'getter' function, this method will delegate</span> |
|
370 <span class="c"> * to the 'getter' to obtain the value of the attribute.</span> |
|
371 <span class="c"> *</span> |
|
372 <span class="c"> * @method get</span> |
|
373 <span class="c"> *</span> |
|
374 <span class="c"> * @param {String} name The name of the attribute. If the value of the attribute is an Object, </span> |
|
375 <span class="c"> * dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</span> |
|
376 <span class="c"> *</span> |
|
377 <span class="c"> * @return {Any} The value of the attribute</span> |
|
378 <span class="c"> */</span> |
|
379 <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="o">{</span> |
|
380 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_getAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
381 <span class="o">},</span> |
|
382 |
|
383 <span class="c">/**</span> |
|
384 <span class="c"> * Checks whether or not the attribute is one which has been</span> |
|
385 <span class="c"> * added lazily and still requires initialization.</span> |
|
386 <span class="c"> *</span> |
|
387 <span class="c"> * @method _isLazyAttr</span> |
|
388 <span class="c"> * @private</span> |
|
389 <span class="c"> * @param {String} name The name of the attribute</span> |
|
390 <span class="c"> * @return {boolean} true if it's a lazily added attribute, false otherwise.</span> |
|
391 <span class="c"> */</span> |
|
392 <span class="nx">_isLazyAttr</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> |
|
393 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">LAZY</span><span class="o">);</span> |
|
394 <span class="o">},</span> |
|
395 |
|
396 <span class="c">/**</span> |
|
397 <span class="c"> * Finishes initializing an attribute which has been lazily added.</span> |
|
398 <span class="c"> *</span> |
|
399 <span class="c"> * @method _addLazyAttr</span> |
|
400 <span class="c"> * @private</span> |
|
401 <span class="c"> * @param {Object} name The name of the attribute</span> |
|
402 <span class="c"> */</span> |
|
403 <span class="nx">_addLazyAttr</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> |
|
404 <span class="k">var</span> <span class="nx">state</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
405 <span class="nx">lazyCfg</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">LAZY</span><span class="o">);</span> |
|
406 |
|
407 <span class="nx">state</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">IS_LAZY_ADD</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
408 <span class="nx">state</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">LAZY</span><span class="o">);</span> |
|
409 <span class="k">this</span><span class="o">.</span><span class="nx">addAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">lazyCfg</span><span class="o">);</span> |
|
410 <span class="o">},</span> |
|
411 |
|
412 <span class="c">/**</span> |
|
413 <span class="c"> * Sets the value of an attribute.</span> |
|
414 <span class="c"> *</span> |
|
415 <span class="c"> * @method set</span> |
|
416 <span class="c"> * @chainable</span> |
|
417 <span class="c"> *</span> |
|
418 <span class="c"> * @param {String} name The name of the attribute. If the </span> |
|
419 <span class="c"> * current value of the attribute is an Object, dot notation can be used</span> |
|
420 <span class="c"> * to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</span> |
|
421 <span class="c"> *</span> |
|
422 <span class="c"> * @param {Any} value The value to set the attribute to.</span> |
|
423 <span class="c"> *</span> |
|
424 <span class="c"> * @param {Object} opts (Optional) Optional event data to be mixed into</span> |
|
425 <span class="c"> * the event facade passed to subscribers of the attribute's change event. This </span> |
|
426 <span class="c"> * can be used as a flexible way to identify the source of a call to set, allowing </span> |
|
427 <span class="c"> * the developer to distinguish between set called internally by the host, vs. </span> |
|
428 <span class="c"> * set called externally by the application developer.</span> |
|
429 <span class="c"> *</span> |
|
430 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
431 <span class="c"> */</span> |
|
432 <span class="nx">set</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">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">)</span> <span class="o">{</span> |
|
433 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_setAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">);</span> |
|
434 <span class="o">},</span> |
|
435 |
|
436 <span class="c">/**</span> |
|
437 <span class="c"> * Resets the attribute (or all attributes) to its initial value, as long as</span> |
|
438 <span class="c"> * the attribute is not readOnly, or writeOnce.</span> |
|
439 <span class="c"> *</span> |
|
440 <span class="c"> * @method reset</span> |
|
441 <span class="c"> * @param {String} name Optional. The name of the attribute to reset. If omitted, all attributes are reset.</span> |
|
442 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
443 <span class="c"> * @chainable</span> |
|
444 <span class="c"> */</span> |
|
445 <span class="nx">reset</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> |
|
446 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
447 <span class="c"></span> <span class="nx">added</span><span class="o">;</span> |
|
448 |
|
449 <span class="k">if</span> <span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">{</span> |
|
450 <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_isLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
451 <span class="nx">host</span><span class="o">.</span><span class="nx">_addLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
452 <span class="o">}</span> |
|
453 <span class="nx">host</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">INIT_VALUE</span><span class="o">));</span> |
|
454 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
455 <span class="nx">added</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">data</span><span class="o">.</span><span class="nx">added</span><span class="o">;</span> |
|
456 <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">added</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">n</span><span class="o">)</span> <span class="o">{</span> |
|
457 <span class="nx">host</span><span class="o">.</span><span class="nx">reset</span><span class="o">(</span><span class="nx">n</span><span class="o">);</span> |
|
458 <span class="o">},</span> <span class="nx">host</span><span class="o">);</span> |
|
459 <span class="o">}</span> |
|
460 <span class="k">return</span> <span class="nx">host</span><span class="o">;</span> |
|
461 <span class="o">},</span> |
|
462 |
|
463 <span class="c">/**</span> |
|
464 <span class="c"> * Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</span> |
|
465 <span class="c"> *</span> |
|
466 <span class="c"> * @method _set</span> |
|
467 <span class="c"> * @protected</span> |
|
468 <span class="c"> * @chainable</span> |
|
469 <span class="c"> * </span> |
|
470 <span class="c"> * @param {String} name The name of the attribute.</span> |
|
471 <span class="c"> * @param {Any} val The value to set the attribute to.</span> |
|
472 <span class="c"> * @param {Object} opts (Optional) Optional event data to be mixed into</span> |
|
473 <span class="c"> * the event facade passed to subscribers of the attribute's change event.</span> |
|
474 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
475 <span class="c"> */</span> |
|
476 <span class="nx">_set</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">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">)</span> <span class="o">{</span> |
|
477 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_setAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
478 <span class="o">},</span> |
|
479 |
|
480 <span class="c">/**</span> |
|
481 <span class="c"> * Provides the common implementation for the public get method,</span> |
|
482 <span class="c"> * allowing Attribute hosts to over-ride either method.</span> |
|
483 <span class="c"> *</span> |
|
484 <span class="c"> * See <a href="#method_get">get</a> for argument details.</span> |
|
485 <span class="c"> *</span> |
|
486 <span class="c"> * @method _getAttr</span> |
|
487 <span class="c"> * @protected</span> |
|
488 <span class="c"> * @chainable</span> |
|
489 <span class="c"> *</span> |
|
490 <span class="c"> * @param {String} name The name of the attribute.</span> |
|
491 <span class="c"> * @return {Any} The value of the attribute.</span> |
|
492 <span class="c"> */</span> |
|
493 <span class="nx">_getAttr</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> |
|
494 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
495 <span class="c"></span> <span class="nx">fullName</span> <span class="o">=</span> <span class="nx">name</span><span class="o">,</span> |
|
496 <span class="nx">state</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
497 <span class="nx">path</span><span class="o">,</span> |
|
498 <span class="nx">getter</span><span class="o">,</span> |
|
499 <span class="nx">val</span><span class="o">,</span> |
|
500 <span class="nx">cfg</span><span class="o">;</span> |
|
501 |
|
502 <span class="k">if</span> <span class="o">(</span><span class="nx">name</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">DOT</span><span class="o">)</span> <span class="o">!==</span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
503 <span class="nx">path</span> <span class="o">=</span> <span class="nx">name</span><span class="o">.</span><span class="nx">split</span><span class="o">(</span><span class="nx">DOT</span><span class="o">);</span> |
|
504 <span class="nx">name</span> <span class="o">=</span> <span class="nx">path</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
505 <span class="o">}</span> |
|
506 |
|
507 <span class="c">// On Demand - Should be rare - handles out of order valueFn references</span> |
|
508 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span> <span class="o">&&</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span><span class="o">[</span><span class="nx">name</span><span class="o">])</span> <span class="o">{</span> |
|
509 <span class="nx">cfg</span> <span class="o">=</span> <span class="o">{};</span> |
|
510 <span class="nx">cfg</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span><span class="o">[</span><span class="nx">name</span><span class="o">];</span> |
|
511 <span class="nx">delete</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span><span class="o">[</span><span class="nx">name</span><span class="o">];</span> |
|
512 <span class="nx">host</span><span class="o">.</span><span class="nx">_addAttrs</span><span class="o">(</span><span class="nx">cfg</span><span class="o">,</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tVals</span><span class="o">);</span> |
|
513 <span class="o">}</span> |
|
514 |
|
515 <span class="c">// Lazy Init</span> |
|
516 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_isLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
517 <span class="nx">host</span><span class="o">.</span><span class="nx">_addLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
518 <span class="o">}</span> |
|
519 |
|
520 <span class="nx">val</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_getStateVal</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
521 <span class="nx">getter</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">GETTER</span><span class="o">);</span> |
|
522 |
|
523 <span class="nx">val</span> <span class="o">=</span> <span class="o">(</span><span class="nx">getter</span><span class="o">)</span> <span class="o">?</span> <span class="nx">getter</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">host</span><span class="o">,</span> <span class="nx">val</span><span class="o">,</span> <span class="nx">fullName</span><span class="o">)</span> <span class="o">:</span> <span class="nx">val</span><span class="o">;</span> |
|
524 <span class="nx">val</span> <span class="o">=</span> <span class="o">(</span><span class="nx">path</span><span class="o">)</span> <span class="o">?</span> <span class="nx">O</span><span class="o">.</span><span class="nx">getValue</span><span class="o">(</span><span class="nx">val</span><span class="o">,</span> <span class="nx">path</span><span class="o">)</span> <span class="o">:</span> <span class="nx">val</span><span class="o">;</span> |
|
525 |
|
526 <span class="k">return</span> <span class="nx">val</span><span class="o">;</span> |
|
527 <span class="o">},</span> |
|
528 |
|
529 <span class="c">/**</span> |
|
530 <span class="c"> * Provides the common implementation for the public set and protected _set methods.</span> |
|
531 <span class="c"> *</span> |
|
532 <span class="c"> * See <a href="#method_set">set</a> for argument details.</span> |
|
533 <span class="c"> *</span> |
|
534 <span class="c"> * @method _setAttr</span> |
|
535 <span class="c"> * @protected</span> |
|
536 <span class="c"> * @chainable</span> |
|
537 <span class="c"> *</span> |
|
538 <span class="c"> * @param {String} name The name of the attribute.</span> |
|
539 <span class="c"> * @param {Any} value The value to set the attribute to.</span> |
|
540 <span class="c"> * @param {Object} opts (Optional) Optional event data to be mixed into</span> |
|
541 <span class="c"> * the event facade passed to subscribers of the attribute's change event.</span> |
|
542 <span class="c"> * @param {boolean} force If true, allows the caller to set values for </span> |
|
543 <span class="c"> * readOnly or writeOnce attributes which have already been set.</span> |
|
544 <span class="c"> *</span> |
|
545 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
546 <span class="c"> */</span> |
|
547 <span class="nx">_setAttr</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">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">,</span> <span class="nx">force</span><span class="o">)</span> <span class="o">{</span> |
|
548 <span class="k">var</span> <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">true</span><span class="o">,</span> |
|
549 <span class="nx">state</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
550 <span class="nx">stateProxy</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_stateProxy</span><span class="o">,</span> |
|
551 <span class="nx">data</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">data</span><span class="o">,</span> |
|
552 <span class="nx">initialSet</span><span class="o">,</span> |
|
553 <span class="nx">strPath</span><span class="o">,</span> |
|
554 <span class="nx">path</span><span class="o">,</span> |
|
555 <span class="nx">currVal</span><span class="o">;</span> |
|
556 |
|
557 <span class="k">if</span> <span class="o">(</span><span class="nx">name</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">DOT</span><span class="o">)</span> <span class="o">!==</span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
558 <span class="nx">strPath</span> <span class="o">=</span> <span class="nx">name</span><span class="o">;</span> |
|
559 <span class="nx">path</span> <span class="o">=</span> <span class="nx">name</span><span class="o">.</span><span class="nx">split</span><span class="o">(</span><span class="nx">DOT</span><span class="o">);</span> |
|
560 <span class="nx">name</span> <span class="o">=</span> <span class="nx">path</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
561 <span class="o">}</span> |
|
562 |
|
563 <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_isLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
564 <span class="k">this</span><span class="o">.</span><span class="nx">_addLazyAttr</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
565 <span class="o">}</span> |
|
566 |
|
567 <span class="nx">initialSet</span> <span class="o">=</span> <span class="o">(!</span><span class="nx">data</span><span class="o">.</span><span class="nx">value</span> <span class="o">||</span> <span class="o">!(</span><span class="nx">name</span> <span class="k">in</span> <span class="nx">data</span><span class="o">.</span><span class="nx">value</span><span class="o">));</span> |
|
568 |
|
569 <span class="k">if</span> <span class="o">(</span><span class="nx">stateProxy</span> <span class="o">&&</span> <span class="nx">name</span> <span class="k">in</span> <span class="nx">stateProxy</span> <span class="o">&&</span> <span class="o">!</span><span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">BYPASS_PROXY</span><span class="o">))</span> <span class="o">{</span> |
|
570 <span class="c">// TODO: Value is always set for proxy. Can we do any better? Maybe take a snapshot as the initial value for the first call to set? </span> |
|
571 <span class="c"></span> <span class="nx">initialSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
572 <span class="o">}</span> |
|
573 |
|
574 <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_requireAddAttr</span> <span class="o">&&</span> <span class="o">!</span><span class="k">this</span><span class="o">.</span><span class="nx">attrAdded</span><span class="o">(</span><span class="nx">name</span><span class="o">))</span> <span class="o">{</span> |
|
575 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Set attribute:'</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">', aborted; Attribute is not configured'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
576 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
577 |
|
578 <span class="k">if</span> <span class="o">(!</span><span class="nx">initialSet</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">force</span><span class="o">)</span> <span class="o">{</span> |
|
579 |
|
580 <span class="k">if</span> <span class="o">(</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">WRITE_ONCE</span><span class="o">))</span> <span class="o">{</span> |
|
581 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Set attribute:'</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">', aborted; Attribute is writeOnce'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
582 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
583 <span class="o">}</span> |
|
584 |
|
585 <span class="k">if</span> <span class="o">(</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">READ_ONLY</span><span class="o">))</span> <span class="o">{</span> |
|
586 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Set attribute:'</span> <span class="o">+</span> <span class="nx">name</span> <span class="o">+</span> <span class="s1">', aborted; Attribute is readOnly'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
587 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
588 <span class="o">}</span> |
|
589 <span class="o">}</span> |
|
590 |
|
591 <span class="k">if</span> <span class="o">(</span><span class="nx">allowSet</span><span class="o">)</span> <span class="o">{</span> |
|
592 <span class="c">// Don't need currVal if initialSet (might fail in custom getter if it always expects a non-undefined/non-null value)</span> |
|
593 <span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="nx">initialSet</span><span class="o">)</span> <span class="o">{</span> |
|
594 <span class="nx">currVal</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
595 <span class="o">}</span> |
|
596 |
|
597 <span class="k">if</span> <span class="o">(</span><span class="nx">path</span><span class="o">)</span> <span class="o">{</span> |
|
598 <span class="nx">val</span> <span class="o">=</span> <span class="nx">O</span><span class="o">.</span><span class="nx">setValue</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">clone</span><span class="o">(</span><span class="nx">currVal</span><span class="o">),</span> <span class="nx">path</span><span class="o">,</span> <span class="nx">val</span><span class="o">);</span> |
|
599 |
|
600 <span class="k">if</span> <span class="o">(</span><span class="nx">val</span> <span class="o">===</span> <span class="kc">undefined</span><span class="o">)</span> <span class="o">{</span> |
|
601 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Set attribute path:'</span> <span class="o">+</span> <span class="nx">strPath</span> <span class="o">+</span> <span class="s1">', aborted; Path is invalid'</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
602 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
603 <span class="o">}</span> |
|
604 <span class="o">}</span> |
|
605 |
|
606 <span class="k">if</span> <span class="o">(</span><span class="nx">allowSet</span><span class="o">)</span> <span class="o">{</span> |
|
607 <span class="k">if</span> <span class="o">(</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">INITIALIZING</span><span class="o">))</span> <span class="o">{</span> |
|
608 <span class="k">this</span><span class="o">.</span><span class="nx">_setAttrVal</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">strPath</span><span class="o">,</span> <span class="nx">currVal</span><span class="o">,</span> <span class="nx">val</span><span class="o">);</span> |
|
609 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
610 <span class="k">this</span><span class="o">.</span><span class="nx">_fireAttrChange</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">strPath</span><span class="o">,</span> <span class="nx">currVal</span><span class="o">,</span> <span class="nx">val</span><span class="o">,</span> <span class="nx">opts</span><span class="o">);</span> |
|
611 <span class="o">}</span> |
|
612 <span class="o">}</span> |
|
613 <span class="o">}</span> |
|
614 <span class="o">}</span> |
|
615 |
|
616 <span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
617 <span class="o">},</span> |
|
618 |
|
619 <span class="c">/**</span> |
|
620 <span class="c"> * Utility method to help setup the event payload and fire the attribute change event.</span> |
|
621 <span class="c"> * </span> |
|
622 <span class="c"> * @method _fireAttrChange</span> |
|
623 <span class="c"> * @private</span> |
|
624 <span class="c"> * @param {String} attrName The name of the attribute</span> |
|
625 <span class="c"> * @param {String} subAttrName The full path of the property being changed, </span> |
|
626 <span class="c"> * if this is a sub-attribute value being change. Otherwise null.</span> |
|
627 <span class="c"> * @param {Any} currVal The current value of the attribute</span> |
|
628 <span class="c"> * @param {Any} newVal The new value of the attribute</span> |
|
629 <span class="c"> * @param {Object} opts Any additional event data to mix into the attribute change event's event facade.</span> |
|
630 <span class="c"> */</span> |
|
631 <span class="nx">_fireAttrChange</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">subAttrName</span><span class="o">,</span> <span class="nx">currVal</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">,</span> <span class="nx">opts</span><span class="o">)</span> <span class="o">{</span> |
|
632 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> |
|
633 <span class="nx">eventName</span> <span class="o">=</span> <span class="nx">attrName</span> <span class="o">+</span> <span class="nx">CHANGE</span><span class="o">,</span> |
|
634 <span class="nx">state</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
635 <span class="nx">facade</span><span class="o">;</span> |
|
636 |
|
637 <span class="k">if</span> <span class="o">(!</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">PUBLISHED</span><span class="o">))</span> <span class="o">{</span> |
|
638 <span class="nx">host</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="nx">eventName</span><span class="o">,</span> <span class="o">{</span> |
|
639 <span class="nx">queuable</span><span class="o">:</span><span class="kc">false</span><span class="o">,</span> |
|
640 <span class="nx">defaultFn</span><span class="o">:</span><span class="nx">host</span><span class="o">.</span><span class="nx">_defAttrChangeFn</span><span class="o">,</span> |
|
641 <span class="nx">silent</span><span class="o">:</span><span class="kc">true</span><span class="o">,</span> |
|
642 <span class="nx">broadcast</span> <span class="o">:</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">BROADCAST</span><span class="o">)</span> |
|
643 <span class="o">});</span> |
|
644 <span class="nx">state</span><span class="o">.</span><span class="nx">add</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">PUBLISHED</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
645 <span class="o">}</span> |
|
646 |
|
647 <span class="nx">facade</span> <span class="o">=</span> <span class="o">(</span><span class="nx">opts</span><span class="o">)</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span><span class="nx">opts</span><span class="o">)</span> <span class="o">:</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_ATTR_E_FACADE</span><span class="o">;</span> |
|
648 |
|
649 <span class="nx">facade</span><span class="o">.</span><span class="nx">type</span> <span class="o">=</span> <span class="nx">eventName</span><span class="o">;</span> |
|
650 <span class="nx">facade</span><span class="o">.</span><span class="nx">attrName</span> <span class="o">=</span> <span class="nx">attrName</span><span class="o">;</span> |
|
651 <span class="nx">facade</span><span class="o">.</span><span class="nx">subAttrName</span> <span class="o">=</span> <span class="nx">subAttrName</span><span class="o">;</span> |
|
652 <span class="nx">facade</span><span class="o">.</span><span class="nx">prevVal</span> <span class="o">=</span> <span class="nx">currVal</span><span class="o">;</span> |
|
653 <span class="nx">facade</span><span class="o">.</span><span class="nx">newVal</span> <span class="o">=</span> <span class="nx">newVal</span><span class="o">;</span> |
|
654 |
|
655 <span class="nx">host</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">facade</span><span class="o">);</span> |
|
656 <span class="o">},</span> |
|
657 |
|
658 <span class="c">/**</span> |
|
659 <span class="c"> * Default function for attribute change events.</span> |
|
660 <span class="c"> *</span> |
|
661 <span class="c"> * @private</span> |
|
662 <span class="c"> * @method _defAttrChangeFn</span> |
|
663 <span class="c"> * @param {EventFacade} e The event object for attribute change events.</span> |
|
664 <span class="c"> */</span> |
|
665 <span class="nx">_defAttrChangeFn</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
666 <span class="k">if</span> <span class="o">(!</span><span class="k">this</span><span class="o">.</span><span class="nx">_setAttrVal</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">e</span><span class="o">.</span><span class="nx">subAttrName</span><span class="o">,</span> <span class="nx">e</span><span class="o">.</span><span class="nx">prevVal</span><span class="o">,</span> <span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span><span class="o">))</span> <span class="o">{</span> |
|
667 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'State not updated and stopImmediatePropagation called for attribute: '</span> <span class="o">+</span> <span class="nx">e</span><span class="o">.</span><span class="nx">attrName</span> <span class="o">+</span> <span class="s1">' , value:'</span> <span class="o">+</span> <span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
668 <span class="c">// Prevent "after" listeners from being invoked since nothing changed.</span> |
|
669 <span class="c"></span> <span class="nx">e</span><span class="o">.</span><span class="nx">stopImmediatePropagation</span><span class="o">();</span> |
|
670 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
671 <span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_getStateVal</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">attrName</span><span class="o">);</span> |
|
672 <span class="o">}</span> |
|
673 <span class="o">},</span> |
|
674 |
|
675 <span class="c">/**</span> |
|
676 <span class="c"> * Gets the stored value for the attribute, from either the </span> |
|
677 <span class="c"> * internal state object, or the state proxy if it exits</span> |
|
678 <span class="c"> * </span> |
|
679 <span class="c"> * @method _getStateVal</span> |
|
680 <span class="c"> * @private</span> |
|
681 <span class="c"> * @param {String} name The name of the attribute</span> |
|
682 <span class="c"> * @return {Any} The stored value of the attribute</span> |
|
683 <span class="c"> */</span> |
|
684 <span class="nx">_getStateVal</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> |
|
685 <span class="k">var</span> <span class="nx">stateProxy</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_stateProxy</span><span class="o">;</span> |
|
686 <span class="k">return</span> <span class="nx">stateProxy</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">name</span> <span class="k">in</span> <span class="nx">stateProxy</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">BYPASS_PROXY</span><span class="o">)</span> <span class="o">?</span> <span class="nx">stateProxy</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">VALUE</span><span class="o">);</span> |
|
687 <span class="o">},</span> |
|
688 |
|
689 <span class="c">/**</span> |
|
690 <span class="c"> * Sets the stored value for the attribute, in either the </span> |
|
691 <span class="c"> * internal state object, or the state proxy if it exits</span> |
|
692 <span class="c"> *</span> |
|
693 <span class="c"> * @method _setStateVal</span> |
|
694 <span class="c"> * @private</span> |
|
695 <span class="c"> * @param {String} name The name of the attribute</span> |
|
696 <span class="c"> * @param {Any} value The value of the attribute</span> |
|
697 <span class="c"> */</span> |
|
698 <span class="nx">_setStateVal</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">value</span><span class="o">)</span> <span class="o">{</span> |
|
699 <span class="k">var</span> <span class="nx">stateProxy</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_stateProxy</span><span class="o">;</span> |
|
700 <span class="k">if</span> <span class="o">(</span><span class="nx">stateProxy</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">name</span> <span class="k">in</span> <span class="nx">stateProxy</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="k">this</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">BYPASS_PROXY</span><span class="o">))</span> <span class="o">{</span> |
|
701 <span class="nx">stateProxy</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="nx">value</span><span class="o">;</span> |
|
702 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
703 <span class="k">this</span><span class="o">.</span><span class="nx">_state</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">VALUE</span><span class="o">,</span> <span class="nx">value</span><span class="o">);</span> |
|
704 <span class="o">}</span> |
|
705 <span class="o">},</span> |
|
706 |
|
707 <span class="c">/**</span> |
|
708 <span class="c"> * Updates the stored value of the attribute in the privately held State object,</span> |
|
709 <span class="c"> * if validation and setter passes.</span> |
|
710 <span class="c"> *</span> |
|
711 <span class="c"> * @method _setAttrVal</span> |
|
712 <span class="c"> * @private</span> |
|
713 <span class="c"> * @param {String} attrName The attribute name.</span> |
|
714 <span class="c"> * @param {String} subAttrName The sub-attribute name, if setting a sub-attribute property ("x.y.z").</span> |
|
715 <span class="c"> * @param {Any} prevVal The currently stored value of the attribute.</span> |
|
716 <span class="c"> * @param {Any} newVal The value which is going to be stored.</span> |
|
717 <span class="c"> * </span> |
|
718 <span class="c"> * @return {booolean} true if the new attribute value was stored, false if not.</span> |
|
719 <span class="c"> */</span> |
|
720 <span class="nx">_setAttrVal</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">subAttrName</span><span class="o">,</span> <span class="nx">prevVal</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">)</span> <span class="o">{</span> |
|
721 |
|
722 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> |
|
723 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">true</span><span class="o">,</span> |
|
724 <span class="nx">state</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">,</span> |
|
725 |
|
726 <span class="nx">validator</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">VALIDATOR</span><span class="o">),</span> |
|
727 <span class="nx">setter</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">SETTER</span><span class="o">),</span> |
|
728 <span class="nx">initializing</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">INITIALIZING</span><span class="o">),</span> |
|
729 <span class="nx">prevValRaw</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_getStateVal</span><span class="o">(</span><span class="nx">attrName</span><span class="o">),</span> |
|
730 |
|
731 <span class="nx">name</span> <span class="o">=</span> <span class="nx">subAttrName</span> <span class="o">||</span> <span class="nx">attrName</span><span class="o">,</span> |
|
732 <span class="nx">retVal</span><span class="o">,</span> |
|
733 <span class="nx">valid</span><span class="o">;</span> |
|
734 |
|
735 <span class="k">if</span> <span class="o">(</span><span class="nx">validator</span><span class="o">)</span> <span class="o">{</span> |
|
736 <span class="nx">valid</span> <span class="o">=</span> <span class="nx">validator</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">host</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">,</span> <span class="nx">name</span><span class="o">);</span> |
|
737 |
|
738 <span class="k">if</span> <span class="o">(!</span><span class="nx">valid</span> <span class="o">&&</span> <span class="nx">initializing</span><span class="o">)</span> <span class="o">{</span> |
|
739 <span class="nx">newVal</span> <span class="o">=</span> <span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">DEF_VALUE</span><span class="o">);</span> |
|
740 <span class="nx">valid</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> <span class="c">// Assume it's valid, for perf.</span> |
|
741 <span class="c"></span> <span class="o">}</span> |
|
742 <span class="o">}</span> |
|
743 |
|
744 <span class="k">if</span> <span class="o">(!</span><span class="nx">validator</span> <span class="o">||</span> <span class="nx">valid</span><span class="o">)</span> <span class="o">{</span> |
|
745 <span class="k">if</span> <span class="o">(</span><span class="nx">setter</span><span class="o">)</span> <span class="o">{</span> |
|
746 <span class="nx">retVal</span> <span class="o">=</span> <span class="nx">setter</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">host</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">,</span> <span class="nx">name</span><span class="o">);</span> |
|
747 |
|
748 <span class="k">if</span> <span class="o">(</span><span class="nx">retVal</span> <span class="o">===</span> <span class="nx">INVALID_VALUE</span><span class="o">)</span> <span class="o">{</span> |
|
749 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute: '</span> <span class="o">+</span> <span class="nx">attrName</span> <span class="o">+</span> <span class="s1">', setter returned Attribute.INVALID_VALUE for value:'</span> <span class="o">+</span> <span class="nx">newVal</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
750 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
751 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">retVal</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="o">){</span> |
|
752 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute: '</span> <span class="o">+</span> <span class="nx">attrName</span> <span class="o">+</span> <span class="s1">', raw value: '</span> <span class="o">+</span> <span class="nx">newVal</span> <span class="o">+</span> <span class="s1">' modified by setter to:'</span> <span class="o">+</span> <span class="nx">retVal</span><span class="o">,</span> <span class="s1">'info'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
753 <span class="nx">newVal</span> <span class="o">=</span> <span class="nx">retVal</span><span class="o">;</span> |
|
754 <span class="o">}</span> |
|
755 <span class="o">}</span> |
|
756 |
|
757 <span class="k">if</span> <span class="o">(</span><span class="nx">allowSet</span><span class="o">)</span> <span class="o">{</span> |
|
758 <span class="k">if</span><span class="o">(!</span><span class="nx">subAttrName</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">newVal</span> <span class="o">===</span> <span class="nx">prevValRaw</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">Lang</span><span class="o">.</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">newVal</span><span class="o">))</span> <span class="o">{</span> |
|
759 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute: '</span> <span class="o">+</span> <span class="nx">attrName</span> <span class="o">+</span> <span class="s1">', value unchanged:'</span> <span class="o">+</span> <span class="nx">newVal</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
760 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
761 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
762 <span class="c">// Store value</span> |
|
763 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">INIT_VALUE</span><span class="o">)</span> <span class="o">===</span> <span class="kc">undefined</span><span class="o">)</span> <span class="o">{</span> |
|
764 <span class="nx">state</span><span class="o">.</span><span class="nx">add</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">INIT_VALUE</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">);</span> |
|
765 <span class="o">}</span> |
|
766 <span class="nx">host</span><span class="o">.</span><span class="nx">_setStateVal</span><span class="o">(</span><span class="nx">attrName</span><span class="o">,</span> <span class="nx">newVal</span><span class="o">);</span> |
|
767 <span class="o">}</span> |
|
768 <span class="o">}</span> |
|
769 |
|
770 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
771 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Attribute:'</span> <span class="o">+</span> <span class="nx">attrName</span> <span class="o">+</span> <span class="s1">', Validation failed for value:'</span> <span class="o">+</span> <span class="nx">newVal</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
772 <span class="nx">allowSet</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
773 <span class="o">}</span> |
|
774 |
|
775 <span class="k">return</span> <span class="nx">allowSet</span><span class="o">;</span> |
|
776 <span class="o">},</span> |
|
777 |
|
778 <span class="c">/**</span> |
|
779 <span class="c"> * Sets multiple attribute values.</span> |
|
780 <span class="c"> *</span> |
|
781 <span class="c"> * @method setAttrs</span> |
|
782 <span class="c"> * @param {Object} attrs An object with attributes name/value pairs.</span> |
|
783 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
784 <span class="c"> * @chainable</span> |
|
785 <span class="c"> */</span> |
|
786 <span class="nx">setAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrs</span><span class="o">,</span> <span class="nx">opts</span><span class="o">)</span> <span class="o">{</span> |
|
787 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_setAttrs</span><span class="o">(</span><span class="nx">attrs</span><span class="o">,</span> <span class="nx">opts</span><span class="o">);</span> |
|
788 <span class="o">},</span> |
|
789 |
|
790 <span class="c">/**</span> |
|
791 <span class="c"> * Implementation behind the public setAttrs method, to set multiple attribute values.</span> |
|
792 <span class="c"> *</span> |
|
793 <span class="c"> * @method _setAttrs</span> |
|
794 <span class="c"> * @protected</span> |
|
795 <span class="c"> * @param {Object} attrs An object with attributes name/value pairs.</span> |
|
796 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
797 <span class="c"> * @chainable</span> |
|
798 <span class="c"> */</span> |
|
799 <span class="nx">_setAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrs</span><span class="o">,</span> <span class="nx">opts</span><span class="o">)</span> <span class="o">{</span> |
|
800 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">attr</span> <span class="k">in</span> <span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
801 <span class="k">if</span> <span class="o">(</span> <span class="nx">attrs</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">attr</span><span class="o">)</span> <span class="o">)</span> <span class="o">{</span> |
|
802 <span class="k">this</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">attr</span><span class="o">,</span> <span class="nx">attrs</span><span class="o">[</span><span class="nx">attr</span><span class="o">]);</span> |
|
803 <span class="o">}</span> |
|
804 <span class="o">}</span> |
|
805 <span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
806 <span class="o">},</span> |
|
807 |
|
808 <span class="c">/**</span> |
|
809 <span class="c"> * Gets multiple attribute values.</span> |
|
810 <span class="c"> *</span> |
|
811 <span class="c"> * @method getAttrs</span> |
|
812 <span class="c"> * @param {Array | boolean} attrs Optional. An array of attribute names. If omitted, all attribute values are</span> |
|
813 <span class="c"> * returned. If set to true, all attributes modified from their initial values are returned.</span> |
|
814 <span class="c"> * @return {Object} An object with attribute name/value pairs.</span> |
|
815 <span class="c"> */</span> |
|
816 <span class="nx">getAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
817 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_getAttrs</span><span class="o">(</span><span class="nx">attrs</span><span class="o">);</span> |
|
818 <span class="o">},</span> |
|
819 |
|
820 <span class="c">/**</span> |
|
821 <span class="c"> * Implementation behind the public getAttrs method, to get multiple attribute values.</span> |
|
822 <span class="c"> *</span> |
|
823 <span class="c"> * @method _getAttrs</span> |
|
824 <span class="c"> * @protected</span> |
|
825 <span class="c"> * @param {Array | boolean} attrs Optional. An array of attribute names. If omitted, all attribute values are</span> |
|
826 <span class="c"> * returned. If set to true, all attributes modified from their initial values are returned.</span> |
|
827 <span class="c"> * @return {Object} An object with attribute name/value pairs.</span> |
|
828 <span class="c"> */</span> |
|
829 <span class="nx">_getAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
830 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> |
|
831 <span class="nx">o</span> <span class="o">=</span> <span class="o">{},</span> |
|
832 <span class="nx">i</span><span class="o">,</span> <span class="nx">l</span><span class="o">,</span> <span class="nx">attr</span><span class="o">,</span> <span class="nx">val</span><span class="o">,</span> |
|
833 <span class="nx">modifiedOnly</span> <span class="o">=</span> <span class="o">(</span><span class="nx">attrs</span> <span class="o">===</span> <span class="kc">true</span><span class="o">);</span> |
|
834 |
|
835 <span class="nx">attrs</span> <span class="o">=</span> <span class="o">(</span><span class="nx">attrs</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">modifiedOnly</span><span class="o">)</span> <span class="o">?</span> <span class="nx">attrs</span> <span class="o">:</span> <span class="nx">O</span><span class="o">.</span><span class="nx">keys</span><span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">data</span><span class="o">.</span><span class="nx">added</span><span class="o">);</span> |
|
836 |
|
837 <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">l</span> <span class="o">=</span> <span class="nx">attrs</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">l</span><span class="o">;</span> <span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
838 <span class="c">// Go through get, to honor cloning/normalization</span> |
|
839 <span class="c"></span> <span class="nx">attr</span> <span class="o">=</span> <span class="nx">attrs</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
840 <span class="nx">val</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attr</span><span class="o">);</span> |
|
841 |
|
842 <span class="k">if</span> <span class="o">(!</span><span class="nx">modifiedOnly</span> <span class="o">||</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_getStateVal</span><span class="o">(</span><span class="nx">attr</span><span class="o">)</span> <span class="o">!=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_state</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attr</span><span class="o">,</span> <span class="nx">INIT_VALUE</span><span class="o">))</span> <span class="o">{</span> |
|
843 <span class="nx">o</span><span class="o">[</span><span class="nx">attr</span><span class="o">]</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">attr</span><span class="o">);</span> |
|
844 <span class="o">}</span> |
|
845 <span class="o">}</span> |
|
846 |
|
847 <span class="k">return</span> <span class="nx">o</span><span class="o">;</span> |
|
848 <span class="o">},</span> |
|
849 |
|
850 <span class="c">/**</span> |
|
851 <span class="c"> * Configures a group of attributes, and sets initial values.</span> |
|
852 <span class="c"> *</span> |
|
853 <span class="c"> * <p></span> |
|
854 <span class="c"> * <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. </span> |
|
855 <span class="c"> * The caller is responsible for merging/cloning the configuration object if required.</span> |
|
856 <span class="c"> * </p></span> |
|
857 <span class="c"> *</span> |
|
858 <span class="c"> * @method addAttrs</span> |
|
859 <span class="c"> * @chainable</span> |
|
860 <span class="c"> *</span> |
|
861 <span class="c"> * @param {Object} cfgs An object with attribute name/configuration pairs.</span> |
|
862 <span class="c"> * @param {Object} values An object with attribute name/value pairs, defining the initial values to apply.</span> |
|
863 <span class="c"> * Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</span> |
|
864 <span class="c"> * @param {boolean} lazy Whether or not to delay the intialization of these attributes until the first call to get/set.</span> |
|
865 <span class="c"> * Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.</span> |
|
866 <span class="c"> * See <a href="#method_addAttr">addAttr</a>.</span> |
|
867 <span class="c"> * </span> |
|
868 <span class="c"> * @return {Object} A reference to the host object.</span> |
|
869 <span class="c"> */</span> |
|
870 <span class="nx">addAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">cfgs</span><span class="o">,</span> <span class="nx">values</span><span class="o">,</span> <span class="nx">lazy</span><span class="o">)</span> <span class="o">{</span> |
|
871 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">;</span> <span class="c">// help compression</span> |
|
872 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">cfgs</span><span class="o">)</span> <span class="o">{</span> |
|
873 <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span> <span class="o">=</span> <span class="nx">cfgs</span><span class="o">;</span> |
|
874 <span class="nx">host</span><span class="o">.</span><span class="nx">_tVals</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_normAttrVals</span><span class="o">(</span><span class="nx">values</span><span class="o">);</span> |
|
875 <span class="nx">host</span><span class="o">.</span><span class="nx">_addAttrs</span><span class="o">(</span><span class="nx">cfgs</span><span class="o">,</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tVals</span><span class="o">,</span> <span class="nx">lazy</span><span class="o">);</span> |
|
876 <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tVals</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
877 <span class="o">}</span> |
|
878 |
|
879 <span class="k">return</span> <span class="nx">host</span><span class="o">;</span> |
|
880 <span class="o">},</span> |
|
881 |
|
882 <span class="c">/**</span> |
|
883 <span class="c"> * Implementation behind the public addAttrs method. </span> |
|
884 <span class="c"> * </span> |
|
885 <span class="c"> * This method is invoked directly by get if it encounters a scenario </span> |
|
886 <span class="c"> * in which an attribute's valueFn attempts to obtain the </span> |
|
887 <span class="c"> * value an attribute in the same group of attributes, which has not yet </span> |
|
888 <span class="c"> * been added (on demand initialization).</span> |
|
889 <span class="c"> *</span> |
|
890 <span class="c"> * @method _addAttrs</span> |
|
891 <span class="c"> * @private</span> |
|
892 <span class="c"> * @param {Object} cfgs An object with attribute name/configuration pairs.</span> |
|
893 <span class="c"> * @param {Object} values An object with attribute name/value pairs, defining the initial values to apply.</span> |
|
894 <span class="c"> * Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</span> |
|
895 <span class="c"> * @param {boolean} lazy Whether or not to delay the intialization of these attributes until the first call to get/set.</span> |
|
896 <span class="c"> * Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.</span> |
|
897 <span class="c"> * See <a href="#method_addAttr">addAttr</a>.</span> |
|
898 <span class="c"> */</span> |
|
899 <span class="nx">_addAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">cfgs</span><span class="o">,</span> <span class="nx">values</span><span class="o">,</span> <span class="nx">lazy</span><span class="o">)</span> <span class="o">{</span> |
|
900 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">,</span> <span class="c">// help compression</span> |
|
901 <span class="c"></span> <span class="nx">attr</span><span class="o">,</span> |
|
902 <span class="nx">attrCfg</span><span class="o">,</span> |
|
903 <span class="nx">value</span><span class="o">;</span> |
|
904 |
|
905 <span class="k">for</span> <span class="o">(</span><span class="nx">attr</span> <span class="k">in</span> <span class="nx">cfgs</span><span class="o">)</span> <span class="o">{</span> |
|
906 <span class="k">if</span> <span class="o">(</span><span class="nx">cfgs</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">attr</span><span class="o">))</span> <span class="o">{</span> |
|
907 |
|
908 <span class="c">// Not Merging. Caller is responsible for isolating configs</span> |
|
909 <span class="c"></span> <span class="nx">attrCfg</span> <span class="o">=</span> <span class="nx">cfgs</span><span class="o">[</span><span class="nx">attr</span><span class="o">];</span> |
|
910 <span class="nx">attrCfg</span><span class="o">.</span><span class="nx">defaultValue</span> <span class="o">=</span> <span class="nx">attrCfg</span><span class="o">.</span><span class="nx">value</span><span class="o">;</span> |
|
911 |
|
912 <span class="c">// Handle simple, complex and user values, accounting for read-only</span> |
|
913 <span class="c"></span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_getAttrInitVal</span><span class="o">(</span><span class="nx">attr</span><span class="o">,</span> <span class="nx">attrCfg</span><span class="o">,</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tVals</span><span class="o">);</span> |
|
914 |
|
915 <span class="k">if</span> <span class="o">(</span><span class="nx">value</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="o">)</span> <span class="o">{</span> |
|
916 <span class="nx">attrCfg</span><span class="o">.</span><span class="nx">value</span> <span class="o">=</span> <span class="nx">value</span><span class="o">;</span> |
|
917 <span class="o">}</span> |
|
918 |
|
919 <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span><span class="o">[</span><span class="nx">attr</span><span class="o">])</span> <span class="o">{</span> |
|
920 <span class="nx">delete</span> <span class="nx">host</span><span class="o">.</span><span class="nx">_tCfgs</span><span class="o">[</span><span class="nx">attr</span><span class="o">];</span> |
|
921 <span class="o">}</span> |
|
922 |
|
923 <span class="nx">host</span><span class="o">.</span><span class="nx">addAttr</span><span class="o">(</span><span class="nx">attr</span><span class="o">,</span> <span class="nx">attrCfg</span><span class="o">,</span> <span class="nx">lazy</span><span class="o">);</span> |
|
924 <span class="o">}</span> |
|
925 <span class="o">}</span> |
|
926 <span class="o">},</span> |
|
927 |
|
928 <span class="c">/**</span> |
|
929 <span class="c"> * Utility method to protect an attribute configuration</span> |
|
930 <span class="c"> * hash, by merging the entire object and the individual </span> |
|
931 <span class="c"> * attr config objects. </span> |
|
932 <span class="c"> *</span> |
|
933 <span class="c"> * @method _protectAttrs</span> |
|
934 <span class="c"> * @protected</span> |
|
935 <span class="c"> * @param {Object} attrs A hash of attribute to configuration object pairs.</span> |
|
936 <span class="c"> * @return {Object} A protected version of the attrs argument.</span> |
|
937 <span class="c"> */</span> |
|
938 <span class="nx">_protectAttrs</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
939 <span class="k">if</span> <span class="o">(</span><span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
940 <span class="nx">attrs</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span><span class="nx">attrs</span><span class="o">);</span> |
|
941 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">attr</span> <span class="k">in</span> <span class="nx">attrs</span><span class="o">)</span> <span class="o">{</span> |
|
942 <span class="k">if</span> <span class="o">(</span><span class="nx">attrs</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">attr</span><span class="o">))</span> <span class="o">{</span> |
|
943 <span class="nx">attrs</span><span class="o">[</span><span class="nx">attr</span><span class="o">]</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span><span class="nx">attrs</span><span class="o">[</span><span class="nx">attr</span><span class="o">]);</span> |
|
944 <span class="o">}</span> |
|
945 <span class="o">}</span> |
|
946 <span class="o">}</span> |
|
947 <span class="k">return</span> <span class="nx">attrs</span><span class="o">;</span> |
|
948 <span class="o">},</span> |
|
949 |
|
950 <span class="c">/**</span> |
|
951 <span class="c"> * Utility method to normalize attribute values. The base implementation </span> |
|
952 <span class="c"> * simply merges the hash to protect the original.</span> |
|
953 <span class="c"> *</span> |
|
954 <span class="c"> * @method _normAttrVals</span> |
|
955 <span class="c"> * @param {Object} valueHash An object with attribute name/value pairs</span> |
|
956 <span class="c"> *</span> |
|
957 <span class="c"> * @return {Object}</span> |
|
958 <span class="c"> *</span> |
|
959 <span class="c"> * @private</span> |
|
960 <span class="c"> */</span> |
|
961 <span class="nx">_normAttrVals</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">valueHash</span><span class="o">)</span> <span class="o">{</span> |
|
962 <span class="k">return</span> <span class="o">(</span><span class="nx">valueHash</span><span class="o">)</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span><span class="nx">valueHash</span><span class="o">)</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
963 <span class="o">},</span> |
|
964 |
|
965 <span class="c">/**</span> |
|
966 <span class="c"> * Returns the initial value of the given attribute from</span> |
|
967 <span class="c"> * either the default configuration provided, or the </span> |
|
968 <span class="c"> * over-ridden value if it exists in the set of initValues </span> |
|
969 <span class="c"> * provided and the attribute is not read-only.</span> |
|
970 <span class="c"> *</span> |
|
971 <span class="c"> * @param {String} attr The name of the attribute</span> |
|
972 <span class="c"> * @param {Object} cfg The attribute configuration object</span> |
|
973 <span class="c"> * @param {Object} initValues The object with simple and complex attribute name/value pairs returned from _normAttrVals</span> |
|
974 <span class="c"> *</span> |
|
975 <span class="c"> * @return {Any} The initial value of the attribute.</span> |
|
976 <span class="c"> *</span> |
|
977 <span class="c"> * @method _getAttrInitVal</span> |
|
978 <span class="c"> * @private</span> |
|
979 <span class="c"> */</span> |
|
980 <span class="nx">_getAttrInitVal</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">attr</span><span class="o">,</span> <span class="nx">cfg</span><span class="o">,</span> <span class="nx">initValues</span><span class="o">)</span> <span class="o">{</span> |
|
981 |
|
982 <span class="c">// init value is provided by the user if it exists, else, provided by the config</span> |
|
983 <span class="c"></span> <span class="k">var</span> <span class="nx">val</span> <span class="o">=</span> <span class="o">(!</span><span class="nx">cfg</span><span class="o">[</span><span class="nx">READ_ONLY</span><span class="o">]</span> <span class="o">&&</span> <span class="nx">initValues</span> <span class="o">&&</span> <span class="nx">initValues</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">attr</span><span class="o">))</span> <span class="o">?</span> |
|
984 <span class="nx">val</span> <span class="o">=</span> <span class="nx">initValues</span><span class="o">[</span><span class="nx">attr</span><span class="o">]</span> <span class="o">:</span> |
|
985 <span class="o">(</span><span class="nx">cfg</span><span class="o">[</span><span class="nx">VALUE_FN</span><span class="o">])</span> <span class="o">?</span> |
|
986 <span class="nx">cfg</span><span class="o">[</span><span class="nx">VALUE_FN</span><span class="o">].</span><span class="nx">call</span><span class="o">(</span><span class="k">this</span><span class="o">)</span> <span class="o">:</span> |
|
987 <span class="nx">cfg</span><span class="o">[</span><span class="nx">VALUE</span><span class="o">];</span> |
|
988 |
|
989 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'initValue for '</span> <span class="o">+</span> <span class="nx">attr</span> <span class="o">+</span> <span class="s1">':'</span> <span class="o">+</span> <span class="nx">val</span><span class="o">,</span> <span class="s1">'info'</span><span class="o">,</span> <span class="s1">'attribute'</span><span class="o">);</span> |
|
990 |
|
991 <span class="k">return</span> <span class="nx">val</span><span class="o">;</span> |
|
992 <span class="o">}</span> |
|
993 <span class="o">};</span> |
|
994 |
|
995 <span class="c">// Basic prototype augment - no lazy constructor invocation.</span> |
|
996 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">Attribute</span><span class="o">,</span> <span class="nx">EventTarget</span><span class="o">,</span> <span class="kc">false</span><span class="o">,</span> <span class="kc">null</span><span class="o">,</span> <span class="m">1</span><span class="o">);</span> |
|
997 |
|
998 <span class="nx">Y</span><span class="o">.</span><span class="nx">Attribute</span> <span class="o">=</span> <span class="nx">Attribute</span><span class="o">;</span> |
|
999 </pre></div> |
|
1000 |
|
1001 </div> |
|
1002 </div> |
|
1003 </div> |
|
1004 <div class="yui-b"> |
|
1005 <div class="nav"> |
|
1006 |
|
1007 <div id="moduleList" class="module"> |
|
1008 <h4>Modules</h4> |
|
1009 <ul class="content"> |
|
1010 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1011 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
1012 <li class="selected"><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1013 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1014 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
1015 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1016 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1017 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1018 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1019 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1020 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1021 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1022 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1023 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1024 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1025 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1026 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1027 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1028 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1029 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1030 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1031 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1032 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1033 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1034 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1035 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1036 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1037 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1038 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1039 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1040 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
1041 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1042 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1043 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1044 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1045 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1046 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1047 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1048 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1049 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1050 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1051 </ul> |
|
1052 </div> |
|
1053 |
|
1054 <div id="classList" class="module"> |
|
1055 <h4>Classes</h4> |
|
1056 <ul class="content"> |
|
1057 <li class=""><a href="Attribute.html" title="Attribute">Attribute</a></li> |
|
1058 <li class=""><a href="State.html" title="State">State</a></li> |
|
1059 </ul> |
|
1060 </div> |
|
1061 |
|
1062 <div id="fileList" class="module"> |
|
1063 <h4>Files</h4> |
|
1064 <ul class="content"> |
|
1065 <li class="selected"><a href="Attribute.js.html" title="Attribute.js">Attribute.js</a></li> |
|
1066 <li class=""><a href="ComplexAttribute.js.html" title="ComplexAttribute.js">ComplexAttribute.js</a></li> |
|
1067 <li class=""><a href="State.js.html" title="State.js">State.js</a></li> |
|
1068 </ul> |
|
1069 </div> |
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 |
|
1075 </div> |
|
1076 </div> |
|
1077 </div> |
|
1078 <div id="ft"> |
|
1079 <hr /> |
|
1080 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1081 </div> |
|
1082 </div> |
|
1083 <script type="text/javascript"> |
|
1084 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"}]; |
|
1085 </script> |
|
1086 </body> |
|
1087 </html> |