|
0
|
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 Plugin.Host (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 |
> Plugin.Host |
|
|
23 |
|
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<h2> |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
Class <b property="yui:name">Plugin.Host</b> |
|
|
52 |
<span class="extends"> |
|
|
53 |
</span> |
|
|
54 |
|
|
|
55 |
</h2> |
|
|
56 |
<!-- class tree goes here --> |
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="summary description" property="yui:description"> |
|
|
62 |
<p> |
|
|
63 |
An augmentable class, which provides the augmented class with the ability to host plugins. |
|
|
64 |
It adds <a href="#method_plug">plug</a> and <a href="#method_unplug">unplug</a> methods to the augmented class, which can |
|
|
65 |
be used to add or remove plugins from instances of the class. |
|
|
66 |
</p> |
|
|
67 |
<p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using |
|
|
68 |
the "plugins" property. Supported values for the "plugins" property are those defined by the <a href="#method_plug">plug</a> method. |
|
|
69 |
For example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host): |
|
|
70 |
<xmp> |
|
|
71 |
var o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:"header"}}]}); |
|
|
72 |
</xmp> |
|
|
73 |
</p> |
|
|
74 |
<p> |
|
|
75 |
Plug.Host's protected <a href="#method_initPlugins">_initPlugins</a> and <a href="#method_destroyPlugins">_destroyPlugins</a> |
|
|
76 |
methods should be invoked by the host class at the appropriate point in the host's lifecyle. This is done by default for |
|
|
77 |
the Base class, so developers extending Base or Widget don't need to do anything to enable plugin support. |
|
|
78 |
</p> |
|
|
79 |
</div> |
|
|
80 |
|
|
|
81 |
|
|
|
82 |
<div rel="yui:properties" resource="#properties"> |
|
|
83 |
|
|
|
84 |
</div> |
|
|
85 |
|
|
|
86 |
<div rel="yui:methods" resource="#methods"> |
|
|
87 |
<div class="section method details"> |
|
|
88 |
<h3 id="methods">Methods</h3> |
|
|
89 |
<div class="content"> |
|
|
90 |
<div class="private" rel="yui:method" resource="#method__destroyPlugins"> |
|
|
91 |
<h4> |
|
|
92 |
<a name="method__destroyPlugins">_destroyPlugins</a></h4> |
|
|
93 |
<div class="detail" > |
|
|
94 |
<code> |
|
|
95 |
private |
|
|
96 |
|
|
|
97 |
|
|
|
98 |
void |
|
|
99 |
<strong property="yui:name">_destroyPlugins</strong> |
|
|
100 |
( |
|
|
101 |
) |
|
|
102 |
</code> |
|
|
103 |
|
|
|
104 |
<div class="description" property="yui:description"> |
|
|
105 |
Unplugs and destroys all plugins on the host |
|
|
106 |
</div> |
|
|
107 |
|
|
|
108 |
<div class="description"> |
|
|
109 |
|
|
|
110 |
|
|
|
111 |
<dl> |
|
|
112 |
<dt>Returns: |
|
|
113 |
<code property="yui:return"> |
|
|
114 |
void |
|
|
115 |
</code></dt> |
|
|
116 |
<dd property="yui:returnInfo"></dd> |
|
|
117 |
</dl> |
|
|
118 |
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
</div> |
|
|
123 |
|
|
|
124 |
</div> |
|
|
125 |
<hr /> |
|
|
126 |
</div> |
|
|
127 |
<div class="private" rel="yui:method" resource="#method__initPlugins"> |
|
|
128 |
<h4> |
|
|
129 |
<a name="method__initPlugins">_initPlugins</a></h4> |
|
|
130 |
<div class="detail" > |
|
|
131 |
<code> |
|
|
132 |
private |
|
|
133 |
|
|
|
134 |
|
|
|
135 |
void |
|
|
136 |
<strong property="yui:name">_initPlugins</strong> |
|
|
137 |
( |
|
|
138 |
|
|
|
139 |
|
|
|
140 |
config |
|
|
141 |
|
|
|
142 |
|
|
|
143 |
) |
|
|
144 |
</code> |
|
|
145 |
|
|
|
146 |
<div class="description" property="yui:description"> |
|
|
147 |
Initializes static plugins registered on the host (using the |
|
|
148 |
Base.plug static method) and any plugins passed to the |
|
|
149 |
instance through the "plugins" configuration property. |
|
|
150 |
</div> |
|
|
151 |
|
|
|
152 |
<div class="description"> |
|
|
153 |
|
|
|
154 |
<dl rel="yui:parameters"> |
|
|
155 |
<dt>Parameters:</dt> |
|
|
156 |
<dd rel="yui:parameter"> |
|
|
157 |
<code><span property="yui:name">config</span> |
|
|
158 |
<<span property="yui:type">Config</span>> |
|
|
159 |
</code> |
|
|
160 |
<span property="yui:description"> The configuration object with property name/value pairs.</span> |
|
|
161 |
</dd> |
|
|
162 |
</dl> |
|
|
163 |
|
|
|
164 |
<dl> |
|
|
165 |
<dt>Returns: |
|
|
166 |
<code property="yui:return"> |
|
|
167 |
void |
|
|
168 |
</code></dt> |
|
|
169 |
<dd property="yui:returnInfo"></dd> |
|
|
170 |
</dl> |
|
|
171 |
|
|
|
172 |
|
|
|
173 |
|
|
|
174 |
|
|
|
175 |
</div> |
|
|
176 |
|
|
|
177 |
</div> |
|
|
178 |
<hr /> |
|
|
179 |
</div> |
|
|
180 |
<div class="private" rel="yui:method" resource="#method__plug"> |
|
|
181 |
<h4> |
|
|
182 |
<a name="method__plug">_plug</a></h4> |
|
|
183 |
<div class="detail" > |
|
|
184 |
<code> |
|
|
185 |
private |
|
|
186 |
|
|
|
187 |
|
|
|
188 |
void |
|
|
189 |
<strong property="yui:name">_plug</strong> |
|
|
190 |
( |
|
|
191 |
|
|
|
192 |
|
|
|
193 |
PluginClass |
|
|
194 |
|
|
|
195 |
|
|
|
196 |
, |
|
|
197 |
config |
|
|
198 |
|
|
|
199 |
|
|
|
200 |
) |
|
|
201 |
</code> |
|
|
202 |
|
|
|
203 |
<div class="description" property="yui:description"> |
|
|
204 |
Private method used to instantiate and attach plugins to the host |
|
|
205 |
</div> |
|
|
206 |
|
|
|
207 |
<div class="description"> |
|
|
208 |
|
|
|
209 |
<dl rel="yui:parameters"> |
|
|
210 |
<dt>Parameters:</dt> |
|
|
211 |
<dd rel="yui:parameter"> |
|
|
212 |
<code><span property="yui:name">PluginClass</span> |
|
|
213 |
<<span property="yui:type">Function</span>> |
|
|
214 |
</code> |
|
|
215 |
<span property="yui:description"> The plugin class to instantiate</span> |
|
|
216 |
</dd> |
|
|
217 |
<dd rel="yui:parameter"> |
|
|
218 |
<code><span property="yui:name">config</span> |
|
|
219 |
<<span property="yui:type">Object</span>> |
|
|
220 |
</code> |
|
|
221 |
<span property="yui:description"> The configuration object for the plugin</span> |
|
|
222 |
</dd> |
|
|
223 |
</dl> |
|
|
224 |
|
|
|
225 |
<dl> |
|
|
226 |
<dt>Returns: |
|
|
227 |
<code property="yui:return"> |
|
|
228 |
void |
|
|
229 |
</code></dt> |
|
|
230 |
<dd property="yui:returnInfo"></dd> |
|
|
231 |
</dl> |
|
|
232 |
|
|
|
233 |
|
|
|
234 |
|
|
|
235 |
|
|
|
236 |
</div> |
|
|
237 |
|
|
|
238 |
</div> |
|
|
239 |
<hr /> |
|
|
240 |
</div> |
|
|
241 |
<div class="private" rel="yui:method" resource="#method__unplug"> |
|
|
242 |
<h4> |
|
|
243 |
<a name="method__unplug">_unplug</a></h4> |
|
|
244 |
<div class="detail" > |
|
|
245 |
<code> |
|
|
246 |
private |
|
|
247 |
|
|
|
248 |
|
|
|
249 |
void |
|
|
250 |
<strong property="yui:name">_unplug</strong> |
|
|
251 |
( |
|
|
252 |
|
|
|
253 |
|
|
|
254 |
plugin |
|
|
255 |
|
|
|
256 |
|
|
|
257 |
) |
|
|
258 |
</code> |
|
|
259 |
|
|
|
260 |
<div class="description" property="yui:description"> |
|
|
261 |
Unplugs and destroys a plugin already instantiated with the host. |
|
|
262 |
</div> |
|
|
263 |
|
|
|
264 |
<div class="description"> |
|
|
265 |
|
|
|
266 |
<dl rel="yui:parameters"> |
|
|
267 |
<dt>Parameters:</dt> |
|
|
268 |
<dd rel="yui:parameter"> |
|
|
269 |
<code><span property="yui:name">plugin</span> |
|
|
270 |
<<span property="yui:type">String | Function</span>> |
|
|
271 |
</code> |
|
|
272 |
<span property="yui:description"> The namespace for the plugin, or a plugin class with the static NS property defined.</span> |
|
|
273 |
</dd> |
|
|
274 |
</dl> |
|
|
275 |
|
|
|
276 |
<dl> |
|
|
277 |
<dt>Returns: |
|
|
278 |
<code property="yui:return"> |
|
|
279 |
void |
|
|
280 |
</code></dt> |
|
|
281 |
<dd property="yui:returnInfo"></dd> |
|
|
282 |
</dl> |
|
|
283 |
|
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
</div> |
|
|
288 |
|
|
|
289 |
</div> |
|
|
290 |
<hr /> |
|
|
291 |
</div> |
|
|
292 |
<div class="" rel="yui:method" resource="#method_hasPlugin"> |
|
|
293 |
<h4> |
|
|
294 |
<a name="method_hasPlugin">hasPlugin</a></h4> |
|
|
295 |
<div class="detail" > |
|
|
296 |
<code> |
|
|
297 |
|
|
|
298 |
|
|
|
299 |
|
|
|
300 |
boolean |
|
|
301 |
<strong property="yui:name">hasPlugin</strong> |
|
|
302 |
( |
|
|
303 |
|
|
|
304 |
|
|
|
305 |
ns |
|
|
306 |
|
|
|
307 |
|
|
|
308 |
) |
|
|
309 |
</code> |
|
|
310 |
|
|
|
311 |
<div class="description" property="yui:description"> |
|
|
312 |
Determines if a plugin has plugged into this host. |
|
|
313 |
</div> |
|
|
314 |
|
|
|
315 |
<div class="description"> |
|
|
316 |
|
|
|
317 |
<dl rel="yui:parameters"> |
|
|
318 |
<dt>Parameters:</dt> |
|
|
319 |
<dd rel="yui:parameter"> |
|
|
320 |
<code><span property="yui:name">ns</span> |
|
|
321 |
<<span property="yui:type">String</span>> |
|
|
322 |
</code> |
|
|
323 |
<span property="yui:description"> The plugin's namespace</span> |
|
|
324 |
</dd> |
|
|
325 |
</dl> |
|
|
326 |
|
|
|
327 |
<dl> |
|
|
328 |
<dt>Returns: |
|
|
329 |
<code property="yui:return"> |
|
|
330 |
boolean |
|
|
331 |
</code></dt> |
|
|
332 |
<dd property="yui:returnInfo">returns true, if the plugin has been plugged into this host, false otherwise.</dd> |
|
|
333 |
</dl> |
|
|
334 |
|
|
|
335 |
|
|
|
336 |
|
|
|
337 |
|
|
|
338 |
</div> |
|
|
339 |
|
|
|
340 |
</div> |
|
|
341 |
<hr /> |
|
|
342 |
</div> |
|
|
343 |
<div class="" rel="yui:method" resource="#method_plug"> |
|
|
344 |
<h4> |
|
|
345 |
<a name="method_plug">plug</a></h4> |
|
|
346 |
<div class="detail" > |
|
|
347 |
<code> |
|
|
348 |
|
|
|
349 |
|
|
|
350 |
|
|
|
351 |
Base |
|
|
352 |
<strong property="yui:name">plug</strong> |
|
|
353 |
( |
|
|
354 |
|
|
|
355 |
|
|
|
356 |
p |
|
|
357 |
|
|
|
358 |
|
|
|
359 |
, |
|
|
360 |
config |
|
|
361 |
|
|
|
362 |
|
|
|
363 |
) |
|
|
364 |
</code> |
|
|
365 |
|
|
|
366 |
<div class="description" property="yui:description"> |
|
|
367 |
Adds a plugin to the host object. This will instantiate the |
|
|
368 |
plugin and attach it to the configured namespace on the host object. |
|
|
369 |
</div> |
|
|
370 |
|
|
|
371 |
<div class="description"> |
|
|
372 |
|
|
|
373 |
<dl rel="yui:parameters"> |
|
|
374 |
<dt>Parameters:</dt> |
|
|
375 |
<dd rel="yui:parameter"> |
|
|
376 |
<code><span property="yui:name">p</span> |
|
|
377 |
<<span property="yui:type">Function | Object |Array</span>> |
|
|
378 |
</code> |
|
|
379 |
<span property="yui:description"> Accepts the plugin class, or an |
|
|
380 |
object with a "fn" property specifying the plugin class and |
|
|
381 |
a "cfg" property specifying the configuration for the Plugin. |
|
|
382 |
<p> |
|
|
383 |
Additionally an Array can also be passed in, with the above function or |
|
|
384 |
object values, allowing the user to add multiple plugins in a single call. |
|
|
385 |
</p></span> |
|
|
386 |
</dd> |
|
|
387 |
<dd rel="yui:parameter"> |
|
|
388 |
<code><span property="yui:name">config</span> |
|
|
389 |
<<span property="yui:type">object</span>> |
|
|
390 |
</code> |
|
|
391 |
<span property="yui:description"> (Optional) If the first argument is the plugin class, the second argument |
|
|
392 |
can be the configuration for the plugin.</span> |
|
|
393 |
</dd> |
|
|
394 |
</dl> |
|
|
395 |
|
|
|
396 |
<dl> |
|
|
397 |
<dt>Returns: |
|
|
398 |
<code property="yui:return"> |
|
|
399 |
Base |
|
|
400 |
</code></dt> |
|
|
401 |
<dd property="yui:returnInfo">A reference to the host object</dd> |
|
|
402 |
</dl> |
|
|
403 |
|
|
|
404 |
<div class="chainable"> |
|
|
405 |
<strong>Chainable:</strong> This method is chainable. |
|
|
406 |
</div> |
|
|
407 |
|
|
|
408 |
|
|
|
409 |
|
|
|
410 |
</div> |
|
|
411 |
|
|
|
412 |
</div> |
|
|
413 |
<hr /> |
|
|
414 |
</div> |
|
|
415 |
<div class="" rel="yui:method" resource="#method_Plugin.Host.plug"> |
|
|
416 |
<h4> |
|
|
417 |
<a name="method_Plugin.Host.plug">Plugin.Host.plug</a></h4> |
|
|
418 |
<div class="detail" > |
|
|
419 |
<code> |
|
|
420 |
|
|
|
421 |
static |
|
|
422 |
|
|
|
423 |
void |
|
|
424 |
<strong property="yui:name">Plugin.Host.plug</strong> |
|
|
425 |
( |
|
|
426 |
|
|
|
427 |
|
|
|
428 |
hostClass |
|
|
429 |
|
|
|
430 |
|
|
|
431 |
, |
|
|
432 |
plugin |
|
|
433 |
|
|
|
434 |
|
|
|
435 |
, |
|
|
436 |
config |
|
|
437 |
|
|
|
438 |
|
|
|
439 |
) |
|
|
440 |
</code> |
|
|
441 |
|
|
|
442 |
<div class="description" property="yui:description"> |
|
|
443 |
Registers plugins to be instantiated at the class level (plugins |
|
|
444 |
which should be plugged into every instance of the class by default). |
|
|
445 |
</div> |
|
|
446 |
|
|
|
447 |
<div class="description"> |
|
|
448 |
|
|
|
449 |
<dl rel="yui:parameters"> |
|
|
450 |
<dt>Parameters:</dt> |
|
|
451 |
<dd rel="yui:parameter"> |
|
|
452 |
<code><span property="yui:name">hostClass</span> |
|
|
453 |
<<span property="yui:type">Function</span>> |
|
|
454 |
</code> |
|
|
455 |
<span property="yui:description"> The host class on which to register the plugins</span> |
|
|
456 |
</dd> |
|
|
457 |
<dd rel="yui:parameter"> |
|
|
458 |
<code><span property="yui:name">plugin</span> |
|
|
459 |
<<span property="yui:type">Function | Array</span>> |
|
|
460 |
</code> |
|
|
461 |
<span property="yui:description"> Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)</span> |
|
|
462 |
</dd> |
|
|
463 |
<dd rel="yui:parameter"> |
|
|
464 |
<code><span property="yui:name">config</span> |
|
|
465 |
<<span property="yui:type">Object</span>> |
|
|
466 |
</code> |
|
|
467 |
<span property="yui:description"> (Optional) If plugin is the plugin class, the configuration for the plugin</span> |
|
|
468 |
</dd> |
|
|
469 |
</dl> |
|
|
470 |
|
|
|
471 |
<dl> |
|
|
472 |
<dt>Returns: |
|
|
473 |
<code property="yui:return"> |
|
|
474 |
void |
|
|
475 |
</code></dt> |
|
|
476 |
<dd property="yui:returnInfo"></dd> |
|
|
477 |
</dl> |
|
|
478 |
|
|
|
479 |
|
|
|
480 |
|
|
|
481 |
|
|
|
482 |
</div> |
|
|
483 |
|
|
|
484 |
</div> |
|
|
485 |
<hr /> |
|
|
486 |
</div> |
|
|
487 |
<div class="" rel="yui:method" resource="#method_Plugin.Host.unplug"> |
|
|
488 |
<h4> |
|
|
489 |
<a name="method_Plugin.Host.unplug">Plugin.Host.unplug</a></h4> |
|
|
490 |
<div class="detail" > |
|
|
491 |
<code> |
|
|
492 |
|
|
|
493 |
static |
|
|
494 |
|
|
|
495 |
void |
|
|
496 |
<strong property="yui:name">Plugin.Host.unplug</strong> |
|
|
497 |
( |
|
|
498 |
|
|
|
499 |
|
|
|
500 |
hostClass |
|
|
501 |
|
|
|
502 |
|
|
|
503 |
, |
|
|
504 |
plugin |
|
|
505 |
|
|
|
506 |
|
|
|
507 |
) |
|
|
508 |
</code> |
|
|
509 |
|
|
|
510 |
<div class="description" property="yui:description"> |
|
|
511 |
Unregisters any class level plugins which have been registered by the host class, or any |
|
|
512 |
other class in the hierarchy. |
|
|
513 |
</div> |
|
|
514 |
|
|
|
515 |
<div class="description"> |
|
|
516 |
|
|
|
517 |
<dl rel="yui:parameters"> |
|
|
518 |
<dt>Parameters:</dt> |
|
|
519 |
<dd rel="yui:parameter"> |
|
|
520 |
<code><span property="yui:name">hostClass</span> |
|
|
521 |
<<span property="yui:type">Function</span>> |
|
|
522 |
</code> |
|
|
523 |
<span property="yui:description"> The host class from which to unregister the plugins</span> |
|
|
524 |
</dd> |
|
|
525 |
<dd rel="yui:parameter"> |
|
|
526 |
<code><span property="yui:name">plugin</span> |
|
|
527 |
<<span property="yui:type">Function | Array</span>> |
|
|
528 |
</code> |
|
|
529 |
<span property="yui:description"> The plugin class, or an array of plugin classes</span> |
|
|
530 |
</dd> |
|
|
531 |
</dl> |
|
|
532 |
|
|
|
533 |
<dl> |
|
|
534 |
<dt>Returns: |
|
|
535 |
<code property="yui:return"> |
|
|
536 |
void |
|
|
537 |
</code></dt> |
|
|
538 |
<dd property="yui:returnInfo"></dd> |
|
|
539 |
</dl> |
|
|
540 |
|
|
|
541 |
|
|
|
542 |
|
|
|
543 |
|
|
|
544 |
</div> |
|
|
545 |
|
|
|
546 |
</div> |
|
|
547 |
<hr /> |
|
|
548 |
</div> |
|
|
549 |
<div class="" rel="yui:method" resource="#method_unplug"> |
|
|
550 |
<h4> |
|
|
551 |
<a name="method_unplug">unplug</a></h4> |
|
|
552 |
<div class="detail" > |
|
|
553 |
<code> |
|
|
554 |
|
|
|
555 |
|
|
|
556 |
|
|
|
557 |
Base |
|
|
558 |
<strong property="yui:name">unplug</strong> |
|
|
559 |
( |
|
|
560 |
|
|
|
561 |
|
|
|
562 |
plugin |
|
|
563 |
|
|
|
564 |
|
|
|
565 |
) |
|
|
566 |
</code> |
|
|
567 |
|
|
|
568 |
<div class="description" property="yui:description"> |
|
|
569 |
Removes a plugin from the host object. This will destroy the |
|
|
570 |
plugin instance and delete the namepsace from the host object. |
|
|
571 |
</div> |
|
|
572 |
|
|
|
573 |
<div class="description"> |
|
|
574 |
|
|
|
575 |
<dl rel="yui:parameters"> |
|
|
576 |
<dt>Parameters:</dt> |
|
|
577 |
<dd rel="yui:parameter"> |
|
|
578 |
<code><span property="yui:name">plugin</span> |
|
|
579 |
<<span property="yui:type">String | Function</span>> |
|
|
580 |
</code> |
|
|
581 |
<span property="yui:description"> The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided, |
|
|
582 |
all registered plugins are unplugged.</span> |
|
|
583 |
</dd> |
|
|
584 |
</dl> |
|
|
585 |
|
|
|
586 |
<dl> |
|
|
587 |
<dt>Returns: |
|
|
588 |
<code property="yui:return"> |
|
|
589 |
Base |
|
|
590 |
</code></dt> |
|
|
591 |
<dd property="yui:returnInfo">A reference to the host object</dd> |
|
|
592 |
</dl> |
|
|
593 |
|
|
|
594 |
<div class="chainable"> |
|
|
595 |
<strong>Chainable:</strong> This method is chainable. |
|
|
596 |
</div> |
|
|
597 |
|
|
|
598 |
|
|
|
599 |
|
|
|
600 |
</div> |
|
|
601 |
|
|
|
602 |
</div> |
|
|
603 |
<hr /> |
|
|
604 |
</div> |
|
|
605 |
</div> |
|
|
606 |
</div> |
|
|
607 |
|
|
|
608 |
</div> |
|
|
609 |
|
|
|
610 |
<div rel="yui:events" resource="#events"> |
|
|
611 |
|
|
|
612 |
|
|
|
613 |
</div> |
|
|
614 |
|
|
|
615 |
<div rel="yui:attributes" resource="#configattributes"> |
|
|
616 |
|
|
|
617 |
</div> |
|
|
618 |
|
|
|
619 |
</div> |
|
|
620 |
</div> |
|
|
621 |
<div class="yui-b"> |
|
|
622 |
<div class="nav"> |
|
|
623 |
|
|
|
624 |
<div id="moduleList" class="module"> |
|
|
625 |
<h4>Modules</h4> |
|
|
626 |
<ul class="content"> |
|
|
627 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
628 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
629 |
<li class="selected"><a href="module_base.html" title="base">base</a></li> |
|
|
630 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
631 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
632 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
633 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
634 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
635 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
636 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
637 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
638 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
639 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
640 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
641 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
642 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
643 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
644 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
645 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
646 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
647 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
648 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
649 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
650 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
651 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
652 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
653 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
654 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
655 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
656 |
<li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
|
657 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
658 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
659 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
660 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
661 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
662 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
663 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
664 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
665 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
666 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
667 |
</ul> |
|
|
668 |
</div> |
|
|
669 |
|
|
|
670 |
<div id="classList" class="module"> |
|
|
671 |
<h4>Classes</h4> |
|
|
672 |
<ul class="content"> |
|
|
673 |
<li class=""><a href="Base.html" title="Base">Base</a></li> |
|
|
674 |
<li class="selected"><a href="Plugin.Host.html" title="Plugin.Host">Plugin.Host</a></li> |
|
|
675 |
</ul> |
|
|
676 |
</div> |
|
|
677 |
|
|
|
678 |
<div id="fileList" class="module"> |
|
|
679 |
<h4>Files</h4> |
|
|
680 |
<ul class="content"> |
|
|
681 |
<li class=""><a href="Base.js.html" title="Base.js">Base.js</a></li> |
|
|
682 |
<li class=""><a href="BaseBuild.js.html" title="BaseBuild.js">BaseBuild.js</a></li> |
|
|
683 |
<li class=""><a href="PluginHost.js.html" title="PluginHost.js">PluginHost.js</a></li> |
|
|
684 |
</ul> |
|
|
685 |
</div> |
|
|
686 |
|
|
|
687 |
|
|
|
688 |
<div id="methodsList" class="module"> |
|
|
689 |
<h4>Methods</h4> |
|
|
690 |
<ul class="content"> |
|
|
691 |
<li class="private"><a href="#method__destroyPlugins" title="_destroyPlugins">_destroyPlugins</a></li> |
|
|
692 |
<li class="private"><a href="#method__initPlugins" title="_initPlugins">_initPlugins</a></li> |
|
|
693 |
<li class="private"><a href="#method__plug" title="_plug">_plug</a></li> |
|
|
694 |
<li class="private"><a href="#method__unplug" title="_unplug">_unplug</a></li> |
|
|
695 |
<li class=""><a href="#method_hasPlugin" title="hasPlugin">hasPlugin</a></li> |
|
|
696 |
<li class=""><a href="#method_plug" title="plug">plug</a></li> |
|
|
697 |
<li class=""><a href="#method_Plugin.Host.plug" title="Plugin.Host.plug">Plugin.Host.plug</a></li> |
|
|
698 |
<li class=""><a href="#method_Plugin.Host.unplug" title="Plugin.Host.unplug">Plugin.Host.unplug</a></li> |
|
|
699 |
<li class=""><a href="#method_unplug" title="unplug">unplug</a></li> |
|
|
700 |
</ul> |
|
|
701 |
</div> |
|
|
702 |
|
|
|
703 |
|
|
|
704 |
|
|
|
705 |
</div> |
|
|
706 |
</div> |
|
|
707 |
</div> |
|
|
708 |
<div id="ft"> |
|
|
709 |
<hr /> |
|
|
710 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
711 |
</div> |
|
|
712 |
</div> |
|
|
713 |
<script type="text/javascript"> |
|
|
714 |
ALL_YUI_PROPS = [{"access": "private", "host": "Plugin.Host", "name": "_destroyPlugins", "url": "Plugin.Host.html#method__destroyPlugins", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "hasPlugin", "url": "Plugin.Host.html#method_hasPlugin", "type": "method"}, {"access": "private", "host": "Plugin.Host", "name": "_initPlugins", "url": "Plugin.Host.html#method__initPlugins", "type": "method"}, {"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": "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"}]; |
|
|
715 |
</script> |
|
|
716 |
</body> |
|
|
717 |
</html> |