Class Application<T>

A class for creating pluggable applications.

Type Parameters

T extends Widget = Widget
The type of the application shell.

Notes
The Application class is useful when creating large, complex UI applications with the ability to be safely extended by third party code via plugins.

Constructors

constructor

new Application<T>(options): Application<T>
Construct a new application.
Type Parameters
- T extends Widget<T> = Widget
Parameters
- options: Application.IOptions<T>
 The options for creating the application.
Returns Application<T>
- Defined in application/src/index.ts:48

Properties

`Private` _bubblingKeydown

_bubblingKeydown: boolean = false

`Private` _delegate

_delegate: PromiseDelegate<void> = ...

`Private` _started

_started: boolean = false

`Readonly` commands

commands: CommandRegistry

The application command registry.

`Readonly` contextMenu

contextMenu: ContextMenu

The application context menu.

`Protected` pluginRegistry

pluginRegistry: PluginRegistry<any>

Application plugin registry.

`Readonly` shell

shell: T

The application shell widget.

Notes

The shell widget is the root "container" widget for the entire application. It will typically expose an API which allows the application plugins to insert content in a variety of places.

Accessors

deferredPlugins

get deferredPlugins(): string[]
The list of all the deferred plugins.

Returns string[]
- Defined in application/src/index.ts:85

started

get started(): Promise<void>
A promise which resolves after the application has started.

Notes
This promise will resolve after the start() method is called, when all the bootstrapping and shell mounting work is complete.

Returns Promise<void>
- Defined in application/src/index.ts:96

Methods

activateDeferredPlugins

activateDeferredPlugins(): Promise<void>
Activate all the deferred plugins.

Returns Promise<void>
A promise which will resolve when each plugin is activated or rejects with an error if one cannot be activated.
- Defined in application/src/index.ts:106

activatePlugin

activatePlugin(id): Promise<void>
Activate the plugin with the given ID.
Parameters
- id: string
 The ID of the plugin of interest.
Returns Promise<void>
A promise which resolves when the plugin is activated or rejects with an error if it cannot be activated.
- Defined in application/src/index.ts:118

`Protected` addEventListeners

addEventListeners(): void
Add the application event listeners.

Notes
The default implementation of this method adds listeners for 'keydown' and 'resize' events.

A subclass may reimplement this method as needed.

Returns void
- Defined in application/src/index.ts:357

`Protected` attachShell

attachShell(id): void
Attach the application shell to the DOM.
Parameters
- id: string
  The ID of the host node for the shell, or ''.
  
  Notes
  If the ID is not provided, the document body will be the host.
  
  A subclass may reimplement this method as needed.
Returns void
- Defined in application/src/index.ts:341

deactivatePlugin

deactivatePlugin(id): Promise<string[]>
Deactivate the plugin and its downstream dependents if and only if the plugin and its dependents all support deactivate.
Parameters
- id: string
 The ID of the plugin of interest.
Returns Promise<string[]>
A list of IDs of downstream plugins deactivated with this one.
- Defined in application/src/index.ts:130

deregisterPlugin

deregisterPlugin(id, force?): void
Deregister a plugin with the application.
Parameters
- id: string
  The ID of the plugin of interest.
- Optional force: boolean
  Whether to deregister the plugin even if it is active.
Returns void
- Defined in application/src/index.ts:141

`Protected` evtContextMenu

evtContextMenu(event): void
A method invoked on a document 'contextmenu' event.

Notes
The default implementation of this method opens the application contextMenu at the current mouse position.

If the application context menu has no matching content or if the shift key is pressed, the default browser context menu will be opened instead.

A subclass may reimplement this method as needed.
Parameters
- event: PointerEvent
Returns void
- Defined in application/src/index.ts:403

`Protected` evtKeydown

evtKeydown(event): void
A method invoked on a document 'keydown' event.

Notes
The default implementation of this method invokes the key down processing method of the application command registry.

A subclass may reimplement this method as needed.
Parameters
- event: KeyboardEvent
Returns void
- Defined in application/src/index.ts:373

`Protected` evtKeyup

evtKeyup(event): void
A method invoked on a document 'keyup' event.

Notes
The default implementation of this method invokes the key up processing method of the application command registry.

A subclass may reimplement this method as needed.
Parameters
- event: KeyboardEvent
Returns void
- Defined in application/src/index.ts:386

`Protected` evtResize

evtResize(event): void
A method invoked on a window 'resize' event.

Notes
The default implementation of this method updates the shell.

A subclass may reimplement this method as needed.
Parameters
- event: Event
Returns void
- Defined in application/src/index.ts:421

getPluginDescription

getPluginDescription(id): string
Get a plugin description.
Parameters
- id: string
  The ID of the plugin of interest.
Returns string
The plugin description.
- Defined in application/src/index.ts:152

handleEvent

