@itwin/appui-react 3.4.0-dev.8 → 3.5.0-dev.11

package/lib/esm/appui-react/frontstage/FrontstageDef.js

@@ -10,7 +10,8 @@
 import * as React from "react";
 import { IModelApp } from "@itwin/core-frontend";
 import { StagePanelLocation, StageUsage, UiError, WidgetState } from "@itwin/appui-abstract";
-import { dockWidgetContainer, findTab, findWidget, floatWidget, isFloatingLocation, isPanelLocation, isPopoutLocation, isPopoutWidgetLocation, panelSides, popoutWidgetToChildWindow, setFloatingWidgetContainerBounds, } from "@itwin/appui-layout-react";
+import { Rectangle } from "@itwin/core-react";
+import { dockWidgetContainer, floatWidget, getTabLocation, getWidgetLocation, isFloatingTabLocation, isPanelTabLocation, isPopoutTabLocation, isPopoutWidgetLocation, panelSides, popoutWidgetToChildWindow, setFloatingWidgetContainerBounds, } from "@itwin/appui-layout-react";
 import { ContentGroupProvider } from "../content/ContentGroup";
 import { ContentLayoutManager } from "../content/ContentLayoutManager";
 import { ContentViewManager } from "../content/ContentViewManager";
@@ -21,8 +22,7 @@ import { Frontstage } from "./Frontstage";
 import { FrontstageManager } from "./FrontstageManager";
 import { TimeTracker } from "../configurableui/TimeTracker";
 import { PopoutWidget } from "../childwindow/PopoutWidget";
-import { saveFrontstagePopoutWidgetSizeAndPosition } from "../widget-panels/Frontstage";
-import { BentleyStatus } from "@itwin/core-bentley";
+import { assert, BentleyStatus, ProcessDetector } from "@itwin/core-bentley";
 import { ContentDialogManager } from "../dialog/ContentDialogManager";
 /** FrontstageDef class provides an API for a Frontstage.
  * @public
@@ -183,6 +183,11 @@ export class FrontstageDef {
         }
     }
     /** @internal */
