Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomEditorWidget

Hierarchy

Implements

  • SaveableSource
  • NavigatableWidget

Index

Constructors

constructor

  • Construct a new widget.

    Parameters

    • Optional options: IOptions

      The options for initializing the widget.

    Returns CustomEditorWidget

Properties

Protected _contentOptions

_contentOptions: WebviewContentOptions = {}

Protected _modelRef

_modelRef: Reference<CustomEditorModel>

Private Optional _moveHandler

_moveHandler: (newResource: default) => void

Type declaration

    • (newResource: default): void
    • Parameters

      • newResource: default

      Returns void

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 | string | { dark: string; light: string }

id

id: string

Readonly identifier

Protected Readonly keybindings

keybindings: KeybindingRegistry

Protected Readonly mouseTracker

mouseTracker: ApplicationShellMouseTracker

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onMessage

onMessage: Event<any> = ...

Protected Readonly onMessageEmitter

onMessageEmitter: Emitter<any> = ...

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly openerService

openerService: OpenerService

options

options: WebviewPanelOptions = {}

Protected Readonly outputManager

outputManager: OutputChannelManager

Protected Readonly pendingMessages

pendingMessages: any[] = []

Protected Readonly preferences

preferences: PreferenceProxy<WebviewConfiguration>

Protected ready

ready: Deferred<void> = ...

resource

resource: default

Protected Readonly resourceCache

resourceCache: WebviewResourceCache

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly sharedStyle

sharedStyle: PluginSharedStyle

Protected Readonly themeDataProvider

themeDataProvider: WebviewThemeDataProvider

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeOnIcon

toDisposeOnIcon: DisposableCollection = ...

Protected Readonly toHide

toHide: DisposableCollection = ...

Protected transparentOverlay

transparentOverlay: HTMLElement

Protected Readonly undoRedoService

undoRedoService: UndoRedoService

viewColumn

viewColumn: ViewColumn

viewState

viewState: WebviewPanelViewState = ...

viewType

viewType: string

Static FACTORY_ID

FACTORY_ID: string = 'plugin-custom-editor'

Accessors

contentOptions

modelRef

saveable

  • get saveable(): Saveable

state

  • get state(): undefined | string

Methods

Protected addClipboardListener

  • addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void
  • Type parameters

    • K: "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>

    Returns void

Protected addEventListener

  • addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>
    • Optional useCapture: boolean

    Returns void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object
        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

clearFlag

  • clearFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

createMoveToUri

  • createMoveToUri(resourceUri: default): undefined | default

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void
  • Parameters

    • scrollContainer: HTMLElement

    Returns void

Protected dispatchMouseEvent

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

dispose

  • dispose(): void
  • Returns void

Protected doHide

  • doHide(): void

Private doMove

  • doMove(target: default): 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>

getResourceUri

  • getResourceUri(): undefined | default

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>
  • Returns MaybePromise<HTMLElement>

Protected init

  • init(): void

Protected loadLocalhost

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

Protected loadResource

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

Protected normalizeRequestUri

  • normalizeRequestUri(requestPath: string): default

Protected on

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

onMove

  • onMove(handler: (newResource: default) => Promise<void>): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected openLink

  • openLink(link: default): void

Protected postMessage

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

Protected preprocessHtml

  • preprocessHtml(value: string): string

redo

  • redo(): void

reload

  • reload(): void

restoreState

  • restoreState(oldState: State): void

save

  • save(options?: SaveOptions): Promise<void>

saveAs

  • saveAs(source: default, target: default, options?: SaveOptions): Promise<void>

sendMessage

  • sendMessage(data: any): void

setContentOptions

setFlag

  • setFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

setHTML

  • setHTML(value: string): void

setIconUrl

  • setIconUrl(iconUrl: undefined | string | { dark: string; light: string }): void

storeState

Protected style

  • style(): void

Protected toEndpoint

  • toEndpoint(pathname: string): string

Protected toRemoteUrl

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

Protected toSupportedLink

  • toSupportedLink(link: default): undefined | default

Protected trace

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

undo

  • undo(): void