@itwin/appui-react 4.0.0-dev.3 → 4.0.0-dev.6

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

@@ -2,6 +2,7 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
 /** @packageDocumentation
  * @module Frontstage
  */
@@ -14,21 +15,26 @@ import { dockWidgetContainer, floatWidget, getTabLocation, getWidgetLocation, is
 import { ContentGroupProvider } from "../content/ContentGroup";
 import { ContentLayoutManager } from "../content/ContentLayoutManager";
 import { ContentViewManager } from "../content/ContentViewManager";
-import { StagePanelDef, StagePanelState, toPanelSide } from "../stagepanels/StagePanelDef";
+import { StagePanelState, toPanelSide } from "../stagepanels/StagePanelDef";
 import { UiFramework } from "../UiFramework";
-import { WidgetDef, WidgetType } from "../widgets/WidgetDef";
+import { Zone, ZoneLocation } from "../zones/Zone";
+import { Frontstage } from "./Frontstage";
 import { FrontstageManager } from "./FrontstageManager";
 import { TimeTracker } from "../configurableui/TimeTracker";
 import { PopoutWidget } from "../childwindow/PopoutWidget";
 import { FrameworkStateReducer } from "../widget-panels/Frontstage";
 import { assert, BentleyStatus, ProcessDetector } from "@itwin/core-bentley";
 import { ContentDialogManager } from "../dialog/ContentDialogManager";
+import { Widget } from "../widgets/Widget";
+import { StagePanel } from "../stagepanels/StagePanel";
 /** FrontstageDef class provides an API for a Frontstage.
  * @public
  */
 export class FrontstageDef {
     constructor() {
         this._id = "";
+        this._defaultContentId = "";
+        this._isInFooterMode = true;
         this._isStageClosing = false;
         this._isReady = false;
         this._isApplicationClosing = false;
@@ -36,21 +42,61 @@ export class FrontstageDef {
         this._timeTracker = new TimeTracker();
     }
     get id() { return this._id; }
+    /** @deprecated in 3.6. */
+    get defaultTool() { return this._defaultTool; }
+    /** @deprecated in 3.6. */
+    get defaultContentId() { return this._defaultContentId; }
+    get isInFooterMode() { return this._isInFooterMode; }
+    /** @deprecated in 3.6. */
+    get applicationData() { return this._applicationData; }
     get usage() { return this._usage !== undefined ? this._usage : StageUsage.General; }
     get version() { return this._version; }
     get contentGroupProvider() { return this._contentGroupProvider; }
     get floatingContentControls() { return this._floatingContentControls; }
-    get toolSettings() { return this._toolSettings; }
-    get statusBar() { return this._statusBar; }
-    get contentManipulation() { return this._contentManipulation; }
-    get viewNavigation() { return this._viewNavigation; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.contentManipulation]] instead. */
+    get topLeft() { return this._topLeft; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.toolSettings]] instead. */
+    get topCenter() { return this._topCenter; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.viewNavigation]] instead. */
+    get topRight() { return this._topRight; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.leftPanel]] instead. */
+    get centerLeft() { return this._centerLeft; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.rightPanel]] instead. */
+    get centerRight() { return this._centerRight; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.leftPanel]] instead. */
+    get bottomLeft() { return this._bottomLeft; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.statusBar]] instead. */
+    get bottomCenter() { return this._bottomCenter; }
+    /** @deprecated in 3.6. Use [[FrontstageDef.rightPanel]] instead. */
+    get bottomRight() { return this._bottomRight; }
+    /** @beta */
+    get toolSettings() { var _a; return (_a = this.topCenter) === null || _a === void 0 ? void 0 : _a.getSingleWidgetDef(); }
+    /** @beta */
+    get statusBar() { var _a; return (_a = this.bottomCenter) === null || _a === void 0 ? void 0 : _a.getSingleWidgetDef(); }
+    /** @beta */
+    get contentManipulation() { var _a; return (_a = this.topLeft) === null || _a === void 0 ? void 0 : _a.getSingleWidgetDef(); }
+    /** @beta */
+    get viewNavigation() { var _a; return (_a = this.topRight) === null || _a === void 0 ? void 0 : _a.getSingleWidgetDef(); }
+    /** @beta */
     get topPanel() { return this._topPanel; }
