org.xwiki.gwt.wysiwyg.client.plugin
Interface PluginManager


public interface PluginManager

Manages the list of installed plug-ins.

Version:
$Id$

Method Summary
 PluginFactoryManager getPluginFactoryManager()
           
 UIExtension getUIExtension(java.lang.String role, java.lang.String feature)
           
 void load(java.lang.String pluginName)
          Loads the specified plug-in.
 void setPluginFactoryManager(PluginFactoryManager pfm)
          Sets the manager of the available plug-in factories.
 void unload(java.lang.String pluginName)
          Unloads the specified plug-in.
 void unloadAll()
          Unloads all the plug-ins for which the load(String) method has been called.
 

Method Detail

getPluginFactoryManager

PluginFactoryManager getPluginFactoryManager()
Returns:
The manager of the available plug-in factories.

setPluginFactoryManager

void setPluginFactoryManager(PluginFactoryManager pfm)
Sets the manager of the available plug-in factories.

Parameters:
pfm - The plug-in factory manager to use.

load

void load(java.lang.String pluginName)
Loads the specified plug-in. A new instance of this plug-in is obtained using the current plug-in factory manager. The Plugin#init(com.xpn.xwiki.wysiwyg.client.widget.rta.RichTextArea, com.xpn.xwiki.wysiwyg.client.util.Config) method is called.

Parameters:
pluginName - The name of the plug-in to be loaded. This name should match the value returned by PluginFactory.getPluginName() method of this plug-in's factory.

unload

void unload(java.lang.String pluginName)
Unloads the specified plug-in. The Plugin.destroy() method is called.

Parameters:
pluginName - The name of the plug-in to be unloaded. This name should match the value returned by PluginFactory.getPluginName() method of this plug-in's factory.

unloadAll

void unloadAll()
Unloads all the plug-ins for which the load(String) method has been called.


getUIExtension

UIExtension getUIExtension(java.lang.String role,
                           java.lang.String feature)
Parameters:
role - The extension point. See UIExtension.getRole().
feature - The feature name. See UIExtension.getFeatures().
Returns:
The user interface extension for the given role and the given feature.


Copyright © 2004-2011 XWiki. All Rights Reserved.