Class DefaultOpenerService

OpenerService provide an access to existing openers.

Implements

OpenerService

Index

Constructors

Properties

customEditorOpenHandlers handlersProvider onDidChangeOpeners onDidChangeOpenersEmitter

Methods

addHandler getHandlers getOpener getOpeners prioritize removeHandler

Constructors

constructor

new DefaultOpenerService(
handlersProvider: ContributionProvider<OpenHandler>,
): DefaultOpenerService
Parameters
- handlersProvider: ContributionProvider<OpenHandler>
Returns DefaultOpenerService
- Defined in packages/core/src/browser/opener-service.ts:119

Properties

`Protected` `Readonly`customEditorOpenHandlers

customEditorOpenHandlers: OpenHandler[] = []

Collection of open-handlers for custom-editor contributions.

`Protected` `Readonly`handlersProvider

handlersProvider: ContributionProvider<OpenHandler>

`Readonly`onDidChangeOpeners

onDidChangeOpeners: Event<void> = ...

Event that fires when a new opener is added or removed.

`Protected` `Readonly`onDidChangeOpenersEmitter

onDidChangeOpenersEmitter: Emitter<void> = ...

Methods

addHandler

addHandler(openHandler: OpenHandler): Disposable
Add open handler i.e. for custom editors
Parameters
- openHandler: OpenHandler
Returns Disposable
Implementation of OpenerService.addHandler
- Defined in packages/core/src/browser/opener-service.ts:124

`Protected`getHandlers

getHandlers(): OpenHandler[]
Returns OpenHandler[]
- Defined in packages/core/src/browser/opener-service.ts:161

getOpener

getOpener(uri: URI, options?: OpenerOptions): Promise<OpenHandler>
Return an opener with the higher priority for the given URI. Reject if such does not exist.
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns Promise<OpenHandler>
Implementation of OpenerService.getOpener
- Defined in packages/core/src/browser/opener-service.ts:138

getOpeners

getOpeners(uri?: URI, options?: OpenerOptions): Promise<OpenHandler[]>
Return all registered openers. Never reject.
Parameters
- Optionaluri: URI
- Optionaloptions: OpenerOptions
Returns Promise<OpenHandler[]>
Implementation of OpenerService.getOpeners
- Defined in packages/core/src/browser/opener-service.ts:146

`Protected`prioritize

prioritize(uri: URI, options?: OpenerOptions): Promise<OpenHandler[]>
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns Promise<OpenHandler[]>
- Defined in packages/core/src/browser/opener-service.ts:150

removeHandler

removeHandler(openHandler: OpenHandler): void
Remove open handler
Parameters
- openHandler: OpenHandler
Returns void
Implementation of OpenerService.removeHandler
- Defined in packages/core/src/browser/opener-service.ts:133