Class WebviewsMainImpl

Implements

WebviewsMain
Disposable

Constructors

constructor

new WebviewsMainImpl(rpc, container): WebviewsMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
Returns WebviewsMainImpl
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:44

Properties

`Protected` `Readonly` pluginService

pluginService: HostedPluginSupport

`Private` `Readonly` proxy

proxy: WebviewsExt

`Protected` `Readonly` shell

shell: ApplicationShell

`Private` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` updateViewStates

updateViewStates: DebouncedFunc<(() => void)> = ...

Type declaration

- (): void
- Returns void

`Protected` `Readonly` viewColumnService

viewColumnService: ViewColumnService

`Protected` `Readonly` widgetManager

widgetManager: WidgetManager

Methods

$createWebviewPanel

$createWebviewPanel(panelId, viewType, title, showOptions, options): Promise<void>
Parameters
- panelId: string
- viewType: string
- title: string
- showOptions: WebviewPanelShowOptions
- options: WebviewPanelOptions & WebviewOptions
Returns Promise<void>
Implementation of WebviewsMain.$createWebviewPanel
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:59

$disposeWebview

$disposeWebview(handle): Promise<void>
Parameters
- handle: string
Returns Promise<void>
Implementation of WebviewsMain.$disposeWebview
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:130

$postMessage

$postMessage(handle, value): Promise<boolean>
Parameters
- handle: string
- value: any
Returns Promise<boolean>
Implementation of WebviewsMain.$postMessage
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:193

$registerSerializer

$registerSerializer(viewType): void
Parameters
- viewType: string
Returns void
Implementation of WebviewsMain.$registerSerializer
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:204

$reveal

$reveal(handle, showOptions): Promise<void>
Parameters
- handle: string
- showOptions: WebviewPanelShowOptions
Returns Promise<void>
Implementation of WebviewsMain.$reveal
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:137

$setBadge

$setBadge(handle, badge): Promise<void>
Parameters
- handle: string
- badge: undefined | ViewBadge
Returns Promise<void>
Implementation of WebviewsMain.$setBadge
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:163

$setHtml

$setHtml(handle, value): Promise<void>
Parameters
- handle: string
- value: string
Returns Promise<void>
Implementation of WebviewsMain.$setHtml
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:176

$setIconPath

$setIconPath(handle, iconUrl): Promise<void>
Parameters
- handle: string
- iconUrl: undefined | IconUrl
Returns Promise<void>
Implementation of WebviewsMain.$setIconPath
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:171

$setOptions

$setOptions(handle, options): Promise<void>
Parameters
- handle: string
- options: WebviewOptions
Returns Promise<void>
Implementation of WebviewsMain.$setOptions
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:181

$setTitle

$setTitle(handle, value): Promise<void>
Parameters
- handle: string
- value: string
Returns Promise<void>
Implementation of WebviewsMain.$setTitle
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:158

$unregisterSerializer

$unregisterSerializer(viewType): void
Parameters
- viewType: string
Returns void
Implementation of WebviewsMain.$unregisterSerializer
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:209

addOrReattachWidget

addOrReattachWidget(widget, showOptions): void
Parameters
- widget: WebviewWidget
- showOptions: WebviewPanelShowOptions
Returns void
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:93

dispose

dispose(): void
Returns void
Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:55

`Private` getWebview

getWebview(viewId): Promise<WebviewWidget>
Parameters
- viewId: string
Returns Promise<WebviewWidget>
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:268

hookWebview

hookWebview(view): void
Parameters
- view: WebviewWidget
Returns void
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:81

`Protected` restoreWidget

restoreWidget(widget): Promise<void>
Parameters
- widget: WebviewWidget
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:213

`Private` tryGetWebview

tryGetWebview(id): Promise<undefined | WebviewWidget>
Parameters
- id: string
Returns Promise<undefined | WebviewWidget>
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:276

`Private` updateViewState

updateViewState(widget, viewColumn?): void
Parameters
- widget: WebviewWidget
- Optional viewColumn: number
Returns void
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:250