+    get savedWidgetDefs() { return this._savedWidgetDefs; }
+    set savedWidgetDefs(widgets) {
+        this._savedWidgetDefs = widgets;
+    }
+    /** @internal */
     get timeTracker() { return this._timeTracker; }
     /** Created a [[FrontstageDef]] and initialize it */
     static async create(provider) {
@@ -552,17 +557,12 @@ export class FrontstageDef {
     }
     /** @beta */
     restoreLayout() {
-        for (const zoneDef of this.zoneDefs) {
-            for (const widgetDef of zoneDef.widgetDefs) {
-                widgetDef.setWidgetState(widgetDef.defaultState);
-            }
-        }
         for (const panelDef of this.panelDefs) {
             panelDef.size = panelDef.defaultSize;
             panelDef.panelState = panelDef.defaultState;
-            for (const widgetDef of panelDef.widgetDefs) {
-                widgetDef.setWidgetState(widgetDef.defaultState);
-            }
+        }
+        for (const widgetDef of this.widgetDefs) {
+            widgetDef.setWidgetState(widgetDef.defaultState);
         }
         FrontstageManager.onFrontstageRestoreLayoutEvent.emit({ frontstageDef: this });
     }
@@ -572,11 +572,11 @@ export class FrontstageDef {
     getWidgetCurrentState(widgetDef) {
         // istanbul ignore else
         if (this.nineZoneState) {
-            const location = findTab(this.nineZoneState, widgetDef.id);
+            const location = getTabLocation(this.nineZoneState, widgetDef.id);
             // istanbul ignore next
             if (!location)
                 return WidgetState.Hidden;
-            if (isFloatingLocation(location)) {
+            if (isFloatingTabLocation(location)) {
                 const floatingWidget = this.nineZoneState.floatingWidgets.byId[location.floatingWidgetId];
                 if (floatingWidget && floatingWidget.hidden)
                     return WidgetState.Hidden;
@@ -615,20 +615,20 @@ export class FrontstageDef {
     isPopoutWidget(widgetId) {
         // istanbul ignore else
         if (this.nineZoneState) {
-            const location = findTab(this.nineZoneState, widgetId);
+            const location = getTabLocation(this.nineZoneState, widgetId);
             // istanbul ignore else
             if (location)
-                return isPopoutLocation(location);
+                return isPopoutTabLocation(location);
         }
         return false;
     }
     isFloatingWidget(widgetId) {
         // istanbul ignore else
         if (this.nineZoneState) {
-            const location = findTab(this.nineZoneState, widgetId);
+            const location = getTabLocation(this.nineZoneState, widgetId);
             // istanbul ignore else
             if (location)
-                return isFloatingLocation(location);
+                return isFloatingTabLocation(location);
         }
         return false;
     }
@@ -643,10 +643,10 @@ export class FrontstageDef {
     floatWidget(widgetId, point, size) {
         // istanbul ignore else
         if (this.nineZoneState) {
-            const location = findTab(this.nineZoneState, widgetId);
+            const location = getTabLocation(this.nineZoneState, widgetId);
             if (location) {
                 let popoutWidgetContainerId;
-                if (isPopoutLocation(location)) {
+                if (isPopoutTabLocation(location)) {
                     popoutWidgetContainerId = location.popoutWidgetId;
                 }
                 const state = floatWidget(this.nineZoneState, widgetId, point, size);
@@ -668,21 +668,21 @@ export class FrontstageDef {
         let widgetIsVisible = false;
         // istanbul ignore else
         if (this.nineZoneState) {
-            const tabLocation = findTab(this.nineZoneState, widgetId);
+            const tabLocation = getTabLocation(this.nineZoneState, widgetId);
             // istanbul ignore else
             if (tabLocation) {
-                if (isFloatingLocation(tabLocation)) {
+                if (isFloatingTabLocation(tabLocation)) {
                     const floatingWidget = this.nineZoneState.floatingWidgets.byId[tabLocation.floatingWidgetId];
                     // istanbul ignore else
                     if (!!!floatingWidget.hidden)
                         widgetIsVisible = true;
                 }
-                else if (isPopoutLocation(tabLocation)) {
+                else if (isPopoutTabLocation(tabLocation)) {
                     widgetIsVisible = true;
                 }
                 else {
                     // istanbul ignore else
-                    if (isPanelLocation(tabLocation)) {
+                    if (isPanelTabLocation(tabLocation)) {
                         const panel = this.nineZoneState.panels[tabLocation.side];
                         const widgetDef = this.findWidgetDef(widgetId);
                         if (widgetDef && widgetDef.state === WidgetState.Open && !panel.collapsed)
@@ -696,25 +696,33 @@ export class FrontstageDef {
     /** Opens window for specified PopoutWidget container. Used to reopen popout when running in Electron.
      * @internal */
     openPopoutWidgetContainer(state, widgetContainerId) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
-        const location = findWidget(state, widgetContainerId);
-        // istanbul ignore else
-        if (location && isPopoutWidgetLocation(location) && 1 === state.widgets[widgetContainerId].tabs.length) {
-            // NOTE: Popout Widget Container will only contain a single WidgetTab
-            const widgetDef = this.findWidgetDef(state.widgets[widgetContainerId].tabs[0]);
-            // istanbul ignore else
-            if (widgetDef) {
-                const tab = state.tabs[widgetDef.id];
-                const popoutContent = (React.createElement(PopoutWidget, { widgetContainerId: widgetContainerId, widgetDef: widgetDef }));
-                const position = {
-                    width: (_b = (_a = tab.preferredPopoutWidgetSize) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : 600,
-                    height: (_d = (_c = tab.preferredPopoutWidgetSize) === null || _c === void 0 ? void 0 : _c.height) !== null && _d !== void 0 ? _d : 800,
-                    left: (_f = (_e = tab.preferredPopoutWidgetSize) === null || _e === void 0 ? void 0 : _e.x) !== null && _f !== void 0 ? _f : 0,
-                    top: (_h = (_g = tab.preferredPopoutWidgetSize) === null || _g === void 0 ? void 0 : _g.y) !== null && _h !== void 0 ? _h : 0,
-                };
-                UiFramework.childWindowManager.openChildWindow(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework.useDefaultPopoutUrl);
-            }
-        }
+        const location = getWidgetLocation(state, widgetContainerId);
+        // istanbul ignore next
+        if (!location)
+            return;
+        // istanbul ignore next
+        if (!isPopoutWidgetLocation(location))
+            return;
+        const widget = state.widgets[widgetContainerId];
+        const popoutWidget = state.popoutWidgets.byId[location.popoutWidgetId];
+        // Popout widget should only contain a single tab.
+        // istanbul ignore next
+        if (widget.tabs.length !== 1)
+            return;
+        const tabId = widget.tabs[0];
+        const widgetDef = this.findWidgetDef(tabId);
+        // istanbul ignore next
+        if (!widgetDef)
+            return;
+        const popoutContent = (React.createElement(PopoutWidget, { widgetContainerId: widgetContainerId, widgetDef: widgetDef }));
+        const bounds = Rectangle.create(popoutWidget.bounds);
+        const position = {
+            width: bounds.getWidth(),
+            height: bounds.getHeight(),
+            left: bounds.left,
+            top: bounds.top,
+        };
+        UiFramework.childWindowManager.openChildWindow(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework.useDefaultPopoutUrl);
     }
     /** Create a new popout/child window that contains the widget specified by its Id. Supported only when in
      *  UI 2.0 or higher.
@@ -725,42 +733,43 @@ export class FrontstageDef {
      * @beta
      */
     popoutWidget(widgetId, point, size) {
-        // istanbul ignore else
-        if (this.nineZoneState) {
-            let location = findTab(this.nineZoneState, widgetId);
-            // istanbul ignore else
-            if (location) {
-                if (isPopoutLocation(location))
-                    return;
-                // get the state to apply that will pop-out the specified WidgetTab to child window.
-                const state = popoutWidgetToChildWindow(this.nineZoneState, widgetId, point, size);
-                // istanbul ignore else
-                if (state) {
-                    // now that the state is updated get the id of the container that houses the widgetTab/widgetId
-                    location = findTab(state, widgetId);
-                    // istanbul ignore else
-                    if (location && isPopoutLocation(location)) {
-                        const widgetDef = this.findWidgetDef(widgetId);
-                        // istanbul ignore else
-                        if (widgetDef) {
-                            const widgetContainerId = location.widgetId;
-                            const tab = state.tabs[widgetId];
-                            this.nineZoneState = state;
-                            setTimeout(() => {
-                                const popoutContent = (React.createElement(PopoutWidget, { widgetContainerId: widgetContainerId, widgetDef: widgetDef }));
-                                const position = {
-                                    width: tab.preferredPopoutWidgetSize.width,
-                                    height: tab.preferredPopoutWidgetSize.height,
-                                    left: tab.preferredPopoutWidgetSize.x,
-                                    top: tab.preferredPopoutWidgetSize.y,
-                                };
-                                UiFramework.childWindowManager.openChildWindow(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework.useDefaultPopoutUrl);
-                            });
-                        }
-                    }
-                }
-            }
-        }
+        // istanbul ignore next
+        if (!this.nineZoneState)
+            return;
+        let location = getTabLocation(this.nineZoneState, widgetId);
+        if (!location || isPopoutTabLocation(location))
+            return;
+        const widgetDef = this.findWidgetDef(widgetId);
+        // istanbul ignore next
+        if (!widgetDef)
+            return;
+        // get the state to apply that will pop-out the specified WidgetTab to child window.
+        let preferredBounds = Rectangle.createFromSize({ height: 800, width: 600 });
+        // istanbul ignore next
+        if (widgetDef.popoutBounds)
+            preferredBounds = widgetDef.popoutBounds;
+        if (size)
+            preferredBounds = preferredBounds.setSize(size);
+        if (point)
+            preferredBounds = preferredBounds.setPosition(point);
+        const state = popoutWidgetToChildWindow(this.nineZoneState, widgetId, preferredBounds);
+        this.nineZoneState = state;
+        // now that the state is updated get the id of the container that houses the widgetTab/widgetId
+        location = getTabLocation(state, widgetId);
+        assert(!!location && isPopoutTabLocation(location));
+        const widgetContainerId = location.widgetId;
+        const popoutWidget = state.popoutWidgets.byId[widgetContainerId];
+        const bounds = Rectangle.create(popoutWidget.bounds);
+        setTimeout(() => {
+            const popoutContent = (React.createElement(PopoutWidget, { widgetContainerId: widgetContainerId, widgetDef: widgetDef }));
+            const position = {
+                width: bounds.getWidth(),
+                height: bounds.getHeight(),
+                left: bounds.left,
+                top: bounds.top,
+            };
+            UiFramework.childWindowManager.openChildWindow(widgetContainerId, widgetDef.label, popoutContent, position, UiFramework.useDefaultPopoutUrl);
+        });
     }
     get isStageClosing() {
         return this._isStageClosing;
@@ -772,12 +781,23 @@ export class FrontstageDef {
         return this._isReady;
     }
     /** @internal */
-    async saveChildWindowSizeAndPosition(childWindowId, childWindow) {
-        // istanbul ignore else
-        if (this.nineZoneState) {
-            const newState = await saveFrontstagePopoutWidgetSizeAndPosition(this.nineZoneState, this.id, this.version, childWindowId, childWindow);
-            this._nineZoneState = newState; // set without triggering new render as only preferred floating position set
-        }
+    saveChildWindowSizeAndPosition(childWindowId, childWindow) {
+        if (!this.nineZoneState)
+            return;
+        const location = getWidgetLocation(this.nineZoneState, childWindowId);
+        if (!location || !isPopoutWidgetLocation(location))
+            return;
+        const widget = this.nineZoneState.widgets[location.popoutWidgetId];
+        const tabId = widget.tabs[0];
+        const widgetDef = this.findWidgetDef(tabId);
+        if (!widgetDef)
+            return;
+        const adjustmentWidth = ProcessDetector.isElectronAppFrontend ? 16 : 0;
+        const adjustmentHeight = ProcessDetector.isElectronAppFrontend ? 39 : 0;
+        const width = childWindow.innerWidth + adjustmentWidth;
+        const height = childWindow.innerHeight + adjustmentHeight;
+        const bounds = Rectangle.createFromSize({ width, height }).offset({ x: childWindow.screenX, y: childWindow.screenY });
+        widgetDef.popoutBounds = bounds;
     }
     /** @internal */
     setFloatingWidgetBoundsInternal(floatingWidgetId, bounds, inhibitNineZoneStateChangedEvent = false) {
@@ -795,16 +815,16 @@ export class FrontstageDef {
      *  @internal
      */
     dockPopoutWidgetContainer(widgetContainerId) {
-        if (this.nineZoneState) {
-            const location = findWidget(this.nineZoneState, widgetContainerId);
-            // Make sure the widgetContainerId is still in popout state. We don't want to set it to docked if the window is being closed because
-            // an API call has moved the widget from a popout state to a floating state.
-            // istanbul ignore else
-            if (location && isPopoutWidgetLocation(location)) {
-                const state = dockWidgetContainer(this.nineZoneState, widgetContainerId, true);
-                state && (this.nineZoneState = state);
-            }
-        }
+        if (!this.nineZoneState)
+            return;
+        // Make sure the widgetContainerId is still in popout state. We don't want to set it to docked if the window is being closed because
+        // an API call has moved the widget from a popout state to a floating state.
+        // istanbul ignore else
+        const location = getWidgetLocation(this.nineZoneState, widgetContainerId);
+        if (!location || !isPopoutWidgetLocation(location))
+            return;
+        const state = dockWidgetContainer(this.nineZoneState, widgetContainerId, true);
+        this.nineZoneState = state;
     }
     /** Finds the container with the specified widget and re-docks all widgets
      * back to the panel zone location that was used when the floating container
@@ -815,12 +835,12 @@ export class FrontstageDef {
     dockWidgetContainer(widgetId) {
         // istanbul ignore else
         if (this.nineZoneState) {
-            const location = findTab(this.nineZoneState, widgetId);
+            const location = getTabLocation(this.nineZoneState, widgetId);
             if (location) {
                 const widgetContainerId = location.widgetId;
                 const state = dockWidgetContainer(this.nineZoneState, widgetContainerId, true);
                 state && (this.nineZoneState = state);
-                if (isPopoutLocation(location)) {
+                if (isPopoutTabLocation(location)) {
                     UiFramework.childWindowManager.closeChildWindow(location.widgetId, true);
                 }
             }
@@ -840,9 +860,9 @@ export class FrontstageDef {
     getFloatingWidgetContainerIdByWidgetId(widgetId) {
         if (!this.nineZoneState)
             return undefined;
-        const location = findTab(this.nineZoneState, widgetId);
+        const location = getTabLocation(this.nineZoneState, widgetId);
         // istanbul ignore else
-        if (location && isFloatingLocation(location)) {
+        if (location && isFloatingTabLocation(location)) {
             return location.floatingWidgetId;
         }
         // istanbul ignore next
@@ -863,5 +883,29 @@ export class FrontstageDef {
         }
         return undefined;
     }
+    *_widgetDefs() {
+        for (const zoneDef of this.zoneDefs) {
+            for (const widgetDef of zoneDef.widgetDefs) {
+                yield widgetDef;
+            }
+        }
+        for (const panelDef of this.panelDefs) {
+            for (const widgetDef of panelDef.widgetDefs) {
+                yield widgetDef;
+            }
+        }
+        return undefined;
+    }
+    /** Iterable of all widget definitions in a frontstage.
+     * @internal
+     */
+    get widgetDefs() {
+        const defs = this._widgetDefs();
+        return {
+            [Symbol.iterator]() {
+                return defs;
+            },
+        };
+    }
 }
 //# sourceMappingURL=FrontstageDef.js.map