Class CustomEditorWidget

Hierarchy (view full)

WebviewWidget
- CustomEditorWidget

Implements

CustomEditorWidget
SaveableSource
NavigatableWidget

Index

Constructors

constructor

Accessors

badge badgeTooltip contentOptions modelRef onDidChangeBadge onDidChangeBadgeTooltip saveable state

Constructors

constructor

new CustomEditorWidget(options?): CustomEditorWidget
Parameters
- Optional options: IOptions
Returns CustomEditorWidget
Inherited from WebviewWidget.constructor
- Defined in packages/core/lib/browser/widgets/widget.d.ts:59

Properties

`Protected` `Optional` _badge

_badge?: number

`Protected` `Optional` _badgeTooltip

_badgeTooltip?: string

`Protected` _contentOptions

_contentOptions: WebviewContentOptions = {}

`Protected` _modelRef

_modelRef: Reference<undefined | CustomEditorModel> = ...

`Private` `Optional` _moveHandler

_moveHandler?: ((newResource) => void)

Type declaration

- (newResource): void
- Parameters
  - newResource: URI
  Returns void

`Protected` _state

_state: undefined | string

`Protected` `Readonly` contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly` contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Protected` `Readonly` delegatingSaveable

delegatingSaveable: DelegatingSaveable = ...

`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

id

id: string

`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> = ...

resource

resource: URI

`Protected` `Readonly` resourceCache

resourceCache: WebviewResourceCache

`Protected` `Readonly` saveService

saveService: SaveableService

secondaryWindow

secondaryWindow: undefined | Window = undefined

`Protected` `Readonly` sharedStyle

sharedStyle: PluginSharedStyle

`Protected` `Readonly` shell

shell: ApplicationShell

`Protected` `Readonly` themeDataProvider

themeDataProvider: WebviewThemeDataProvider

`Protected` `Readonly` toDisposeOnIcon

toDisposeOnIcon: DisposableCollection = ...

`Protected` `Readonly` toHide

toHide: DisposableCollection = ...

`Protected` transparentOverlay

transparentOverlay: HTMLElement

viewState

viewState: WebviewPanelViewState = ...

viewType

viewType: string

`Static` FACTORY_ID

FACTORY_ID: string = 'plugin-custom-editor'

`Static` `Readonly` SIDE_BY_SIDE_FACTORY_ID

SIDE_BY_SIDE_FACTORY_ID: string = ...

Accessors

badge

get badge(): undefined | number
Returns undefined | number
Inherited from WebviewWidget.badge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:242
set badge(badge): void
Parameters
- badge: undefined | number
Returns void
Inherited from WebviewWidget.badge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:246

badgeTooltip

get badgeTooltip(): undefined | string
Returns undefined | string
Inherited from WebviewWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:251
set badgeTooltip(badgeTooltip): void
Parameters
- badgeTooltip: undefined | string
Returns void
Inherited from WebviewWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:255

contentOptions

get contentOptions(): WebviewContentOptions
Returns WebviewContentOptions
Inherited from WebviewWidget.contentOptions
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:177

modelRef

get modelRef(): Reference<undefined | CustomEditorModel>
Returns Reference<undefined | CustomEditorModel>
Implementation of CustomEditorWidgetShape.modelRef
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:36
set modelRef(modelRef): void
Parameters
- modelRef: Reference<CustomEditorModel>
Returns void
Implementation of CustomEditorWidgetShape.modelRef
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:39

onDidChangeBadge

get onDidChangeBadge(): Event<void>
Returns Event<void>
Inherited from WebviewWidget.onDidChangeBadge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:234

onDidChangeBadgeTooltip

get onDidChangeBadgeTooltip(): Event<void>
Returns Event<void>
Inherited from WebviewWidget.onDidChangeBadgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:238

saveable

get saveable(): Saveable
Returns Saveable
Implementation of SaveableSource.saveable
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:48

state

get state(): undefined | string
Returns undefined | string
Inherited from WebviewWidget.state
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:182

Methods

createMoveToUri

createMoveToUri(resourceUri): undefined | URI
Parameters
- resourceUri: URI
Returns undefined | URI
Implementation of NavigatableWidget.createMoveToUri
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:93

`Protected` dispatchMouseEvent

dispatchMouseEvent(type, data): void
Parameters
- type: string
- data: MouseEvent
Returns void
Inherited from WebviewWidget.dispatchMouseEvent
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:390

`Protected` doHide

doHide(): void
Returns void
Inherited from WebviewWidget.doHide
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:286

`Private` doMove

doMove(target): void
Parameters
- target: URI
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:116

`Protected` doSend

doSend(channel, data?): Promise<void>
Parameters
- channel: string
- Optional data: any
Returns Promise<void>
Inherited from WebviewWidget.doSend
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:650

