3
Copyright 2011 Yahoo! Inc. All rights reserved.
4
Licensed under the BSD License.
5
http://yuilibrary.com/license/
7
YUI.add('pluginhost-base', function(Y) {
10
* Provides the augmentable PluginHost interface, which can be added to any class.
15
* Provides the augmentable PluginHost interface, which can be added to any class.
16
* @module pluginhost-base
21
* An augmentable class, which provides the augmented class with the ability to host plugins.
22
* It adds <a href="#method_plug">plug</a> and <a href="#method_unplug">unplug</a> methods to the augmented class, which can
23
* be used to add or remove plugins from instances of the class.
26
* <p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using
27
* the "plugins" property. Supported values for the "plugins" property are those defined by the <a href="#method_plug">plug</a> method.
29
* For example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):
31
* var o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:"header"}}]});
35
* Plug.Host's protected <a href="#method_initPlugins">_initPlugins</a> and <a href="#method_destroyPlugins">_destroyPlugins</a>
36
* methods should be invoked by the host class at the appropriate point in the host's lifecyle.
44
function PluginHost() {
48
PluginHost.prototype = {
51
* Adds a plugin to the host object. This will instantiate the
52
* plugin and attach it to the configured namespace on the host object.
56
* @param P {Function | Object |Array} Accepts the plugin class, or an
57
* object with a "fn" property specifying the plugin class and
58
* a "cfg" property specifying the configuration for the Plugin.
60
* Additionally an Array can also be passed in, with the above function or
61
* object values, allowing the user to add multiple plugins in a single call.
63
* @param config (Optional) If the first argument is the plugin class, the second argument
64
* can be the configuration for the plugin.
65
* @return {Base} A reference to the host object
67
plug: function(Plugin, config) {
70
if (L.isArray(Plugin)) {
71
for (i = 0, ln = Plugin.length; i < ln; i++) {
75
if (Plugin && !L.isFunction(Plugin)) {
80
// Plugin should be fn by now
81
if (Plugin && Plugin.NS) {
84
config = config || {};
87
if (this.hasPlugin(ns)) {
89
this[ns].setAttrs(config);
91
// Create new instance
92
this[ns] = new Plugin(config);
93
this._plugins[ns] = Plugin;
96
else { Y.log("Attempt to plug in an invalid plugin. Host:" + this + ", Plugin:" + Plugin); }
102
* Removes a plugin from the host object. This will destroy the
103
* plugin instance and delete the namepsace from the host object.
106
* @param {String | Function} plugin The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided,
107
* all registered plugins are unplugged.
108
* @return {Base} A reference to the host object
111
unplug: function(plugin) {
113
plugins = this._plugins;
116
if (L.isFunction(plugin)) {
118
if (ns && (!plugins[ns] || plugins[ns] !== plugin)) {
133
for (ns in this._plugins) {
134
if (this._plugins.hasOwnProperty(ns)) {
143
* Determines if a plugin has plugged into this host.
146
* @param {String} ns The plugin's namespace
147
* @return {boolean} returns true, if the plugin has been plugged into this host, false otherwise.
149
hasPlugin : function(ns) {
150
return (this._plugins[ns] && this[ns]);
154
* Initializes static plugins registered on the host (using the
155
* Base.plug static method) and any plugins passed to the
156
* instance through the "plugins" configuration property.
158
* @method _initPlugins
159
* @param {Config} config The configuration object with property name/value pairs.
163
_initPlugins: function(config) {
164
this._plugins = this._plugins || {};
166
if (this._initConfigPlugins) {
167
this._initConfigPlugins(config);
172
* Unplugs and destroys all plugins on the host
173
* @method _destroyPlugins
176
_destroyPlugins: function() {
181
Y.namespace("Plugin").Host = PluginHost;
184
}, '3.4.1' ,{requires:['yui-base']});