Class MiniBrowserOpenHandler

The command contribution should be implemented to register custom commands and handler.

Hierarchy (View Summary)

NavigatableWidgetOpenHandler<MiniBrowser>
- MiniBrowserOpenHandler

Implements

Constructors

constructor

new MiniBrowserOpenHandler(): MiniBrowserOpenHandler
Returns MiniBrowserOpenHandler
Inherited from NavigatableWidgetOpenHandler.constructor

Properties

`Readonly`id

id: string = MiniBrowser.ID

The widget open handler id.

Implementation

A widget factory for this id should be registered.
Subclasses should not implement WidgetFactory to avoid exposing capabilities to create a widget outside of WidgetManager.

`Readonly`label

label: string = ...

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`locationMapperService

locationMapperService: LocationMapperService

`Protected` `Readonly`miniBrowserService

miniBrowserService: MiniBrowserService

`Readonly`onCreated

onCreated: Event<MiniBrowser>

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<MiniBrowser>

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Protected` `Readonly`shell

shell: ApplicationShell

`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: Lumino 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 Lumino code to React.

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Static`PREVIEW_URI

PREVIEW_URI: URI = ...

Accessors

all

get all(): W[]
Retrieves all open widgets that have been opened by this handler.

Returns W[]
all open widgets for this open handler.
Inherited from NavigatableWidgetOpenHandler.all
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:79

Methods

canHandle

canHandle(uri: URI, options?: MiniBrowserOpenerOptions): number
Test whether this handler can open the given URI for given options. Return a nonzero number if this handler can open; otherwise it cannot. Never reject.

A returned value indicating a priority of this handler.
Parameters
- uri: URI
- Optionaloptions: MiniBrowserOpenerOptions
Returns number
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:112

`Protected`canPreviewWidget

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

closeAll

closeAll(options?: ApplicationShell.CloseOptions): Promise<MiniBrowser[]>
Closes all widgets that have been opened by this open handler.
Parameters
- Optionaloptions: ApplicationShell.CloseOptions
  the close options that should be applied to all widgets.
Returns Promise<MiniBrowser[]>
a promise of all closed widgets that resolves after they have been closed.
Inherited from NavigatableWidgetOpenHandler.closeAll
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:90

`Protected`createWidgetOptions

createWidgetOptions(
uri: URI,
options?: WidgetOpenerOptions,
): NavigatableWidgetOptions
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns NavigatableWidgetOptions
Inherited from NavigatableWidgetOpenHandler.createWidgetOptions
- Defined in packages/core/lib/browser/navigatable.d.ts:6

`Protected`defaultOptions

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

`Protected`doOpen

doOpen(
    widget: MiniBrowser,
    uri: URI,
    options?: WidgetOpenerOptions,
): Promise<void>
Parameters
- widget: MiniBrowser
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<void>
Inherited from NavigatableWidgetOpenHandler.doOpen
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:57

getByUri

getByUri(uri: URI): Promise<undefined | MiniBrowser>
Tries to get an existing widget for the given uri.
Parameters
- uri: URI
  the uri of the widget.
Returns Promise<undefined | MiniBrowser>
a promise that resolves to the existing widget or undefined if no widget for the given uri exists.
Inherited from NavigatableWidgetOpenHandler.getByUri
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:64

`Protected`getOpenPreviewProps

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

getOrCreateByUri

getOrCreateByUri(uri: URI): Promise<MiniBrowser>
Return an existing widget for the given uri or creates a new one.

It does not open a widget, use WidgetOpenHandler#open instead.
Parameters
- uri: URI
  uri of the widget.
Returns Promise<MiniBrowser>
a promise of the existing or newly created widget.
Inherited from NavigatableWidgetOpenHandler.getOrCreateByUri
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:73

`Protected`getOrCreateWidget

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

`Protected`getSourceUri

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

`Protected`getUriToPreview

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

`Protected`getWidget

getWidget(
uri: URI,
options?: WidgetOpenerOptions,
): Promise<undefined | MiniBrowser>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns Promise<undefined | MiniBrowser>
Inherited from NavigatableWidgetOpenHandler.getWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:81

`Protected`getWidgetToPreview

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

`Protected`init

init(): void
Returns void
Inherited from NavigatableWidgetOpenHandler.init
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:37

