Class Index | File Index

Classes


Class orion.pluginregistry.Plugin

Represents a single plugin in the plugin registry.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/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.
 
setParent(parent)
Sets the parent of this plugin.
 
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.

At any given time, a plugin is in exactly one of the following six states:

"uninstalled"
The plugin has been uninstalled and may not be used.

The uninstalled state is only visible after a plugin has been uninstalled; the plugin is unusable, but references to its Plugin object may still be available and used for introspection.

"installed"
The plugin is installed, but not yet resolved.

"resolved"
The plugin is resolved and is able to be started.

Note that the plugin is not active yet. A plugin must be in the resolved state before it can be started.

The resolved state is reserved for future use. Future versions of the framework may require successful dependency resolution before moving a plugin to the resolved state.

"starting"
The plugin is in the process of starting.

A plugin is in the starting state when its #start method has been called but has not yet resolved. Once the start call resolves, the plugin has successfully started and moves to the active state.

If the plugin has a lazy activation policy, it may remain in the starting state for some time until the activation is triggered.

"stopping"
The plugin is in the process of stopping.

A plugin is in the stopping state when its #stop method has been called but not yet resolved. Once the stop call resolves, the plugin moves to the resolved state.

"active"
The plugin is running. It has been successfully started and activated.

In the active state, any services the plugin provides are available for use.

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.

{String} getState()
Returns this plugin's current state.
Returns:
{String} This plugin's state.

{orion.Promise} setParent(parent)
Sets the parent of this plugin.
Parameters:
{DOMElement} parent Optional, Default: null
the plugin parent. null puts the plugin in the default parent of the plugin registry
Returns:
{orion.Promise} A promise that will resolve when the plugin parent has been set.

{orion.Promise} uninstall()
Uninstalls this plugin.
Returns:
{orion.Promise} A promise that will resolve when the plugin has been uninstalled.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Apr 04 2017 10:51:57 GMT-0400 (EDT)