Interface ILayoutRestorer

A static class that restores the widgets of the application when it reloads.

interface ILayoutRestorer {
    restored: Promise<void>;
    add(widget, name): void;
    restore<T>(tracker, options): Promise<any>;
}

Hierarchy (view full)

IRestorer
- ILayoutRestorer

Implemented by

LayoutRestorer

Index

Properties

Methods

Properties

restored

restored: Promise<void>

A promise resolved when the layout restorer is ready to receive signals.

Methods

add

add(widget, name): void
Add a widget to be tracked by the layout restorer.
Parameters
- widget: Widget
- name: string
Returns void
- Defined in packages/application/src/layoutrestorer.ts:42

restore

restore<T>(tracker, options): Promise<any>
Restore the widgets of a particular widget tracker.
Type Parameters
- T extends Widget
Parameters
- tracker: WidgetTracker<T>
  The widget tracker whose widgets will be restored.
- options: IRestorer.IOptions<T>
  The restoration options.
Returns Promise<any>
Overrides IRestorer.restore
- Defined in packages/application/src/layoutrestorer.ts:51