Class PluginViewRegistry

Implements

FrontendApplicationContribution

Index

Constructors

Properties

commands contextKeyService debug explorer menus onDidExpandView onDidExpandViewEmitter onNewResolverRegistered onNewResolverRegisteredEmitter quickView scm shell style viewContextKeys widgetManager

Methods

createNewWebviewView createViewDataWidget createWebviewWidget doOpenView doRegisterViewContainer getContainerViews getOrCreateViewContainerWidget getPluginViewContainer getTreeViewWelcomeWidget getView getViewContainerId getViewWelcomes handleViewWelcomeChange init initView initViewContainer initWidgets isViewContainerVisible isViewVisible isVisibleWidget onDidInitializeLayout openView openViewContainer prepareView prepareViewContainer registerView registerViewContainer registerViewDataProvider registerViewWelcome registerWebviewView registerWidgetPartEvents removeStaleWidgets resolveWebviewView storeViewDataStateOnDispose toggleViewContainer toPluginViewWidgetIdentifier toViewContainerId toViewContainerIdentifier toViewId toViewWelcomeId updateFocusedView updateViewContainerVisibility updateViewVisibility updateViewWelcomeVisibility

Constructors

constructor

new PluginViewRegistry(): PluginViewRegistry
Returns PluginViewRegistry

Properties

`Protected` `Readonly`commands

commands: CommandRegistry

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Readonly`onDidExpandView

onDidExpandView: Event<string> = ...

`Protected` `Readonly`onDidExpandViewEmitter

onDidExpandViewEmitter: Emitter<string> = ...

`Readonly`onNewResolverRegistered

onNewResolverRegistered: Event<{ viewType: string }> = ...

`Protected` `Readonly`onNewResolverRegisteredEmitter

onNewResolverRegisteredEmitter: Emitter<{ viewType: string }> = ...

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`scm

