Class Index | File Index

Classes


Class orion.pluginregistry.Plugin

Represents a single plugin in the plugin registry.
Defined in: </shared/eclipse/e4/orion/I201306251555/plugins/org.eclipse.orion.client.core/web/orion/pluginregistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new plugin.
Method Summary
Method Attributes Method Name and Description
 
Returns the headers of this plugin
 
Returns the URL location of this plugin
 
Returns the service references provided by this plugin
 
Returns this plugin's current state.
 
Uninstalls this plugin
Class Detail
orion.pluginregistry.Plugin()
Creates a new plugin. This constructor is private and should only be called by the plugin registry.

A plugin can be in one of three states:

orion.pluginregistry.Plugin.INSTALLED
The plugin is not running, and is present in the plugin registry.

From the INSTALLED state, the plugin will become LOADED if a service method provided by one of the plugin's service references is called through the service registry.

orion.pluginregistry.Plugin.LOADED
The plugin is running, and is present in the plugin registry.

From the LOADED state, the plugin will become UNINSTALLED if its #uninstall method is called.

orion.pluginregistry.Plugin.UNINSTALLED
The plugin is not running, and has been removed from the plugin registry.

Any services formerly provided by the plugin have been unregistered and cannot be called. Although uninstalled plugins do not appear in the plugin registry, they can be observed if references to a Plugin instance are kept after its #uninstall method has been called.

From the UNINSTALLED state, the plugin cannot change to any other state.

Method Detail
{Object} getHeaders()
Returns the headers of this plugin
Returns:
{Object} The plugin headers

{String} getLocation()
Returns the URL location of this plugin
Returns:
{String} The URL of this plugin

{orion.serviceregistry.ServiceReference} getServiceReferences()
Returns the service references provided by this plugin
Returns:
{orion.serviceregistry.ServiceReference} The service references provided by this plugin.

{Number} getState()
Returns this plugin's current state.
Returns:
{Number} This plugin's state. The value is one of:
  • orion.pluginregistry.Plugin.INSTALLED
  • orion.pluginregistry.Plugin.LOADED
  • orion.pluginregistry.Plugin.UNINSTALLED

uninstall()
Uninstalls this plugin

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jun 25 2013 15:58:42 GMT-0400 (EDT)