Class WebviewPanelImpl

Implements

WebviewPanel

Constructors

constructor

new WebviewPanelImpl(viewId, proxy, _viewType, _title, showOptions, _options, _webview): WebviewPanelImpl
Parameters
- viewId: string
- proxy: WebviewsMain
- _viewType: string
- _title: string
- showOptions: WebviewPanelShowOptions | ViewColumn
- _options: WebviewPanelOptions
- _webview: WebviewImpl
Returns WebviewPanelImpl
- Defined in packages/plugin-ext/src/plugin/webviews.ts:326

Properties

`Private` _active

_active: boolean = true

`Private` _iconPath

_iconPath: undefined | Uri | {
dark: Uri;
light: Uri;
}

Type declaration

dark: Uri
light: Uri

`Private` `Readonly` _options

_options: WebviewPanelOptions

`Private` _showOptions

_showOptions: WebviewPanelShowOptions

`Private` _title

_title: string

`Private` `Readonly` _viewType

_viewType: string

`Private` _visible

_visible: boolean = true

`Private` `Readonly` _webview

_webview: WebviewImpl

`Private` isDisposed

isDisposed: boolean = false

`Readonly` onDidChangeViewState

onDidChangeViewState: Event<WebviewPanelOnDidChangeViewStateEvent> = ...

`Readonly` onDidChangeViewStateEmitter

onDidChangeViewStateEmitter: Emitter<WebviewPanelOnDidChangeViewStateEvent> = ...

`Readonly` onDidDispose

onDidDispose: Event<void> = ...

`Readonly` onDisposeEmitter

onDisposeEmitter: Emitter<void> = ...

`Private` `Readonly` proxy

proxy: WebviewsMain

`Private` `Readonly` viewId

viewId: string

Accessors

active

get active(): boolean
Returns boolean
Implementation of theia.WebviewPanel.active
- Defined in packages/plugin-ext/src/plugin/webviews.ts:412

iconPath

get iconPath(): undefined | Uri | {
dark: Uri;
light: Uri;
}
Returns undefined | Uri | {
dark: Uri;
light: Uri;
}
Implementation of theia.WebviewPanel.iconPath
- Defined in packages/plugin-ext/src/plugin/webviews.ts:370
set iconPath(iconPath): void
Parameters
- iconPath: undefined | Uri | {
  dark: Uri;
  light: Uri;
  }
Returns void
Implementation of theia.WebviewPanel.iconPath
- Defined in packages/plugin-ext/src/plugin/webviews.ts:374

options

get options(): WebviewPanelOptions
Returns WebviewPanelOptions
Implementation of theia.WebviewPanel.options
- Defined in packages/plugin-ext/src/plugin/webviews.ts:387

showOptions

get showOptions(): WebviewPanelShowOptions
Returns WebviewPanelShowOptions
Implementation of theia.WebviewPanel.showOptions
- Defined in packages/plugin-ext/src/plugin/webviews.ts:402

title

get title(): string
Returns string
Implementation of theia.WebviewPanel.title
- Defined in packages/plugin-ext/src/plugin/webviews.ts:357
set title(newTitle): void
Parameters
- newTitle: string
Returns void
Implementation of theia.WebviewPanel.title
- Defined in packages/plugin-ext/src/plugin/webviews.ts:362

viewColumn

get viewColumn(): undefined | ViewColumn
Returns undefined | ViewColumn
Implementation of theia.WebviewPanel.viewColumn
- Defined in packages/plugin-ext/src/plugin/webviews.ts:392

viewType

get viewType(): string
Returns string
Implementation of theia.WebviewPanel.viewType
- Defined in packages/plugin-ext/src/plugin/webviews.ts:352

visible

get visible(): boolean
Returns boolean
Implementation of theia.WebviewPanel.visible
- Defined in packages/plugin-ext/src/plugin/webviews.ts:422

webview

get webview(): WebviewImpl
Returns WebviewImpl
Implementation of theia.WebviewPanel.webview
- Defined in packages/plugin-ext/src/plugin/webviews.ts:382

Methods

`Private` checkIsDisposed

checkIsDisposed(): void
Returns void
- Defined in packages/plugin-ext/src/plugin/webviews.ts:463

dispose

dispose(): void
Returns void
Implementation of theia.WebviewPanel.dispose
- Defined in packages/plugin-ext/src/plugin/webviews.ts:337

postMessage

postMessage(message): PromiseLike<boolean>
Parameters
- message: any
Returns PromiseLike<boolean>
- Defined in packages/plugin-ext/src/plugin/webviews.ts:458

reveal

reveal(arg0?, arg1?, arg2?): void
Parameters
- Optional arg0: ViewColumn | WebviewPanelTargetArea
- Optional arg1: boolean | ViewColumn
- Optional arg2: boolean
Returns void
Implementation of theia.WebviewPanel.reveal
- Defined in packages/plugin-ext/src/plugin/webviews.ts:432

setActive

setActive(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/plugin-ext/src/plugin/webviews.ts:417

setShowOptions

setShowOptions(value): void
Parameters
- value: WebviewPanelShowOptions
Returns void
- Defined in packages/plugin-ext/src/plugin/webviews.ts:407

setViewColumn

setViewColumn(value): void
Parameters
- value: undefined | ViewColumn
Returns void
- Defined in packages/plugin-ext/src/plugin/webviews.ts:397

setVisible

setVisible(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/plugin-ext/src/plugin/webviews.ts:427