scm: ScmContribution

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`style

style: PluginSharedStyle

`Protected` `Readonly`viewContextKeys

viewContextKeys: ViewContextKeyService

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Methods

`Protected`createNewWebviewView

createNewWebviewView(viewId: string): Promise<WebviewView>
Parameters
- viewId: string
Returns Promise<WebviewView>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:521

`Protected`createViewDataWidget

createViewDataWidget(
viewId: string,
webviewId?: string,
): Promise<undefined | Widget>
Parameters
- viewId: string
- OptionalwebviewId: string
Returns Promise<undefined | Widget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:968

`Protected`createWebviewWidget

createWebviewWidget(
viewId: string,
webviewId?: string,
): Promise<undefined | Widget>
Parameters
- viewId: string
- OptionalwebviewId: string
Returns Promise<undefined | Widget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:989

`Protected`doOpenView

doOpenView(viewId: string): Promise<undefined | PluginViewWidget>
Parameters
- viewId: string
Returns Promise<undefined | PluginViewWidget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:646

`Protected`doRegisterViewContainer

doRegisterViewContainer(
    id: string,
    location: string,
    options: ViewContainerTitleOptions,
    when?: string,
): Disposable
Parameters
- id: string
- location: string
- options: ViewContainerTitleOptions
- Optionalwhen: string
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:355

getContainerViews

getContainerViews(viewContainerId: string): string[]
Parameters
- viewContainerId: string
Returns string[]
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:431

`Protected`getOrCreateViewContainerWidget

getOrCreateViewContainerWidget(containerId: string): Promise<ViewContainer>
Parameters
- containerId: string
Returns Promise<ViewContainer>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:686

`Protected`getPluginViewContainer

getPluginViewContainer(
viewContainerId: string,
): Promise<undefined | ViewContainer>
Parameters
- viewContainerId: string
Returns Promise<undefined | ViewContainer>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:798

`Protected`getTreeViewWelcomeWidget

getTreeViewWelcomeWidget(
viewId: string,
): Promise<undefined | TreeViewWelcomeWidget>
Parameters
- viewId: string
Returns Promise<undefined | TreeViewWelcomeWidget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:611

getView

getView(viewId: string): Promise<undefined | PluginViewWidget>
Parameters
- viewId: string
Returns Promise<undefined | PluginViewWidget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:628

`Protected`getViewContainerId

getViewContainerId(container: ViewContainer): undefined | string
Parameters
- container: ViewContainer
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:785

getViewWelcomes

getViewWelcomes(viewId: string): ViewWelcome[]
Parameters
- viewId: string
Returns ViewWelcome[]
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:624

handleViewWelcomeChange

handleViewWelcomeChange(viewId: string): Promise<void>
Parameters
- viewId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:604

`Protected`init

init(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:150

`Protected`initView

initView(viewId: string, toDispose: DisposableCollection): Promise<void>
Parameters
- viewId: string
- toDispose: DisposableCollection
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:945

`Protected`initViewContainer

initViewContainer(containerId: string): Promise<void>
Parameters
- containerId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:821

initWidgets

initWidgets(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:834

`Protected`isViewContainerVisible

isViewContainerVisible(containerId: string): boolean
Parameters
- containerId: string
Returns boolean
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:411

`Protected`isViewVisible

isViewVisible(viewId: string): boolean
Parameters
- viewId: string
Returns boolean
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:299

`Protected`isVisibleWidget

isVisibleWidget(widget: Widget): boolean
Parameters
- widget: Widget
Returns boolean
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:1009

onDidInitializeLayout

onDidInitializeLayout(): void
retrieve restored layout state from previous user session but close widgets widgets should be opened only when view data providers are registered

Returns void
Implementation of FrontendApplicationContribution.onDidInitializeLayout
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:918

openView

openView(
viewId: string,
options?: { activate?: boolean; reveal?: boolean },
): Promise<undefined | PluginViewWidget>
Parameters
- viewId: string
- Optionaloptions: { activate?: boolean; reveal?: boolean }
Returns Promise<undefined | PluginViewWidget>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:635

openViewContainer

openViewContainer(containerId: string): Promise<undefined | ViewContainer>
Parameters
- containerId: string
Returns Promise<undefined | ViewContainer>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:691

`Protected`prepareView

prepareView(widget: PluginViewWidget): Promise<void>
Parameters
- widget: PluginViewWidget
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:660

`Protected`prepareViewContainer

prepareViewContainer(
viewContainerId: string,
containerWidget: ViewContainer,
): Promise<void>
Parameters
- viewContainerId: string
- containerWidget: ViewContainer
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:728

registerView

registerView(viewContainerId: string, view: View): Disposable
Parameters
- viewContainerId: string
- view: View
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:435

registerViewContainer

registerViewContainer(
location: string,
viewContainer: ViewContainer,
): Disposable
Parameters
- location: string
- viewContainer: ViewContainer
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:308

registerViewDataProvider

registerViewDataProvider(viewId: string, provider: ViewDataProvider): Disposable
Parameters
- viewId: string
- provider: ViewDataProvider
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:931

registerViewWelcome

registerViewWelcome(viewWelcome: ViewWelcome): Disposable
Parameters
- viewWelcome: ViewWelcome
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:577

registerWebviewView

registerWebviewView(
viewId: string,
resolver: WebviewViewResolver,
): Promise<Disposable>
Parameters
- viewId: string
- resolver: WebviewViewResolver
Returns Promise<Disposable>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:500

`Protected`registerWidgetPartEvents

registerWidgetPartEvents(
widget: PluginViewWidget,
containerWidget: ViewContainer,
): undefined | ViewContainerPart
Parameters
- widget: PluginViewWidget
- containerWidget: ViewContainer
Returns undefined | ViewContainerPart
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:755

removeStaleWidgets

removeStaleWidgets(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:875

resolveWebviewView

resolveWebviewView(
    viewId: string,
    webview: WebviewView,
    cancellation: CancellationToken,
): Promise<void>
Parameters
- viewId: string
- webview: WebviewView
- cancellation: CancellationToken
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:486

`Protected`storeViewDataStateOnDispose

storeViewDataStateOnDispose(
viewId: string,
widget: Widget & StatefulWidget,
): void
Parameters
- viewId: string
- widget: Widget & StatefulWidget
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:998

`Protected`toggleViewContainer

toggleViewContainer(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:343

`Protected`toPluginViewWidgetIdentifier

toPluginViewWidgetIdentifier(viewId: string): PluginViewWidgetIdentifier
Parameters
- viewId: string
Returns PluginViewWidgetIdentifier
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:903

`Protected`toViewContainerId

toViewContainerId(identifier: ViewContainerIdentifier): string
Parameters
- identifier: ViewContainerIdentifier
Returns string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:899

`Protected`toViewContainerIdentifier

toViewContainerIdentifier(viewContainerId: string): ViewContainerIdentifier
Parameters
- viewContainerId: string
Returns ViewContainerIdentifier
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:896

`Protected`toViewId

toViewId(identifier: PluginViewWidgetIdentifier): string
Parameters
- identifier: PluginViewWidgetIdentifier
Returns string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:906

`Protected`toViewWelcomeId

toViewWelcomeId(index: number, viewId: string): string
Parameters
- index: number
- viewId: string
Returns string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:910

`Protected`updateFocusedView

updateFocusedView(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:1013

`Protected`updateViewContainerVisibility

updateViewContainerVisibility(containerId: string): Promise<void>
Parameters
- containerId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:419

`Protected`updateViewVisibility

updateViewVisibility(viewId: string): Promise<void>
Parameters
- viewId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:273

`Protected`updateViewWelcomeVisibility

updateViewWelcomeVisibility(viewId: string): Promise<void>
Parameters
- viewId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts:266

Class PluginViewRegistry

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginViewRegistry

Properties

Protected Readonlycommands

Protected ReadonlycontextKeyService

Protected Readonlydebug

Protected Readonlyexplorer

Protected Readonlymenus

ReadonlyonDidExpandView

Protected ReadonlyonDidExpandViewEmitter

ReadonlyonNewResolverRegistered

Protected ReadonlyonNewResolverRegisteredEmitter

Protected ReadonlyquickView

Protected Readonlyscm

Protected Readonlyshell

Protected Readonlystyle

Protected ReadonlyviewContextKeys

Protected ReadonlywidgetManager

Methods

ProtectedcreateNewWebviewView

Parameters

Returns Promise<WebviewView>

ProtectedcreateViewDataWidget

Parameters

Returns Promise<undefined | Widget>

ProtectedcreateWebviewWidget

Parameters

Returns Promise<undefined | Widget>

ProtecteddoOpenView

Parameters

Returns Promise<undefined | PluginViewWidget>

ProtecteddoRegisterViewContainer

Parameters

Returns Disposable

getContainerViews

Parameters

Returns string[]

ProtectedgetOrCreateViewContainerWidget

Parameters

Returns Promise<ViewContainer>

ProtectedgetPluginViewContainer

Parameters

Returns Promise<undefined | ViewContainer>

ProtectedgetTreeViewWelcomeWidget

Parameters

Returns Promise<undefined | TreeViewWelcomeWidget>

getView

Parameters

Returns Promise<undefined | PluginViewWidget>

ProtectedgetViewContainerId

Parameters

Returns undefined | string

getViewWelcomes

Parameters

Returns ViewWelcome[]

handleViewWelcomeChange

Parameters

Returns Promise<void>

Protectedinit

Returns void

ProtectedinitView

Parameters

Returns Promise<void>

ProtectedinitViewContainer

Parameters

Returns Promise<void>

initWidgets

Returns Promise<void>

ProtectedisViewContainerVisible

Parameters

Returns boolean

ProtectedisViewVisible

Parameters

`Protected` `Readonly`commands

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`debug

