Class MergeEditorOpenHandler

Generic base class for OpenHandlers that are opening a widget for a given URI.

Hierarchy (View Summary)

NavigatableWidgetOpenHandler<MergeEditor>
- MergeEditorOpenHandler

Index

Constructors

constructor

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

Properties

`Readonly`id

id: "merge-editor-opener" = MergeEditorOpenHandler.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 = ...

`Readonly`onCreated

onCreated: Event<MergeEditor>

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<MergeEditor>

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Static` `Readonly`ID

ID: "merge-editor-opener" = 'merge-editor-opener'

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?: MergeEditorOpenerOptions): 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: MergeEditorOpenerOptions
Returns number
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/scm/src/browser/merge-editor/merge-editor.ts:628

closeAll

closeAll(options?: ApplicationShell.CloseOptions): Promise<MergeEditor[]>
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<MergeEditor[]>
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`doOpen

doOpen(
    widget: MergeEditor,
    uri: URI,
    options?: WidgetOpenerOptions,
): Promise<void>
Parameters
- widget: MergeEditor
- 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 | MergeEditor>
Tries to get an existing widget for the given uri.
Parameters
- uri: URI
  the uri of the widget.
Returns Promise<undefined | MergeEditor>
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

getOrCreateByUri

getOrCreateByUri(uri: URI): Promise<MergeEditor>
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<MergeEditor>
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?: MergeEditorOpenerOptions,
): Promise<MergeEditor>
Parameters
- uri: URI
- Optionaloptions: MergeEditorOpenerOptions
Returns Promise<MergeEditor>
Overrides NavigatableWidgetOpenHandler.getOrCreateWidget
- Defined in packages/scm/src/browser/merge-editor/merge-editor.ts:636

`Protected`getWidget

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

`Protected`init

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

open

open(uri: URI, options?: MergeEditorOpenerOptions): Promise<MergeEditor>
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: MergeEditorOpenerOptions
  the widget opener options.
Returns Promise<MergeEditor>
promise of the widget that resolves when the widget has been opened.
Overrides NavigatableWidgetOpenHandler.open
- Defined in packages/scm/src/browser/merge-editor/merge-editor.ts:632

`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<MergeEditor>
Parameters
- uri: URI
- Optionaloptions: WidgetOpenerOptions
Returns undefined | MaybePromise<MergeEditor>
Inherited from NavigatableWidgetOpenHandler.tryGetPendingWidget
- Defined in packages/core/lib/browser/widget-open-handler.d.ts:80

Class MergeEditorOpenHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MergeEditorOpenHandler

Properties

Readonlyid

Implementation

Readonlylabel

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

Protected Readonlyshell

Protected ReadonlywidgetManager

Static ReadonlyID

Accessors

all

Returns W[]

Methods

canHandle

Parameters

Returns number

closeAll

Parameters

Returns Promise<MergeEditor[]>

ProtectedcreateWidgetOptions

Parameters

Returns NavigatableWidgetOptions

ProtecteddoOpen

Parameters

Returns Promise<void>

getByUri

Parameters

Returns Promise<undefined | MergeEditor>

getOrCreateByUri

Parameters

Returns Promise<MergeEditor>

ProtectedgetOrCreateWidget

Parameters

Returns Promise<MergeEditor>

ProtectedgetWidget

Parameters

Returns Promise<undefined | MergeEditor>

Protectedinit

Returns void

open

Parameters

Returns Promise<MergeEditor>

ProtectedserializeUri

Parameters

Returns string

ProtectedtryGetPendingWidget

Parameters

Returns undefined | MaybePromise<MergeEditor>

Settings

On This Page

`Readonly`id

`Readonly`label

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Protected` `Readonly`shell

`Protected` `Readonly`widgetManager

`Static` `Readonly`ID

`Protected`createWidgetOptions

`Protected`doOpen

`Protected`getOrCreateWidget

`Protected`getWidget

`Protected`init

`Protected`serializeUri

`Protected`tryGetPendingWidget