Class TypeHierarchyContribution

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

Hierarchy (View Summary)

AbstractViewContribution<TypeHierarchyTreeWidget>
- TypeHierarchyContribution

Constructors

constructor

new TypeHierarchyContribution(): TypeHierarchyContribution
Returns TypeHierarchyContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:52

Properties

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly`editorAccess

editorAccess: EditorAccess

`Protected`editorHasTypeHierarchyProvider

editorHasTypeHierarchyProvider: ContextKey<boolean>

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`typeHierarchyServiceProvider

typeHierarchyServiceProvider: TypeHierarchyServiceProvider

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

effectiveWidgetId

get effectiveWidgetId(): string
The widget ID used for shell operations — viewContainerId if set, otherwise widgetId.

Returns string
Inherited from AbstractViewContribution.effectiveWidgetId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

Methods

closeView

closeView(): Promise<undefined | TypeHierarchyTreeWidget>
Returns Promise<undefined | TypeHierarchyTreeWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:41

`Protected`getDirection

getDirection(
args?: Partial<TypeHierarchyOpenViewArguments>,
): TypeHierarchyDirection
Extracts the type hierarchy direction from the argument. If the direction cannot be extracted, returns with the Children as the default type.
Parameters
- Optionalargs: Partial<TypeHierarchyOpenViewArguments>
Returns TypeHierarchyDirection
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:144

`Protected`init

init(): void
Returns void
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:65

`Protected`isEnabled

isEnabled(languageId?: undefined | string): boolean
Enabled if the current editor has the languageId or the Type Hierarchy widget is the active one.
Parameters
- languageId: undefined | string = ...
Returns boolean
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:137

`Protected`isTypeHierarchyAvailable

isTypeHierarchyAvailable(): boolean
Returns boolean
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:71

openView

openView(
args?: Partial<TypeHierarchyOpenViewArguments>,
): Promise<TypeHierarchyTreeWidget>
Parameters
- Optionalargs: Partial<TypeHierarchyOpenViewArguments>
Returns Promise<TypeHierarchyTreeWidget>
Overrides AbstractViewContribution.openView
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:76

`Protected`openViewOrFlipHierarchyDirection

openViewOrFlipHierarchyDirection(
direction: TypeHierarchyDirection,
): Promise<void>
Flips the hierarchy direction in the Type Hierarchy view, if it is active and has a valid root. Otherwise, calculates the type hierarchy based on the selection of the current editor.
Parameters
- direction: TypeHierarchyDirection
Returns Promise<void>
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:119

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:84

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:107

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/typehierarchy/src/browser/typehierarchy-contribution.ts:96

toggleView

toggleView(): Promise<TypeHierarchyTreeWidget>
Returns Promise<TypeHierarchyTreeWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:42

tryGetWidget

tryGetWidget(): undefined | TypeHierarchyTreeWidget
Returns undefined | TypeHierarchyTreeWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:38

Class TypeHierarchyContribution

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TypeHierarchyContribution

Properties

Protected ReadonlycontextKeyService

Protected ReadonlyeditorAccess

ProtectededitorHasTypeHierarchyProvider

Protected ReadonlyeditorManager

Protected Readonlyoptions

Protected ReadonlyquickView

Protected Readonlyshell

Optional ReadonlytoggleCommand

Protected ReadonlytypeHierarchyServiceProvider

Protected ReadonlywidgetManager

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

effectiveWidgetId

Returns string

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

closeView

Returns Promise<undefined | TypeHierarchyTreeWidget>

ProtectedgetDirection

Parameters

Returns TypeHierarchyDirection

Protectedinit

Returns void

ProtectedisEnabled

Parameters

Returns boolean

ProtectedisTypeHierarchyAvailable

Returns boolean

openView

Parameters

Returns Promise<TypeHierarchyTreeWidget>

ProtectedopenViewOrFlipHierarchyDirection

Parameters

Returns Promise<void>

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

toggleView

Returns Promise<TypeHierarchyTreeWidget>

tryGetWidget

Returns undefined | TypeHierarchyTreeWidget

Settings

On This Page

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`editorAccess

`Protected`editorHasTypeHierarchyProvider

`Protected` `Readonly`editorManager

`Protected` `Readonly`options

`Protected` `Readonly`quickView

`Protected` `Readonly`shell

`Optional` `Readonly`toggleCommand

`Protected` `Readonly`typeHierarchyServiceProvider

`Protected` `Readonly`widgetManager

`Protected`getDirection

`Protected`init

`Protected`isEnabled

`Protected`isTypeHierarchyAvailable

`Protected`openViewOrFlipHierarchyDirection