|
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: oop oop.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>oop <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_oop.html" title="oop">oop</a> |
|
22 |
|
23 > oop.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"> * Supplies object inheritance and manipulation utilities. This adds</span> |
|
52 <span class="c"> * additional functionaity to what is provided in yui-base, and the</span> |
|
53 <span class="c"> * methods are applied directly to the YUI instance. This module</span> |
|
54 <span class="c"> * is required for most YUI components.</span> |
|
55 <span class="c"> * @module oop</span> |
|
56 <span class="c"> */</span> |
|
57 |
|
58 <span class="k">var</span> <span class="nx">L</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> |
|
59 <span class="nx">A</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">,</span> |
|
60 <span class="nx">OP</span> <span class="o">=</span> <span class="nb">Object</span><span class="o">.</span><span class="nx">prototype</span><span class="o">;</span> |
|
61 |
|
62 <span class="c">/**</span> |
|
63 <span class="c"> * The following methods are added to the YUI instance</span> |
|
64 <span class="c"> * @class YUI~oop</span> |
|
65 <span class="c"> */</span> |
|
66 |
|
67 <span class="c">/**</span> |
|
68 <span class="c"> * Applies prototype properties from the supplier to the receiver.</span> |
|
69 <span class="c"> * The receiver can be a constructor or an instance.</span> |
|
70 <span class="c"> * @method augment</span> |
|
71 <span class="c"> * @param {Function} r the object to receive the augmentation</span> |
|
72 <span class="c"> * @param {Function} s the object that supplies the properties to augment</span> |
|
73 <span class="c"> * @param ov {boolean} if true, properties already on the receiver</span> |
|
74 <span class="c"> * will be overwritten if found on the supplier.</span> |
|
75 <span class="c"> * @param wl {string[]} a whitelist. If supplied, only properties in </span> |
|
76 <span class="c"> * this list will be applied to the receiver.</span> |
|
77 <span class="c"> * @param args {Array | Any} arg or arguments to apply to the supplier</span> |
|
78 <span class="c"> * constructor when initializing.</span> |
|
79 <span class="c"> * @return {object} the augmented object</span> |
|
80 <span class="c"> *</span> |
|
81 <span class="c"> * @todo constructor optional?</span> |
|
82 <span class="c"> * @todo understanding what an instance is augmented with</span> |
|
83 <span class="c"> * @TODO best practices for overriding sequestered methods.</span> |
|
84 <span class="c"> */</span> |
|
85 <span class="nx">Y</span><span class="o">.</span><span class="nx">augment</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">r</span><span class="o">,</span> <span class="nx">s</span><span class="o">,</span> <span class="nx">ov</span><span class="o">,</span> <span class="nx">wl</span><span class="o">,</span> <span class="nx">args</span><span class="o">)</span> <span class="o">{</span> |
|
86 <span class="k">var</span> <span class="nx">sProto</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">prototype</span><span class="o">,</span> |
|
87 <span class="nx">newProto</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span> |
|
88 <span class="nx">construct</span> <span class="o">=</span> <span class="nx">s</span><span class="o">,</span> |
|
89 <span class="nx">a</span> <span class="o">=</span> <span class="o">(</span><span class="nx">args</span><span class="o">)</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">args</span><span class="o">)</span> <span class="o">:</span> <span class="o">[],</span> |
|
90 <span class="nx">rProto</span> <span class="o">=</span> <span class="nx">r</span><span class="o">.</span><span class="nx">prototype</span><span class="o">,</span> |
|
91 <span class="nx">target</span> <span class="o">=</span> <span class="nx">rProto</span> <span class="o">||</span> <span class="nx">r</span><span class="o">,</span> |
|
92 <span class="nx">applyConstructor</span> <span class="o">=</span> <span class="kc">false</span><span class="o">,</span> |
|
93 <span class="nx">sequestered</span><span class="o">,</span> <span class="nx">replacements</span><span class="o">,</span> <span class="nx">i</span><span class="o">;</span> |
|
94 |
|
95 <span class="c">// working on a class, so apply constructor infrastructure</span> |
|
96 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">rProto</span> <span class="o">&&</span> <span class="nx">construct</span><span class="o">)</span> <span class="o">{</span> |
|
97 <span class="nx">sequestered</span> <span class="o">=</span> <span class="o">{};</span> |
|
98 <span class="nx">replacements</span> <span class="o">=</span> <span class="o">{};</span> |
|
99 <span class="nx">newProto</span> <span class="o">=</span> <span class="o">{};</span> |
|
100 |
|
101 <span class="c">// sequester all of the functions in the supplier and replace with</span> |
|
102 <span class="c"></span> <span class="c">// one that will restore all of them.</span> |
|
103 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">sProto</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nx">k</span><span class="o">)</span> <span class="o">{</span> |
|
104 <span class="nx">replacements</span><span class="o">[</span><span class="nx">k</span><span class="o">]</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
105 |
|
106 <span class="c">// Y.log('sequestered function "' + k + '" executed. Initializing EventTarget');</span> |
|
107 <span class="c">// overwrite the prototype with all of the sequestered functions,</span> |
|
108 <span class="c">// but only if it hasn't been overridden</span> |
|
109 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="k">in</span> <span class="nx">sequestered</span><span class="o">)</span> <span class="o">{</span> |
|
110 <span class="k">if</span> <span class="o">(</span><span class="nx">sequestered</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">i</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">i</span><span class="o">]</span> <span class="o">===</span> <span class="nx">replacements</span><span class="o">[</span><span class="nx">i</span><span class="o">]))</span> <span class="o">{</span> |
|
111 <span class="c">// Y.log('... restoring ' + k);</span> |
|
112 <span class="c"></span> <span class="k">this</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">=</span> <span class="nx">sequestered</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
113 <span class="o">}</span> |
|
114 <span class="o">}</span> |
|
115 |
|
116 <span class="c">// apply the constructor</span> |
|
117 <span class="c"></span> <span class="nx">construct</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
118 |
|
119 <span class="c">// apply the original sequestered function</span> |
|
120 <span class="c"></span> <span class="k">return</span> <span class="nx">sequestered</span><span class="o">[</span><span class="nx">k</span><span class="o">].</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">arguments</span><span class="o">);</span> |
|
121 <span class="o">};</span> |
|
122 |
|
123 <span class="k">if</span> <span class="o">((!</span><span class="nx">wl</span> <span class="o">||</span> <span class="o">(</span><span class="nx">k</span> <span class="k">in</span> <span class="nx">wl</span><span class="o">))</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">ov</span> <span class="o">||</span> <span class="o">!(</span><span class="nx">k</span> <span class="k">in</span> <span class="k">this</span><span class="o">)))</span> <span class="o">{</span> |
|
124 <span class="c">// Y.log('augment: ' + k);</span> |
|
125 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">v</span><span class="o">))</span> <span class="o">{</span> |
|
126 <span class="c">// sequester the function</span> |
|
127 <span class="c"></span> <span class="nx">sequestered</span><span class="o">[</span><span class="nx">k</span><span class="o">]</span> <span class="o">=</span> <span class="nx">v</span><span class="o">;</span> |
|
128 |
|
129 <span class="c">// replace the sequestered function with a function that will</span> |
|
130 <span class="c">// restore all sequestered functions and exectue the constructor.</span> |
|
131 <span class="c"></span> <span class="k">this</span><span class="o">[</span><span class="nx">k</span><span class="o">]</span> <span class="o">=</span> <span class="nx">replacements</span><span class="o">[</span><span class="nx">k</span><span class="o">];</span> |
|
132 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
133 <span class="c">// Y.log('augment() applying non-function: ' + k);</span> |
|
134 <span class="c"></span> <span class="k">this</span><span class="o">[</span><span class="nx">k</span><span class="o">]</span> <span class="o">=</span> <span class="nx">v</span><span class="o">;</span> |
|
135 <span class="o">}</span> |
|
136 |
|
137 <span class="o">}</span> |
|
138 |
|
139 <span class="o">},</span> <span class="nx">newProto</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
140 |
|
141 <span class="c">// augmenting an instance, so apply the constructor immediately</span> |
|
142 <span class="c"></span> <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
143 <span class="nx">applyConstructor</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
144 <span class="o">}</span> |
|
145 |
|
146 <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">target</span><span class="o">,</span> <span class="nx">newProto</span> <span class="o">||</span> <span class="nx">sProto</span><span class="o">,</span> <span class="nx">ov</span><span class="o">,</span> <span class="nx">wl</span><span class="o">);</span> |
|
147 |
|
148 <span class="k">if</span> <span class="o">(</span><span class="nx">applyConstructor</span><span class="o">)</span> <span class="o">{</span> |
|
149 <span class="nx">s</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">target</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
150 <span class="o">}</span> |
|
151 |
|
152 <span class="k">return</span> <span class="nx">r</span><span class="o">;</span> |
|
153 <span class="o">};</span> |
|
154 |
|
155 <span class="c">/**</span> |
|
156 <span class="c"> * Applies object properties from the supplier to the receiver. If</span> |
|
157 <span class="c"> * the target has the property, and the property is an object, the target</span> |
|
158 <span class="c"> * object will be augmented with the supplier's value. If the property</span> |
|
159 <span class="c"> * is an array, the suppliers value will be appended to the target.</span> |
|
160 <span class="c"> * @method aggregate</span> |
|
161 <span class="c"> * @param {Function} r the object to receive the augmentation</span> |
|
162 <span class="c"> * @param {Function} s the object that supplies the properties to augment</span> |
|
163 <span class="c"> * @param ov {boolean} if true, properties already on the receiver</span> |
|
164 <span class="c"> * will be overwritten if found on the supplier.</span> |
|
165 <span class="c"> * @param wl {string[]} a whitelist. If supplied, only properties in </span> |
|
166 <span class="c"> * this list will be applied to the receiver.</span> |
|
167 <span class="c"> * @return {object} the extended object</span> |
|
168 <span class="c"> */</span> |
|
169 <span class="nx">Y</span><span class="o">.</span><span class="nx">aggregate</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">r</span><span class="o">,</span> <span class="nx">s</span><span class="o">,</span> <span class="nx">ov</span><span class="o">,</span> <span class="nx">wl</span><span class="o">)</span> <span class="o">{</span> |
|
170 <span class="k">return</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">r</span><span class="o">,</span> <span class="nx">s</span><span class="o">,</span> <span class="nx">ov</span><span class="o">,</span> <span class="nx">wl</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
171 <span class="o">};</span> |
|
172 |
|
173 <span class="c">/**</span> |
|
174 <span class="c"> * Utility to set up the prototype, constructor and superclass properties to</span> |
|
175 <span class="c"> * support an inheritance strategy that can chain constructors and methods.</span> |
|
176 <span class="c"> * Static members will not be inherited.</span> |
|
177 <span class="c"> *</span> |
|
178 <span class="c"> * @method extend</span> |
|
179 <span class="c"> * @param {Function} r the object to modify</span> |
|
180 <span class="c"> * @param {Function} s the object to inherit</span> |
|
181 <span class="c"> * @param {Object} px prototype properties to add/override</span> |
|
182 <span class="c"> * @param {Object} sx static properties to add/override</span> |
|
183 <span class="c"> * @return {YUI} the YUI instance</span> |
|
184 <span class="c"> */</span> |
|
185 <span class="nx">Y</span><span class="o">.</span><span class="nx">extend</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">r</span><span class="o">,</span> <span class="nx">s</span><span class="o">,</span> <span class="nx">px</span><span class="o">,</span> <span class="nx">sx</span><span class="o">)</span> <span class="o">{</span> |
|
186 <span class="k">if</span> <span class="o">(!</span><span class="nx">s</span><span class="o">||!</span><span class="nx">r</span><span class="o">)</span> <span class="o">{</span> |
|
187 <span class="c">// @TODO error symbols</span> |
|
188 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">error</span><span class="o">(</span><span class="s2">"extend failed, verify dependencies"</span><span class="o">);</span> |
|
189 <span class="o">}</span> |
|
190 |
|
191 <span class="k">var</span> <span class="nx">sp</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">prototype</span><span class="o">,</span> <span class="nx">rp</span><span class="o">=</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">(</span><span class="nx">sp</span><span class="o">);</span> |
|
192 <span class="nx">r</span><span class="o">.</span><span class="nx">prototype</span><span class="o">=</span><span class="nx">rp</span><span class="o">;</span> |
|
193 |
|
194 <span class="nx">rp</span><span class="o">.</span><span class="nx">constructor</span><span class="o">=</span><span class="nx">r</span><span class="o">;</span> |
|
195 <span class="nx">r</span><span class="o">.</span><span class="nx">superclass</span><span class="o">=</span><span class="nx">sp</span><span class="o">;</span> |
|
196 |
|
197 <span class="c">// assign constructor property</span> |
|
198 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">s</span> <span class="o">!=</span> <span class="nb">Object</span> <span class="o">&&</span> <span class="nx">sp</span><span class="o">.</span><span class="nx">constructor</span> <span class="o">==</span> <span class="nx">OP</span><span class="o">.</span><span class="nx">constructor</span><span class="o">)</span> <span class="o">{</span> |
|
199 <span class="nx">sp</span><span class="o">.</span><span class="nx">constructor</span><span class="o">=</span><span class="nx">s</span><span class="o">;</span> |
|
200 <span class="o">}</span> |
|
201 |
|
202 <span class="c">// add prototype overrides</span> |
|
203 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">px</span><span class="o">)</span> <span class="o">{</span> |
|
204 <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">rp</span><span class="o">,</span> <span class="nx">px</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
205 <span class="o">}</span> |
|
206 |
|
207 <span class="c">// add object overrides</span> |
|
208 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">sx</span><span class="o">)</span> <span class="o">{</span> |
|
209 <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">r</span><span class="o">,</span> <span class="nx">sx</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
210 <span class="o">}</span> |
|
211 |
|
212 <span class="k">return</span> <span class="nx">r</span><span class="o">;</span> |
|
213 <span class="o">};</span> |
|
214 |
|
215 <span class="c">/**</span> |
|
216 <span class="c"> * Executes the supplied function for each item in</span> |
|
217 <span class="c"> * a collection. Supports arrays, objects, and</span> |
|
218 <span class="c"> * Y.NodeLists</span> |
|
219 <span class="c"> * @method each</span> |
|
220 <span class="c"> * @param o the object to iterate</span> |
|
221 <span class="c"> * @param f the function to execute. This function</span> |
|
222 <span class="c"> * receives the value, key, and object as parameters</span> |
|
223 <span class="c"> * @param proto if true, prototype properties are</span> |
|
224 <span class="c"> * iterated on objects</span> |
|
225 <span class="c"> * @return {YUI} the YUI instance</span> |
|
226 <span class="c"> */</span> |
|
227 <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">,</span> <span class="nx">proto</span><span class="o">)</span> <span class="o">{</span> |
|
228 |
|
229 <span class="k">if</span> <span class="o">(</span><span class="nx">o</span><span class="o">.</span><span class="nx">each</span> <span class="o">&&</span> <span class="nx">o</span><span class="o">.</span><span class="nx">item</span><span class="o">)</span> <span class="o">{</span> |
|
230 <span class="k">return</span> <span class="nx">o</span><span class="o">.</span><span class="nx">each</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">);</span> |
|
231 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
232 <span class="nx">switch</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">test</span><span class="o">(</span><span class="nx">o</span><span class="o">))</span> <span class="o">{</span> |
|
233 <span class="nx">case</span> <span class="m">1</span><span class="o">:</span> |
|
234 <span class="k">return</span> <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">);</span> |
|
235 <span class="nx">case</span> <span class="m">2</span><span class="o">:</span> |
|
236 <span class="k">return</span> <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">),</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">);</span> |
|
237 <span class="nx">default</span><span class="o">:</span> |
|
238 <span class="k">return</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">,</span> <span class="nx">proto</span><span class="o">);</span> |
|
239 <span class="o">}</span> |
|
240 <span class="o">}</span> |
|
241 |
|
242 <span class="c">// return Y.Object.each(o, f, c);</span> |
|
243 <span class="c"></span> <span class="o">};</span> |
|
244 |
|
245 <span class="c">/**</span> |
|
246 <span class="c"> * Deep obj/array copy. Functions will are cloned with Y.bind.</span> |
|
247 <span class="c"> * Array-like objects are treated as arrays.</span> |
|
248 <span class="c"> * primitives are returned untouched. Optionally a</span> |
|
249 <span class="c"> * function can be provided to handle other data types,</span> |
|
250 <span class="c"> * filter keys, validate values, etc.</span> |
|
251 <span class="c"> *</span> |
|
252 <span class="c"> * @method clone</span> |
|
253 <span class="c"> * @param o what to clone</span> |
|
254 <span class="c"> * @param safe {boolean} if true, objects will not have prototype</span> |
|
255 <span class="c"> * items from the source. If false, it does. In this case, the</span> |
|
256 <span class="c"> * original is initally protected, but the clone is not completely immune</span> |
|
257 <span class="c"> * from changes to the source object prototype. Also, cloned prototype</span> |
|
258 <span class="c"> * items that are deleted from the clone will result in the value</span> |
|
259 <span class="c"> * of the source prototype to be exposed. If operating on a non-safe</span> |
|
260 <span class="c"> * clone, items should be nulled out rather than deleted.</span> |
|
261 <span class="c"> * @TODO review</span> |
|
262 <span class="c"> * @param f optional function to apply to each item in a collection</span> |
|
263 <span class="c"> * it will be executed prior to applying the value to</span> |
|
264 <span class="c"> * the new object. Return false to prevent the copy.</span> |
|
265 <span class="c"> * @param c optional execution context for f</span> |
|
266 <span class="c"> * @param owner Owner object passed when clone is iterating an</span> |
|
267 <span class="c"> * object. Used to set up context for cloned functions.</span> |
|
268 <span class="c"> * @return {Array|Object} the cloned object</span> |
|
269 <span class="c"> */</span> |
|
270 <span class="nx">Y</span><span class="o">.</span><span class="nx">clone</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">safe</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">,</span> <span class="nx">owner</span><span class="o">)</span> <span class="o">{</span> |
|
271 |
|
272 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">o</span><span class="o">))</span> <span class="o">{</span> |
|
273 <span class="k">return</span> <span class="nx">o</span><span class="o">;</span> |
|
274 <span class="o">}</span> |
|
275 |
|
276 <span class="k">var</span> <span class="nx">o2</span><span class="o">;</span> |
|
277 |
|
278 <span class="nx">switch</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">type</span><span class="o">(</span><span class="nx">o</span><span class="o">))</span> <span class="o">{</span> |
|
279 <span class="nx">case</span> <span class="s1">'date'</span><span class="o">:</span> |
|
280 <span class="k">return</span> <span class="k">new</span> <span class="nb">Date</span><span class="o">(</span><span class="nx">o</span><span class="o">);</span> |
|
281 <span class="nx">case</span> <span class="s1">'regexp'</span><span class="o">:</span> |
|
282 <span class="k">return</span> <span class="k">new</span> <span class="nb">RegExp</span><span class="o">(</span><span class="nx">o</span><span class="o">.</span><span class="nx">source</span><span class="o">);</span> |
|
283 <span class="nx">case</span> <span class="s1">'function'</span><span class="o">:</span> |
|
284 <span class="nx">o2</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">owner</span><span class="o">);</span> |
|
285 <span class="k">break</span><span class="o">;</span> |
|
286 <span class="nx">case</span> <span class="s1">'array'</span><span class="o">:</span> |
|
287 <span class="nx">o2</span> <span class="o">=</span> <span class="o">[];</span> |
|
288 <span class="k">break</span><span class="o">;</span> |
|
289 <span class="nx">default</span><span class="o">:</span> |
|
290 <span class="nx">o2</span> <span class="o">=</span> <span class="o">(</span><span class="nx">safe</span><span class="o">)</span> <span class="o">?</span> <span class="o">{}</span> <span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">(</span><span class="nx">o</span><span class="o">);</span> |
|
291 <span class="o">}</span> |
|
292 |
|
293 <span class="nx">Y</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nx">k</span><span class="o">)</span> <span class="o">{</span> |
|
294 <span class="k">if</span> <span class="o">(!</span><span class="nx">f</span> <span class="o">||</span> <span class="o">(</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">c</span> <span class="o">||</span> <span class="k">this</span><span class="o">,</span> <span class="nx">v</span><span class="o">,</span> <span class="nx">k</span><span class="o">,</span> <span class="k">this</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">!==</span> <span class="kc">false</span><span class="o">))</span> <span class="o">{</span> |
|
295 <span class="k">this</span><span class="o">[</span><span class="nx">k</span><span class="o">]</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">v</span><span class="o">,</span> <span class="nx">safe</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">,</span> <span class="k">this</span><span class="o">);</span> |
|
296 <span class="o">}</span> |
|
297 <span class="o">},</span> <span class="nx">o2</span><span class="o">);</span> |
|
298 |
|
299 <span class="k">return</span> <span class="nx">o2</span><span class="o">;</span> |
|
300 <span class="o">};</span> |
|
301 |
|
302 |
|
303 <span class="c">/**</span> |
|
304 <span class="c"> * Returns a function that will execute the supplied function in the</span> |
|
305 <span class="c"> * supplied object's context, optionally adding any additional</span> |
|
306 <span class="c"> * supplied parameters to the beginning of the arguments collection the </span> |
|
307 <span class="c"> * supplied to the function.</span> |
|
308 <span class="c"> *</span> |
|
309 <span class="c"> * @method bind</span> |
|
310 <span class="c"> * @param f {Function|String} the function to bind, or a function name</span> |
|
311 <span class="c"> * to execute on the context object</span> |
|
312 <span class="c"> * @param c the execution context</span> |
|
313 <span class="c"> * @param args* 0..n arguments to include before the arguments the </span> |
|
314 <span class="c"> * function is executed with.</span> |
|
315 <span class="c"> * @return {function} the wrapped function</span> |
|
316 <span class="c"> */</span> |
|
317 <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
318 <span class="k">var</span> <span class="nx">xargs</span> <span class="o">=</span> <span class="nx">arguments</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">2</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">2</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
319 <span class="k">return</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
320 <span class="k">var</span> <span class="nx">fn</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">f</span><span class="o">)</span> <span class="o">?</span> <span class="nx">c</span><span class="o">[</span><span class="nx">f</span><span class="o">]</span> <span class="o">:</span> <span class="nx">f</span><span class="o">,</span> |
|
321 <span class="nx">args</span> <span class="o">=</span> <span class="o">(</span><span class="nx">xargs</span><span class="o">)</span> <span class="o">?</span> <span class="nx">xargs</span><span class="o">.</span><span class="nx">concat</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">))</span> <span class="o">:</span> <span class="nx">arguments</span><span class="o">;</span> |
|
322 <span class="k">return</span> <span class="nx">fn</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">c</span> <span class="o">||</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span> |
|
323 <span class="o">};</span> |
|
324 <span class="o">};</span> |
|
325 |
|
326 <span class="c">/**</span> |
|
327 <span class="c"> * Returns a function that will execute the supplied function in the</span> |
|
328 <span class="c"> * supplied object's context, optionally adding any additional</span> |
|
329 <span class="c"> * supplied parameters to the end of the arguments the function</span> |
|
330 <span class="c"> * is executed with.</span> |
|
331 <span class="c"> *</span> |
|
332 <span class="c"> * @method rbind</span> |
|
333 <span class="c"> * @param f {Function|String} the function to bind, or a function name</span> |
|
334 <span class="c"> * to execute on the context object</span> |
|
335 <span class="c"> * @param c the execution context</span> |
|
336 <span class="c"> * @param args* 0..n arguments to append to the end of arguments collection</span> |
|
337 <span class="c"> * supplied to the function</span> |
|
338 <span class="c"> * @return {function} the wrapped function</span> |
|
339 <span class="c"> */</span> |
|
340 <span class="nx">Y</span><span class="o">.</span><span class="nx">rbind</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">f</span><span class="o">,</span> <span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
341 <span class="k">var</span> <span class="nx">xargs</span> <span class="o">=</span> <span class="nx">arguments</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">2</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">2</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
342 <span class="k">return</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
343 <span class="k">var</span> <span class="nx">fn</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">f</span><span class="o">)</span> <span class="o">?</span> <span class="nx">c</span><span class="o">[</span><span class="nx">f</span><span class="o">]</span> <span class="o">:</span> <span class="nx">f</span><span class="o">,</span> |
|
344 <span class="nx">args</span> <span class="o">=</span> <span class="o">(</span><span class="nx">xargs</span><span class="o">)</span> <span class="o">?</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span> <span class="m">0</span><span class="o">,</span> <span class="kc">true</span><span class="o">).</span><span class="nx">concat</span><span class="o">(</span><span class="nx">xargs</span><span class="o">)</span> <span class="o">:</span> <span class="nx">arguments</span><span class="o">;</span> |
|
345 <span class="k">return</span> <span class="nx">fn</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">c</span> <span class="o">||</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">args</span><span class="o">);</span> |
|
346 <span class="o">};</span> |
|
347 <span class="o">};</span> |
|
348 </pre></div> |
|
349 </div> |
|
350 </div> |
|
351 </div> |
|
352 <div class="yui-b"> |
|
353 <div class="nav"> |
|
354 |
|
355 <div id="moduleList" class="module"> |
|
356 <h4>Modules</h4> |
|
357 <ul class="content"> |
|
358 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
359 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
360 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
361 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
362 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
363 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
364 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
365 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
366 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
367 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
368 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
369 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
370 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
371 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
372 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
373 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
374 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
375 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
376 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
377 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
378 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
379 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
380 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
381 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
382 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
383 <li class="selected"><a href="module_oop.html" title="oop">oop</a></li> |
|
384 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
385 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
386 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
387 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
388 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
389 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
390 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
391 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
392 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
393 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
394 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
395 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
396 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
397 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
398 </ul> |
|
399 </div> |
|
400 |
|
401 <div id="classList" class="module"> |
|
402 <h4>Classes</h4> |
|
403 <ul class="content"> |
|
404 <li class=""><a href="YUI~oop.html" title="YUI~oop">YUI~oop</a></li> |
|
405 </ul> |
|
406 </div> |
|
407 |
|
408 <div id="fileList" class="module"> |
|
409 <h4>Files</h4> |
|
410 <ul class="content"> |
|
411 <li class="selected"><a href="oop.js.html" title="oop.js">oop.js</a></li> |
|
412 </ul> |
|
413 </div> |
|
414 |
|
415 |
|
416 |
|
417 |
|
418 |
|
419 </div> |
|
420 </div> |
|
421 </div> |
|
422 <div id="ft"> |
|
423 <hr /> |
|
424 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
425 </div> |
|
426 </div> |
|
427 <script type="text/javascript"> |
|
428 ALL_YUI_PROPS = [{"access": "", "host": "YUI~oop", "name": "aggregate", "url": "YUI~oop.html#method_aggregate", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "augment", "url": "YUI~oop.html#method_augment", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "bind", "url": "YUI~oop.html#method_bind", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "clone", "url": "YUI~oop.html#method_clone", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "each", "url": "YUI~oop.html#method_each", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "extend", "url": "YUI~oop.html#method_extend", "type": "method"}, {"access": "", "host": "YUI~oop", "name": "rbind", "url": "YUI~oop.html#method_rbind", "type": "method"}]; |
|
429 </script> |
|
430 </body> |
|
431 </html> |