Class AbstractViewContribution<T> Abstract

An abstract superclass for frontend contributions that add a view to the application shell.

Type Parameters

T extends Widget

Hierarchy

AbstractViewContribution

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AbstractViewContribution<T>(options: ViewContributionOptions): AbstractViewContribution<T>

- Defined in packages/core/src/browser/shell/view-contribution.ts:66
Type Parameters
- T extends Widget<T>
Parameters
- options: ViewContributionOptions
Returns AbstractViewContribution<T>

Properties

Protected Readonly options

options: ViewContributionOptions

Protected Readonly quickView

quickView: QuickViewService

Protected Readonly shell

shell: ApplicationShell

Optional Readonly toggleCommand

toggleCommand?: Command

Protected Readonly widgetManager

widgetManager: WidgetManager

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions

- Defined in packages/core/src/browser/shell/view-contribution.ts:85
Returns ApplicationShell.WidgetOptions

viewId

get viewId(): string

- Defined in packages/core/src/browser/shell/view-contribution.ts:77
Returns string

viewLabel

get viewLabel(): string

- Defined in packages/core/src/browser/shell/view-contribution.ts:81
Returns string

widget

get widget(): Promise<T>

- Defined in packages/core/src/browser/shell/view-contribution.ts:89
Returns Promise<T>

Methods

closeView

closeView(): Promise<undefined | T>

- Defined in packages/core/src/browser/shell/view-contribution.ts:148
Returns Promise<undefined | T>

openView

openView(args?: Partial<OpenViewArguments>): Promise<T>

- Defined in packages/core/src/browser/shell/view-contribution.ts:97
Parameters
- args: Partial<OpenViewArguments> = {}
Returns Promise<T>

registerCommands

registerCommands(commands: CommandRegistry): void

Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/browser/shell/view-contribution.ts:136
Parameters
- commands: CommandRegistry
Returns void

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void

Implementation of KeybindingContribution.registerKeybindings
- Defined in packages/core/src/browser/shell/view-contribution.ts:169
Parameters
- keybindings: KeybindingRegistry
Returns void

registerMenus

registerMenus(menus: MenuModelRegistry): void

Implementation of MenuContribution.registerMenus
- Defined in packages/core/src/browser/shell/view-contribution.ts:160
Parameters
- menus: MenuModelRegistry
Returns void

toggleView

toggleView(): Promise<T>

- Defined in packages/core/src/browser/shell/view-contribution.ts:153
Returns Promise<T>

tryGetWidget

tryGetWidget(): undefined | T

- Defined in packages/core/src/browser/shell/view-contribution.ts:93
Returns undefined | T