Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerminalWidgetImpl

Hierarchy

Implements

  • StatefulWidget

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new widget.

    Parameters

    • Optional options: IOptions

      The options for initializing the widget.

    Returns TerminalWidgetImpl

Properties

Protected _terminalId

_terminalId: number = -1

Protected closeOnDispose

closeOnDispose: boolean = true

Protected Readonly copyOnSelectionHandler

copyOnSelectionHandler: TerminalCopyOnSelectionHandler

Protected Readonly deviceStatusCodes

deviceStatusCodes: Set<string> = ...

Protected fitAddon

fitAddon: FitAddon

Protected hoverMessage

hoverMessage: HTMLDivElement

Readonly id

id: string

Protected initialData

initialData: string = ''

Protected isAttachedCloseListener

isAttachedCloseListener: boolean = false

lastCwd

lastCwd: default = ...

The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails

Protected lastTouchEnd

lastTouchEnd: undefined | TouchEvent

Protected Readonly logger

logger: ILogger

Protected needsResize

needsResize: boolean = true

Readonly onData

onData: Event<string> = ...

Event that fires when the terminal input data

Protected Readonly onDataEmitter

onDataEmitter: Emitter<string> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onDidOpen

onDidOpen: Event<void> = ...

Event that fires when the terminal is connected or reconnected

Protected Readonly onDidOpenEmitter

onDidOpenEmitter: Emitter<void> = ...

Readonly onDidOpenFailure

onDidOpenFailure: Event<void> = ...

Event that fires when the terminal fails to connect or reconnect

Protected Readonly onDidOpenFailureEmitter

onDidOpenFailureEmitter: Emitter<void> = ...

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Readonly onSizeChanged

onSizeChanged: Event<{ cols: number; rows: number }> = ...

Event that fires when the terminal size changed

Protected Readonly onSizeChangedEmitter

onSizeChangedEmitter: Emitter<{ cols: number; rows: number }> = ...

Protected Readonly onTermDidClose

onTermDidClose: Emitter<TerminalWidget> = ...

options

Protected Readonly preferences

preferences: PreferenceProxy<TerminalConfiguration>

Protected restored

restored: boolean = false

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected searchBox

Protected Readonly shellCommandBuilder

shellCommandBuilder: ShellCommandBuilder

Protected Readonly shellTerminalServer

shellTerminalServer: JsonRpcProxy<IShellTerminalServer>

Protected term

term: Terminal

Protected termOpened

termOpened: boolean = false

Protected Readonly terminalContributionProvider

terminalContributionProvider: ContributionProvider<TerminalContribution>

Protected terminalKind

terminalKind: string = 'user'

Protected Readonly terminalSearchBoxFactory

terminalSearchBoxFactory: TerminalSearchWidgetFactory

Protected Readonly terminalService

terminalService: TerminalService

Protected Readonly terminalWatcher

terminalWatcher: TerminalWatcher

Protected Readonly themeService

themeService: TerminalThemeService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnConnect

toDisposeOnConnect: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected waitForConnection

waitForConnection: undefined | Deferred<MessageConnection>

Protected Readonly webSocketConnectionProvider

webSocketConnectionProvider: WebSocketConnectionProvider

Protected Readonly workspaceService

workspaceService: WorkspaceService

Static LABEL

LABEL: string = ...

Accessors

Protected copyOnSelection

  • get copyOnSelection(): boolean

cwd

  • get cwd(): Promise<default>

dimensions

Protected enableCopy

  • get enableCopy(): boolean

Protected enablePaste

  • get enablePaste(): boolean

kind

  • get kind(): string

lastTouchEndEvent

  • get lastTouchEndEvent(): undefined | TouchEvent

onTerminalDidClose

processId

  • get processId(): Promise<number>

processInfo

Protected shellPreferences

terminalId

  • get terminalId(): number

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

Protected attachCustomKeyEventHandler

  • attachCustomKeyEventHandler(): void

Private attachPressEnterKeyToCloseListener

  • attachPressEnterKeyToCloseListener(term: Terminal): void

Protected attachTerminal

  • attachTerminal(id: number): Promise<number>

clearFlag

  • clearFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

clearOutput

  • clearOutput(): void

Protected connectTerminalProcess

  • connectTerminalProcess(): void

Protected createTerminal

  • createTerminal(): Promise<number>

Protected customKeyHandler

  • customKeyHandler(event: KeyboardEvent): boolean

Private disableEnterWhenAttachCloseListener

  • disableEnterWhenAttachCloseListener(): boolean

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

dispose

  • dispose(): void

executeCommand

  • executeCommand(commandOptions: CommandLineOptions): Promise<void>

Private getCursorStyle

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>

getSearchBox

getTerminal

  • getTerminal(): Terminal

Private getTerminalRendererType

hasChildProcesses

  • hasChildProcesses(): Promise<boolean>

hideHover

  • hideHover(): void

Protected init

  • init(): void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

onDispose

  • onDispose(onDispose: () => void): void

Protected onFitRequest

  • onFitRequest(msg: Message): void

Protected onResize

  • onResize(msg: ResizeMessage): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

Protected open

  • open(): void

processMessage

  • processMessage(msg: Message): void

Protected reconnectTerminalProcess

  • reconnectTerminalProcess(): Promise<void>

resetTerminal

  • resetTerminal(): void

resize

  • resize(cols: number, rows: number): void

Protected resizeTerminal

  • resizeTerminal(): void

Protected resizeTerminalProcess

  • resizeTerminalProcess(): void

restoreState

  • restoreState(oldState: object): void

scrollLineDown

  • scrollLineDown(): void

scrollLineUp

  • scrollLineUp(): void

scrollPageDown

  • scrollPageDown(): void

scrollPageUp

  • scrollPageUp(): void

scrollToBottom

  • scrollToBottom(): void

scrollToTop

  • scrollToTop(): void

sendText

  • sendText(text: string): void

setFlag

  • setFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

setTitle

  • setTitle(title: string): void

showHoverMessage

  • showHoverMessage(x: number, y: number, message: string): void

start

  • start(id?: number): Promise<number>

storeState

  • storeState(): object

waitOnExit

  • waitOnExit(waitOnExit?: string | boolean): void

write

  • write(data: string): void

writeLine

  • writeLine(text: string): void

Static getFollowLinkHover

  • getFollowLinkHover(): string