+    /** @beta
+     * @deprecated in 3.0. Only topPanel is supported in UI 2.0 */
+    get topMostPanel() { return this._topMostPanel; }
+    /** @beta */
     get leftPanel() { return this._leftPanel; }
+    /** @beta */
     get rightPanel() { return this._rightPanel; }
+    /** @beta */
     get bottomPanel() { return this._bottomPanel; }
+    /** @beta
+     * @deprecated in 3.0. Only bottomPanel is supported in UI 2.0  */
+    get bottomMostPanel() { return this._bottomMostPanel; }
     get contentLayoutDef() { return this._contentLayoutDef; }
     get contentGroup() { return this._contentGroup; }
     get frontstageProvider() { return this._frontstageProvider; }
+    /** @internal */
+    get nineZone() { return this._nineZone; } // istanbul ignore next
+    set nineZone(props) { this._nineZone = props; }
     toStagePanelLocation(side) {
         switch (side) {
             case "bottom":
@@ -144,7 +190,7 @@ export class FrontstageDef {
     set nineZoneState(state) {
         if (this._nineZoneState === state)
             return;
-        if (!this._nineZoneState) {
+        if ("1" === UiFramework.uiVersion || !this._nineZoneState) {
             this._nineZoneState = state;
         }
         else {
@@ -169,8 +215,14 @@ export class FrontstageDef {
     static async create(provider) {
         const def = new FrontstageDef();
         def._frontstageProvider = provider;
-        const config = provider.frontstageConfig();
-        await def.initializeFromConfig(config);
+        if (provider.frontstageConfig) {
+            const config = provider.frontstageConfig();
+            const props = toFrontstageProps(config);
+            await def.initializeFromProps(props);
+        }
+        else {
+            await def.initializeFromProps(provider.frontstage.props);
+        }
         return def;
     }
     /** Handles when the Frontstage becomes activated */
@@ -179,8 +231,14 @@ export class FrontstageDef {
     async onActivated() {
         this.updateWidgetDefs();
         const provider = this._contentGroupProvider;
-        if (provider && this._initialConfig) {
-            this._contentGroup = await provider.contentGroup(this._initialConfig);
+        if (provider && this._initialProps) {
+            if (provider.contentGroup) {
+                const config = toFrontstageConfig(this._initialProps);
+                this._contentGroup = await provider.contentGroup(config);
+            }
+            else {
+                this._contentGroup = await provider.provideContentGroup(this._initialProps);
+            }
         }
         // istanbul ignore next
         if (!this._contentGroup)
@@ -256,6 +314,22 @@ export class FrontstageDef {
             this.contentGroup.onFrontstageReady();
         this._onFrontstageReady();
     }
+    /** Starts the default tool for the Frontstage.
+     * @deprecated in 3.6.
+     */
+    startDefaultTool() {
+        // Start the default tool
+        // istanbul ignore next
+        if (IModelApp.toolAdmin && IModelApp.viewManager) {
+            if (this.defaultTool) {
+                IModelApp.toolAdmin.defaultToolId = this.defaultTool.toolId;
+                this.defaultTool.execute();
+            }
+            else {
+                IModelApp.toolAdmin.startDefaultTool(); // eslint-disable-line @typescript-eslint/no-floating-promises
+            }
+        }
+    }
     /** Sets the Content Layout and Content Group */
     setContentLayoutAndGroup(contentLayoutDef, contentGroup) {
         this._contentLayoutDef = contentLayoutDef;
@@ -265,6 +339,9 @@ export class FrontstageDef {
     async setActiveContent() {
         let contentControl;
         let activated = false;
+        if (this.contentGroup && this.defaultContentId) {
+            contentControl = this.contentGroup.getContentControlById(this.defaultContentId);
+        }
         // istanbul ignore else
         if (!contentControl && this.contentControls.length >= 0) {
             contentControl = this.contentControls[0];
@@ -296,6 +373,56 @@ export class FrontstageDef {
         // istanbul ignore next
         return false;
     }
+    /** Gets a [[ZoneDef]] based on a given zone id.
+     * @deprecated in 3.6. UI1.0 is deprecated.
+     */
+    getZoneDef(zoneId) {
+        let zoneDef;
+        switch (zoneId) {
+            case 1:
+                zoneDef = this.topLeft;
+                break;
+            case 2:
+                zoneDef = this.topCenter;
+                break;
+            case 3:
+                zoneDef = this.topRight;
+                break;
+            case 4:
+                zoneDef = this.centerLeft;
+                break;
+            case 6:
+                zoneDef = this.centerRight;
+                break;
+            case 7:
+                zoneDef = this.bottomLeft;
+                break;
+            case 8:
+                zoneDef = this.bottomCenter;
+                break;
+            case 9:
+                zoneDef = this.bottomRight;
+                break;
+            // istanbul ignore next
+            default:
+                throw new RangeError();
+        }
+        // Zones can be undefined in a Frontstage
+        return zoneDef;
+    }
+    /** Gets a list of [[ZoneDef]]s.
+     * @deprecated in 3.6. UI1.0 is deprecated.
+     */
+    get zoneDefs() {
+        const zones = [1, 2, 3, 4, 6, 7, 8, 9];
+        const zoneDefs = [];
+        zones.forEach((zoneId) => {
+            const zoneDef = this.getZoneDef(zoneId);
+            if (zoneDef)
+                zoneDefs.push(zoneDef);
+        });
+        return zoneDefs;
+    }
     /** Gets a [[StagePanelDef]] based on a given panel location
      * @beta
      */
@@ -305,6 +432,9 @@ export class FrontstageDef {
             case StagePanelLocation.Top:
                 panelDef = this.topPanel;
                 break;
+            case StagePanelLocation.TopMost:
+                panelDef = this.topMostPanel; // eslint-disable-line deprecation/deprecation
+                break;
             case StagePanelLocation.Left:
                 panelDef = this.leftPanel;
                 break;
@@ -314,6 +444,12 @@ export class FrontstageDef {
             case StagePanelLocation.Bottom:
                 panelDef = this.bottomPanel;
                 break;
+            case StagePanelLocation.BottomMost:
+                panelDef = this.bottomMostPanel; // eslint-disable-line deprecation/deprecation
+                break;
+            // istanbul ignore next
+            default:
+                throw new RangeError();
         }
         // Panels can be undefined in a Frontstage
         return panelDef;
@@ -322,29 +458,44 @@ export class FrontstageDef {
      * @beta
      */
     get panelDefs() {
-        const locations = [
+        const panels = [
             StagePanelLocation.Left, StagePanelLocation.Right,
-            StagePanelLocation.Top, StagePanelLocation.Bottom,
+            StagePanelLocation.Top, StagePanelLocation.TopMost,
+            StagePanelLocation.Bottom, StagePanelLocation.BottomMost,
         ];
-        const panels = [];
-        locations.forEach((location) => {
-            const panel = this.getStagePanelDef(location);
-            if (panel)
-                panels.push(panel);
+        const panelDefs = [];
+        panels.forEach((location) => {
+            const panelDef = this.getStagePanelDef(location);
+            if (panelDef)
+                panelDefs.push(panelDef);
         });
-        return panels;
+        return panelDefs;
     }
     /** Finds a [[WidgetDef]] based on a given id */
     findWidgetDef(id) {
-        for (const widgetDef of this.widgetDefs) {
-            if (widgetDef.id === id)
+        for (const zoneDef of this.zoneDefs) {
+            const widgetDef = zoneDef.findWidgetDef(id);
+            if (widgetDef)
+                return widgetDef;
+        }
+        for (const panelDef of this.panelDefs) {
+            const widgetDef = panelDef.findWidgetDef(id);
+            if (widgetDef)
                 return widgetDef;
         }
+        // istanbul ignore next
         return undefined;
     }
     /** Gets the list of [[WidgetControl]]s */
     get _widgetControls() {
         const widgetControls = new Array();
+        this.zoneDefs.forEach((zoneDef) => {
+            zoneDef.widgetDefs.forEach((widgetDef) => {
+                const widgetControl = widgetDef.widgetControl;
+                if (widgetControl)
+                    widgetControls.push(widgetControl);
+            });
+        });
         this.panelDefs.forEach((panelDef) => {
             panelDef.widgetDefs.forEach((widgetDef) => {
                 const widgetControl = widgetDef.widgetControl;
@@ -387,36 +538,60 @@ export class FrontstageDef {
         }
         return contentControls;
     }
-    /** Initializes a FrontstageDef from FrontstageConfig.
+    /** Initializes a FrontstageDef from FrontstageProps
      * @internal
      */
-    async initializeFromConfig(config) {
-        this._id = config.id;
-        this._initialConfig = config;
-        if (config.contentGroup instanceof ContentGroupProvider) {
-            this._contentGroupProvider = config.contentGroup;
+    async initializeFromProps(props) {
+        this._id = props.id;
+        this._initialProps = props;
+        this._defaultTool = props.defaultTool; // Might be `undefined`, see `toFrontstageProps`.
+        if (props.defaultContentId !== undefined)
+            this._defaultContentId = props.defaultContentId;
+        if (props.contentGroup instanceof ContentGroupProvider) {
+            this._contentGroupProvider = props.contentGroup;
         }
         else {
-            this._contentGroup = config.contentGroup;
-        }
-        this._usage = config.usage;
-        this._version = config.version;
-        this._toolSettings = createWidgetDef(config.toolSettings, WidgetType.ToolSettings);
-        this._statusBar = createWidgetDef(config.statusBar, WidgetType.StatusBar);
-        this._contentManipulation = createWidgetDef(config.contentManipulation, WidgetType.Tool);
-        this._viewNavigation = createWidgetDef(config.viewNavigation, WidgetType.Navigation);
-        this._topPanel = createStagePanelDef(config, StagePanelLocation.Top);
-        this._leftPanel = createStagePanelDef(config, StagePanelLocation.Left);
-        this._rightPanel = createStagePanelDef(config, StagePanelLocation.Right);
-        this._bottomPanel = createStagePanelDef(config, StagePanelLocation.Bottom);
+            this._contentGroup = props.contentGroup;
+        }
+        if (props.isInFooterMode !== undefined)
+            this._isInFooterMode = props.isInFooterMode;
+        this._applicationData = props.applicationData;
+        this._usage = props.usage;
+        this._version = props.version || 0;
+        // eslint-disable-next-line deprecation/deprecation
+        this._topLeft = Frontstage.createZoneDef(props.contentManipulationTools ? props.contentManipulationTools : props.topLeft, ZoneLocation.TopLeft, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._topCenter = Frontstage.createZoneDef(props.toolSettings ? props.toolSettings : props.topCenter, ZoneLocation.TopCenter, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._topRight = Frontstage.createZoneDef(props.viewNavigationTools ? /* istanbul ignore next */ props.viewNavigationTools : props.topRight, ZoneLocation.TopRight, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._centerLeft = Frontstage.createZoneDef(props.centerLeft, ZoneLocation.CenterLeft, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._centerRight = Frontstage.createZoneDef(props.centerRight, ZoneLocation.CenterRight, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._bottomLeft = Frontstage.createZoneDef(props.bottomLeft, ZoneLocation.BottomLeft, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._bottomCenter = Frontstage.createZoneDef(props.statusBar ? props.statusBar : props.bottomCenter, ZoneLocation.BottomCenter, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._bottomRight = Frontstage.createZoneDef(props.bottomRight, ZoneLocation.BottomRight, props);
+        // eslint-disable-next-line deprecation/deprecation
+        this._topPanel = Frontstage.createStagePanelDef(StagePanelLocation.Top, props);
+        this._topMostPanel = Frontstage.createStagePanelDef(StagePanelLocation.TopMost, props);
+        this._leftPanel = Frontstage.createStagePanelDef(StagePanelLocation.Left, props);
+        this._rightPanel = Frontstage.createStagePanelDef(StagePanelLocation.Right, props);
+        this._bottomPanel = Frontstage.createStagePanelDef(StagePanelLocation.Bottom, props);
+        this._bottomMostPanel = Frontstage.createStagePanelDef(StagePanelLocation.BottomMost, props);
     }
     /** @internal */
     updateWidgetDefs() {
         // Tracks provided widgets to prevent duplicates.
         const allStageWidgetDefs = [];
-        // Process panels before zones so extension can explicitly target a widget for a StagePanelSection
+        // Process panels before zones so in uiVersion="2" extension can explicitly target a widget for a StagePanelSection
         this.panelDefs.forEach((stagePanelDef) => {
-            stagePanelDef.updateDynamicWidgetDefs(this.id, this.usage, stagePanelDef.location, undefined, allStageWidgetDefs);
+            stagePanelDef.updateDynamicWidgetDefs(this.id, this.usage, stagePanelDef.location, undefined, allStageWidgetDefs, this.applicationData);
+        });
+        this.zoneDefs.forEach((zoneDef) => {
+            zoneDef.updateDynamicWidgetDefs(this.id, this.usage, zoneDef.zoneLocation, undefined, allStageWidgetDefs, this.applicationData);
         });
     }
     /** @beta */
@@ -747,6 +922,11 @@ 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;
@@ -766,53 +946,90 @@ export class FrontstageDef {
         };
     }
 }
-function createWidgetDef(config, type) {
-    if (!config)
-        return undefined;
-    const widgetDef = WidgetDef.create(config, type);
-    return widgetDef;
+function toFrontstageProps(config) {
+    const { contentManipulation, viewNavigation, toolSettings, statusBar, topPanel, leftPanel, bottomPanel, rightPanel, ...other } = config;
+    const props = {
+        ...other,
+        defaultTool: undefined,
+        toolSettings: toolSettings ? toZoneElement(toolSettings) : undefined,
+        statusBar: statusBar ? toZoneElement(statusBar) : undefined,
+        contentManipulationTools: contentManipulation ? toZoneElement(contentManipulation) : undefined,
+        viewNavigationTools: viewNavigation ? toZoneElement(viewNavigation) : undefined,
+        topPanel: topPanel ? toStagePanelElement(topPanel) : undefined,
+        leftPanel: leftPanel ? toStagePanelElement(leftPanel) : undefined,
+        bottomPanel: bottomPanel ? toStagePanelElement(bottomPanel) : undefined,
+        rightPanel: rightPanel ? toStagePanelElement(rightPanel) : undefined,
+    };
+    return props;
 }
-function createStagePanelDef(frontstageConfig, location) {
-    const config = getStagePanel(location, frontstageConfig);
-    const panelDef = new StagePanelDef();
-    panelDef.initializeFromConfig(config, location);
-    return panelDef;
+function toWidgetElement(config) {
+    return (React.createElement(Widget, { key: config.id, ...config }));
 }
-function getStagePanel(location, config) {
-    switch (location) {
-        case StagePanelLocation.Top:
-            return config.topPanel;
-        case StagePanelLocation.Left:
-            return config.leftPanel;
-        case StagePanelLocation.Right:
-            return config.rightPanel;
-        case StagePanelLocation.Bottom:
-            return config.bottomPanel;
-    }
+function toZoneElement(config) {
+    return (React.createElement(Zone, { widgets: [
+            toWidgetElement(config),
+        ] }));
 }
-/** Hook that returns active frontstage id.
- * @public
- */
-export const useActiveFrontstageId = () => {
-    const def = useActiveFrontstageDef();
-    const id = React.useMemo(() => def ? /* istanbul ignore next */ def.id : "", [def]);
-    return id;
-};
-/** @internal */
-export function useActiveFrontstageDef() {
-    const [def, setDef] = React.useState(FrontstageManager.activeFrontstageDef);
-    React.useEffect(() => {
-        return FrontstageManager.onFrontstageActivatedEvent.addListener((args) => {
-            setDef(args.activatedFrontstageDef);
-        });
-    }, []);
-    return def;
+function toStagePanelElement(config) {
+    var _a, _b;
+    const { sections, ...other } = config;
+    const startWidgets = (_a = sections === null || sections === void 0 ? void 0 : sections.start) === null || _a === void 0 ? void 0 : _a.map((widget) => toWidgetElement(widget));
+    const endWidgets = (_b = sections === null || sections === void 0 ? void 0 : sections.end) === null || _b === void 0 ? void 0 : _b.map((widget) => toWidgetElement(widget));
+    const panelZones = {};
+    if (startWidgets)
+        panelZones.start = {
+            widgets: startWidgets,
+        };
+    if (endWidgets)
+        panelZones.end = {
+            widgets: endWidgets,
+        };
+    return (React.createElement(StagePanel, { panelZones: panelZones, ...other }));
 }
-/** Hook that returns the widgetDef for a specific widgetId within the active frontstage.
- * @public
- */
-export function useSpecificWidgetDef(widgetId) {
-    const frontstageDef = useActiveFrontstageDef();
-    return frontstageDef === null || frontstageDef === void 0 ? void 0 : frontstageDef.findWidgetDef(widgetId);
+let widgetConfigId = 0;
+function toWidgetConfig(widget) {
+    const props = widget.props;
+    return {
+        ...props,
+        id: props.id ? props.id : `widget-config-${++widgetConfigId}`,
+    };
+}
+function toWidgetConfigFromZone(zone) {
+    const widgets = zone.props.widgets;
+    if (!widgets || widgets.length === 0)
+        return undefined;
+    const widget = widgets[0];
+    return toWidgetConfig(widget);
+}
+function toPanelConfig(panel) {
+    var _a, _b, _c, _d;
+    const props = panel.props;
+    const { panelZones, ...other } = props;
+    const start = (_b = (_a = panelZones === null || panelZones === void 0 ? void 0 : panelZones.start) === null || _a === void 0 ? void 0 : _a.widgets) === null || _b === void 0 ? void 0 : _b.map((w) => toWidgetConfig(w));
+    const end = (_d = (_c = panelZones === null || panelZones === void 0 ? void 0 : panelZones.end) === null || _c === void 0 ? void 0 : _c.widgets) === null || _d === void 0 ? void 0 : _d.map((w) => toWidgetConfig(w));
+    const config = {
+        ...other,
+        sections: {
+            start,
+            end,
+        },
+    };
+    return config;
+}
+function toFrontstageConfig(props) {
+    const { contentManipulationTools, viewNavigationTools, toolSettings, statusBar, topPanel, leftPanel, bottomPanel, rightPanel, ...other } = props;
+    const config = {
+        ...other,
+        version: props.version || 0,
+        contentManipulation: contentManipulationTools ? toWidgetConfigFromZone(contentManipulationTools) : undefined,
+        viewNavigation: viewNavigationTools ? toWidgetConfigFromZone(viewNavigationTools) : undefined,
+        toolSettings: toolSettings ? toWidgetConfigFromZone(toolSettings) : undefined,
+        statusBar: statusBar ? toWidgetConfigFromZone(statusBar) : undefined,
+        topPanel: topPanel ? toPanelConfig(topPanel) : undefined,
+        leftPanel: leftPanel ? toPanelConfig(leftPanel) : undefined,
+        bottomPanel: bottomPanel ? toPanelConfig(bottomPanel) : undefined,
+        rightPanel: rightPanel ? toPanelConfig(rightPanel) : undefined,
+    };
+    return config;
 }
 //# sourceMappingURL=FrontstageDef.js.map