Class MiniBrowserOpenHandler

Hierarchy

NavigatableWidgetOpenHandler<MiniBrowser>
- MiniBrowserOpenHandler

Implements

FrontendApplicationContribution
CommandContribution
MenuContribution
TabBarToolbarContribution

Constructors

constructor

new MiniBrowserOpenHandler(): MiniBrowserOpenHandler
Returns MiniBrowserOpenHandler
Inherited from NavigatableWidgetOpenHandler<MiniBrowser>.constructor

Properties

`Readonly` id

id: string = MiniBrowser.ID

`Readonly` label

label: string = ...

`Protected` `Readonly` labelProvider

labelProvider: LabelProvider

`Protected` `Readonly` locationMapperService

locationMapperService: LocationMapperService

`Protected` `Readonly` miniBrowserService

miniBrowserService: MiniBrowserService

`Protected` `Readonly` openerService

openerService: OpenerService

`Protected` `Readonly` quickInputService

quickInputService: QuickInputService

`Protected` `Readonly` supportedExtensions

supportedExtensions: Map<string, number> = ...

Instead of going to the backend with each file URI to ask whether it can handle the current file or not, we have this map of extension and priority pairs that we populate at application startup. The real advantage of this approach is the following: Phosphor cannot run async code when invoking isEnabled/isVisible for the command handlers so the menu item would be always visible for the user even if the file type cannot be handled eventually. Hopefully, we could get rid of this hack once we have migrated the existing Phosphor code to React.

`Static` PREVIEW_URI

PREVIEW_URI: URI = ...

Methods

canHandle

canHandle(uri, options?): number
Parameters
- uri: URI
- Optional options: MiniBrowserOpenerOptions
Returns number
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:112

`Protected` canPreviewWidget

canPreviewWidget(widget?): boolean
Parameters
- Optional widget: Widget
Returns boolean
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:232

`Protected` defaultOptions

defaultOptions(): Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>
Returns Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:188

`Protected` getOpenPreviewProps

getOpenPreviewProps(startPage): Promise<MiniBrowserOpenerOptions>
Parameters
- startPage: string
Returns Promise<MiniBrowserOpenerOptions>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:297

`Protected` getOrCreateWidget

getOrCreateWidget(uri, options?): Promise<MiniBrowser>
Parameters
- uri: URI
- Optional options: MiniBrowserOpenerOptions
Returns Promise<MiniBrowser>
Overrides NavigatableWidgetOpenHandler.getOrCreateWidget
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:141

`Protected` getSourceUri

getSourceUri(ref?): undefined | URI
Parameters
- Optional ref: Widget
Returns undefined | URI
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:274

`Protected` getUriToPreview

getUriToPreview(widget?): undefined | URI
Parameters
- Optional widget: Widget
Returns undefined | URI
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:237

`Protected` getWidgetToPreview

getWidgetToPreview(widget?): undefined | NavigatableWidget
Parameters
- Optional widget: Widget
Returns undefined | NavigatableWidget
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:242

onStart

onStart(): void
Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:103

open

open(uri, options?): Promise<MiniBrowser>
Parameters
- uri: URI
- Optional options: MiniBrowserOpenerOptions
Returns Promise<MiniBrowser>
Overrides NavigatableWidgetOpenHandler.open
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:128

openPreview

openPreview(startPage): Promise<MiniBrowser>
Parameters
- startPage: string
Returns Promise<MiniBrowser>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:292

`Protected` openSource

openSource(ref?): Promise<void>
Parameters
- Optional ref: Widget
Returns Promise<void>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:264

`Protected` openUrl

openUrl(arg?): Promise<void>
Parameters
- Optional arg: string
Returns Promise<void>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:282

`Protected` options

options(uri?, options?): Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>
Parameters
- Optional uri: URI
- Optional options: MiniBrowserOpenerOptions
Returns Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:148

`Protected` preview

preview(widget?): Promise<void>
Parameters
- Optional widget: Widget
Returns Promise<void>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:248

registerCommands

registerCommands(commands): void
Parameters
- commands: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:197

registerMenus

registerMenus(menus): void
Parameters
- menus: MenuModelRegistry
Returns void
Implementation of MenuContribution.registerMenus
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:213

registerToolbarItems

registerToolbarItems(toolbar): void
Parameters
- toolbar: TabBarToolbarRegistry
Returns void
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:219

`Protected` resetBackground

resetBackground(uri): MaybePromise<boolean>
Parameters
- uri: URI
Returns MaybePromise<boolean>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:178

Class MiniBrowserOpenHandler

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MiniBrowserOpenHandler

Properties

Readonly id

Readonly label

Protected Readonly labelProvider

Protected Readonly locationMapperService

Protected Readonly miniBrowserService

Protected Readonly openerService

Protected Readonly quickInputService

Protected Readonly supportedExtensions

Static PREVIEW_URI

Methods

canHandle

Parameters

Returns number

Protected canPreviewWidget

Parameters

Returns boolean

Protected defaultOptions

Returns Promise<MiniBrowserOpenerOptions & { widgetOptions: WidgetOptions; }>

Protected getOpenPreviewProps

Parameters

Returns Promise<MiniBrowserOpenerOptions>

Protected getOrCreateWidget

Parameters

Returns Promise<MiniBrowser>

Protected getSourceUri

Parameters

Returns undefined | URI

Protected getUriToPreview

Parameters

Returns undefined | URI

Protected getWidgetToPreview

Parameters

Returns undefined | NavigatableWidget

onStart

Returns void

open

Parameters

Returns Promise<MiniBrowser>

openPreview

Parameters

Returns Promise<MiniBrowser>

Protected openSource

Parameters

Returns Promise<void>

Protected openUrl

Parameters

Returns Promise<void>

Protected options

Parameters

Returns Promise<MiniBrowserOpenerOptions & { widgetOptions: WidgetOptions; }>

Protected preview

Parameters

Returns Promise<void>

registerCommands

Parameters

Returns void

registerMenus

Parameters

Returns void

registerToolbarItems

Parameters

Returns void

Protected resetBackground

Parameters

Returns MaybePromise<boolean>

Settings

Member Visibility

Theme

On This Page

`Readonly` id

`Readonly` label

`Protected` `Readonly` labelProvider

`Protected` `Readonly` locationMapperService

`Protected` `Readonly` miniBrowserService

`Protected` `Readonly` openerService

`Protected` `Readonly` quickInputService

`Protected` `Readonly` supportedExtensions

`Static` PREVIEW_URI

`Protected` canPreviewWidget

`Protected` defaultOptions

Returns Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>

`Protected` getOpenPreviewProps

`Protected` getOrCreateWidget

`Protected` getSourceUri

`Protected` getUriToPreview

`Protected` getWidgetToPreview

`Protected` openSource

`Protected` openUrl

`Protected` options

Returns Promise<MiniBrowserOpenerOptions & {
widgetOptions: WidgetOptions;
}>

`Protected` preview

`Protected` resetBackground