onStart

onStart(): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

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

open

open(uri: URI, options?: MiniBrowserOpenerOptions): Promise<MiniBrowser>
Open a widget for the given uri and options. Reject if the given options are not widget options or a widget cannot be opened.
Parameters
- uri: URI
  the uri of the resource that should be opened.
- Optionaloptions: MiniBrowserOpenerOptions
  the widget opener options.
Returns Promise<MiniBrowser>
promise of the widget that resolves when the widget has been opened.
Overrides NavigatableWidgetOpenHandler.open
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:128

openPreview

openPreview(startPage: string): 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?: Widget): Promise<void>
Parameters
- Optionalref: Widget
Returns Promise<void>
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:264

`Protected`openUrl

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

`Protected`options

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

`Protected`preview

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

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
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: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Implementation of MenuContribution.registerMenus
- Defined in packages/mini-browser/src/browser/mini-browser-open-handler.ts:213

registerToolbarItems

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

`Protected`resetBackground

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

`Protected`serializeUri

serializeUri(uri: URI): string
Parameters
- uri: URI
Returns string
Inherited from NavigatableWidgetOpenHandler.serializeUri
- Defined in packages/core/lib/browser/navigatable.d.ts:7

`Protected`tryGetPendingWidget

tryGetPendingWidget(
uri: URI,
options?: WidgetOpenerOptions,
): undefined | MaybePromise<MiniBrowser>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns undefined | MaybePromise<MiniBrowser>
Inherited from NavigatableWidgetOpenHandler.tryGetPendingWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:80

Class MiniBrowserOpenHandler

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MiniBrowserOpenHandler

Properties

Readonlyid

Implementation

Readonlylabel

Protected ReadonlylabelProvider

Protected ReadonlylocationMapperService

Protected ReadonlyminiBrowserService

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

Protected ReadonlyopenerService

Protected ReadonlyquickInputService

Protected Readonlyshell

Protected ReadonlysupportedExtensions

Protected ReadonlywidgetManager

StaticPREVIEW_URI

Accessors

all

Returns W[]

Methods

canHandle

Parameters

Returns number

ProtectedcanPreviewWidget

Parameters

Returns boolean

closeAll

Parameters

Returns Promise<MiniBrowser[]>

ProtectedcreateWidgetOptions

Parameters

Returns NavigatableWidgetOptions

ProtecteddefaultOptions

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

ProtecteddoOpen

Parameters

Returns Promise<void>

getByUri

Parameters

Returns Promise<undefined | MiniBrowser>

ProtectedgetOpenPreviewProps

Parameters

Returns Promise<MiniBrowserOpenerOptions>

getOrCreateByUri

Parameters

Returns Promise<MiniBrowser>

ProtectedgetOrCreateWidget

Parameters

Returns Promise<MiniBrowser>

ProtectedgetSourceUri

Parameters

Returns undefined | URI

ProtectedgetUriToPreview

Parameters

Returns undefined | URI

ProtectedgetWidget

Parameters

Returns Promise<undefined | MiniBrowser>

ProtectedgetWidgetToPreview

Parameters

Returns undefined | NavigatableWidget

Protectedinit

Returns void

onStart

Returns void

open

Parameters

Returns Promise<MiniBrowser>

openPreview

Parameters

`Readonly`id

`Readonly`label

`Protected` `Readonly`labelProvider

`Protected` `Readonly`locationMapperService

`Protected` `Readonly`miniBrowserService

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Protected` `Readonly`openerService

`Protected` `Readonly`quickInputService

`Protected` `Readonly`shell

`Protected` `Readonly`supportedExtensions

`Protected` `Readonly`widgetManager

`Static`PREVIEW_URI

`Protected`canPreviewWidget

`Protected`createWidgetOptions

`Protected`defaultOptions

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

`Protected`doOpen

`Protected`getOpenPreviewProps

`Protected`getOrCreateWidget

`Protected`getSourceUri

`Protected`getUriToPreview

`Protected`getWidget

`Protected`getWidgetToPreview

`Protected`init

`Protected`openSource

`Protected`openUrl

`Protected`options

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

`Protected`preview

`Protected`resetBackground

`Protected`serializeUri

`Protected`tryGetPendingWidget