Class Index | File Index

Classes


Class orion.pluginregistry.PluginRegistry

The Orion plugin registry
Defined in: </shared/eclipse/e4/orion/I201302221257/plugins/org.eclipse.orion.client.core/web/orion/pluginregistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.pluginregistry.PluginRegistry(serviceRegistry, opt_storage, opt_visible)
Creates a new plugin registry.
Method Summary
Method Attributes Method Name and Description
 
Returns the installed plugin with the given URL.
 
Returns all installed plugins
 
installPlugin(url, optManifest)
Installs the plugin at the given location into the plugin registry
 
Starts the plugin registry
 
stop()
Shuts down the plugin registry
Event Summary
Event Attributes Event Name and Description
 
Dispatched when a plugin has been installed.
 
pluginLoaded(plugin)
Dispatched when a plugin has been loaded.
 
Dispatched when a plugin has been uninstalled.
 
pluginUpdated(plugin)
Dispatched when a plugin has been updated.
Class Detail
orion.pluginregistry.PluginRegistry(serviceRegistry, opt_storage, opt_visible)
Creates a new plugin registry.
Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
The service registry to register plugin-provided services with.
{Object} opt_storage Optional, Default: localStorage
Target object to read and write plugin metadata from.
{Boolean} opt_visible Optional, Default: false
Whether a loaded plugin's iframe will be displayed. By default it is not displayed.
Method Detail
{orion.pluginregistry.Plugin} getPlugin()
Returns the installed plugin with the given URL.
Returns:
{orion.pluginregistry.Plugin} The installed plugin matching the given URL, or null if no such plugin is installed.

{orion.pluginregistry.Plugin[]} getPlugins()
Returns all installed plugins
Returns:
{orion.pluginregistry.Plugin[]} An array of all installed plugins.

{orion.Promise} installPlugin(url, optManifest)
Installs the plugin at the given location into the plugin registry
Parameters:
{String} url
The location of the plugin
{Object} optManifest Optional
The plugin metadata
Returns:
{orion.Promise} A promise that will resolve when the plugin has been installed.

startup()
Starts the plugin registry
Returns:
A promise that will resolve when the registry has been fully started

stop()
Shuts down the plugin registry
Event Detail
pluginInstalled(plugin)
Dispatched when a plugin has been installed. The type of this event is 'pluginInstalled'.
Parameters:
{orion.pluginregistry.Plugin} plugin
The plugin that was installed.

pluginLoaded(plugin)
Dispatched when a plugin has been loaded. The type of this event is 'pluginLoaded'.
Parameters:
{orion.pluginregistry.Plugin} plugin
The plugin that was loaded.

pluginUninstalled(plugin)
Dispatched when a plugin has been uninstalled. The type of this event is 'pluginUninstalled'.
Parameters:
{orion.pluginregistry.Plugin} plugin
The plugin that was uninstalled.

pluginUpdated(plugin)
Dispatched when a plugin has been updated. The type of this event is 'pluginUpdated'.
Parameters:
{orion.pluginregistry.Plugin} plugin
The plugin that was updated.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 22 2013 13:00:53 GMT-0500 (EST)