Interface LayoutManager<T>`Experimental`

NOTE: Internal use only. This type is reserved for Workspace Browser implementation.

Responsible for aggergating all layout snapshots and storing LayoutInstances

Type Parameters

T extends LayoutSnapshot

Hierarchy

LayoutManager

Index

Methods

applyLayoutSnapshot getLayoutByName getLayoutIdentityForView getLayoutSnapshot getLayouts isLayoutVisible resolveLayout showLayout

Methods

applyLayoutSnapshot

applyLayoutSnapshot(snapshot): Promise<void>
Experimental
To enable multiple layouts, override this method and do not call super.applyLayoutSnapshot()

This hook is called by OpenFin during fin.Platform.Layout.init() call, to pass a snapshot to derived classes which will be used launch a platform window. Use this hook to set your local UI state and begin rendering the containers for your layouts UI.

Ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts when that layout is ready to be created in your application.

If you add custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will be included in the snapshot type.

The default implementation throws if it is called with a snapshot containing more than one layout.
Parameters
- snapshot: T
Returns Promise<void>

Throws
if Object.keys(snapshot).length > 1

getLayoutByName

getLayoutByName(layoutName): LayoutInstance
Experimental
Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName. Throws if it does not exist.
Parameters
- layoutName: string
Returns LayoutInstance

getLayoutIdentityForView

getLayoutIdentityForView(viewIdentity): LayoutIdentity
Experimental
Parameters
- viewIdentity: Identity
Returns LayoutIdentity

getLayoutSnapshot

getLayoutSnapshot(): Promise<T>
Experimental
Returns Promise<T>
T

getLayouts

getLayouts(): Record<string, LayoutInstance>
Experimental
Returns Record<string, LayoutInstance>

isLayoutVisible

isLayoutVisible(__namedParameters): boolean
Experimental
Parameters
- __namedParameters: LayoutIdentity
Returns boolean

resolveLayout

resolveLayout(layoutIdentity?): Promise<LayoutInstance>
Experimental
Parameters
- Optional layoutIdentity: LayoutIdentity
Returns Promise<LayoutInstance>

showLayout

showLayout(layoutIdentity): Promise<void>
Experimental
Must be overridden when working with multiple layouts

Hook for allowing OpenFin to show a given layout. It's recommended to enumerate your layout containers and find the one matching layoutIdentity.layoutName and show that container and hide the others.
Parameters
- layoutIdentity: LayoutIdentity
Returns Promise<void>