PluginViewWidget | Theia TypeDoc

Hierarchy

Panel
- PluginViewWidget

Implements

StatefulWidget
DescriptionWidget
BadgeWidget
DynamicToolbarWidget

Constructors

constructor

new PluginViewWidget(): PluginViewWidget

Overrides Panel.constructor
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:67
Returns PluginViewWidget

Properties

Protected Optional _badge

_badge?: number

Protected Optional _badgeTooltip

_badgeTooltip?: string

Protected _description

_description: string = ''

Protected Optional _message

_message?: string

Protected _suppressUpdateViewVisibility

_suppressUpdateViewVisibility: boolean = false

Protected Readonly commands

commands: CommandRegistry

Protected Readonly contextKeyService

contextKeyService: ContextKeyService

Optional currentViewContainerId

currentViewContainerId?: string

Protected Readonly menus

menus: MenuModelRegistry

Protected onDidChangeBadgeEmitter

onDidChangeBadgeEmitter: Emitter<void> = ...

Protected onDidChangeBadgeTooltipEmitter

onDidChangeBadgeTooltipEmitter: Emitter<void> = ...

Protected onDidChangeDescriptionEmitter

onDidChangeDescriptionEmitter: Emitter<void> = ...

Protected Readonly onDidChangeToolbarItemsEmitter

onDidChangeToolbarItemsEmitter: Emitter<void> = ...

Readonly options

options: PluginViewWidgetIdentifier

Protected toDispose

toDispose: DisposableCollection = ...

Protected updatingViewVisibility

updatingViewVisibility: boolean = false

Accessors

badge

get badge(): undefined | number
set badge(badge: undefined | number): void

Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:158
Returns undefined | number
Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:166
Parameters
- badge: undefined | number
Returns void

badgeTooltip

get badgeTooltip(): undefined | string
set badgeTooltip(badgeTooltip: undefined | string): void

Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:171
Returns undefined | string
Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:179
Parameters
- badgeTooltip: undefined | string
Returns void

description

get description(): string
set description(description: string): void

Implementation of DescriptionWidget.description
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:149
Returns string
Implementation of DescriptionWidget.description
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:153
Parameters
- description: string
Returns void

message

get message(): undefined | string
set message(message: undefined | string): void

- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:140
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:144
Parameters
- message: undefined | string
Returns void

onDidChangeBadge

get onDidChangeBadge(): Event<void>

Implementation of BadgeWidget.onDidChangeBadge
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:85
Returns Event<void>

onDidChangeBadgeTooltip

get onDidChangeBadgeTooltip(): Event<void>

Implementation of BadgeWidget.onDidChangeBadgeTooltip
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:89
Returns Event<void>

onDidChangeDescription

get onDidChangeDescription(): Event<void>

Implementation of DescriptionWidget.onDidChangeDescription
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:81
Returns Event<void>

onDidChangeToolbarItems

get onDidChangeToolbarItems(): Event<void>

Implementation of DynamicToolbarWidget.onDidChangeToolbarItems
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:51
Returns Event<void>

suppressUpdateViewVisibility

set suppressUpdateViewVisibility(suppressUpdateViewVisibility: boolean): void

- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:124
Parameters
- suppressUpdateViewVisibility: boolean
Returns void

Methods

addWidget

addWidget(widget: Widget): void

Overrides Panel.addWidget
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:193
Parameters
- widget: Widget
Returns void

dispose

dispose(): void

Overrides Panel.dispose
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:209
Returns void

Protected init

init(): void

- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:74
Returns void

insertWidget

insertWidget(index: number, widget: Widget): void

Overrides Panel.insertWidget
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:203
Parameters
- index: number
- widget: Widget
Returns void

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides Panel.onActivateRequest
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:93
Parameters
- msg: Message
Returns void

restoreState

restoreState(state: PluginViewWidget.State): void

Implementation of StatefulWidget.restoreState
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:114
Parameters
- state: PluginViewWidget.State
Returns void

storeState

storeState(): PluginViewWidget.State

Implementation of StatefulWidget.storeState
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:104
Returns PluginViewWidget.State

updateViewVisibility

updateViewVisibility(cb: (() => void)): void

- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:128
Parameters
- cb: (() => void)
  - - (): void
    - Returns void
Returns void

Private updateWidgetMessage

updateWidgetMessage(): void

- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:184
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PluginViewWidget

Properties

Protected Optional _badge

Protected Optional _badgeTooltip

Protected _description

Protected Optional _message

Protected _suppressUpdateViewVisibility

Protected Readonly commands

Protected Readonly contextKeyService

Optional currentViewContainerId

Protected Readonly menus

Protected onDidChangeBadgeEmitter

Protected onDidChangeBadgeTooltipEmitter

Protected onDidChangeDescriptionEmitter

Protected Readonly onDidChangeToolbarItemsEmitter

Readonly options

Protected toDispose

Protected updatingViewVisibility

Accessors

badge

Returns undefined | number

Parameters

badge: undefined | number

Returns void

badgeTooltip

Returns undefined | string

Parameters

badgeTooltip: undefined | string

Returns void

description

Returns string

Parameters

description: string

Returns void

message

Returns undefined | string

Parameters

message: undefined | string

Returns void

onDidChangeBadge

Returns Event<void>

onDidChangeBadgeTooltip

Returns Event<void>

onDidChangeDescription

Returns Event<void>

onDidChangeToolbarItems

Returns Event<void>

suppressUpdateViewVisibility

Parameters

suppressUpdateViewVisibility: boolean

Returns void

Methods

addWidget

Parameters

widget: Widget

Returns void

dispose

Returns void

Protected init

Returns void

insertWidget

Parameters

index: number

widget: Widget

Returns void

Protected onActivateRequest

Parameters

msg: Message

Returns void

restoreState

Parameters