AboutSupportDeveloper GuideVersion 34.116.78.49

Interface LayoutManager<T>Experimental

Type Parameters

Hierarchy

  • LayoutManager

Properties

applyLayoutSnapshot: ((snapshot) => Promise<void>)

Type declaration

    • (snapshot): Promise<void>
    • Experimental

      Must be overridden when working with multiple layouts

      Hook called during fin.Platform.Layout.init() call, to inform derived classes when a snapshot is being applied to launch a platform window. Use this hook to set the local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts

      When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will be included in the snapshot type T and should align with your component state T.

      TODO: detect if layoutManager override was set and this was not overridden somehow to warn?

      Parameters

      • snapshot: T

      Returns Promise<void>

getLayoutByName: ((layoutName) => LayoutInstance)

Type declaration

    • (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

getLayoutSnapshot: (() => Promise<T>)

Type declaration

    • (): Promise<T>
    • Experimental

      Returns Promise<T>

      T

resolveLayout: ((param0) => LayoutInstance)

Type declaration

showLayout: ((layoutIdentity) => Promise<void>)

Type declaration

    • (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

      Returns Promise<void>

Methods