AbstractLayout class

Signature:

export declare abstract class AbstractLayout extends ExternalObject implements ILayout

Extends: ExternalObject

Implements: ILayout

Methods

Method	Modifiers	Description
destroy()		Destroy this layout so it can never be used again.
hide()		If this is the active layout stop showing it
show(preserveActiveLayout)		Makes this layout visible.

AbstractLayout.destroy() method

Destroy this layout so it can never be used again.

Signature:

destroy(): void;

Returns:

void

Remarks

If this is the active layout stops showing it. Frees all components and resources used exclusively by this layout.

AbstractLayout.hide() method

If this is the active layout stop showing it

Signature:

hide(): void;

Returns:

void

AbstractLayout.show() method

Makes this layout visible.

Signature:

show(preserveActiveLayout?: boolean): Promise<void>;

Parameters

Parameter	Type	Description
preserveActiveLayout	boolean	(Optional) If true the equivalent of calling ILayout.hide() on the active layout first, otherwise equivalent of calling ILayout.destroy() on the active layout first. (Default: false)

Returns:

Promise<void>

A promise that resolves once any transitions associated with this layout are complete

Remarks

Only one layout can be active at a time, if there's an existing layout it'll be made inactive with behaviour dictated by the preserveActiveLayout value.