`Protected` `Readonly`explorer

`Protected` `Readonly`menus

`Readonly`onDidExpandView

`Protected` `Readonly`onDidExpandViewEmitter

`Readonly`onNewResolverRegistered

`Protected` `Readonly`onNewResolverRegisteredEmitter

`Protected` `Readonly`quickView

`Protected` `Readonly`scm

`Protected` `Readonly`shell

`Protected` `Readonly`style

`Protected` `Readonly`viewContextKeys

`Protected` `Readonly`widgetManager

`Protected`createNewWebviewView

`Protected`createViewDataWidget

`Protected`createWebviewWidget

`Protected`doOpenView

`Protected`doRegisterViewContainer

`Protected`getOrCreateViewContainerWidget

`Protected`getPluginViewContainer

`Protected`getTreeViewWelcomeWidget

`Protected`getViewContainerId

`Protected`init

`Protected`initView

`Protected`initViewContainer

`Protected`isViewContainerVisible

`Protected`isViewVisible

`Protected`isVisibleWidget

`Protected`prepareView

`Protected`prepareViewContainer

`Protected`registerWidgetPartEvents

`Protected`storeViewDataStateOnDispose

`Protected`toggleViewContainer

`Protected`toPluginViewWidgetIdentifier

`Protected`toViewContainerId

`Protected`toViewContainerIdentifier

`Protected`toViewId

`Protected`toViewWelcomeId

`Protected`updateFocusedView

`Protected`updateViewContainerVisibility

`Protected`updateViewVisibility