Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebviewWidget

Hierarchy

Implements

  • StatefulWidget
  • ExtractableWidget
  • BadgeWidget

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • Optional options: IOptions

    Returns WebviewWidget

Properties

Protected Optional _badge

_badge?: number

Protected Optional _badgeTooltip

_badgeTooltip?: string

Protected _contentOptions

_contentOptions: WebviewContentOptions = {}

Protected _state

_state: undefined | string

Protected element

element: undefined | HTMLIFrameElement

Protected Readonly environment

environment: WebviewEnvironment

Readonly externalEndpoint

externalEndpoint: string

Protected Readonly externalUriService

externalUriService: ExternalUriService

Protected Readonly fileService

fileService: FileService

Protected hideTimeout

hideTimeout: any

Protected html

html: string = ''

Protected iconUrl

iconUrl: undefined | IconUrl

Readonly identifier

identifier: WebviewWidgetIdentifier

isExtractable

isExtractable: boolean = true

Protected Readonly keybindings

keybindings: KeybindingRegistry

Protected Readonly mouseTracker

mouseTracker: ApplicationShellMouseTracker

Protected onDidChangeBadgeEmitter

onDidChangeBadgeEmitter: Emitter<void> = ...

Protected onDidChangeBadgeTooltipEmitter

onDidChangeBadgeTooltipEmitter: Emitter<void> = ...

Readonly onMessage

onMessage: Event<any> = ...

Protected Readonly onMessageEmitter

onMessageEmitter: Emitter<any> = ...

Protected Readonly openerService

openerService: OpenerService

options

options: WebviewPanelOptions = {}

Protected Readonly outputManager

outputManager: OutputChannelManager

Protected Readonly pendingMessages

pendingMessages: any[] = []

Protected Readonly preferences

preferences: WebviewPreferences

Protected ready

ready: Deferred<void> = ...

Protected Readonly resourceCache

resourceCache: WebviewResourceCache

secondaryWindow

secondaryWindow: undefined | Window = undefined

Protected Readonly sharedStyle

sharedStyle: PluginSharedStyle

Protected Readonly themeDataProvider

themeDataProvider: WebviewThemeDataProvider

Protected Readonly toDisposeOnIcon

toDisposeOnIcon: DisposableCollection = ...

Protected Readonly toHide

toHide: DisposableCollection = ...

Protected transparentOverlay

transparentOverlay: HTMLElement

viewColumn

viewColumn: ViewColumn

viewState

viewState: WebviewPanelViewState = ...

viewType

viewType: string

Static FACTORY_ID

FACTORY_ID: string = 'plugin-webview'

Static Private Readonly standardSupportedLinkSchemes

standardSupportedLinkSchemes: Set<string> = ...

Accessors

badge

  • get badge(): undefined | number
  • set badge(badge: undefined | number): void

badgeTooltip

  • get badgeTooltip(): undefined | string
  • set badgeTooltip(badgeTooltip: undefined | string): void

contentOptions

onDidChangeBadge

  • get onDidChangeBadge(): Event<void>

onDidChangeBadgeTooltip

  • get onDidChangeBadgeTooltip(): Event<void>

state

  • get state(): undefined | string

Methods

Protected dispatchMouseEvent

  • dispatchMouseEvent(type: string, data: MouseEvent): void

Protected doHide

  • doHide(): void

Protected doSend

  • doSend(channel: string, data?: any): Promise<void>

Protected doShow

  • doShow(): void

Protected doUpdateContent

  • doUpdateContent(): void

Protected forceHide

  • forceHide(): void

Protected getRedirect

  • getRedirect(url: string): Promise<undefined | string>

Protected init

  • init(): void

Protected loadLocalhost

  • loadLocalhost(origin: string): Promise<void>

Protected loadResource

  • loadResource(requestPath: string): Promise<void>

Protected normalizeRequestUri

  • normalizeRequestUri(requestPath: string): URI

Protected on

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

Protected openLink

  • openLink(link: URI): void

Protected postMessage

  • postMessage(channel: string, data?: any): void

Protected preprocessHtml

  • preprocessHtml(value: string): string

reload

  • reload(): void

restoreState

sendMessage

  • sendMessage(data: any): void

setContentOptions

setHTML

  • setHTML(value: string): void

setIconUrl

  • setIconUrl(iconUrl: undefined | IconUrl): void

storeState

Protected style

  • style(): void

Protected toEndpoint

  • toEndpoint(pathname: string): string

Protected toRemoteUrl

  • toRemoteUrl(localUri: URI): Promise<string>

Protected toSupportedLink

  • toSupportedLink(link: URI): undefined | URI

Protected trace

  • trace(kind: "in" | "out", channel: string, data?: any): void