2 YUI 3.13.0 (build 508226d)
3 Copyright 2013 Yahoo! Inc. All rights reserved.
4 Licensed under the BSD License.
5 http://yuilibrary.com/license/
8 YUI.add('pluginhost-base', function (Y, NAME) {
11 * Provides the augmentable PluginHost interface, which can be added to any class.
16 * Provides the augmentable PluginHost interface, which can be added to any class.
17 * @module pluginhost-base
22 * An augmentable class, which provides the augmented class with the ability to host plugins.
23 * It adds <a href="#method_plug">plug</a> and <a href="#method_unplug">unplug</a> methods to the augmented class, which can
24 * be used to add or remove plugins from instances of the class.
27 * <p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using
28 * the "plugins" property. Supported values for the "plugins" property are those defined by the <a href="#method_plug">plug</a> method.
30 * For example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):
32 * var o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:"header"}}]});
36 * Plug.Host's protected <a href="#method_initPlugins">_initPlugins</a> and <a href="#method_destroyPlugins">_destroyPlugins</a>
37 * methods should be invoked by the host class at the appropriate point in the host's lifecyle.
45 function PluginHost() {
49 PluginHost.prototype = {
52 * Adds a plugin to the host object. This will instantiate the
53 * plugin and attach it to the configured namespace on the host object.
57 * @param P {Function | Object |Array} Accepts the plugin class, or an
58 * object with a "fn" property specifying the plugin class and
59 * a "cfg" property specifying the configuration for the Plugin.
61 * Additionally an Array can also be passed in, with the above function or
62 * object values, allowing the user to add multiple plugins in a single call.
64 * @param config (Optional) If the first argument is the plugin class, the second argument
65 * can be the configuration for the plugin.
66 * @return {Base} A reference to the host object
68 plug: function(Plugin, config) {
71 if (L.isArray(Plugin)) {
72 for (i = 0, ln = Plugin.length; i < ln; i++) {
76 if (Plugin && !L.isFunction(Plugin)) {
81 // Plugin should be fn by now
82 if (Plugin && Plugin.NS) {
85 config = config || {};
88 if (this.hasPlugin(ns)) {
90 if (this[ns].setAttrs) {
91 this[ns].setAttrs(config);
93 else { Y.log("Attempt to replug an already attached plugin, and we can't setAttrs, because it's not Attribute based: " + ns); }
95 // Create new instance
96 this[ns] = new Plugin(config);
97 this._plugins[ns] = Plugin;
100 else { Y.log("Attempt to plug in an invalid plugin. Host:" + this + ", Plugin:" + Plugin); }
106 * Removes a plugin from the host object. This will destroy the
107 * plugin instance and delete the namespace from the host object.
110 * @param {String | Function} plugin The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided,
111 * all registered plugins are unplugged.
112 * @return {Base} A reference to the host object
115 unplug: function(plugin) {
117 plugins = this._plugins;
120 if (L.isFunction(plugin)) {
122 if (ns && (!plugins[ns] || plugins[ns] !== plugin)) {
129 if (this[ns].destroy) {
139 for (ns in this._plugins) {
140 if (this._plugins.hasOwnProperty(ns)) {
149 * Determines if a plugin has plugged into this host.
152 * @param {String} ns The plugin's namespace
153 * @return {Plugin} Returns a truthy value (the plugin instance) if present, or undefined if not.
155 hasPlugin : function(ns) {
156 return (this._plugins[ns] && this[ns]);
160 * Initializes static plugins registered on the host (using the
161 * Base.plug static method) and any plugins passed to the
162 * instance through the "plugins" configuration property.
164 * @method _initPlugins
165 * @param {Config} config The configuration object with property name/value pairs.
169 _initPlugins: function(config) {
170 this._plugins = this._plugins || {};
172 if (this._initConfigPlugins) {
173 this._initConfigPlugins(config);
178 * Unplugs and destroys all plugins on the host
179 * @method _destroyPlugins
182 _destroyPlugins: function() {
187 Y.namespace("Plugin").Host = PluginHost;
190 }, '3.13.0', {"requires": ["yui-base"]});