Theia API Documentation v1.66.0
    Preparing search index...

    Class TerminalWidgetImpl

    Terminal UI widget.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    _markdownRenderer _terminalDOMId _terminalId closeOnDispose colorRegistry connectionProvider contextMenuRenderer copyOnSelectionHandler deviceStatusCodes enhancedPreviewNode exitStatus fitAddon initialData isAttachedCloseListener isExtractable lastCwd lastMousePosition lastTouchEnd linkHover linkHoverButton location logger markdownRendererFactory needsResize node onData onDataEmitter onDidChangeVisibility onDidChangeVisibilityEmitter onDidDispose onDidDisposeEmitter onDidOpen onDidOpenEmitter onDidOpenFailure onDidOpenFailureEmitter onKey onKeyEmitter onMouseEnterLinkHover onMouseEnterLinkHoverEmitter onMouseLeaveLinkHover onMouseLeaveLinkHoverEmitter onOutput onOutputEmitter onScrollUp onScrollUpEmitter onScrollYReachEnd onScrollYReachEndEmitter onShellTypeChanged onShellTypeChangedEmiter onSizeChanged onSizeChangedEmitter onTermDidClose options preferences resizeTerminal restored scrollBar? scrollOptions? searchBox secondaryWindow shellCommandBuilder shellTerminalServer shown styleElement term terminalContributionProvider terminalKind terminalSearchBoxFactory terminalService terminalWatcher termOpened themeService toDispose toDisposeOnConnect toDisposeOnDetach waitForConnection workspaceService LABEL

    Accessors

    buffer copyOnSelection cwd dataset dimensions disposed enableCopy enablePaste envVarCollectionDescriptionsByExtension hiddenFromUser hiddenMode id isAttached isDisposed isHidden isVisible kind lastTouchEndEvent layout markdownRenderer onTerminalDidClose parent processId processInfo shellPreferences terminalId title transient

    Methods

    activate addClass addClipboardListener addEventListener addKeyListener addUpdateListener attachCustomKeyEventHandler attachTerminal children clearFlag clearOutput close connectTerminalProcess contains createTerminal customKeyHandler disableScrollBarFocus dispose doResizeTerminal executeCommand fit getEnhancedPreviewNode getPreviewNode getScrollContainer getSearchBox getTerminal handleVisiblityChanged hasChildProcesses hasClass hide hideLinkHover init initializeLinkHover linkHoverMessage notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onDispose onFitRequest onResize onUpdateRequest open processMessage reconnectTerminalProcess removeClass resetTerminal resize resizeTerminalProcess restoreState scrollLineDown scrollLineUp scrollPageDown scrollPageUp scrollToBottom scrollToTop selectAll sendText setFlag setHidden setIconClass setTitle show showLinkHover start storeState testFlag toggleClass update updateConfig waitOnExit write writeLine

    Constructors

    Properties

    Protected_markdownRenderer

    _markdownRenderer: undefined | MarkdownRenderer

    Readonly_terminalDOMId

    _terminalDOMId: string

    Protected_terminalId

    _terminalId: number = -1
    closeOnDispose: boolean = true
    colorRegistry: ColorRegistry
    connectionProvider: ServiceConnectionProvider
    contextMenuRenderer: ContextMenuRenderer
    copyOnSelectionHandler: TerminalCopyOnSelectionHandler
    deviceStatusCodes: Set<string> = ...

    Device status code emitted by Xterm.js Check: https://github.com/xtermjs/xterm.js/blob/release/3.14/src/InputHandler.ts#L1055-L1082

    enhancedPreviewNode: undefined | Node
    exitStatus: undefined | TerminalExitStatus
    fitAddon: FitAddon
    initialData: string = ''
    isAttachedCloseListener: boolean = false
    isExtractable: boolean = true

    Set to true to mark the widget to be extractable.

    lastCwd: URI = ...

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

    lastMousePosition: undefined | { x: number; y: number }
    lastTouchEnd: undefined | TouchEvent
    linkHover: HTMLDivElement
    linkHoverButton: HTMLAnchorElement
    location: TerminalLocationOptions

    The position of the terminal widget.

    logger: ILogger
    markdownRendererFactory: MarkdownRendererFactory
    needsResize: boolean = true
    node: HTMLElement

    Get the DOM node owned by the widget.

    onData: Event<string> = ...

    Event that fires when the terminal input data

    onDataEmitter: Emitter<string> = ...
    onDidChangeVisibility: Event<boolean>
    onDidChangeVisibilityEmitter: Emitter<boolean>
    onDidDispose: Event<void>
    onDidDisposeEmitter: Emitter<void>
    onDidOpen: Event<void> = ...

    Event that fires when the terminal is connected or reconnected

    onDidOpenEmitter: Emitter<void> = ...
    onDidOpenFailure: Event<void> = ...

    Event that fires when the terminal fails to connect or reconnect

    onDidOpenFailureEmitter: Emitter<void> = ...
    onKey: Event<{ domEvent: KeyboardEvent; key: string }> = ...

    Event that fires when the terminal receives a key event.

    onKeyEmitter: Emitter<{ domEvent: KeyboardEvent; key: string }> = ...
    onMouseEnterLinkHover: Event<MouseEvent> = ...
    onMouseEnterLinkHoverEmitter: Emitter<MouseEvent> = ...
    onMouseLeaveLinkHover: Event<MouseEvent> = ...
    onMouseLeaveLinkHoverEmitter: Emitter<MouseEvent> = ...
    onOutput: Event<string> = ...
    onOutputEmitter: Emitter<string> = ...
    onScrollUp: Event<void>
    onScrollUpEmitter: Emitter<void>
    onScrollYReachEnd: Event<void>
    onScrollYReachEndEmitter: Emitter<void>
    onShellTypeChanged: Event<string> = ...

    Event that fires when the terminal shell type is changed

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

    Event that fires when the terminal size changed

    onSizeChangedEmitter: Emitter<{ cols: number; rows: number }> = ...
    onTermDidClose: Emitter<TerminalWidget> = ...
    options: TerminalWidgetOptions
    preferences: TerminalPreferences
    resizeTerminal: (...arguments: []) => Promise<void> = ...
    restored: boolean = false
    scrollBar?: PerfectScrollbar
    scrollOptions?: Options
    searchBox: TerminalSearchWidget
    secondaryWindow: undefined | Window

    The secondary window that the window was extracted to or undefined if it is not yet extracted.

    shellCommandBuilder: ShellCommandBuilder
    shellTerminalServer: ShellTerminalServerProxy
    shown: boolean = false
    styleElement: undefined | HTMLStyleElement
    term: Terminal
    terminalContributionProvider: ContributionProvider<TerminalContribution>
    terminalKind: string = 'user'
    terminalSearchBoxFactory: TerminalSearchWidgetFactory
    terminalService: TerminalService
    terminalWatcher: TerminalWatcher
    termOpened: boolean = false
    themeService: TerminalThemeService
    toDispose: DisposableCollection
    toDisposeOnConnect: DisposableCollection = ...
    toDisposeOnDetach: DisposableCollection
    waitForConnection: undefined | Deferred<Channel>
    workspaceService: WorkspaceService
    LABEL: string = ...

    Accessors

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

    • get disposed(): ISignal<this, void>

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get envVarCollectionDescriptionsByExtension(): Promise<
          Map<string, (undefined | string | MarkdownString)[]>,
      >

      The ids of extensions contributing to the environment of this terminal mapped to the provided description for their changes.

      Returns Promise<Map<string, (undefined | string | MarkdownString)[]>>

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • get isAttached(): boolean

      Test whether the widget's node is attached to the DOM.

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      Test whether the widget is visible.

      A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      Set the layout for the widget.

      The layout is single-use only. It cannot be changed after the first assignment.

      The layout is disposed automatically when the widget is disposed.

      Parameters

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      Set the parent of the widget.

      Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

      The widget will be automatically removed from its old parent.

      This is a no-op if there is no effective parent change.

      Parameters

      Returns void

    • get title(): Title<Widget>

      The title object for the widget.

      The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

      Since not all widgets will use the title, it is created on demand.

      The owner property of the title is set to this widget.

      Returns Title<Widget>

    Methods

    • Post an 'activate-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        The class name to add to the node.

        If the class name is already added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • element: HTMLElement
      • type: K
      • OptionaluseCapture: boolean

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      A new iterator over the children of the widget.

      The widget must have a populated layout in order to have children.

      If a layout is not installed, the returned iterator will be empty.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Send a 'close-request' message to the widget.

      This is a simple convenience method for sending the message.

      Returns void

    • Test whether a widget is a descendant of this widget.

      Parameters

      • widget: Widget

        The descendant widget of interest.

      Returns boolean

      true if the widget is a descendant, false otherwise.

    • Parameters

      • scrollContainer: HTMLElement

      Returns void

    • Post a 'fit-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Returns undefined | Node

    • Parameters

      • isNowVisible: boolean

      Returns void

    • Test whether the widget's DOM node has the given class name.

      Parameters

      • name: string

        The class name of interest.

      Returns boolean

      true if the node has the class, false otherwise.

    • Hide the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

      If the widget is explicitly hidden, this is a no-op.

      Returns void

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        The message to dispatch to the layout.

        This is a no-op if the widget does not have a layout.

        This will not typically be called directly by user code.

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        The class name to remove from the node.

        If the class name is not yet added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

      If the widget is not explicitly hidden, this is a no-op.

      Returns void

    • Parameters

      • invokeAction: (event: MouseEvent) => void
      • x: number
      • y: number
      • Optionalmessage: string

      Returns void

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: boolean

        Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

      Returns boolean

      true if the class is now present, false otherwise.

      The class name must not contain whitespace.

    • Post an 'update-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    _markdownRenderer_terminalDOMId_terminalIdcloseOnDisposecolorRegistryconnectionProvidercontextMenuRenderercopyOnSelectionHandlerdeviceStatusCodesenhancedPreviewNodeexitStatusfitAddoninitialDataisAttachedCloseListenerisExtractablelastCwdlastMousePositionlastTouchEndlinkHoverlinkHoverButtonlocationloggermarkdownRendererFactoryneedsResizenodeonDataonDataEmitteronDidChangeVisibilityonDidChangeVisibilityEmitteronDidDisposeonDidDisposeEmitteronDidOpenonDidOpenEmitteronDidOpenFailureonDidOpenFailureEmitteronKeyonKeyEmitteronMouseEnterLinkHoveronMouseEnterLinkHoverEmitteronMouseLeaveLinkHoveronMouseLeaveLinkHoverEmitteronOutputonOutputEmitteronScrollUponScrollUpEmitteronScrollYReachEndonScrollYReachEndEmitteronShellTypeChangedonShellTypeChangedEmiteronSizeChangedonSizeChangedEmitteronTermDidCloseoptionspreferencesresizeTerminalrestoredscrollBarscrollOptionssearchBoxsecondaryWindowshellCommandBuildershellTerminalServershownstyleElementtermterminalContributionProviderterminalKindterminalSearchBoxFactoryterminalServiceterminalWatchertermOpenedthemeServicetoDisposetoDisposeOnConnecttoDisposeOnDetachwaitForConnectionworkspaceServiceLABEL
    Accessors
    Methods
    activateaddClassaddClipboardListeneraddEventListeneraddKeyListeneraddUpdateListenerattachCustomKeyEventHandlerattachTerminalchildrenclearFlagclearOutputcloseconnectTerminalProcesscontainscreateTerminalcustomKeyHandlerdisableScrollBarFocusdisposedoResizeTerminalexecuteCommandfitgetEnhancedPreviewNodegetPreviewNodegetScrollContainergetSearchBoxgetTerminalhandleVisiblityChangedhasChildProcesseshasClasshidehideLinkHoverinitinitializeLinkHoverlinkHoverMessagenotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonDisposeonFitRequestonResizeonUpdateRequestopenprocessMessagereconnectTerminalProcessremoveClassresetTerminalresizeresizeTerminalProcessrestoreStatescrollLineDownscrollLineUpscrollPageDownscrollPageUpscrollToBottomscrollToTopselectAllsendTextsetFlagsetHiddensetIconClasssetTitleshowshowLinkHoverstartstoreStatetestFlagtoggleClassupdateupdateConfigwaitOnExitwritewriteLine