handleEvent(event): void
Handle the DOM events for the application.
Parameters
- event: Event
  The DOM event sent to the application.
  
  Notes
  This method implements the DOM EventListener interface and is called in response to events registered for the application. It should not be called directly by user code.
Returns void
- Defined in application/src/index.ts:314

hasPlugin

hasPlugin(id): boolean
Test whether a plugin is registered with the application.
Parameters
- id: string
  The ID of the plugin of interest.
Returns boolean
true if the plugin is registered, false otherwise.
- Defined in application/src/index.ts:163

isPluginActivated

isPluginActivated(id): boolean
Test whether a plugin is activated with the application.
Parameters
- id: string
  The ID of the plugin of interest.
Returns boolean
true if the plugin is activated, false otherwise.
- Defined in application/src/index.ts:174

listPlugins

listPlugins(): string[]
List the IDs of the plugins registered with the application.

Returns string[]
A new array of the registered plugin IDs.
- Defined in application/src/index.ts:183

registerPlugin

registerPlugin(plugin): void
Register a plugin with the application.
Parameters
- plugin: IPlugin<Application<T>, any>
 The plugin to register.
 
 Notes
 An error will be thrown if a plugin with the same ID is already registered, or if the plugin has a circular dependency.
 
 If the plugin provides a service which has already been provided by another plugin, the new service will override the old service.
Returns void
- Defined in application/src/index.ts:199

registerPlugins

registerPlugins(plugins): void
Register multiple plugins with the application.
Parameters
- plugins: IPlugin<Application<T>, any>[]
 The plugins to register.
 
 Notes
 This calls registerPlugin() for each of the given plugins.
Returns void
- Defined in application/src/index.ts:211

resolveOptionalService

resolveOptionalService(token): Promise<null | U>
Resolve an optional service of a given type.
Type Parameters
- U
Parameters
- token: Token
 The token for the service type of interest.
Returns Promise<null | U>
A promise which resolves to an instance of the requested service, or null if it cannot be resolved.

Notes
Services are singletons. The same instance will be returned each time a given service token is resolved.

If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.

User code will not typically call this method directly. Instead, the optional services for the user's plugins will be resolved automatically when the plugin is activated.
- Defined in application/src/index.ts:234

resolveRequiredService

resolveRequiredService(token): Promise
Resolve a required service of a given type.
Type Parameters
- U
Parameters
- token: Token
 The token for the service type of interest.
Returns Promise
A promise which resolves to an instance of the requested service, or rejects with an error if it cannot be resolved.

Notes
Services are singletons. The same instance will be returned each time a given service token is resolved.

If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.

User code will not typically call this method directly. Instead, the required services for the user's plugins will be resolved automatically when the plugin is activated.
- Defined in application/src/index.ts:257

start

start(options?): Promise<void>
Start the application.
Parameters
- options: Application.IStartOptions = {}
 The options for starting the application.
Returns Promise<void>
A promise which resolves when all bootstrapping work is complete and the shell is mounted to the DOM.

Notes
This should be called once by the application creator after all initial plugins have been registered.

If a plugin fails to the load, the error will be logged and the other valid plugins will continue to be loaded.

Bootstrapping the application consists of the following steps:
1. Activate the startup plugins
2. Wait for those plugins to activate
3. Attach the shell widget to the DOM
4. Add the application event listeners
- Defined in application/src/index.ts:282

Class Application<T>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Application<T>

Properties

Private _bubblingKeydown

Private _delegate

Private _started

Readonly commands

Readonly contextMenu

Protected pluginRegistry

Readonly shell

Accessors

deferredPlugins

Returns string[]

started

Returns Promise<void>

Methods

activateDeferredPlugins

Returns Promise<void>

activatePlugin

Parameters

Returns Promise<void>

Protected addEventListeners

Returns void

Protected attachShell

Parameters

Returns void

deactivatePlugin

Parameters

Returns Promise<string[]>

deregisterPlugin

Parameters

Returns void

Protected evtContextMenu

Parameters

Returns void

Protected evtKeydown

Parameters

Returns void

Protected evtKeyup

Parameters

Returns void

Protected evtResize

Parameters

Returns void

getPluginDescription

Parameters

Returns string

handleEvent

Parameters

Returns void

hasPlugin

Parameters

Returns boolean

isPluginActivated

Parameters

Returns boolean

listPlugins

Returns string[]

registerPlugin

Parameters

Returns void

registerPlugins

Parameters

Returns void

resolveOptionalService

Type Parameters

Parameters

Returns Promise<null | U>

resolveRequiredService

Type Parameters

`Private` _bubblingKeydown

`Private` _delegate

`Private` _started

`Readonly` commands

`Readonly` contextMenu

`Protected` pluginRegistry

`Readonly` shell

`Protected` addEventListeners

`Protected` attachShell

`Protected` evtContextMenu

`Protected` evtKeydown

`Protected` evtKeyup

`Protected` evtResize