@itwin/appui-react 4.17.1 → 5.0.0-dev.2

package/lib/appui-react/widgets/WidgetDef.d.ts

@@ -0,0 +1,160 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import type * as React from "react";
+import type { ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
+import { UiEvent } from "@itwin/appui-abstract";
+import type { XAndY } from "@itwin/core-geometry";
+import type { ConfigurableUiControlConstructor } from "../configurableui/ConfigurableUiControl.js";
+import { ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl.js";
+import type { WidgetControl } from "./WidgetControl.js";
+import type { BadgeType, IconSpec } from "@itwin/core-react";
+import type { BadgeKind } from "@itwin/core-react/internal";
+import type { WidgetConfig } from "./WidgetConfig.js";
+import { WidgetState } from "./WidgetState.js";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation.js";
+import type { NineZoneState } from "../layout/state/NineZoneState.js";
+import type { SizeProps } from "../utils/SizeProps.js";
+/** Widget State Changed Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface WidgetStateChangedEventArgs {
+    widgetDef: WidgetDef;
+    widgetState: WidgetState;
+}
+/** Widget State Changed Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class WidgetStateChangedEvent extends UiEvent<WidgetStateChangedEventArgs> {
+}
+/** Widget type enum.
+ * @public
+ */
+export declare enum WidgetType {
+    Tool = 0,
+    Navigation = 1,
+    Rectangular = 2,
+    ToolSettings = 3,
+    StatusBar = 4
+}
+/** A Widget Definition in the 9-Zone Layout system.
+ * @public
+ */
+export declare class WidgetDef {
+    private static _sId;
+    private _label;
+    private _tooltip;
+    private _widgetReactNode;
+    private _widgetControl;
+    private _defaultState;
+    private _id;
+    private _priority;
+    private _stateChanged;
+    private _widgetType;
+    private _applicationData?;
+    private _iconSpec?;
+    private _internalData?;
+    private _badge?;
+    private _badgeKind?;
+    private _saveTransientState?;
+    private _restoreTransientState?;
+    private _preferredPanelSize;
+    private _defaultFloatingSize;
+    private _canPopout?;
+    private _floatingContainerId?;
+    private _defaultFloatingPosition;
+    private _hideWithUiWhenFloating?;
+    private _allowedPanelTargets?;
+    private _initialConfig?;
+    get state(): WidgetState;
+    get id(): string;
+    get priority(): number;
+    get isFloatingStateSupported(): boolean;
+    get isFloatingStateWindowResizable(): boolean;
+    get isToolSettings(): boolean;
+    get isStatusBar(): boolean;
+    get stateChanged(): boolean;
+    get applicationData(): any;
+    get isFloating(): boolean;
+    /** @deprecated in 4.16.0. Use {@link Widget.iconNode} instead. */
+    get iconSpec(): IconSpec;
+    set iconSpec(spec: IconSpec);
+    /** @deprecated in 4.16.0. Use `badgeKind` instead. */
+    get badgeType(): BadgeType | undefined;
+    get badgeKind(): BadgeKind | undefined;
+    get initialConfig(): WidgetConfig | undefined;
+    get widgetType(): WidgetType;
+    set widgetType(type: WidgetType);
+    /** @internal */
+    get defaultFloatingPosition(): XAndY | undefined;
+    set defaultFloatingPosition(position: XAndY | undefined);
+    /** @internal */
+    get defaultFloatingSize(): SizeProps | undefined;
+    set defaultFloatingSize(size: SizeProps | undefined);
+    /** @internal */
+    get defaultState(): WidgetState;
+    constructor();
+    /** @internal */
+    static create(config: WidgetConfig, type?: WidgetType): WidgetDef;
+    private initializeFromConfig;
+    /** @alpha */
+    get preferredPanelSize(): "fit-content" | undefined;
+    /** Get the label string */
+    get label(): string;
+    /** Set the label.
+     * @param labelSpec A string or a function to get the string.
+     */
+    setLabel(labelSpec: string | ConditionalStringValue | StringGetter): void;
+    /** Get the tooltip string */
+    get tooltip(): string;
+    /** Set the tooltip.
+     * @param v A string or a function to get the string.
+     */
+    setTooltip(v: string | ConditionalStringValue | StringGetter): void;
+    get reactNode(): React.ReactNode;
+    set reactNode(node: React.ReactNode);
+    setWidgetState(newState: WidgetState): void;
+    /** @internal */
+    handleWidgetStateChanged(newState: WidgetState): void;
+    setCanPopout(value: boolean | undefined): void;
+    get canPopout(): boolean | undefined;
+    setFloatingContainerId(value: string | undefined): void;
+    get floatingContainerId(): string | undefined;
+    canOpen(): boolean;
+    get isVisible(): boolean;
+    get activeState(): WidgetState;
+    get isActive(): boolean;
+    set hideWithUiWhenFloating(hide: boolean | undefined);
+    get hideWithUiWhenFloating(): boolean;
+    get allowedPanelTargets(): ReadonlyArray<StagePanelLocation> | undefined;
+    set allowedPanelTargets(targets: ReadonlyArray<StagePanelLocation> | undefined);
+    onWidgetStateChanged(): void;
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState(): void;
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState(): boolean;
+    /** Opens the widget and makes it visible to the user.
+     * @note Opens the stage panel if needed.
+     * @note Brings the floating widget to the front.
+     * @note Brings the window of the popout widget to the front (if allowed by the browser).
+     * @public
+     */
+    show(): void;
+    /** Opens the widget and expands it to fill full size of the stage panel.
+     * @public
+     */
+    expand(): void;
+    /** @deprecated in 4.16.0. Uses a deprecated type {@link ConfigurableUiControlConstructor}. */
+    get classId(): string | ConfigurableUiControlConstructor | undefined;
+    /** @deprecated in 4.16.0. Returns an instance of a deprecated type {@link WidgetControl}. */
+    get widgetControl(): WidgetControl | undefined;
+    /** @deprecated in 4.16.0. Returns an instance of a deprecated type {@link WidgetControl}. */
+    getWidgetControl(type: ConfigurableUiControlType): WidgetControl | undefined;
+}
+/** @internal */
+export declare function getWidgetState(widgetId: WidgetDef["id"], nineZone: NineZoneState): WidgetState;
+//# sourceMappingURL=WidgetDef.d.ts.map

package/lib/appui-react/widgets/WidgetDef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetDef.d.ts","sourceRoot":"","sources":["../../../src/appui-react/widgets/WidgetDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EACV,sBAAsB,EACtB,YAAY,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAW,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAEL,yBAAyB,EAC1B,MAAM,4CAA4C,CAAC;AAGpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAQ1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGvD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AAEH,qBAAa,uBAAwB,SAAQ,OAAO,CAAC,2BAA2B,CAAC;CAAG;AAEpF;;GAEG;AACH,oBAAY,UAAU;IACpB,IAAI,IAAA;IACJ,UAAU,IAAA;IACV,WAAW,IAAA;IACX,YAAY,IAAA;IACZ,SAAS,IAAA;CACV;AAID;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACxB,OAAO,CAAC,MAAM,CAAsD;IACpE,OAAO,CAAC,QAAQ,CAAsD;IACtE,OAAO,CAAC,gBAAgB,CAAkB;IAE1C,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,aAAa,CAAmC;IACxD,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,gBAAgB,CAAC,CAAM;IAE/B,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,OAAO,CAAC,aAAa,CAAC,CAAmB;IAEzC,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,mBAAmB,CAAC,CAAa;IACzC,OAAO,CAAC,sBAAsB,CAAC,CAAgB;IAC/C,OAAO,CAAC,mBAAmB,CAA4B;IACvD,OAAO,CAAC,oBAAoB,CAAwB;IACpD,OAAO,CAAC,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,oBAAoB,CAAC,CAAS;IACtC,OAAO,CAAC,wBAAwB,CAAoB;IAEpD,OAAO,CAAC,uBAAuB,CAAC,CAAU;IAC1C,OAAO,CAAC,oBAAoB,CAAC,CAAoC;IACjE,OAAO,CAAC,cAAc,CAAC,CAAe;IAEtC,IAAW,KAAK,IAAI,WAAW,CAM9B;IAED,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,wBAAwB,IAAI,OAAO,CAW7C;IAED,IAAW,8BAA8B,IAAI,OAAO,CAOnD;IAED,IAAW,cAAc,IAAI,OAAO,CAEnC;IACD,IAAW,WAAW,IAAI,OAAO,CAEhC;IACD,IAAW,YAAY,IAAI,OAAO,CAEjC;IACD,IAAW,eAAe,IAAI,GAAG,CAEhC;IACD,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,kEAAkE;IAElE,IAAW,QAAQ,IAAI,QAAQ,CAK9B;IAGD,IAAW,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAKjC;IACD,sDAAsD;IAEtD,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IAED,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IACD,IAAW,aAAa,IAAI,YAAY,GAAG,SAAS,CAEnD;IAED,IAAW,UAAU,IAAI,UAAU,CAElC;IACD,IAAW,UAAU,CAAC,IAAI,EAAE,UAAU,EAErC;IAED,gBAAgB;IAChB,IAAW,uBAAuB,IAGW,KAAK,GAAG,SAAS,CAD7D;IACD,IAAW,uBAAuB,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,EAE7D;IAED,gBAAgB;IAChB,IAAW,mBAAmB,IAGO,SAAS,GAAG,SAAS,CADzD;IACD,IAAW,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAEzD;IAED,gBAAgB;IAChB,IAAW,YAAY,gBAEtB;;IAOD,gBAAgB;WACF,MAAM,CAClB,MAAM,EAAE,YAAY,EACpB,IAAI,GAAE,UAAmC;IAO3C,OAAO,CAAC,oBAAoB;IA2D5B,aAAa;IACb,IAAW,kBAAkB,8BAE5B;IAED,2BAA2B;IAC3B,IAAW,KAAK,IAAI,MAAM,CAGzB;IAED;;OAEG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,GAAG,YAAY;IAezE,6BAA6B;IAC7B,IAAW,OAAO,IAAI,MAAM,CAG3B;IAED;;OAEG;IACI,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,YAAY;IAInE,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAatC;IAED,IAAW,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAEzC;IAEM,cAAc,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IA8ClD,gBAAgB;IACT,wBAAwB,CAAC,QAAQ,EAAE,WAAW;IAS9C,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS;IAI9C,IAAW,SAAS,IAAI,OAAO,GAAG,SAAS,CAE1C;IAEM,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAIvD,IAAW,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAEnD;IAEM,OAAO,IAAI,OAAO;IAIzB,IAAW,SAAS,IAAI,OAAO,CAI9B;IAED,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,IAAW,sBAAsB,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,EAE1D;IAED,IAAW,sBAAsB,IAAI,OAAO,CAE3C;IAED,IAAW,mBAAmB,IAC1B,aAAa,CAAC,kBAAkB,CAAC,GACjC,SAAS,CAEZ;IAED,IAAW,mBAAmB,CAC5B,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC,GAAG,SAAS,EAGvD;IAEM,oBAAoB,IAAI,IAAI;IAKnC,kEAAkE;IAC3D,kBAAkB,IAAI,IAAI;IAMjC;;OAEG;IACI,qBAAqB,IAAI,OAAO;IAgBvC;;;;;OAKG;IACI,IAAI;IAqBX;;OAEG;IACI,MAAM;IAcb,8FAA8F;IAC9F,IAAW,OAAO,IAAI,MAAM,GAAG,gCAAgC,GAAG,SAAS,CAE1E;IAED,6FAA6F;IAC7F,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IAED,6FAA6F;IACtF,gBAAgB,CACrB,IAAI,EAAE,yBAAyB,GAC9B,aAAa,GAAG,SAAS;CAsD7B;AAED,gBAAgB;AAChB,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,EACzB,QAAQ,EAAE,aAAa,eAuCxB"}

package/lib/appui-react/widgets/WidgetDef.js

@@ -0,0 +1,487 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+import { UiError, UiEvent } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControlType, } from "../configurableui/ConfigurableUiControl.js";
+import { UiFramework } from "../UiFramework.js";
+import { PropsHelper } from "../utils/PropsHelper.js";
+import { IconHelper } from "@itwin/core-react";
+import { WidgetState } from "./WidgetState.js";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation.js";
+import { StatusBarWidgetComposerControl } from "./StatusBarWidgetComposerControl.js";
+import { getTabLocation, isFloatingTabLocation, isPanelTabLocation, isPopoutTabLocation, } from "../layout/state/TabLocation.js";
+import { IModelApp } from "@itwin/core-frontend";
+/** Widget State Changed Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+// eslint-disable-next-line deprecation/deprecation
+export class WidgetStateChangedEvent extends UiEvent {
+}
+/** Widget type enum.
+ * @public
+ */
+export var WidgetType;
+(function (WidgetType) {
+    WidgetType[WidgetType["Tool"] = 0] = "Tool";
+    WidgetType[WidgetType["Navigation"] = 1] = "Navigation";
+    WidgetType[WidgetType["Rectangular"] = 2] = "Rectangular";
+    WidgetType[WidgetType["ToolSettings"] = 3] = "ToolSettings";
+    WidgetType[WidgetType["StatusBar"] = 4] = "StatusBar";
+})(WidgetType || (WidgetType = {}));
+// -----------------------------------------------------------------------------
+/** A Widget Definition in the 9-Zone Layout system.
+ * @public
+ */
+export class WidgetDef {
+    get state() {
+        const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+        const nineZone = frontstageDef?.nineZoneState;
+        if (!nineZone)
+            return this.defaultState;
+        if (!frontstageDef.findWidgetDef(this.id))
+            return this.defaultState;
+        return getWidgetState(this.id, nineZone);
+    }
+    get id() {
+        return this._id;
+    }
+    get priority() {
+        return this._priority;
+    }
+    get isFloatingStateSupported() {
+        if (!this.initialConfig)
+            return true;
+        const allowedPanels = this.initialConfig.allowedPanels;
+        if (allowedPanels && allowedPanels.length === 0) {
+            return true;
+        }
+        const canFloat = this.initialConfig.canFloat;
+        if (canFloat === undefined)
+            return true;
+        return !!canFloat;
+    }
+    get isFloatingStateWindowResizable() {
+        const canFloat = this.initialConfig?.canFloat;
+        if (typeof canFloat === "object") {
+            return canFloat.isResizable === undefined ? true : canFloat.isResizable;
+        }
+        return true;
+    }
+    get isToolSettings() {
+        return this._widgetType === WidgetType.ToolSettings;
+    }
+    get isStatusBar() {
+        return this._widgetType === WidgetType.StatusBar;
+    }
+    get stateChanged() {
+        return this._stateChanged;
+    }
+    get applicationData() {
+        return this._applicationData;
+    }
+    get isFloating() {
+        return this.state === WidgetState.Floating;
+    }
+    /** @deprecated in 4.16.0. Use {@link Widget.iconNode} instead. */
+    // eslint-disable-next-line deprecation/deprecation
+    get iconSpec() {
+        // eslint-disable-next-line deprecation/deprecation
+        return this._iconSpec === IconHelper.reactIconKey
+            ? IconHelper.getIconReactNode(this._iconSpec, this._internalData) // eslint-disable-line deprecation/deprecation
+            : this._iconSpec;
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    set iconSpec(spec) {
+        // Setter is deprecated as well: ae-setter-with-docs.
+        this._iconSpec = this._internalData
+            ? IconHelper.getIconData(spec, this._internalData) // eslint-disable-line deprecation/deprecation
+            : spec;
+    }
+    /** @deprecated in 4.16.0. Use `badgeKind` instead. */
+    // eslint-disable-next-line deprecation/deprecation
+    get badgeType() {
+        return this._badge;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+    get badgeKind() {
+        return this._badgeKind;
+    }
+    get initialConfig() {
+        return this._initialConfig;
+    }
+    get widgetType() {
+        return this._widgetType;
+    }
+    set widgetType(type) {
+        this._widgetType = type;
+    }
+    /** @internal */
+    get defaultFloatingPosition() {
+        return this._defaultFloatingPosition;
+    }
+    set defaultFloatingPosition(position) {
+        this._defaultFloatingPosition = position;
+    }
+    /** @internal */
+    get defaultFloatingSize() {
+        return this._defaultFloatingSize;
+    }
+    set defaultFloatingSize(size) {
+        this._defaultFloatingSize = size;
+    }
+    /** @internal */
+    get defaultState() {
+        return this._defaultState;
+    }
+    constructor() {
+        this._label = "";
+        this._tooltip = "";
+        this._defaultState = WidgetState.Closed;
+        this._priority = 0;
+        this._stateChanged = false;
+        this._widgetType = WidgetType.Rectangular;
+        WidgetDef._sId++;
+        this._id = `Widget-${WidgetDef._sId}`;
+    }
+    /** @internal */
+    static create(config, type = WidgetType.Rectangular) {
+        const def = new WidgetDef();
+        def.initializeFromConfig(config, type);
+        return def;
+    }
+    initializeFromConfig(config, type) {
+        this._widgetType = type;
+        this._initialConfig = config;
+        this._id = config.id;
+        if (config.label)
+            this._label = config.label;
+        else if (config.labelKey)
+            this._label = IModelApp.localization.getLocalizedString(config.labelKey);
+        else if (type === WidgetType.ToolSettings)
+            this._label = "Tool Settings";
+        this.setCanPopout(config.canPopout);
+        const canFloat = config.canFloat;
+        if (typeof canFloat === "object") {
+            this.setFloatingContainerId(canFloat.containerId);
+            this.defaultFloatingPosition = canFloat.defaultPosition;
+            this._hideWithUiWhenFloating = !!canFloat.hideWithUi;
+            this._defaultFloatingSize = canFloat.defaultSize;
+        }
+        if ("allowedPanels" in config) {
+            this.allowedPanelTargets = config.allowedPanels;
+        }
+        else if (type === WidgetType.ToolSettings)
+            this.allowedPanelTargets = [
+                StagePanelLocation.Bottom,
+                StagePanelLocation.Left,
+                StagePanelLocation.Right,
+            ];
+        if (config.priority !== undefined)
+            this._priority = config.priority;
+        if (config.tooltip)
+            this.setTooltip(config.tooltip);
+        else if (config.tooltipKey)
+            this._tooltip = IModelApp.localization.getLocalizedString(config.tooltipKey);
+        if (config.defaultState !== undefined) {
+            this._defaultState = config.defaultState;
+        }
+        if (config.allowedPanels &&
+            config.allowedPanels.length === 0 &&
+            config.defaultState === WidgetState.Open) {
+            this._defaultState = WidgetState.Floating;
+        }
+        this._widgetReactNode = config.content;
+        // eslint-disable-next-line deprecation/deprecation
+        this._iconSpec = config.iconNode ?? config.icon;
+        // eslint-disable-next-line deprecation/deprecation
+        this._badge = config.badge;
+        this._badgeKind = config.badgeKind;
+        this._preferredPanelSize = config.preferredPanelSize;
+    }
+    /** @alpha */
+    get preferredPanelSize() {
+        return this._preferredPanelSize;
+    }
+    /** Get the label string */
+    get label() {
+        // eslint-disable-next-line deprecation/deprecation
+        return PropsHelper.getStringFromSpec(this._label);
+    }
+    /** Set the label.
+     * @param labelSpec A string or a function to get the string.
+     */
+    setLabel(labelSpec) {
+        this._label = labelSpec; // TODO: handle ConditionalStringValue
+        const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+        if (!frontstageDef)
+            return;
+        // eslint-disable-next-line deprecation/deprecation
+        const label = PropsHelper.getStringFromSpec(labelSpec);
+        frontstageDef.dispatch({
+            type: "WIDGET_TAB_SET_LABEL",
+            id: this.id,
+            label,
+        });
+    }
+    /** Get the tooltip string */
+    get tooltip() {
+        // eslint-disable-next-line deprecation/deprecation
+        return PropsHelper.getStringFromSpec(this._tooltip);
+    }
+    /** Set the tooltip.
+     * @param v A string or a function to get the string.
+     */
+    setTooltip(v) {
+        this._tooltip = v;
+    }
+    get reactNode() {
+        if (!this._widgetReactNode) {
+            // eslint-disable-next-line deprecation/deprecation
+            const widgetControl = this.getWidgetControl(
+            // eslint-disable-next-line deprecation/deprecation
+            ConfigurableUiControlType.Widget);
+            if (widgetControl && widgetControl.reactNode)
+                this._widgetReactNode = widgetControl.reactNode;
+        }
+        return this._widgetReactNode;
+    }
+    set reactNode(node) {
+        this._widgetReactNode = node;
+    }
+    setWidgetState(newState) {
+        const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+        const nineZone = frontstageDef?.nineZoneState;
+        if (!nineZone || this.isStatusBar)
+            return;
+        if (!frontstageDef.findWidgetDef(this.id))
+            return;
+        switch (newState) {
+            case WidgetState.Closed: {
+                frontstageDef.dispatch({
+                    type: "WIDGET_TAB_CLOSE",
+                    id: this.id,
+                });
+                break;
+            }
+            case WidgetState.Floating: {
+                frontstageDef.dispatch({
+                    type: "WIDGET_TAB_FLOAT",
+                    id: this.id,
+                    position: this._defaultFloatingPosition,
+                });
+                break;
+            }
+            case WidgetState.Hidden: {
+                frontstageDef.dispatch({
+                    type: "WIDGET_TAB_HIDE",
+                    id: this.id,
+                });
+                break;
+            }
+            case WidgetState.Open: {
+                frontstageDef.dispatch({
+                    type: "WIDGET_TAB_OPEN",
+                    id: this.id,
+                });
+                break;
+            }
+            case WidgetState.Unloaded: {
+                frontstageDef.dispatch({
+                    type: "WIDGET_TAB_UNLOAD",
+                    id: this.id,
+                });
+                break;
+            }
+        }
+    }
+    /** @internal */
+    handleWidgetStateChanged(newState) {
+        this._stateChanged = true;
+        UiFramework.frontstages.onWidgetStateChangedEvent.emit({
+            widgetDef: this,
+            widgetState: newState,
+        });
+        this.onWidgetStateChanged();
+    }
+    setCanPopout(value) {
+        this._canPopout = value;
+    }
+    get canPopout() {
+        return this._canPopout;
+    }
+    setFloatingContainerId(value) {
+        this._floatingContainerId = value;
+    }
+    get floatingContainerId() {
+        return this._floatingContainerId;
+    }
+    canOpen() {
+        return this.isFloating || this.isActive;
+    }
+    get isVisible() {
+        return (WidgetState.Hidden !== this.state && WidgetState.Unloaded !== this.state);
+    }
+    get activeState() {
+        return this.state;
+    }
+    get isActive() {
+        return WidgetState.Open === this.activeState;
+    }
+    set hideWithUiWhenFloating(hide) {
+        this._hideWithUiWhenFloating = !!hide;
+    }
+    get hideWithUiWhenFloating() {
+        return !!this._hideWithUiWhenFloating;
+    }
+    get allowedPanelTargets() {
+        return this._allowedPanelTargets;
+    }
+    set allowedPanelTargets(targets) {
+        this._allowedPanelTargets = targets;
+    }
+    onWidgetStateChanged() {
+        // eslint-disable-next-line deprecation/deprecation
+        this.widgetControl && this.widgetControl.onWidgetStateChanged();
+    }
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState() {
+        // eslint-disable-next-line deprecation/deprecation
+        this.widgetControl && this.widgetControl.saveTransientState();
+        this._saveTransientState && this._saveTransientState();
+    }
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState() {
+        let result = true;
+        // eslint-disable-next-line deprecation/deprecation
+        if (this.widgetControl || this._restoreTransientState) {
+            let result1 = false, result2 = false;
+            // eslint-disable-next-line deprecation/deprecation
+            if (this.widgetControl)
+                // eslint-disable-next-line deprecation/deprecation
+                result1 = this.widgetControl.restoreTransientState();
+            if (this._restoreTransientState)
+                result2 = this._restoreTransientState();
+            result = !(result1 || result2);
+        }
+        return result;
+    }
+    /** Opens the widget and makes it visible to the user.
+     * @note Opens the stage panel if needed.
+     * @note Brings the floating widget to the front.
+     * @note Brings the window of the popout widget to the front (if allowed by the browser).
+     * @public
+     */
+    show() {
+        const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+        const nineZone = frontstageDef?.nineZoneState;
+        if (!nineZone)
+            return;
+        if (!frontstageDef.findWidgetDef(this.id))
+            return;
+        const tabLocation = getTabLocation(nineZone, this.id);
+        if (tabLocation && isPopoutTabLocation(tabLocation)) {
+            const testWindow = UiFramework.childWindows.find(tabLocation.popoutWidgetId);
+            // Try to bring the window of the popout widget to the front.
+            testWindow?.window.focus();
+        }
+        frontstageDef.dispatch({
+            type: "WIDGET_TAB_SHOW",
+            id: this.id,
+        });
+    }
+    /** Opens the widget and expands it to fill full size of the stage panel.
+     * @public
+     */
+    expand() {
+        const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+        const nineZone = frontstageDef?.nineZoneState;
+        if (!nineZone)
+            return;
+        if (!frontstageDef.findWidgetDef(this.id))
+            return;
+        frontstageDef.dispatch({
+            type: "WIDGET_TAB_EXPAND",
+            id: this.id,
+        });
+    }
+    /* eslint-disable deprecation/deprecation */
+    /** @deprecated in 4.16.0. Uses a deprecated type {@link ConfigurableUiControlConstructor}. */
+    get classId() {
+        return undefined;
+    }
+    /** @deprecated in 4.16.0. Returns an instance of a deprecated type {@link WidgetControl}. */
+    get widgetControl() {
+        return this._widgetControl;
+    }
+    /** @deprecated in 4.16.0. Returns an instance of a deprecated type {@link WidgetControl}. */
+    getWidgetControl(type) {
+        if (!this._widgetControl && this.classId) {
+            let usedClassId = "";
+            if (typeof this.classId === "string") {
+                if (this.classId)
+                    this._widgetControl = UiFramework.controls.create(this.classId, this.id, this.applicationData);
+                usedClassId = this.classId;
+            }
+            else {
+                const info = new ConfigurableCreateInfo(this.classId.name, this.id, this.id);
+                usedClassId = this.classId.name;
+                this._widgetControl = new this.classId(info, this.applicationData);
+            }
+            if (this._widgetControl) {
+                if (this._widgetControl.getType() !== type) {
+                    // eslint-disable-next-line deprecation/deprecation
+                    throw new UiError(UiFramework.loggerCategory("WidgetDef"), `getWidgetControl: '${usedClassId}' is NOT a ${type}; it is a ${this._widgetControl.getType()}`);
+                }
+                this._widgetControl.widgetDef = this;
+                this._widgetControl.initialize();
+            }
+        }
+        if (!this._widgetControl && this.isStatusBar) {
+            const info = new ConfigurableCreateInfo("StatusBarWidgetComposerControl", StatusBarWidgetComposerControl.controlId, StatusBarWidgetComposerControl.controlId);
+            this._widgetControl = new StatusBarWidgetComposerControl(info, undefined);
+            this._widgetControl.widgetDef = this;
+            this._widgetControl.initialize();
+        }
+        return this._widgetControl;
+    }
+}
+WidgetDef._sId = 0;
+/** @internal */
+export function getWidgetState(widgetId, nineZone) {
+    const tab = nineZone.tabs[widgetId];
+    if (tab && tab.unloaded) {
+        return WidgetState.Unloaded;
+    }
+    if (nineZone.draggedTab?.tabId === widgetId) {
+        return WidgetState.Closed;
+    }
+    const toolSettingsTabId = nineZone.toolSettings?.tabId;
+    if (toolSettingsTabId === widgetId &&
+        nineZone.toolSettings?.type === "docked") {
+        return nineZone.toolSettings.hidden ? WidgetState.Hidden : WidgetState.Open;
+    }
+    const location = getTabLocation(nineZone, widgetId);
+    if (!location) {
+        return WidgetState.Hidden;
+    }
+    if (isFloatingTabLocation(location)) {
+        return WidgetState.Floating;
+    }
+    if (isPanelTabLocation(location)) {
+        const panel = nineZone.panels[location.side];
+        if (panel.collapsed || undefined === panel.size || 0 === panel.size)
+            return WidgetState.Closed;
+    }
+    const widget = nineZone.widgets[location.widgetId];
+    if (widget.minimized || widgetId !== widget.activeTabId)
+        return WidgetState.Closed;
+    return WidgetState.Open;
+}
+//# sourceMappingURL=WidgetDef.js.map