Class EditorManager

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

Hierarchy (View Summary)

NavigatableWidgetOpenHandler<EditorWidget>
- EditorManager
  - EditorPreviewManager

Index

Constructors

Properties

_activeEditor _currentEditor commands editorCounters id label navigationLocationService onActiveEditorChanged onActiveEditorChangedEmitter onCreated onCreatedEmitter onCurrentEditorChanged onCurrentEditorChangedEmitter preferenceService recentlyVisibleIds resolverContributions selectionResolvers shell widgetManager

Accessors

activeEditor all currentEditor recentlyVisible

Constructors

constructor

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

Properties

`Protected`_activeEditor

_activeEditor: undefined | EditorWidget

`Protected`_currentEditor

_currentEditor: undefined | EditorWidget

`Protected` `Readonly`commands

commands: CommandService

`Protected` `Readonly`editorCounters

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

`Readonly`id

id: string = EditorWidgetFactory.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`navigationLocationService

navigationLocationService: NavigationLocationService

`Readonly`onActiveEditorChanged

onActiveEditorChanged: Event<undefined | EditorWidget> = ...

Emit when the active editor is changed.

`Protected` `Readonly`onActiveEditorChangedEmitter

onActiveEditorChangedEmitter: Emitter<undefined | EditorWidget> = ...

`Readonly`onCreated

onCreated: Event<EditorWidget>

Emit when a new widget is created.

`Protected` `Readonly`onCreatedEmitter

onCreatedEmitter: Emitter<EditorWidget>

`Readonly`onCurrentEditorChanged

onCurrentEditorChanged: Event<undefined | EditorWidget> = ...

Emit when the current editor is changed.

`Protected` `Readonly`onCurrentEditorChangedEmitter

onCurrentEditorChangedEmitter: Emitter<undefined | EditorWidget> = ...

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`recentlyVisibleIds

recentlyVisibleIds: string[] = []

`Protected` `Readonly`resolverContributions

resolverContributions: ContributionProvider<EditorSelectionResolver>

`Protected`selectionResolvers

selectionResolvers: EditorSelectionResolver[] = []

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Accessors

activeEditor

get activeEditor(): undefined | EditorWidget
The active editor. If there is an active editor (one that has focus), active and current are the same.

Returns undefined | EditorWidget
- Defined in packages/editor/src/browser/editor-manager.ts:172

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

currentEditor

get currentEditor(): undefined | EditorWidget
The most recently activated editor (which might not have the focus anymore, hence it is not active). If no editor has focus, e.g. when a context menu is shown, the active editor is undefined, but current might be the editor that was active before the menu popped up.

Returns undefined | EditorWidget
- Defined in packages/editor/src/browser/editor-manager.ts:196

`Protected`recentlyVisible

get recentlyVisible(): undefined | EditorWidget
Returns undefined | EditorWidget
- Defined in packages/editor/src/browser/editor-manager.ts:152

Methods

`Protected`addRecentlyVisible

addRecentlyVisible(widget: EditorWidget): void
Parameters
- widget: EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:156

canHandle

canHandle(uri: URI, options?: WidgetOpenerOptions): 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: WidgetOpenerOptions
Returns number
Overrides NavigatableWidgetOpenHandler.canHandle
- Defined in packages/editor/src/browser/editor-manager.ts:214

`Protected`checkCounterForWidget

checkCounterForWidget(widget: EditorWidget): void
Parameters
- widget: EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:379

closeAll

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

createByUri

