Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MiniBrowserOpenHandler

Hierarchy

  • NavigatableWidgetOpenHandler<MiniBrowser>
    • MiniBrowserOpenHandler

Implements

  • FrontendApplicationContribution
  • CommandContribution
  • MenuContribution
  • TabBarToolbarContribution

Index

Constructors

constructor

Properties

Readonly id

id: string = ...

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: 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.

Protected Readonly widgetManager

widgetManager: WidgetManager

Static PREVIEW_URI

PREVIEW_URI: default = ...

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.

Methods

canHandle

Protected canPreviewWidget

  • canPreviewWidget(widget?: Widget): boolean

closeAll

  • closeAll(options?: CloseOptions): Promise<MiniBrowser[]>
  • Closes all widgets that have been opened by this open handler.

    Parameters

    • Optional options: 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.

Protected createWidgetOptions

  • createWidgetOptions(uri: default, options?: WidgetOpenerOptions): NavigatableWidgetOptions
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns NavigatableWidgetOptions

Protected defaultOptions

Protected doOpen

  • doOpen(widget: MiniBrowser, options?: WidgetOpenerOptions): Promise<void>
  • Parameters

    • widget: MiniBrowser
    • Optional options: WidgetOpenerOptions

    Returns Promise<void>

getByUri

  • getByUri(uri: default): Promise<undefined | MiniBrowser>
  • Tries to get an existing widget for the given uri.

    Parameters

    • uri: default

      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.

Protected getOpenPreviewProps

getOrCreateByUri

  • Return an existing widget for the given uri or creates a new one.

    It does not open a widget, use {@link WidgetOpenHandler#open} instead.

    Parameters

    • uri: default

      uri of the widget.

    Returns Promise<MiniBrowser>

    a promise of the existing or newly created widget.

Protected getOrCreateWidget

Protected getSourceUri

  • getSourceUri(ref?: Widget): undefined | default

Protected getUriToPreview

  • getUriToPreview(widget?: Widget): undefined | default

Protected getWidget

  • getWidget(uri: default, options?: WidgetOpenerOptions): Promise<undefined | MiniBrowser>
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns Promise<undefined | MiniBrowser>

Protected getWidgetToPreview

  • getWidgetToPreview(widget?: Widget): undefined | NavigatableWidget

Protected init

  • init(): void
  • Returns void

onStart

  • onStart(): void

open

openPreview

Protected openSource

  • openSource(ref?: Widget): Promise<void>

Protected openUrl

  • openUrl(arg?: string): Promise<void>

Protected options

Protected preview

  • preview(widget?: Widget): Promise<void>

registerCommands

  • registerCommands(commands: CommandRegistry): void

registerMenus

  • registerMenus(menus: MenuModelRegistry): void

registerToolbarItems

  • registerToolbarItems(toolbar: TabBarToolbarRegistry): void

Protected resetBackground

  • resetBackground(uri: default): MaybePromise<boolean>

Protected serializeUri

  • serializeUri(uri: default): string
  • Parameters

    • uri: default

    Returns string

Protected tryGetPendingWidget

  • tryGetPendingWidget(uri: default, options?: WidgetOpenerOptions): undefined | MiniBrowser | PromiseLike<MiniBrowser>
  • Parameters

    • uri: default
    • Optional options: WidgetOpenerOptions

    Returns undefined | MiniBrowser | PromiseLike<MiniBrowser>