Class PerspectiveServiceImpl

The command contribution should be implemented to register custom commands and handler.

Implements

Index

Constructors

Properties

activePerspectiveId appContributions contextKeyService contributions defaultPerspectiveId logger onDidChangePerspective onDidChangePerspectiveEmitter perspectives quickInputService savedLayouts shell switchInProgress widgetAreaResolver widgetManager DEFAULT_PERSPECTIVE_ID RESET_PERSPECTIVE_COMMAND SWITCH_PERSPECTIVE_COMMAND

Constructors

constructor

new PerspectiveServiceImpl(): PerspectiveServiceImpl
Returns PerspectiveServiceImpl

Properties

`Protected`activePerspectiveId

activePerspectiveId: undefined | string

`Protected` `Readonly`appContributions

appContributions: ContributionProvider<FrontendApplicationContribution>

`Protected` `Readonly`contextKeyService

contextKeyService: undefined | ContextKeyService

`Protected` `Readonly`contributions

contributions: undefined | ContributionProvider<PerspectiveContribution>

`Readonly` `Internal`defaultPerspectiveId

defaultPerspectiveId: "default" = PerspectiveServiceImpl.DEFAULT_PERSPECTIVE_ID

The ID of the built-in default perspective. Plumbing API, used by ShellLayoutRestorer for legacy migration.

`Protected` `Readonly`logger

logger: ILogger

`Readonly`onDidChangePerspective

onDidChangePerspective: Event<string> = ...

Event fired whenever the active perspective changes. The payload is the new perspective ID.

`Protected` `Readonly`onDidChangePerspectiveEmitter

onDidChangePerspectiveEmitter: Emitter<string> = ...

`Protected` `Readonly`perspectives

perspectives: Map<string, PerspectiveDescriptor> = ...

`Protected` `Readonly`quickInputService

quickInputService: undefined | QuickInputService

`Protected` `Readonly`savedLayouts

savedLayouts: Map<string, ApplicationShell.LayoutData> = ...

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected`switchInProgress

switchInProgress: undefined | Promise<void>

`Protected` `Readonly`widgetAreaResolver

widgetAreaResolver: WidgetAreaResolver

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Static` `Readonly`DEFAULT_PERSPECTIVE_ID

DEFAULT_PERSPECTIVE_ID: "default" = 'default'

`Static` `Readonly`RESET_PERSPECTIVE_COMMAND

RESET_PERSPECTIVE_COMMAND: Command = ...

`Static` `Readonly`SWITCH_PERSPECTIVE_COMMAND

SWITCH_PERSPECTIVE_COMMAND: Command = ...

Methods

`Protected`applyViewPlacements

applyViewPlacements(descriptor: PerspectiveDescriptor): Promise<void>
Parameters
- descriptor: PerspectiveDescriptor
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:312

clearSavedLayouts

clearSavedLayouts(): void
Internal
Clears all saved in-memory layout snapshots. Plumbing API, used by ShellLayoutRestorer during layout reset.

Returns void
Implementation of PerspectiveServiceInternal.clearSavedLayouts
- Defined in packages/core/src/browser/perspective-service.ts:591

`Protected`collectDockWidgetIds

collectDockWidgetIds(
config: ITabAreaConfig | ISplitAreaConfig,
ids: Set<string>,
): void
Parameters
- config: ITabAreaConfig | ISplitAreaConfig
- ids: Set<string>
Returns void
- Defined in packages/core/src/browser/perspective-service.ts:517

`Protected`collectSidePanelWidgetIds

collectSidePanelWidgetIds(layout: SidePanel.LayoutData, ids: Set<string>): void
Parameters
- layout: SidePanel.LayoutData
- ids: Set<string>
Returns void
- Defined in packages/core/src/browser/perspective-service.ts:507

`Protected`collectWidgetIds

collectWidgetIds(layout: ApplicationShell.LayoutData): Set<string>
Parameters
- layout: ApplicationShell.LayoutData
Returns Set<string>
- Defined in packages/core/src/browser/perspective-service.ts:490

`Protected`detachStrayWidgets

detachStrayWidgets(layoutWidgetIds: Set<string>): void
Parameters
- layoutWidgetIds: Set<string>
Returns void
- Defined in packages/core/src/browser/perspective-service.ts:534

`Protected`doResetCurrentPerspective

