OutputWidget | Theia TypeDoc

Hierarchy

BaseWidget
- OutputWidget

Implements

StatefulWidget

Index

Constructors

constructor

Accessors

Constructors

constructor

new OutputWidget(): OutputWidget

Overrides BaseWidget.constructor
- Defined in packages/output/src/browser/output-widget.ts:50
Returns OutputWidget

Properties

Protected _state

_state: State = ...

Protected Readonly editorContainer

editorContainer: DockPanel

Protected Readonly editorProvider

editorProvider: MonacoEditorProvider

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly onStateChangedEmitter

onStateChangedEmitter: Emitter<State> = ...

Protected Readonly outputChannelManager

outputChannelManager: OutputChannelManager

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly selectionService

selectionService: SelectionService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeOnSelectedChannelChanged

toDisposeOnSelectedChannelChanged: DisposableCollection = ...

Static Readonly ID

ID: "outputView" = 'outputView'

Static Readonly LABEL

LABEL: string = ...

Accessors

Private editor

get editor(): undefined | MonacoEditor

- Defined in packages/output/src/browser/output-widget.ts:228
Returns undefined | MonacoEditor

Private editorWidget

get editorWidget(): undefined | EditorWidget

- Defined in packages/output/src/browser/output-widget.ts:219
Returns undefined | EditorWidget

isLocked

get isLocked(): boolean

- Defined in packages/output/src/browser/output-widget.ts:187
Returns boolean

onStateChanged

get onStateChanged(): Event<State>

- Defined in packages/output/src/browser/output-widget.ts:157
Returns Event<State>

Private selectedChannel

get selectedChannel(): undefined | OutputChannel

- Defined in packages/output/src/browser/output-widget.ts:206
Returns undefined | OutputChannel

Protected state

get state(): State
set state(state: State): void

- Defined in packages/output/src/browser/output-widget.ts:90
Returns State
- Defined in packages/output/src/browser/output-widget.ts:94
Parameters
- state: State
Returns void

Methods

Protected addClipboardListener

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

Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:83
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

Inherited from BaseWidget.addEventListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:81
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

Inherited from BaseWidget.addKeyListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:82
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

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:80
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

clear

clear(): void

- Defined in packages/output/src/browser/output-widget.ts:161
Returns void

clearFlag

clearFlag(flag: Flag): void

Inherited from BaseWidget.clearFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:85
Parameters
- flag: Flag
Returns void

Private createEditorWidget

createEditorWidget(): Promise<undefined | EditorWidget>

- Defined in packages/output/src/browser/output-widget.ts:210
Returns Promise<undefined | EditorWidget>

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/lib/browser/widgets/widget.d.ts:78
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from BaseWidget.dispose
- Defined in packages/core/lib/browser/widgets/widget.d.ts:71
Returns void

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/lib/browser/widgets/widget.d.ts:77
Returns MaybePromise<HTMLElement>

getText

getText(): undefined | string

- Defined in packages/output/src/browser/output-widget.ts:238
Returns undefined | string

Protected init

init(): void

- Defined in packages/output/src/browser/output-widget.ts:67
Returns void

lock

lock(): void

- Defined in packages/output/src/browser/output-widget.ts:179
Returns void

Protected onActivateRequest

onActivateRequest(message: Message): void

Overrides BaseWidget.onActivateRequest
- Defined in packages/output/src/browser/output-widget.ts:135
Parameters
- message: Message
Returns void

Protected onAfterAttach

onAfterAttach(message: Message): void

Overrides BaseWidget.onAfterAttach
- Defined in packages/output/src/browser/output-widget.ts:129
Parameters
- message: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:74
Parameters
- msg: Message
Returns void

Protected onAfterShow

onAfterShow(msg: Message): void

Overrides BaseWidget.onAfterShow
- Defined in packages/output/src/browser/output-widget.ts:152
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from BaseWidget.onBeforeAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:73
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:75
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onResize

onResize(message: ResizeMessage): void

Overrides BaseWidget.onResize
- Defined in packages/output/src/browser/output-widget.ts:144
Parameters
- message: ResizeMessage
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Inherited from BaseWidget.onUpdateRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:79
Parameters
- msg: Message
Returns void

Protected refreshEditorWidget

refreshEditorWidget(__namedParameters?: { preserveFocus: boolean }): Promise<void>

- Defined in packages/output/src/browser/output-widget.ts:99
Parameters
- __namedParameters: { preserveFocus: boolean } = ...
  - preserveFocus: boolean
Returns Promise<void>

restoreState

restoreState(oldState: object & Partial<State>): void

Implementation of StatefulWidget.restoreState
- Defined in packages/output/src/browser/output-widget.ts:82
Parameters
- oldState: object & Partial<State>
Returns void

Protected revealLastLine

revealLastLine(): void

- Defined in packages/output/src/browser/output-widget.ts:191
Returns void

selectAll

selectAll(): void

- Defined in packages/output/src/browser/output-widget.ts:167
Returns void

setFlag

setFlag(flag: Flag): void

Inherited from BaseWidget.setFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:84
Parameters
- flag: Flag
Returns void

storeState

storeState(): object

Implementation of StatefulWidget.storeState
- Defined in packages/output/src/browser/output-widget.ts:78
Returns object

unlock

unlock(): void

- Defined in packages/output/src/browser/output-widget.ts:183
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns OutputWidget

Properties

Protected _state

Protected Readonly editorContainer

Protected Readonly editorProvider

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Readonly onStateChangedEmitter

Protected Readonly outputChannelManager

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly selectionService

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected Readonly toDisposeOnSelectedChannelChanged

Static Readonly ID

Static Readonly LABEL

Accessors

Private editor

Returns undefined | MonacoEditor

Private editorWidget

Returns undefined | EditorWidget

isLocked

Returns boolean

onStateChanged

Returns Event<State>

Private selectedChannel

Returns undefined | OutputChannel

Protected state

Returns State

Parameters

state: State

Returns void

Methods

Protected addClipboardListener

Type parameters

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

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type parameters

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type parameters

Parameters

element: HTMLElement

keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]

action: (event: KeyboardEvent) => boolean | void | Object

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void

Protected addUpdateListener

Type parameters

Parameters

element: HTMLElement