Overview of Window Management APIs

The Window Management API facilitates additional toolbar management from the main horizontal toolbar. Fusion Service acts as a message bus for communication between horizontal, vertical, and notification toolbars, and enables opening and closing of the vertical toolbar.

The Window Management API is broken up is broken up into three groups, Embedded (Horizontal) Toolbar APIs, Live Window Controller (Vertical) Toolbar APIs, and Inter-Toolbar Communication APIs.

Embedded Toolbar API

The following table lists the Embedded Toolbar APIs and their usage.

Note: Although the Embedded (horizontal) Toolbar API functionality is still supported, you will find a more complete set of functionality if you use the Live Window Controller (Vertical) Toolbar APIs. Live Window is also where all new features will be developed and deployed going forward. For more information, see the Live Window Controller topic which follows this one.

Method

Description

openFloatingToolbar

Requests Fusion Service to programmatically open a floating toolbar.

isFloatingToolbarOpen

Requests Fusion Service to determine whether the floating toolbar is open or not.

closeFloatingToolbar

Requests Fusion Service to programmatically close the floating toolbar.

setToolbarDimensions

Sets toolbar dimensions for horizontal and vertical toolbars.

Live Window Controller API

This table lists the Live Window Controller (Vertical) Toolbar APIs and their usage.

Method

Description

openCompanionPanel

Requests Fusion Service to programmatically open a companion panel.

isCompanionPanelOpen

Requests Fusion Service to determine whether the companion panel is open or not.

closeCompanionPanel

Requests Fusion Service to programmatically close the companion panel.

Inter-Toolbar Communication API

This table lists the Inter-Toolbar Communication APIs and their usage.

Method

Description

postToolbarMessage

Sends a message from one toolbar, such as the horizontal toolbar, to another, such as the floating toolbar using Fusion Service as a message bus.

onToolbarMessage

Registers a callback for the messages exchanged between toolbars.