Class KeyWindowManager

The KeyWindowManager provides access to KeyWindow information.

Constructors

constructor

Properties

Accessors

activeContainerWindow activeKeyWindow containersCount layoutProfile

Methods

closeProjectWindows getDockedKeyWindowsFromContainer getKeyWindowContainer getKeyWindowsForType updateAlToolbarItemStates

Events

onCloudSyncButtonClicked onDiscussionButtonClicked onNotificationButtonClicked didOpenKeyWindow willCloseKeyWindow

Constructors

constructor

Accessors

StaticactiveContainerWindow

StaticactiveKeyWindow

StaticcontainersCount

  • get containersCount(): number

  • Gets the count of active containers for KeyWindows.

    Returns number

StaticlayoutProfile

  • get layoutProfile(): KeyWindowLayoutProfile

  • Sets the layout profile currently active. Setting a new profile will change the layout of all windows present on the profile.

    Returns KeyWindowLayoutProfile

  • set layoutProfile(value): void

  • Parameters

    Returns void

Methods

StaticcloseProjectWindows

  • closeProjectWindows(): void

  • Forcefully closes all key window and key window containers but one, that only contains the HomeKeyWindow.

    Returns void

StaticgetDockedKeyWindowsFromContainer

  • getDockedKeyWindowsFromContainer(containerIndex): KeyWindowBase[]

  • Get all docked KeyWindows from the given container index.

    Parameters

    • containerIndex: number

      The index of the container to fetch all docked KeyWindows.

    Returns KeyWindowBase[]

StaticgetKeyWindowContainer

StaticgetKeyWindowsForType

  • getKeyWindowsForType<T>(type): T[]

  • Gets all active KeyWindow instances that match the type.

    Type Parameters

    Parameters

    Returns T[]

    Array of KeyWindow instances that match the type.

StaticupdateAlToolbarItemStates

  • updateAlToolbarItemStates(): void

  • Updates the toggle state of all main toolbar buttons in the toolbar for all current active key windows.

    Returns void

Events

Static ReadonlyonCloudSyncButtonClicked

onCloudSyncButtonClicked: Event<[UIButton], void>

Gets called when the given cloud sync button gets clicked by the user.

Static ReadonlyonDiscussionButtonClicked

onDiscussionButtonClicked: Event<[UIButton], void>

Gets called when the given discussion button gets clicked by the user.

Static ReadonlyonNotificationButtonClicked

onNotificationButtonClicked: Event<[UIButton], void>

Gets called when the given notification button gets clicked by the user.

Static ReadonlydidOpenKeyWindow

didOpenKeyWindow: Event<[KeyWindowBase], void>

Gets called when a KeyWindow has been opened.

Static ReadonlywillCloseKeyWindow

willCloseKeyWindow: Event<[KeyWindowBase], void>

Gets called when a KeyWindow is about to be closed.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
Events