<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: base PluginHost.js (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>base <span class="subtitle">3.0.0b1</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_base.html" title="base">base</a>
> PluginHost.js (source view)
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight" ><pre> <span class="c">/**</span>
<span class="c"> * <p></span>
<span class="c"> * An augmentable class, which provides the augmented class with the ability to host plugins.</span>
<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>
<span class="c"> * be used to add or remove plugins from instances of the class.</span>
<span class="c"> * </p></span>
<span class="c"> *</span>
<span class="c"> * <p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using</span>
<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>
<span class="c"> * </span>
<span class="c"> * For example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):</span>
<span class="c"> * <xmp></span>
<span class="c"> * var o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:"header"}}]});</span>
<span class="c"> * </xmp></span>
<span class="c"> * </p></span>
<span class="c"> * <p></span>
<span class="c"> * Plug.Host's protected <a href="#method_initPlugins">_initPlugins</a> and <a href="#method_destroyPlugins">_destroyPlugins</a> </span>
<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>
<span class="c"> * the Base class, so developers extending Base or Widget don't need to do anything to enable plugin support.</span>
<span class="c"> * </p></span>
<span class="c"> *</span>
<span class="c"> * @class Plugin.Host</span>
<span class="c"> */</span>
<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>
<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>
<span class="k">this</span><span class="o">.</span><span class="nx">_plugins</span> <span class="o">=</span> <span class="o">{};</span>
<span class="o">}</span>
<span class="nx">PluginHost</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Adds a plugin to the host object. This will instantiate the </span>
<span class="c"> * plugin and attach it to the configured namespace on the host object.</span>
<span class="c"> *</span>
<span class="c"> * @method plug</span>
<span class="c"> * @chainable</span>
<span class="c"> * @param p {Function | Object |Array} Accepts the plugin class, or an </span>
<span class="c"> * object with a "fn" property specifying the plugin class and </span>
<span class="c"> * a "cfg" property specifying the configuration for the Plugin.</span>
<span class="c"> * <p></span>
<span class="c"> * Additionally an Array can also be passed in, with the above function or </span>
<span class="c"> * object values, allowing the user to add multiple plugins in a single call.</span>
<span class="c"> * </p></span>
<span class="c"> * @param config (Optional) If the first argument is the plugin class, the second argument</span>
<span class="c"> * can be the configuration for the plugin.</span>
<span class="c"> * @return {Base} A reference to the host object</span>
<span class="c"> */</span>
<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>
<span class="k">if</span> <span class="o">(</span><span class="nx">p</span><span class="o">)</span> <span class="o">{</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">p</span><span class="o">))</span> <span class="o">{</span>
<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>
<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>
<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>
<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>
<span class="o">}</span>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<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>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">return</span> <span class="k">this</span><span class="o">;</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Removes a plugin from the host object. This will destroy the </span>
<span class="c"> * plugin instance and delete the namepsace from the host object. </span>
<span class="c"> *</span>
<span class="c"> * @method unplug</span>
<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>
<span class="c"> * all registered plugins are unplugged.</span>
<span class="c"> * @return {Base} A reference to the host object</span>
<span class="c"> * @chainable</span>
<span class="c"> */</span>
<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>
<span class="k">if</span> <span class="o">(</span><span class="nx">plugin</span><span class="o">)</span> <span class="o">{</span>
<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>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">ns</span><span class="o">;</span>
<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>
<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>
<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>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">return</span> <span class="k">this</span><span class="o">;</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Determines if a plugin has plugged into this host.</span>
<span class="c"> *</span>
<span class="c"> * @method hasPlugin</span>
<span class="c"> * @param {String} ns The plugin's namespace</span>
<span class="c"> * @return {boolean} returns true, if the plugin has been plugged into this host, false otherwise.</span>
<span class="c"> */</span>
<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>
<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>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Initializes static plugins registered on the host (using the</span>
<span class="c"> * Base.plug static method) and any plugins passed to the </span>
<span class="c"> * instance through the "plugins" configuration property.</span>
<span class="c"> *</span>
<span class="c"> * @method _initPlugins</span>
<span class="c"> * @param {Config} config The configuration object with property name/value pairs.</span>
<span class="c"> * @private</span>
<span class="c"> */</span>
<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>
<span class="c">// Class Configuration</span>
<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>
<span class="nx">plug</span> <span class="o">=</span> <span class="o">[],</span>
<span class="nx">unplug</span> <span class="o">=</span> <span class="o">{},</span>
<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>
<span class="c">//TODO: Room for optimization. Can we apply statically/unplug in same pass?</span>
<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>
<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>
<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>
<span class="k">if</span> <span class="o">(</span><span class="nx">classUnplug</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// subclasses over-write</span>
<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>
<span class="o">}</span>
<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>
<span class="k">if</span> <span class="o">(</span><span class="nx">classPlug</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// subclasses over-write</span>
<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>
<span class="o">}</span>
<span class="o">}</span>
<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>
<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>
<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>
<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>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="c">// User Configuration</span>
<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>
<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>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Unplugs and destroys all plugins on the host</span>
<span class="c"> * @method _destroyPlugins</span>
<span class="c"> * @private</span>
<span class="c"> */</span>
<span class="nx">_destroyPlugins</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_unplug</span><span class="o">();</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Private method used to instantiate and attach plugins to the host</span>
<span class="c"> *</span>
<span class="c"> * @method _plug</span>
<span class="c"> * @param {Function} PluginClass The plugin class to instantiate</span>
<span class="c"> * @param {Object} config The configuration object for the plugin</span>
<span class="c"> * @private</span>
<span class="c"> */</span>
<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>
<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>
<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>
<span class="nx">config</span> <span class="o">=</span> <span class="nx">config</span> <span class="o">||</span> <span class="o">{};</span>
<span class="nx">config</span><span class="o">.</span><span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">;</span>
<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>
<span class="c">// Update config</span>
<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>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="c">// Create new instance</span>
<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>
<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>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Unplugs and destroys a plugin already instantiated with the host.</span>
<span class="c"> *</span>
<span class="c"> * @method _unplug</span>
<span class="c"> * @private</span>
<span class="c"> * @param {String | Function} plugin The namespace for the plugin, or a plugin class with the static NS property defined.</span>
<span class="c"> */</span>
<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>
<span class="k">var</span> <span class="nx">ns</span> <span class="o">=</span> <span class="nx">plugin</span><span class="o">,</span>
<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>
<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>
<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>
<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>
<span class="nx">ns</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">ns</span><span class="o">)</span> <span class="o">{</span>
<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>
<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>
<span class="nx">delete</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">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>
<span class="nx">delete</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="o">}</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Registers plugins to be instantiated at the class level (plugins </span>
<span class="c"> * which should be plugged into every instance of the class by default).</span>
<span class="c"> *</span>
<span class="c"> * @method Plugin.Host.plug</span>
<span class="c"> * @static</span>
<span class="c"> *</span>
<span class="c"> * @param {Function} hostClass The host class on which to register the plugins</span>
<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>
<span class="c"> * @param {Object} config (Optional) If plugin is the plugin class, the configuration for the plugin</span>
<span class="c"> */</span>
<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>
<span class="c">// Cannot plug into Base, since Plugins derive from Base [ will cause infinite recurrsion ]</span>
<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>
<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>
<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>
<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>
<span class="k">if</span> <span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span>
<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>
<span class="o">}</span>
<span class="nx">plugin</span> <span class="o">=</span> <span class="o">[</span><span class="nx">plugin</span><span class="o">];</span>
<span class="o">}</span>
<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>
<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>
<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>
<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>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Unregisters any class level plugins which have been registered by the host class, or any</span>
<span class="c"> * other class in the hierarchy.</span>
<span class="c"> *</span>
<span class="c"> * @method Plugin.Host.unplug</span>
<span class="c"> * @static</span>
<span class="c"> *</span>
<span class="c"> * @param {Function} hostClass The host class from which to unregister the plugins</span>
<span class="c"> * @param {Function | Array} plugin The plugin class, or an array of plugin classes</span>
<span class="c"> */</span>
<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>
<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>
<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>
<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>
<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>
<span class="nx">plugin</span> <span class="o">=</span> <span class="o">[</span><span class="nx">plugin</span><span class="o">];</span>
<span class="o">}</span>
<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>
<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>
<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="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>
<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>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<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>
<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="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>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class="selected"><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue.html" title="queue">queue</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Base.html" title="Base">Base</a></li>
<li class=""><a href="Plugin.Host.html" title="Plugin.Host">Plugin.Host</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Base.js.html" title="Base.js">Base.js</a></li>
<li class=""><a href="BaseBuild.js.html" title="BaseBuild.js">BaseBuild.js</a></li>
<li class="selected"><a href="PluginHost.js.html" title="PluginHost.js">PluginHost.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
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"}];
</script>
</body>
</html>