createByUri(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>
Parameters
- uri: URI
- Optionaloptions: EditorOpenerOptions
Returns Promise<EditorWidget>
- Defined in packages/editor/src/browser/editor-manager.ts:143

`Protected`createCounterForUri

createCounterForUri(uri: URI): number
Parameters
- uri: URI
Returns number
- Defined in packages/editor/src/browser/editor-manager.ts:390

`Protected`createWidgetOptions

createWidgetOptions(
uri: URI,
options?: EditorOpenerOptions,
): NavigatableWidgetOptions
Parameters
- uri: URI
- Optionaloptions: EditorOpenerOptions
Returns NavigatableWidgetOptions
Overrides NavigatableWidgetOpenHandler.createWidgetOptions
- Defined in packages/editor/src/browser/editor-manager.ts:406

`Protected`doOpen

doOpen(
    widget: EditorWidget,
    uri: URI,
    options?: EditorOpenerOptions,
): Promise<void>
Parameters
- widget: EditorWidget
- uri: URI
- Optionaloptions: EditorOpenerOptions
Returns Promise<void>
Overrides NavigatableWidgetOpenHandler.doOpen
- Defined in packages/editor/src/browser/editor-manager.ts:275

`Protected`extractIdFromWidget

extractIdFromWidget(widget: EditorWidget): WidgetId
Parameters
- widget: EditorWidget
Returns WidgetId
- Defined in packages/editor/src/browser/editor-manager.ts:373

getByUri

getByUri(
uri: URI,
options?: EditorOpenerOptions,
): Promise<undefined | EditorWidget>
Tries to get an existing widget for the given uri.
Parameters
- uri: URI
  the uri of the widget.
- Optionaloptions: EditorOpenerOptions
Returns Promise<undefined | EditorWidget>
a promise that resolves to the existing widget or undefined if no widget for the given uri exists.
Overrides NavigatableWidgetOpenHandler.getByUri
- Defined in packages/editor/src/browser/editor-manager.ts:135

`Protected`getCounterForUri

getCounterForUri(uri: URI): undefined | number
Parameters
- uri: URI
Returns undefined | number
- Defined in packages/editor/src/browser/editor-manager.ts:396

getOrCreateByUri

getOrCreateByUri(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>
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.
- Optionaloptions: EditorOpenerOptions
Returns Promise<EditorWidget>
a promise of the existing or newly created widget.
Overrides NavigatableWidgetOpenHandler.getOrCreateByUri
- Defined in packages/editor/src/browser/editor-manager.ts:139

`Protected`getOrCreateCounterForUri

getOrCreateCounterForUri(uri: URI): number
Parameters
- uri: URI
Returns number
- Defined in packages/editor/src/browser/editor-manager.ts:402

`Protected`getOrCreateWidget

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

`Protected`getSelection

getSelection(
widget: EditorWidget,
selection: RecursivePartial<Range>,
): undefined | Range | Position
Parameters
- widget: EditorWidget
- selection: RecursivePartial<Range>
Returns undefined | Range | Position
- Defined in packages/editor/src/browser/editor-manager.ts:330

`Protected`getWidget

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

`Protected`init

init(): void
Returns void
Overrides NavigatableWidgetOpenHandler.init
- Defined in packages/editor/src/browser/editor-manager.ts:79

open

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

openToSide

openToSide(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget>
Opens an editor to the side of the current editor. Defaults to opening to the right. To modify direction, pass options with {widgetOptions: {mode: ...}}
Parameters
- uri: URI
- Optionaloptions: EditorOpenerOptions
Returns Promise<EditorWidget>
- Defined in packages/editor/src/browser/editor-manager.ts:269

registerSelectionResolver

registerSelectionResolver(resolver: EditorSelectionResolver): Disposable
Registers a dynamic selection resolver. The resolver is added to the sorted list of selection resolvers and can later be disposed to remove it.
Parameters
- resolver: EditorSelectionResolver
  The selection resolver to register.
Returns Disposable
A Disposable that unregisters the resolver when disposed.
- Defined in packages/editor/src/browser/editor-manager.ts:122

`Protected`removeFromCounter

removeFromCounter(widget: EditorWidget): void
Parameters
- widget: EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:354

`Protected`removeRecentlyVisible

removeRecentlyVisible(widget: EditorWidget): void
Parameters
- widget: EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:160

`Protected`resolveSelection

resolveSelection(
    widget: EditorWidget,
    options: EditorOpenerOptions,
    uri?: URI,
): Promise<undefined | RecursivePartial<Range>>
Parameters
- widget: EditorWidget
- options: EditorOpenerOptions
- Optionaluri: URI
Returns Promise<undefined | RecursivePartial<Range>>
- Defined in packages/editor/src/browser/editor-manager.ts:313

`Protected`revealSelection

revealSelection(
    widget: EditorWidget,
    uri: URI,
    options?: EditorOpenerOptions,
): Promise<void>
Parameters
- widget: EditorWidget
- uri: URI
- Optionaloptions: EditorOpenerOptions
Returns Promise<void>
- Defined in packages/editor/src/browser/editor-manager.ts:280

`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`setActiveEditor

setActiveEditor(active: undefined | EditorWidget): void
Parameters
- active: undefined | EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:175

`Protected`setCurrentEditor

setCurrentEditor(current: undefined | EditorWidget): void
Parameters
- current: undefined | EditorWidget
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:199

`Protected`tryGetPendingWidget

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

`Protected`updateActiveEditor

updateActiveEditor(): void
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:181

`Protected`updateCurrentEditor

updateCurrentEditor(): void
Returns void
- Defined in packages/editor/src/browser/editor-manager.ts:205

Class EditorManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns EditorManager

Properties

Protected_activeEditor

Protected_currentEditor

Protected Readonlycommands

Protected ReadonlyeditorCounters

Readonlyid

Implementation

Readonlylabel

Protected ReadonlynavigationLocationService

ReadonlyonActiveEditorChanged

Protected ReadonlyonActiveEditorChangedEmitter

ReadonlyonCreated

Protected ReadonlyonCreatedEmitter

ReadonlyonCurrentEditorChanged

Protected ReadonlyonCurrentEditorChangedEmitter

Protected ReadonlypreferenceService

Protected ReadonlyrecentlyVisibleIds

Protected ReadonlyresolverContributions

ProtectedselectionResolvers

Protected Readonlyshell

Protected ReadonlywidgetManager

Accessors

activeEditor

Returns undefined | EditorWidget

all

Returns W[]

currentEditor

Returns undefined | EditorWidget

ProtectedrecentlyVisible

Returns undefined | EditorWidget

Methods

ProtectedaddRecentlyVisible

Parameters

Returns void

canHandle

Parameters

Returns number

ProtectedcheckCounterForWidget

Parameters

Returns void

closeAll

Parameters

Returns Promise<EditorWidget[]>

createByUri

Parameters

Returns Promise<EditorWidget>

ProtectedcreateCounterForUri

Parameters

Returns number

ProtectedcreateWidgetOptions

Parameters

Returns NavigatableWidgetOptions

ProtecteddoOpen

Parameters

Returns Promise<void>

ProtectedextractIdFromWidget

Parameters

Returns WidgetId

getByUri

Parameters

Returns Promise<undefined | EditorWidget>

ProtectedgetCounterForUri

Parameters

Returns undefined | number

getOrCreateByUri

Parameters

Returns Promise<EditorWidget>

ProtectedgetOrCreateCounterForUri

Parameters

Returns number

`Protected`_activeEditor

`Protected`_currentEditor

`Protected` `Readonly`commands

`Protected` `Readonly`editorCounters

`Readonly`id

`Readonly`label

`Protected` `Readonly`navigationLocationService

`Readonly`onActiveEditorChanged

`Protected` `Readonly`onActiveEditorChangedEmitter

`Readonly`onCreated

`Protected` `Readonly`onCreatedEmitter

`Readonly`onCurrentEditorChanged

`Protected` `Readonly`onCurrentEditorChangedEmitter

`Protected` `Readonly`preferenceService

`Protected` `Readonly`recentlyVisibleIds

`Protected` `Readonly`resolverContributions

`Protected`selectionResolvers

`Protected` `Readonly`shell

`Protected` `Readonly`widgetManager

`Protected`recentlyVisible

`Protected`addRecentlyVisible

`Protected`checkCounterForWidget

`Protected`createCounterForUri

`Protected`createWidgetOptions

`Protected`doOpen

`Protected`extractIdFromWidget

`Protected`getCounterForUri

`Protected`getOrCreateCounterForUri

`Protected`getOrCreateWidget

`Protected`getSelection

`Protected`getWidget

`Protected`init

`Protected`removeFromCounter

`Protected`removeRecentlyVisible

`Protected`resolveSelection

`Protected`revealSelection

`Protected`serializeUri

`Protected`setActiveEditor

`Protected`setCurrentEditor

`Protected`tryGetPendingWidget

`Protected`updateActiveEditor

`Protected`updateCurrentEditor