RSX Code Reference
    Preparing search index...

    Class KeyWindowManager

    The KeyWindowManager provides access to KeyWindow information.

    Index
    constructor
    activeContainerWindow activeKeyWindow containersCount layoutProfile
    closeProjectWindows getDockedKeyWindowsFromContainer getKeyWindowContainer getKeyWindowsForType raiseWindowForCondition updateAlToolbarItemStates
    onCloudSyncButtonClicked onDiscussionButtonClicked onNotificationButtonClicked didOpenKeyWindow willCloseKeyWindow
    • get containersCount(): number

      Gets the count of active containers for KeyWindows.

      Returns number

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

      Returns void

    • Get all docked KeyWindows from the given container index.

      Parameters

      • containerIndex: number

        The index of the container to fetch all docked KeyWindows.

      Returns KeyWindowBase[]

    • Get the KeyWindow Container from the given index.

      Parameters

      • containerIndex: number

      Returns KeyWindowContainerWindow

    • Raises and returns the first KeyWindow of type T that fulfills the predicate.

      Type Parameters

      Parameters

      • type: ClassOf<T>

        The type of windows to test. Only KeyWindows of this type are considered.

      • predicate: (window: T) => boolean

        The predicate to test for. The first window that is encountered for predicate returns true is raised.

      Returns T

      The raised window or null if no window of type T was found that fulfills the predicate.

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

      Returns void

    onCloudSyncButtonClicked: Event<[p0: UIButton]>

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

    onDiscussionButtonClicked: Event<[p0: UIButton]>

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

    onNotificationButtonClicked: Event<[p0: UIButton]>

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

    didOpenKeyWindow: Event<[p0: KeyWindowBase]>

    Gets called when a KeyWindow has been opened.

    willCloseKeyWindow: Event<[p0: KeyWindowBase]>

    Gets called when a KeyWindow is about to be closed.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods
    Events