Class WorkspaceVariableContribution

The variable contribution should be implemented to register custom variables.

Implements

VariableContribution

Index

Constructors

Properties

currentWidget fileService recentlyVisibleIds shell widgetManager workspaceService

Accessors

recentlyVisible

Methods

addRecentlyVisible getResourceUri getWorkspaceRelativePath getWorkspaceRootUri init registerVariables registerWorkspaceRootVariables removeRecentlyVisible updateCurrentWidget

Constructors

constructor

new WorkspaceVariableContribution(): WorkspaceVariableContribution
Returns WorkspaceVariableContribution

Properties

`Protected`currentWidget

currentWidget: undefined | NavigatableWidget

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`recentlyVisibleIds

recentlyVisibleIds: string[] = []

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

`Protected`recentlyVisible

get recentlyVisible(): undefined | NavigatableWidget
Returns undefined | NavigatableWidget
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:67

Methods

`Protected`addRecentlyVisible

addRecentlyVisible(widget: NavigatableWidget): void
Parameters
- widget: NavigatableWidget
Returns void
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:75

getResourceUri

getResourceUri(): undefined | URI
Returns undefined | URI
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:212

getWorkspaceRelativePath

getWorkspaceRelativePath(uri: URI, context?: URI): undefined | string
Parameters
- uri: URI
- Optionalcontext: URI
Returns undefined | string
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:216

getWorkspaceRootUri

getWorkspaceRootUri(uri?: undefined | URI): undefined | URI
Parameters
- uri: undefined | URI = ...
Returns undefined | URI
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:208

`Protected`init

init(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:40

registerVariables

registerVariables(variables: VariableRegistry): void
Parameters
- variables: VariableRegistry
Returns void
Implementation of VariableContribution.registerVariables
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:95

`Protected`registerWorkspaceRootVariables

registerWorkspaceRootVariables(variables: VariableRegistry): void
Parameters
- variables: VariableRegistry
Returns void
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:140

`Protected`removeRecentlyVisible

removeRecentlyVisible(widget: NavigatableWidget): void
Parameters
- widget: NavigatableWidget
Returns void
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:79

`Protected`updateCurrentWidget

updateCurrentWidget(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-variable-contribution.ts:86