`Protected` getRedirect

getRedirect(url): Promise<undefined | string>
Parameters
- url: string
Returns Promise<undefined | string>
Inherited from WebviewWidget.getRedirect
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:414

getResourceUri

getResourceUri(): undefined | URI
Returns undefined | URI
Implementation of NavigatableWidget.getResourceUri
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:89

handleContextMenu

handleContextMenu(event): void
Parameters
- event: {
      clientX: number;
      clientY: number;
      context: any;
  }
  - clientX: number
  - clientY: number
  - context: any
Returns void
Inherited from WebviewWidget.handleContextMenu
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:399

`Protected` init

init(): void
Returns void
Overrides WebviewWidget.init
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:59

`Protected` loadLocalhost

loadLocalhost(origin): Promise<void>
Parameters
- origin: string
Returns Promise<void>
Inherited from WebviewWidget.loadLocalhost
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:385

`Protected` loadResource

loadResource(requestPath, requestQuery?): Promise<void>
Parameters
- requestPath: string
- requestQuery: string = ''
Returns Promise<void>
Inherited from WebviewWidget.loadResource
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:545

`Protected` normalizeRequestUri

normalizeRequestUri(requestPath): URI
Parameters
- requestPath: string
Returns URI
Inherited from WebviewWidget.normalizeRequestUri
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:590

`Protected` on

on<T>(channel, handler): Disposable
Type Parameters
- T = unknown
Parameters
- channel: WebviewMessageChannels
- handler: ((data) => void)
  - - (data): void
    - Parameters
      data: T
      Returns void
Returns Disposable
Inherited from WebviewWidget.on
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:673

`Protected` onActivateRequest

onActivateRequest(msg): void
Parameters
- msg: Message
Returns void
Implementation of CustomEditorWidgetShape.onActivateRequest
Inherited from WebviewWidget.onActivateRequest
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:495

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Implementation of CustomEditorWidgetShape.onAfterAttach
Inherited from WebviewWidget.onAfterAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:267

`Protected` onAfterHide

onAfterHide(msg): void
Parameters
- msg: Message
Returns void
Implementation of CustomEditorWidgetShape.onAfterHide
Inherited from WebviewWidget.onAfterHide
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:281

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Implementation of CustomEditorWidgetShape.onBeforeAttach
Inherited from WebviewWidget.onBeforeAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:260

`Protected` onBeforeShow

onBeforeShow(msg): void
Parameters
- msg: Message
Returns void
Implementation of CustomEditorWidgetShape.onBeforeShow
Inherited from WebviewWidget.onBeforeShow
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:276

onMove

onMove(handler): void
Parameters
- handler: ((newResource) => Promise<void>)
  - - (newResource): Promise<void>
    - Parameters
      newResource: URI
      Returns Promise<void>
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:110

`Protected` openLink

openLink(link): void
Parameters
- link: URI
Returns void
Inherited from WebviewWidget.openLink
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:518

`Protected` postMessage

postMessage(channel, data?): void
Parameters
- channel: string
- Optional data: any
Returns void
Inherited from WebviewWidget.postMessage
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:662

`Protected` preprocessHtml

preprocessHtml(value): string
Parameters
- value: string
Returns string
Inherited from WebviewWidget.preprocessHtml
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:485

redo

