|
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: base PluginHost.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>base <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_base.html" title="base">base</a> |
|
22 |
|
23 > PluginHost.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"> * <p></span> |
|
52 <span class="c"> * An augmentable class, which provides the augmented class with the ability to host plugins.</span> |
|
53 <span class="c"> * It adds <a href="#method_plug">plug</a> and <a href="#method_unplug">unplug</a> methods to the augmented class, which can </span> |
|
54 <span class="c"> * be used to add or remove plugins from instances of the class.</span> |
|
55 <span class="c"> * </p></span> |
|
56 <span class="c"> *</span> |
|
57 <span class="c"> * <p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using</span> |
|
58 <span class="c"> * the "plugins" property. Supported values for the "plugins" property are those defined by the <a href="#method_plug">plug</a> method. </span> |
|
59 <span class="c"> * </span> |
|
60 <span class="c"> * For example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):</span> |
|
61 <span class="c"> * <xmp></span> |
|
62 <span class="c"> * var o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:"header"}}]});</span> |
|
63 <span class="c"> * </xmp></span> |
|
64 <span class="c"> * </p></span> |
|
65 <span class="c"> * <p></span> |
|
66 <span class="c"> * Plug.Host's protected <a href="#method_initPlugins">_initPlugins</a> and <a href="#method_destroyPlugins">_destroyPlugins</a> </span> |
|
67 <span class="c"> * methods should be invoked by the host class at the appropriate point in the host's lifecyle. This is done by default for </span> |
|
68 <span class="c"> * the Base class, so developers extending Base or Widget don't need to do anything to enable plugin support.</span> |
|
69 <span class="c"> * </p></span> |
|
70 <span class="c"> *</span> |
|
71 <span class="c"> * @class Plugin.Host</span> |
|
72 <span class="c"> */</span> |
|
73 |
|
74 <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> |
|
75 |
|
76 <span class="k">function</span> <span class="nx">PluginHost</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
77 <span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span> <span class="o">=</span> <span class="o">{};</span> |
|
78 <span class="o">}</span> |
|
79 |
|
80 <span class="nx">PluginHost</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span> |
|
81 |
|
82 <span class="c">/**</span> |
|
83 <span class="c"> * Adds a plugin to the host object. This will instantiate the </span> |
|
84 <span class="c"> * plugin and attach it to the configured namespace on the host object.</span> |
|
85 <span class="c"> *</span> |
|
86 <span class="c"> * @method plug</span> |
|
87 <span class="c"> * @chainable</span> |
|
88 <span class="c"> * @param p {Function | Object |Array} Accepts the plugin class, or an </span> |
|
89 <span class="c"> * object with a "fn" property specifying the plugin class and </span> |
|
90 <span class="c"> * a "cfg" property specifying the configuration for the Plugin.</span> |
|
91 <span class="c"> * <p></span> |
|
92 <span class="c"> * Additionally an Array can also be passed in, with the above function or </span> |
|
93 <span class="c"> * object values, allowing the user to add multiple plugins in a single call.</span> |
|
94 <span class="c"> * </p></span> |
|
95 <span class="c"> * @param config (Optional) If the first argument is the plugin class, the second argument</span> |
|
96 <span class="c"> * can be the configuration for the plugin.</span> |
|
97 <span class="c"> * @return {Base} A reference to the host object</span> |
|
98 <span class="c"> */</span> |
|
99 |
|
100 <span class="nx">plug</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">p</span><span class="o">,</span> <span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
101 <span class="k">if</span> <span class="o">(</span><span class="nx">p</span><span class="o">)</span> <span class="o">{</span> |
|
102 <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">p</span><span class="o">))</span> <span class="o">{</span> |
|
103 <span class="k">this</span><span class="o">.</span><span class="nx">_plug</span><span class="o">(</span><span class="nx">p</span><span class="o">,</span> <span class="nx">config</span><span class="o">);</span> |
|
104 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">p</span><span class="o">))</span> <span class="o">{</span> |
|
105 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">ln</span> <span class="o">=</span> <span class="nx">p</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">ln</span><span class="o">;</span> <span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
106 <span class="k">this</span><span class="o">.</span><span class="nx">plug</span><span class="o">(</span><span class="nx">p</span><span class="o">[</span><span class="nx">i</span><span class="o">]);</span> |
|
107 <span class="o">}</span> |
|
108 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
109 <span class="k">this</span><span class="o">.</span><span class="nx">_plug</span><span class="o">(</span><span class="nx">p</span><span class="o">.</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">p</span><span class="o">.</span><span class="nx">cfg</span><span class="o">);</span> |
|
110 <span class="o">}</span> |
|
111 <span class="o">}</span> |
|
112 <span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
113 <span class="o">},</span> |
|
114 |
|
115 <span class="c">/**</span> |
|
116 <span class="c"> * Removes a plugin from the host object. This will destroy the </span> |
|
117 <span class="c"> * plugin instance and delete the namepsace from the host object. </span> |
|
118 <span class="c"> *</span> |
|
119 <span class="c"> * @method unplug</span> |
|
120 <span class="c"> * @param {String | Function} plugin The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided,</span> |
|
121 <span class="c"> * all registered plugins are unplugged.</span> |
|
122 <span class="c"> * @return {Base} A reference to the host object</span> |
|
123 <span class="c"> * @chainable</span> |
|
124 <span class="c"> */</span> |
|
125 <span class="nx">unplug</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">plugin</span><span class="o">)</span> <span class="o">{</span> |
|
126 <span class="k">if</span> <span class="o">(</span><span class="nx">plugin</span><span class="o">)</span> <span class="o">{</span> |
|
127 <span class="k">this</span><span class="o">.</span><span class="nx">_unplug</span><span class="o">(</span><span class="nx">plugin</span><span class="o">);</span> |
|
128 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
129 <span class="k">var</span> <span class="nx">ns</span><span class="o">;</span> |
|
130 <span class="k">for</span> <span class="o">(</span><span class="nx">ns</span> <span class="k">in</span> <span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span><span class="o">)</span> <span class="o">{</span> |
|
131 <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">ns</span><span class="o">))</span> <span class="o">{</span> |
|
132 <span class="k">this</span><span class="o">.</span><span class="nx">_unplug</span><span class="o">(</span><span class="nx">ns</span><span class="o">);</span> |
|
133 <span class="o">}</span> |
|
134 <span class="o">}</span> |
|
135 <span class="o">}</span> |
|
136 <span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
137 <span class="o">},</span> |
|
138 |
|
139 <span class="c">/**</span> |
|
140 <span class="c"> * Determines if a plugin has plugged into this host.</span> |
|
141 <span class="c"> *</span> |
|
142 <span class="c"> * @method hasPlugin</span> |
|
143 <span class="c"> * @param {String} ns The plugin's namespace</span> |
|
144 <span class="c"> * @return {boolean} returns true, if the plugin has been plugged into this host, false otherwise.</span> |
|
145 <span class="c"> */</span> |
|
146 <span class="nx">hasPlugin</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">ns</span><span class="o">)</span> <span class="o">{</span> |
|
147 <span class="k">return</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">]</span> <span class="o">&&</span> <span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">]);</span> |
|
148 <span class="o">},</span> |
|
149 |
|
150 <span class="c">/**</span> |
|
151 <span class="c"> * Initializes static plugins registered on the host (using the</span> |
|
152 <span class="c"> * Base.plug static method) and any plugins passed to the </span> |
|
153 <span class="c"> * instance through the "plugins" configuration property.</span> |
|
154 <span class="c"> *</span> |
|
155 <span class="c"> * @method _initPlugins</span> |
|
156 <span class="c"> * @param {Config} config The configuration object with property name/value pairs.</span> |
|
157 <span class="c"> * @private</span> |
|
158 <span class="c"> */</span> |
|
159 <span class="nx">_initPlugins</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
160 |
|
161 <span class="c">// Class Configuration</span> |
|
162 <span class="c"></span> <span class="k">var</span> <span class="nx">classes</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_getClasses</span><span class="o">(),</span> |
|
163 <span class="nx">plug</span> <span class="o">=</span> <span class="o">[],</span> |
|
164 <span class="nx">unplug</span> <span class="o">=</span> <span class="o">{},</span> |
|
165 <span class="nx">constructor</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">classPlug</span><span class="o">,</span> <span class="nx">classUnplug</span><span class="o">,</span> <span class="nx">pluginClassName</span><span class="o">;</span> |
|
166 |
|
167 <span class="c">//TODO: Room for optimization. Can we apply statically/unplug in same pass?</span> |
|
168 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="o">=</span> <span class="nx">classes</span><span class="o">.</span><span class="nx">length</span> <span class="o">-</span> <span class="m">1</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">i</span><span class="o">--)</span> <span class="o">{</span> |
|
169 <span class="nx">constructor</span> <span class="o">=</span> <span class="nx">classes</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
170 |
|
171 <span class="nx">classUnplug</span> <span class="o">=</span> <span class="nx">constructor</span><span class="o">.</span><span class="nx">_UNPLUG</span><span class="o">;</span> |
|
172 <span class="k">if</span> <span class="o">(</span><span class="nx">classUnplug</span><span class="o">)</span> <span class="o">{</span> |
|
173 <span class="c">// subclasses over-write</span> |
|
174 <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">unplug</span><span class="o">,</span> <span class="nx">classUnplug</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
175 <span class="o">}</span> |
|
176 |
|
177 <span class="nx">classPlug</span> <span class="o">=</span> <span class="nx">constructor</span><span class="o">.</span><span class="nx">_PLUG</span><span class="o">;</span> |
|
178 <span class="k">if</span> <span class="o">(</span><span class="nx">classPlug</span><span class="o">)</span> <span class="o">{</span> |
|
179 <span class="c">// subclasses over-write</span> |
|
180 <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">plug</span><span class="o">,</span> <span class="nx">classPlug</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
181 <span class="o">}</span> |
|
182 <span class="o">}</span> |
|
183 |
|
184 <span class="k">for</span> <span class="o">(</span><span class="nx">pluginClassName</span> <span class="k">in</span> <span class="nx">plug</span><span class="o">)</span> <span class="o">{</span> |
|
185 <span class="k">if</span> <span class="o">(</span><span class="nx">plug</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">pluginClassName</span><span class="o">))</span> <span class="o">{</span> |
|
186 <span class="k">if</span> <span class="o">(!</span><span class="nx">unplug</span><span class="o">[</span><span class="nx">pluginClassName</span><span class="o">])</span> <span class="o">{</span> |
|
187 <span class="k">this</span><span class="o">.</span><span class="nx">plug</span><span class="o">(</span><span class="nx">plug</span><span class="o">[</span><span class="nx">pluginClassName</span><span class="o">]);</span> |
|
188 <span class="o">}</span> |
|
189 <span class="o">}</span> |
|
190 <span class="o">}</span> |
|
191 |
|
192 <span class="c">// User Configuration</span> |
|
193 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">config</span> <span class="o">&&</span> <span class="nx">config</span><span class="o">.</span><span class="nx">plugins</span><span class="o">)</span> <span class="o">{</span> |
|
194 <span class="k">this</span><span class="o">.</span><span class="nx">plug</span><span class="o">(</span><span class="nx">config</span><span class="o">.</span><span class="nx">plugins</span><span class="o">);</span> |
|
195 <span class="o">}</span> |
|
196 <span class="o">},</span> |
|
197 |
|
198 <span class="c">/**</span> |
|
199 <span class="c"> * Unplugs and destroys all plugins on the host</span> |
|
200 <span class="c"> * @method _destroyPlugins</span> |
|
201 <span class="c"> * @private</span> |
|
202 <span class="c"> */</span> |
|
203 <span class="nx">_destroyPlugins</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
204 <span class="k">this</span><span class="o">.</span><span class="nx">_unplug</span><span class="o">();</span> |
|
205 <span class="o">},</span> |
|
206 |
|
207 <span class="c">/**</span> |
|
208 <span class="c"> * Private method used to instantiate and attach plugins to the host</span> |
|
209 <span class="c"> *</span> |
|
210 <span class="c"> * @method _plug</span> |
|
211 <span class="c"> * @param {Function} PluginClass The plugin class to instantiate</span> |
|
212 <span class="c"> * @param {Object} config The configuration object for the plugin</span> |
|
213 <span class="c"> * @private</span> |
|
214 <span class="c"> */</span> |
|
215 <span class="nx">_plug</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">PluginClass</span><span class="o">,</span> <span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
216 <span class="k">if</span> <span class="o">(</span><span class="nx">PluginClass</span> <span class="o">&&</span> <span class="nx">PluginClass</span><span class="o">.</span><span class="nx">NS</span><span class="o">)</span> <span class="o">{</span> |
|
217 <span class="k">var</span> <span class="nx">ns</span> <span class="o">=</span> <span class="nx">PluginClass</span><span class="o">.</span><span class="nx">NS</span><span class="o">;</span> |
|
218 |
|
219 <span class="nx">config</span> <span class="o">=</span> <span class="nx">config</span> <span class="o">||</span> <span class="o">{};</span> |
|
220 <span class="nx">config</span><span class="o">.</span><span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">;</span> |
|
221 |
|
222 <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">hasPlugin</span><span class="o">(</span><span class="nx">ns</span><span class="o">))</span> <span class="o">{</span> |
|
223 <span class="c">// Update config</span> |
|
224 <span class="c"></span> <span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">].</span><span class="nx">setAttrs</span><span class="o">(</span><span class="nx">config</span><span class="o">);</span> |
|
225 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
226 <span class="c">// Create new instance</span> |
|
227 <span class="c"></span> <span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">]</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PluginClass</span><span class="o">(</span><span class="nx">config</span><span class="o">);</span> |
|
228 <span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">]</span> <span class="o">=</span> <span class="nx">PluginClass</span><span class="o">;</span> |
|
229 <span class="o">}</span> |
|
230 <span class="o">}</span> |
|
231 <span class="o">},</span> |
|
232 |
|
233 <span class="c">/**</span> |
|
234 <span class="c"> * Unplugs and destroys a plugin already instantiated with the host.</span> |
|
235 <span class="c"> *</span> |
|
236 <span class="c"> * @method _unplug</span> |
|
237 <span class="c"> * @private</span> |
|
238 <span class="c"> * @param {String | Function} plugin The namespace for the plugin, or a plugin class with the static NS property defined.</span> |
|
239 <span class="c"> */</span> |
|
240 <span class="nx">_unplug</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">plugin</span><span class="o">)</span> <span class="o">{</span> |
|
241 <span class="k">var</span> <span class="nx">ns</span> <span class="o">=</span> <span class="nx">plugin</span><span class="o">,</span> |
|
242 <span class="nx">plugins</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span><span class="o">;</span> |
|
243 |
|
244 <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">plugin</span><span class="o">))</span> <span class="o">{</span> |
|
245 <span class="nx">ns</span> <span class="o">=</span> <span class="nx">plugin</span><span class="o">.</span><span class="nx">NS</span><span class="o">;</span> |
|
246 <span class="k">if</span> <span class="o">(</span><span class="nx">ns</span> <span class="o">&&</span> <span class="o">(!</span><span class="nx">plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">]</span> <span class="o">||</span> <span class="nx">plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">]</span> <span class="o">!==</span> <span class="nx">plugin</span><span class="o">))</span> <span class="o">{</span> |
|
247 <span class="nx">ns</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
248 <span class="o">}</span> |
|
249 <span class="o">}</span> |
|
250 |
|
251 <span class="k">if</span> <span class="o">(</span><span class="nx">ns</span><span class="o">)</span> <span class="o">{</span> |
|
252 <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">])</span> <span class="o">{</span> |
|
253 <span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">].</span><span class="nx">destroy</span><span class="o">();</span> |
|
254 <span class="nx">delete</span> <span class="k">this</span><span class="o">[</span><span class="nx">ns</span><span class="o">];</span> |
|
255 <span class="o">}</span> |
|
256 <span class="k">if</span> <span class="o">(</span><span class="nx">plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">])</span> <span class="o">{</span> |
|
257 <span class="nx">delete</span> <span class="nx">plugins</span><span class="o">[</span><span class="nx">ns</span><span class="o">];</span> |
|
258 <span class="o">}</span> |
|
259 <span class="o">}</span> |
|
260 <span class="o">}</span> |
|
261 <span class="o">};</span> |
|
262 |
|
263 <span class="c">/**</span> |
|
264 <span class="c"> * Registers plugins to be instantiated at the class level (plugins </span> |
|
265 <span class="c"> * which should be plugged into every instance of the class by default).</span> |
|
266 <span class="c"> *</span> |
|
267 <span class="c"> * @method Plugin.Host.plug</span> |
|
268 <span class="c"> * @static</span> |
|
269 <span class="c"> *</span> |
|
270 <span class="c"> * @param {Function} hostClass The host class on which to register the plugins</span> |
|
271 <span class="c"> * @param {Function | Array} plugin Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)</span> |
|
272 <span class="c"> * @param {Object} config (Optional) If plugin is the plugin class, the configuration for the plugin</span> |
|
273 <span class="c"> */</span> |
|
274 <span class="nx">PluginHost</span><span class="o">.</span><span class="nx">plug</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">hostClass</span><span class="o">,</span> <span class="nx">plugin</span><span class="o">,</span> <span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
275 <span class="c">// Cannot plug into Base, since Plugins derive from Base [ will cause infinite recurrsion ]</span> |
|
276 <span class="c"></span> <span class="k">var</span> <span class="nx">p</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">name</span><span class="o">;</span> |
|
277 |
|
278 <span class="k">if</span> <span class="o">(</span><span class="nx">hostClass</span> <span class="o">!==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Base</span><span class="o">)</span> <span class="o">{</span> |
|
279 <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_PLUG</span> <span class="o">=</span> <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_PLUG</span> <span class="o">||</span> <span class="o">{};</span> |
|
280 |
|
281 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">plugin</span><span class="o">))</span> <span class="o">{</span> |
|
282 <span class="k">if</span> <span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
283 <span class="nx">plugin</span> <span class="o">=</span> <span class="o">{</span><span class="nx">fn</span><span class="o">:</span><span class="nx">plugin</span><span class="o">,</span> <span class="nx">cfg</span><span class="o">:</span><span class="nx">config</span><span class="o">};</span> |
|
284 <span class="o">}</span> |
|
285 <span class="nx">plugin</span> <span class="o">=</span> <span class="o">[</span><span class="nx">plugin</span><span class="o">];</span> |
|
286 <span class="o">}</span> |
|
287 |
|
288 <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">plugin</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> |
|
289 <span class="nx">p</span> <span class="o">=</span> <span class="nx">plugin</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
290 <span class="nx">name</span> <span class="o">=</span> <span class="nx">p</span><span class="o">.</span><span class="nx">NAME</span> <span class="o">||</span> <span class="nx">p</span><span class="o">.</span><span class="nx">fn</span><span class="o">.</span><span class="nx">NAME</span><span class="o">;</span> |
|
291 <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_PLUG</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="nx">p</span><span class="o">;</span> |
|
292 <span class="o">}</span> |
|
293 <span class="o">}</span> |
|
294 <span class="o">};</span> |
|
295 |
|
296 <span class="c">/**</span> |
|
297 <span class="c"> * Unregisters any class level plugins which have been registered by the host class, or any</span> |
|
298 <span class="c"> * other class in the hierarchy.</span> |
|
299 <span class="c"> *</span> |
|
300 <span class="c"> * @method Plugin.Host.unplug</span> |
|
301 <span class="c"> * @static</span> |
|
302 <span class="c"> *</span> |
|
303 <span class="c"> * @param {Function} hostClass The host class from which to unregister the plugins</span> |
|
304 <span class="c"> * @param {Function | Array} plugin The plugin class, or an array of plugin classes</span> |
|
305 <span class="c"> */</span> |
|
306 <span class="nx">PluginHost</span><span class="o">.</span><span class="nx">unplug</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">hostClass</span><span class="o">,</span> <span class="nx">plugin</span><span class="o">)</span> <span class="o">{</span> |
|
307 <span class="k">var</span> <span class="nx">p</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">name</span><span class="o">;</span> |
|
308 |
|
309 <span class="k">if</span> <span class="o">(</span><span class="nx">hostClass</span> <span class="o">!==</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Base</span><span class="o">)</span> <span class="o">{</span> |
|
310 <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_UNPLUG</span> <span class="o">=</span> <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_UNPLUG</span> <span class="o">||</span> <span class="o">{};</span> |
|
311 |
|
312 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">plugin</span><span class="o">))</span> <span class="o">{</span> |
|
313 <span class="nx">plugin</span> <span class="o">=</span> <span class="o">[</span><span class="nx">plugin</span><span class="o">];</span> |
|
314 <span class="o">}</span> |
|
315 |
|
316 <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">plugin</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> |
|
317 <span class="nx">p</span> <span class="o">=</span> <span class="nx">plugin</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
318 <span class="nx">name</span> <span class="o">=</span> <span class="nx">p</span><span class="o">.</span><span class="nx">NAME</span><span class="o">;</span> |
|
319 <span class="k">if</span> <span class="o">(!</span><span class="nx">hostClass</span><span class="o">.</span><span class="nx">_PLUG</span><span class="o">[</span><span class="nx">name</span><span class="o">])</span> <span class="o">{</span> |
|
320 <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_UNPLUG</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="nx">p</span><span class="o">;</span> |
|
321 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
322 <span class="nx">delete</span> <span class="nx">hostClass</span><span class="o">.</span><span class="nx">_PLUG</span><span class="o">[</span><span class="nx">name</span><span class="o">];</span> |
|
323 <span class="o">}</span> |
|
324 <span class="o">}</span> |
|
325 <span class="o">}</span> |
|
326 <span class="o">};</span> |
|
327 |
|
328 <span class="nx">Y</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">"Plugin"</span><span class="o">).</span><span class="nx">Host</span> <span class="o">=</span> <span class="nx">PluginHost</span><span class="o">;</span> |
|
329 </pre></div> |
|
330 </div> |
|
331 </div> |
|
332 </div> |
|
333 <div class="yui-b"> |
|
334 <div class="nav"> |
|
335 |
|
336 <div id="moduleList" class="module"> |
|
337 <h4>Modules</h4> |
|
338 <ul class="content"> |
|
339 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
340 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
341 <li class="selected"><a href="module_base.html" title="base">base</a></li> |
|
342 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
343 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
344 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
345 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
346 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
347 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
348 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
349 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
350 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
351 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
352 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
353 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
354 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
355 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
356 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
357 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
358 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
359 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
360 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
361 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
362 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
363 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
364 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
365 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
366 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
367 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
368 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
369 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
370 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
371 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
372 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
373 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
374 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
375 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
376 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
377 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
378 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
379 </ul> |
|
380 </div> |
|
381 |
|
382 <div id="classList" class="module"> |
|
383 <h4>Classes</h4> |
|
384 <ul class="content"> |
|
385 <li class=""><a href="Base.html" title="Base">Base</a></li> |
|
386 <li class=""><a href="Plugin.Host.html" title="Plugin.Host">Plugin.Host</a></li> |
|
387 </ul> |
|
388 </div> |
|
389 |
|
390 <div id="fileList" class="module"> |
|
391 <h4>Files</h4> |
|
392 <ul class="content"> |
|
393 <li class=""><a href="Base.js.html" title="Base.js">Base.js</a></li> |
|
394 <li class=""><a href="BaseBuild.js.html" title="BaseBuild.js">BaseBuild.js</a></li> |
|
395 <li class="selected"><a href="PluginHost.js.html" title="PluginHost.js">PluginHost.js</a></li> |
|
396 </ul> |
|
397 </div> |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 </div> |
|
404 </div> |
|
405 </div> |
|
406 <div id="ft"> |
|
407 <hr /> |
|
408 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
409 </div> |
|
410 </div> |
|
411 <script type="text/javascript"> |
|
412 ALL_YUI_PROPS = [{"access": "private", "host": "Base", "name": "_aggregateAttrs", "url": "Base.html#method__aggregateAttrs", "type": "method"}, {"access": "private", "host": "Base", "name": "Base._ATTR_CFG", "url": "Base.html#property_Base._ATTR_CFG", "type": "property"}, {"access": "", "host": "Base", "name": "Base.ATTRS", "url": "Base.html#property_Base.ATTRS", "type": "property"}, {"access": "", "host": "Base", "name": "Base.build", "url": "Base.html#method_Base.build", "type": "method"}, {"access": "private", "host": "Base", "name": "Base._buildCfg", "url": "Base.html#property_Base._buildCfg", "type": "property"}, {"access": "", "host": "Base", "name": "Base.NAME", "url": "Base.html#property_Base.NAME", "type": "property"}, {"access": "", "host": "Base", "name": "Base.plug", "url": "Base.html#method_Base.plug", "type": "method"}, {"access": "", "host": "Base", "name": "Base.unplug", "url": "Base.html#method_Base.unplug", "type": "method"}, {"access": "protected", "host": "Base", "name": "_defDestroyFn", "url": "Base.html#method__defDestroyFn", "type": "method"}, {"access": "protected", "host": "Base", "name": "_defInitFn", "url": "Base.html#method__defInitFn", "type": "method"}, {"access": "", "host": "Base", "name": "destroy", "url": "Base.html#method_destroy", "type": "method"}, {"access": "", "host": "Base", "name": "destroy", "url": "Base.html#event_destroy", "type": "event"}, {"access": "", "host": "Base", "name": "destroyed", "url": "Base.html#config_destroyed", "type": "config"}, {"access": "", "host": "Base", "name": "destroyedChange", "url": "Base.html#event_destroyedChange", "type": "event"}, {"access": "private", "host": "Base", "name": "_destroyHierarchy", "url": "Base.html#method__destroyHierarchy", "type": "method"}, {"access": "private", "host": "Plugin.Host", "name": "_destroyPlugins", "url": "Plugin.Host.html#method__destroyPlugins", "type": "method"}, {"access": "private", "host": "Base", "name": "_filterAttrCfs", "url": "Base.html#method__filterAttrCfs", "type": "method"}, {"access": "protected", "host": "Base", "name": "_getAttrCfgs", "url": "Base.html#method__getAttrCfgs", "type": "method"}, {"access": "protected", "host": "Base", "name": "_getClasses", "url": "Base.html#method__getClasses", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "hasPlugin", "url": "Plugin.Host.html#method_hasPlugin", "type": "method"}, {"access": "", "host": "Base", "name": "init", "url": "Base.html#method_init", "type": "method"}, {"access": "", "host": "Base", "name": "init", "url": "Base.html#event_init", "type": "event"}, {"access": "private", "host": "Base", "name": "_initHierarchy", "url": "Base.html#method__initHierarchy", "type": "method"}, {"access": "private", "host": "Base", "name": "_initHierarchyData", "url": "Base.html#method__initHierarchyData", "type": "method"}, {"access": "", "host": "Base", "name": "initialized", "url": "Base.html#config_initialized", "type": "config"}, {"access": "", "host": "Base", "name": "initializedChange", "url": "Base.html#event_initializedChange", "type": "event"}, {"access": "private", "host": "Plugin.Host", "name": "_initPlugins", "url": "Plugin.Host.html#method__initPlugins", "type": "method"}, {"access": "", "host": "Base", "name": "name", "url": "Base.html#property_name", "type": "property"}, {"access": "private", "host": "Plugin.Host", "name": "_plug", "url": "Plugin.Host.html#method__plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "plug", "url": "Plugin.Host.html#method_plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "Plugin.Host.plug", "url": "Plugin.Host.html#method_Plugin.Host.plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "Plugin.Host.unplug", "url": "Plugin.Host.html#method_Plugin.Host.unplug", "type": "method"}, {"access": "", "host": "Base", "name": "toString", "url": "Base.html#method_toString", "type": "method"}, {"access": "private", "host": "Plugin.Host", "name": "_unplug", "url": "Plugin.Host.html#method__unplug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "unplug", "url": "Plugin.Host.html#method_unplug", "type": "method"}]; |
|
413 </script> |
|
414 </body> |
|
415 </html> |