Class PluginViewWidget

Hierarchy

Panel
- PluginViewWidget

Implements

StatefulWidget
DescriptionWidget
BadgeWidget
DynamicToolbarWidget

Constructors

constructor

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

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
Returns undefined | number
Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:157
set badge(badge): void
Parameters
- badge: undefined | number
Returns void
Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:165

badgeTooltip

get badgeTooltip(): undefined | string
Returns undefined | string
Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:170
set badgeTooltip(badgeTooltip): void
Parameters
- badgeTooltip: undefined | string
Returns void
Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:178

description

get description(): string
Returns string
Implementation of DescriptionWidget.description
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:148
set description(description): void
Parameters
- description: string
Returns void
Implementation of DescriptionWidget.description
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:152

message

get message(): undefined | string
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:139
set message(message): void
Parameters
- message: undefined | string
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:143

onDidChangeBadge

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

onDidChangeBadgeTooltip

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

onDidChangeDescription

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

onDidChangeToolbarItems

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

suppressUpdateViewVisibility

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

Methods

addWidget

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

dispose

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

`Protected` init

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

insertWidget

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

`Protected` onActivateRequest

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

restoreState

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

storeState

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

updateViewVisibility

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

`Private` updateWidgetMessage

updateWidgetMessage(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/view/plugin-view-widget.ts:183

Class PluginViewWidget

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

Returns void

badgeTooltip

Returns undefined | string

Parameters

Returns void

description

Returns string

Parameters

Returns void

message

Returns undefined | string

Parameters

Returns void

onDidChangeBadge

Returns Event<void>

onDidChangeBadgeTooltip

Returns Event<void>

onDidChangeDescription

Returns Event<void>

onDidChangeToolbarItems

Returns Event<void>

suppressUpdateViewVisibility

Parameters

Returns void

Methods

addWidget

Parameters

Returns void

dispose

Returns void

Protected init

Returns void

insertWidget

Parameters

Returns void

Protected onActivateRequest

Parameters

Returns void

restoreState

Parameters

Returns void

storeState

Returns plugin-ext.State

updateViewVisibility

Parameters

Returns void

Returns void

Private updateWidgetMessage

`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

`Protected` init

`Protected` onActivateRequest

`Private` updateWidgetMessage