redo(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:73

reload

reload(): void
Returns void
Inherited from WebviewWidget.reload
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:500

restoreState

restoreState(oldState): void
Parameters
- oldState: plugin-ext.State
Returns void
Overrides WebviewWidget.restoreState
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:104

save

save(options?): Promise<void>
Parameters
- Optional options: SaveOptions
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:77

saveAs

saveAs(source, target, options?): Promise<void>
Parameters
- source: URI
- target: URI
- Optional options: SaveOptions
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:81

sendMessage

sendMessage(data): void
Parameters
- data: any
Returns void
Inherited from WebviewWidget.sendMessage
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:607

setContentOptions

setContentOptions(contentOptions): void
Parameters
- contentOptions: WebviewContentOptions
Returns void
Inherited from WebviewWidget.setContentOptions
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:445

setHTML

setHTML(value): void
Parameters
- value: string
Returns void
Inherited from WebviewWidget.setHTML
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:480

setIconUrl

setIconUrl(iconUrl): void
Parameters
- iconUrl: undefined | IconUrl
Returns void
Inherited from WebviewWidget.setIconUrl
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:455

setIframeHeight

setIframeHeight(height): void
Parameters
- height: number
Returns void
Inherited from WebviewWidget.setIframeHeight
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:644

storeState

storeState(): plugin-ext.State
Returns plugin-ext.State
Overrides WebviewWidget.storeState
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:97

`Protected` style

style(): void
Returns void
Inherited from WebviewWidget.style
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:513

`Protected` toEndpoint

toEndpoint(pathname): string
Parameters
- pathname: string
Returns string
Inherited from WebviewWidget.toEndpoint
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:476

`Protected` toRemoteUrl

toRemoteUrl(localUri): Promise<string>
Parameters
- localUri: URI
Returns Promise<string>
Inherited from WebviewWidget.toRemoteUrl
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:436

`Protected` toSupportedLink

toSupportedLink(link): undefined | URI
Parameters
- link: URI
Returns undefined | URI
Inherited from WebviewWidget.toSupportedLink
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:525

`Protected` trace

trace(kind, channel, data?): void
Parameters
- kind: "in" | "out"
- channel: string
- Optional data: any
Returns void
Inherited from WebviewWidget.trace
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:689

undo

undo(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/custom-editors/custom-editor-widget.ts:69

Class CustomEditorWidget

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CustomEditorWidget

Properties

Protected Optional _badge

Protected Optional _badgeTooltip

Protected _contentOptions

Protected _modelRef

Private Optional _moveHandler

Type declaration

Parameters

Returns void

Protected _state

Protected Readonly contextKeyService

Protected Readonly contextMenuRenderer

Protected Readonly delegatingSaveable

Protected element

Protected Readonly environment

Readonly externalEndpoint

Protected Readonly externalUriService

Protected Readonly fileService

Protected hideTimeout

Protected html

Protected iconUrl

id

Readonly identifier

isExtractable

Protected Readonly keybindings

Protected Readonly mouseTracker

Protected onDidChangeBadgeEmitter

Protected onDidChangeBadgeTooltipEmitter

Readonly onMessage

Protected Readonly onMessageEmitter

Protected Readonly openerService

options

Protected Readonly outputManager

Protected Readonly pendingMessages

Protected Readonly preferences

Protected ready

resource

Protected Readonly resourceCache

Protected Readonly saveService

secondaryWindow

Protected Readonly sharedStyle

Protected Readonly shell

Protected Readonly themeDataProvider

Protected Readonly toDisposeOnIcon

Protected Readonly toHide

Protected transparentOverlay

viewState

viewType

Static FACTORY_ID

Static Readonly SIDE_BY_SIDE_FACTORY_ID

Accessors

badge

Returns undefined | number

Parameters

Returns void

badgeTooltip

Returns undefined | string

Parameters

Returns void

contentOptions

Returns WebviewContentOptions

modelRef

Returns Reference<undefined | CustomEditorModel>

Parameters

Returns void

onDidChangeBadge

Returns Event<void>

onDidChangeBadgeTooltip

`Protected` `Optional` _badge

`Protected` `Optional` _badgeTooltip

`Protected` _contentOptions

`Protected` _modelRef

`Private` `Optional` _moveHandler

`Protected` _state

`Protected` `Readonly` contextKeyService

`Protected` `Readonly` contextMenuRenderer

`Protected` `Readonly` delegatingSaveable

`Protected` element

`Protected` `Readonly` environment

`Readonly` externalEndpoint

`Protected` `Readonly` externalUriService

`Protected` `Readonly` fileService

`Protected` hideTimeout

`Protected` html

`Protected` iconUrl

`Readonly` identifier

`Protected` `Readonly` keybindings

`Protected` `Readonly` mouseTracker

`Protected` onDidChangeBadgeEmitter

`Protected` onDidChangeBadgeTooltipEmitter

`Readonly` onMessage

`Protected` `Readonly` onMessageEmitter

`Protected` `Readonly` openerService

`Protected` `Readonly` outputManager

`Protected` `Readonly` pendingMessages

`Protected` `Readonly` preferences

`Protected` ready

`Protected` `Readonly` resourceCache

`Protected` `Readonly` saveService

`Protected` `Readonly` sharedStyle

`Protected` `Readonly` shell

`Protected` `Readonly` themeDataProvider

`Protected` `Readonly` toDisposeOnIcon

`Protected` `Readonly` toHide

`Protected` transparentOverlay

`Static` FACTORY_ID

`Static` `Readonly` SIDE_BY_SIDE_FACTORY_ID

`Protected` dispatchMouseEvent

`Protected` doHide

`Private` doMove

`Protected` doSend

`Protected` doShow

`Protected` doUpdateContent

`Protected` forceHide

`Protected` forwardConsoleLog

`Protected` getRedirect

`Protected` init

`Protected` loadLocalhost

`Protected` loadResource

`Protected` normalizeRequestUri

`Protected` on

`Protected` onActivateRequest

`Protected` onAfterAttach

`Protected` onAfterHide

`Protected` onBeforeAttach

`Protected` onBeforeShow