doResetCurrentPerspective(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:370

`Protected`doSwitchPerspective

doSwitchPerspective(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:267

getActivePerspective

getActivePerspective(): undefined | PerspectiveDescriptor
Returns the descriptor of the currently active perspective, or undefined if none.

Returns undefined | PerspectiveDescriptor
Implementation of PerspectiveService.getActivePerspective
- Defined in packages/core/src/browser/perspective-service.ts:548

getActivePerspectiveId

getActivePerspectiveId(): string
Returns the ID of the currently active perspective. A convenient alternative to getActivePerspective()?.id that always returns a string.

Returns string
Implementation of PerspectiveServiceInternal.getActivePerspectiveId
- Defined in packages/core/src/browser/perspective-service.ts:567

getAreaForView

getAreaForView(viewId: string): undefined | Area
Returns the target shell area for a widget in the active perspective, or undefined if unmapped.
Parameters
- viewId: string
Returns undefined | Area
Implementation of PerspectiveService.getAreaForView
- Defined in packages/core/src/browser/perspective-service.ts:555

getRegisteredPerspectives

getRegisteredPerspectives(): PerspectiveDescriptor[]
Returns all registered perspective descriptors.

Returns PerspectiveDescriptor[]
Implementation of PerspectiveService.getRegisteredPerspectives
- Defined in packages/core/src/browser/perspective-service.ts:563

getSavedLayout

getSavedLayout(perspectiveId: string): undefined | ApplicationShell.LayoutData
Internal
Returns the saved in-memory layout for a perspective, or undefined if none exists. Plumbing API, used by ShellLayoutRestorer for layout persistence.
Parameters
- perspectiveId: string
Returns undefined | ApplicationShell.LayoutData
Implementation of PerspectiveServiceInternal.getSavedLayout
- Defined in packages/core/src/browser/perspective-service.ts:575

getSavedPerspectiveIds

getSavedPerspectiveIds(): string[]
Internal
Returns the IDs of all perspectives that have a saved (in-memory) layout snapshot. Plumbing API, used by ShellLayoutRestorer for layout persistence.

Returns string[]
Implementation of PerspectiveServiceInternal.getSavedPerspectiveIds
- Defined in packages/core/src/browser/perspective-service.ts:571

`Protected`healDockAreaConfig

healDockAreaConfig(config: ITabAreaConfig | ISplitAreaConfig): Promise<void>
Parameters
- config: ITabAreaConfig | ISplitAreaConfig
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:469

`Protected`healLayoutData

healLayoutData(layout: ApplicationShell.LayoutData): Promise<void>
Views may be shared between multiple perspective. If a view exists in two or more perspectives and is closed in one of them, the shared widget is disposed. When switching back to the other perspective, we need to restore this widget (i.e. reopen the view).
Parameters
- layout: ApplicationShell.LayoutData
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:438

`Protected`healSidePanelLayout

healSidePanelLayout(layout: SidePanel.LayoutData): Promise<void>
Parameters
- layout: SidePanel.LayoutData
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:453

initialize

initialize(): void
Called on application startup before configure is called.

Returns void
Implementation of FrontendApplicationContribution.initialize
- Defined in packages/core/src/browser/perspective-service.ts:225

onLayoutRestored

onLayoutRestored(activePerspectiveId: string): void
Internal
Called by ShellLayoutRestorer after restoring a persisted layout to apply chrome options (e.g., status bar visibility) for the given perspective. Plumbing API, used by ShellLayoutRestorer after layout restore.
Parameters
- activePerspectiveId: string
Returns void
Implementation of PerspectiveServiceInternal.onLayoutRestored
- Defined in packages/core/src/browser/perspective-service.ts:221

onStop

onStop(): void
Called when an application is stopped or unloaded.

Note that this is implemented using window.beforeunload which doesn't allow any asynchronous code anymore. I.e. this is the last tick.

Returns void
Implementation of FrontendApplicationContribution.onStop
- Defined in packages/core/src/browser/perspective-service.ts:241

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/browser/perspective-service.ts:595

registerPerspective

registerPerspective(descriptor: PerspectiveDescriptor): void
Registers a new perspective descriptor. Contributions should call this from their PerspectiveContribution.registerPerspectives callback.
Parameters
- descriptor: PerspectiveDescriptor
Returns void
Implementation of PerspectiveService.registerPerspective
- Defined in packages/core/src/browser/perspective-service.ts:249

resetCurrentPerspective

resetCurrentPerspective(): Promise<void>
Resets the active perspective to its programmatic state (viewPlacements from its descriptor), discarding the saved layout. Does not affect other perspectives.

Returns Promise<void>
Implementation of PerspectiveService.resetCurrentPerspective
- Defined in packages/core/src/browser/perspective-service.ts:356

`Protected`resetDefaultPerspective

resetDefaultPerspective(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:395

setActivePerspectiveId

setActivePerspectiveId(id: string): boolean
Internal
Sets the active perspective ID (without triggering a switch). Returns true if the ID corresponds to a registered perspective, false otherwise. Plumbing API, used by ShellLayoutRestorer during layout restore.
Parameters
- id: string
Returns boolean
Implementation of PerspectiveServiceInternal.setActivePerspectiveId
- Defined in packages/core/src/browser/perspective-service.ts:583

setSavedLayout

setSavedLayout(perspectiveId: string, layout: ApplicationShell.LayoutData): void
Internal
Stores an in-memory layout snapshot for a perspective. Plumbing API, used by ShellLayoutRestorer for layout persistence.
Parameters
- perspectiveId: string
- layout: ApplicationShell.LayoutData
Returns void
Implementation of PerspectiveServiceInternal.setSavedLayout
- Defined in packages/core/src/browser/perspective-service.ts:579

`Protected`showPerspectivePicker

showPerspectivePicker(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/perspective-service.ts:606

switchPerspective

switchPerspective(id: string): Promise<void>
Switches the workbench to the given perspective. Saves the current perspective's layout, then restores the target perspective's layout (or applies its viewPlacements on first activation). Concurrent calls are serialized.
Parameters
- id: string
Returns Promise<void>
Implementation of PerspectiveService.switchPerspective
- Defined in packages/core/src/browser/perspective-service.ts:253

`Protected`updateActivePerspectiveContextKey

updateActivePerspectiveContextKey(id: string): void
Parameters
- id: string
Returns void
- Defined in packages/core/src/browser/perspective-service.ts:245

Class PerspectiveServiceImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PerspectiveServiceImpl

Properties

ProtectedactivePerspectiveId

Protected ReadonlyappContributions

Protected ReadonlycontextKeyService

Protected Readonlycontributions

Readonly InternaldefaultPerspectiveId

Protected Readonlylogger

ReadonlyonDidChangePerspective

Protected ReadonlyonDidChangePerspectiveEmitter

Protected Readonlyperspectives

Protected ReadonlyquickInputService

Protected ReadonlysavedLayouts

Protected Readonlyshell

ProtectedswitchInProgress

Protected ReadonlywidgetAreaResolver

Protected ReadonlywidgetManager

Static ReadonlyDEFAULT_PERSPECTIVE_ID

Static ReadonlyRESET_PERSPECTIVE_COMMAND

Static ReadonlySWITCH_PERSPECTIVE_COMMAND

Methods

ProtectedapplyViewPlacements

Parameters

Returns Promise<void>

clearSavedLayouts

Returns void

ProtectedcollectDockWidgetIds

Parameters

Returns void

ProtectedcollectSidePanelWidgetIds

Parameters

Returns void

ProtectedcollectWidgetIds

Parameters

Returns Set<string>

ProtecteddetachStrayWidgets

Parameters

Returns void

ProtecteddoResetCurrentPerspective

Returns Promise<void>

ProtecteddoSwitchPerspective

Parameters

Returns Promise<void>

getActivePerspective

Returns undefined | PerspectiveDescriptor

getActivePerspectiveId

Returns string

getAreaForView

Parameters

Returns undefined | Area

getRegisteredPerspectives

Returns PerspectiveDescriptor[]

getSavedLayout

Parameters

Returns undefined | ApplicationShell.LayoutData

getSavedPerspectiveIds

Returns string[]

ProtectedhealDockAreaConfig

Parameters

Returns Promise<void>

ProtectedhealLayoutData

Parameters

Returns Promise<void>

ProtectedhealSidePanelLayout

Parameters

Returns Promise<void>

initialize

Returns void

onLayoutRestored

Parameters

Returns void

onStop

`Protected`activePerspectiveId

`Protected` `Readonly`appContributions

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`contributions

`Readonly` `Internal`defaultPerspectiveId

`Protected` `Readonly`logger

`Readonly`onDidChangePerspective

`Protected` `Readonly`onDidChangePerspectiveEmitter

`Protected` `Readonly`perspectives

`Protected` `Readonly`quickInputService

`Protected` `Readonly`savedLayouts

`Protected` `Readonly`shell

`Protected`switchInProgress

`Protected` `Readonly`widgetAreaResolver

`Protected` `Readonly`widgetManager

`Static` `Readonly`DEFAULT_PERSPECTIVE_ID

`Static` `Readonly`RESET_PERSPECTIVE_COMMAND

`Static` `Readonly`SWITCH_PERSPECTIVE_COMMAND

`Protected`applyViewPlacements

`Protected`collectDockWidgetIds

`Protected`collectSidePanelWidgetIds

`Protected`collectWidgetIds

`Protected`detachStrayWidgets

`Protected`doResetCurrentPerspective

`Protected`doSwitchPerspective

`Protected`healDockAreaConfig

`Protected`healLayoutData

`Protected`healSidePanelLayout

`Protected`resetDefaultPerspective

`Protected`showPerspectivePicker

`Protected`updateActivePerspectiveContextKey