Class ShellLayoutRestorer

Hierarchy

ShellLayoutRestorer

Implements

CommandContribution

Constructors

constructor

new ShellLayoutRestorer(widgetManager: WidgetManager, logger: ILogger, storageService: StorageService): ShellLayoutRestorer

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:130
Parameters
- widgetManager: WidgetManager
- logger: ILogger
- storageService: StorageService
Returns ShellLayoutRestorer

Properties

Protected logger

logger: ILogger

Protected Readonly migrations

migrations: ContributionProvider<ApplicationShellLayoutMigration>

Protected shouldStoreLayout

shouldStoreLayout: boolean = true

Protected storageKey

storageKey: string = 'layout'

Protected storageService

storageService: StorageService

Protected Readonly themeService

themeService: ThemeService

Protected widgetManager

widgetManager: WidgetManager

Protected Readonly windowService

windowService: WindowService

Methods

Private convertToDescription

convertToDescription(widget: Widget): undefined | WidgetDescription

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:210
Parameters
- widget: Widget
Returns undefined | WidgetDescription

Protected convertToWidget

convertToWidget(desc: WidgetDescription, context: InflateContext): Promise<undefined | Widget>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:315
Parameters
- desc: WidgetDescription
- context: InflateContext
Returns Promise<undefined | Widget>

Protected deflate

deflate(data: object): string

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:191
Turns the layout data to a string representation.

Parameters
- data: object
Returns string

Protected fireWillInflateLayout

fireWillInflateLayout(context: InflateContext): Promise<void>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:261
Parameters
- context: InflateContext
Returns Promise<void>

Protected fireWillInflateWidget

fireWillInflateWidget(desc: WidgetDescription, context: InflateContext): Promise<WidgetDescription>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:298
Parameters
- desc: WidgetDescription
- context: InflateContext
Returns Promise<WidgetDescription>

Protected inflate

inflate(layoutData: string): Promise<ApplicationShell.LayoutData>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:231
Creates the layout data from its string representation.

Parameters
- layoutData: string
Returns Promise<ApplicationShell.LayoutData>

Protected isWidgetProperty

isWidgetProperty(propertyName: string): boolean

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:180
Parameters
- propertyName: string
Returns boolean

Protected isWidgetsProperty

isWidgetsProperty(propertyName: string): boolean

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:184
Parameters
- propertyName: string
Returns boolean

Protected parse

parse<T>(layoutData: string, parseContext: ParseContext): T

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:270
Type Parameters
- T
Parameters
- layoutData: string
- parseContext: ParseContext
Returns T

registerCommands

registerCommands(commands: CommandRegistry): void

Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:135
Parameters
- commands: CommandRegistry
Returns void

Protected resetLayout

resetLayout(): Promise<void>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:141
Returns Promise<void>

restoreLayout

restoreLayout(app: FrontendApplication): Promise<boolean>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:167
Parameters
- app: FrontendApplication
Returns Promise<boolean>

storeLayout

storeLayout(app: FrontendApplication): void

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:152
Parameters
- app: FrontendApplication
Returns void