PluginWidget | Theia TypeDoc

Hierarchy

ReactWidget
- PluginWidget

Index

Constructors

constructor

Properties

Constructors

constructor

new PluginWidget(): PluginWidget

Overrides ReactWidget.constructor
- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:35
Returns PluginWidget

Properties

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Protected Readonly onRender

onRender: DisposableCollection

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly pluginService

pluginService: HostedPluginSupport

Protected Readonly progressBarFactory

progressBarFactory: ProgressBarFactory

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeProgress

toDisposeProgress: DisposableCollection = ...

Methods

Protected addClipboardListener

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

Inherited from ReactWidget.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 ReactWidget.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 ReactWidget.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 ReactWidget.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

clearFlag

clearFlag(flag: Flag): void

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

Protected compareMetadata

compareMetadata(a: PluginMetadata, b: PluginMetadata): number

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:116
Compare two plugins based on their names, and publishers.

Parameters
- a: PluginMetadata
  
  the first plugin metadata.
- b: PluginMetadata
  
  the second plugin metadata.
Returns number

Protected createPluginClassName

createPluginClassName(plugin: PluginMetadata): string

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:106
Parameters
- plugin: PluginMetadata
Returns string

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

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

dispose

dispose(): void

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

Protected doRender

doRender(): ReactNode

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:72
Returns ReactNode

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

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

Protected init

init(): void

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:51
Returns void

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides ReactWidget.onActivateRequest
- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:55
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Inherited from ReactWidget.onAfterAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:76
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

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

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from ReactWidget.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 ReactWidget.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 ReactWidget.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

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

Protected render

render(): ReactNode

Overrides ReactWidget.render
- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:62
Returns ReactNode

Private renderPlugin

renderPlugin(plugin: PluginMetadata): Element

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:86
Parameters
- plugin: PluginMetadata
Returns Element

Protected renderPlugins

renderPlugins(plugins: PluginMetadata[]): ReactNode

- Defined in packages/plugin-ext/src/main/browser/plugin-ext-widget.tsx:80
Parameters
- plugins: PluginMetadata[]
Returns ReactNode

setFlag

setFlag(flag: Flag): void

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginWidget

Properties

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Protected Readonly onRender

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Readonly pluginService

Protected Readonly progressBarFactory

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected Readonly toDisposeProgress

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

type: K

Optional useCapture: boolean

Returns void

clearFlag

Parameters

flag: Flag

Returns void

Protected compareMetadata

Parameters

a: PluginMetadata

b: PluginMetadata

Returns number

Protected createPluginClassName

Parameters

plugin: PluginMetadata

Returns string

Protected disableScrollBarFocus

Parameters

scrollContainer: HTMLElement

Returns void

dispose

Returns void

Protected doRender