Class ShellLayoutRestorer

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

Implements

CommandContribution

Constructors

constructor

new ShellLayoutRestorer(
    widgetManager: WidgetManager,
    logger: ILogger,
    storageService: StorageService,
): ShellLayoutRestorer
Parameters
- widgetManager: WidgetManager
- logger: ILogger
- storageService: StorageService
Returns ShellLayoutRestorer
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:144

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` `Readonly`transformations

transformations: ContributionProvider<ShellLayoutTransformer>

`Protected`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`windowService

windowService: WindowService

Methods

`Protected`convertToWidget

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

`Protected`deflate

deflate(data: object): string
Turns the layout data to a string representation.
Parameters
- data: object
Returns string
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:206

`Protected`fireWillInflateLayout

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

`Protected`fireWillInflateWidget

fireWillInflateWidget(
desc: WidgetDescription,
context: InflateContext,
): Promise<WidgetDescription>
Parameters
- desc: WidgetDescription
- context: InflateContext
Returns Promise<WidgetDescription>
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:313

`Protected`inflate

inflate(layoutData: string): Promise<ApplicationShell.LayoutData>
Creates the layout data from its string representation.
Parameters
- layoutData: string
Returns Promise<ApplicationShell.LayoutData>
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:246

`Protected`isWidgetProperty

isWidgetProperty(propertyName: string): boolean
Parameters
- propertyName: string
Returns boolean
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:195

`Protected`isWidgetsProperty

isWidgetsProperty(propertyName: string): boolean
Parameters
- propertyName: string
Returns boolean
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:199

`Protected`parse

parse<T>(layoutData: string, parseContext: ParseContext): T
Type Parameters
- T
Parameters
- layoutData: string
- parseContext: ParseContext
Returns T
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:285

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:149

`Protected`resetLayout

resetLayout(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:155

restoreLayout

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

storeLayout

storeLayout(app: FrontendApplication): void
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:166