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

package/lib/esm/appui-react/syncui/BooleanListener.js

@@ -0,0 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+* 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 SyncUi
+ */
+import * as React from "react";
+import { SyncUiEventDispatcher } from "./SyncUiEventDispatcher";
+// cSpell:Ignore Unmounting
+/**
+ * A component that expect its children to be a function that will be passed the current boolValue state.
+ * @public @deprecated in 3.0.
+ */
+export class BooleanSyncUiListener extends React.Component {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false;
+        this._handleVisibilitySyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (this.props.eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                const boolValue = this.props.boolFunc();
+                /* istanbul ignore else */
+                if (this.state.boolValue !== boolValue) {
+                    this.setState({ boolValue });
+                }
+            }
+        };
+        // istanbul ignore next
+        this._hasNoChildren = (children) => React.Children.count(children) === 0;
+        this.state = {
+            boolValue: undefined !== props.defaultValue ? props.defaultValue : true,
+        };
+    }
+    componentDidMount() {
+        /* istanbul ignore else */
+        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);
+    }
+    componentWillUnmount() {
+        /* istanbul ignore else */
+        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {
+            this._componentUnmounting = true;
+            SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);
+        }
+    }
+    render() {
+        const { 
+        // do not bleed our props
+        children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars
+        // eslint-disable-next-line comma-dangle
+        ...otherProps // pass-through props
+         } = this.props;
+        const boolValue = this.state.boolValue;
+        return (typeof children === "function" ?
+            children(boolValue, otherProps)
+            : /* istanbul ignore next */ !this._hasNoChildren(children)
+                ? React.Children.only(children)
+                : null);
+    }
+}
+//# sourceMappingURL=BooleanListener.js.map

package/lib/esm/appui-react/syncui/BooleanListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanListener.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/BooleanListener.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAmB,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AA2BjF,2BAA2B;AAC3B;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,KAAK,CAAC,SAAqD;IAMpG,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;QANP,yBAAoB,GAAG,KAAK,CAAC;QAY7B,iCAA4B,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACrE,0BAA0B;YAC1B,IAAI,IAAI,CAAC,oBAAoB;gBAC3B,OAAO;YAET,0BAA0B;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAChG,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,0BAA0B;gBAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE;oBACtC,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;iBAC9B;aACF;QACH,CAAC,CAAC;QAgBF,uBAAuB;QACf,mBAAc,GAAG,CAAC,QAAa,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAnC/E,IAAI,CAAC,KAAK,GAAG;YACX,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC;IACJ,CAAC;IAiBe,iBAAiB;QAC/B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YACvE,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACvF,CAAC;IAEe,oBAAoB;QAClC,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACzE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;YACjC,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;SACvF;IACH,CAAC;IAKe,MAAM;QACpB,MAAM;QACJ,yBAAyB;QACzB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,wDAAwD;QACpG,wCAAwC;QACxC,GAAG,UAAU,CAAC,qBAAqB;UACpC,GAAG,IAAI,CAAC,KAAK,CAAC;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QAEvC,OAAO,CACL,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC;YAC9B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;YAC/B,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACzD,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC/B,CAAC,CAAC,IAAI,CACX,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module SyncUi\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"./SyncUiEventDispatcher\";\r\n\r\n/**\r\n * Properties supported by [[BooleanSyncUiListener]] component.\r\n * @public @deprecated in 3.0.\r\n */\r\nexport interface BooleanListenerProps {\r\n  /** One or more SyncUi event Ids that will trigger the function to be called. */\r\n  eventIds: string[];\r\n  /** Function to be called to return a boolean value. If the boolean value is different than the component's state value setState is\r\n   * called to update the value and trigger a re-render.\r\n   */\r\n  boolFunc: () => boolean;\r\n  /** Optional, default/initial boolean value that is saved in the components state. If\r\n   * not defined it will default to true.\r\n   */\r\n  defaultValue?: boolean;\r\n}\r\n\r\n/**\r\n * State for the [[BooleanSyncUiListener]] component.\r\n * @internal\r\n */\r\ninterface BooleanListenerState {\r\n  boolValue: boolean;\r\n}\r\n\r\n// cSpell:Ignore Unmounting\r\n/**\r\n * A component that expect its children to be a function that will be passed the current boolValue state.\r\n * @public @deprecated in 3.0.\r\n */\r\nexport class BooleanSyncUiListener extends React.Component<BooleanListenerProps, BooleanListenerState> {\r\n  private _componentUnmounting = false;\r\n\r\n  /** @internal */\r\n  public override readonly state: BooleanListenerState;\r\n\r\n  constructor(props: BooleanListenerProps) {\r\n    super(props);\r\n    this.state = {\r\n      boolValue: undefined !== props.defaultValue ? props.defaultValue : true,\r\n    };\r\n  }\r\n\r\n  private _handleVisibilitySyncUiEvent = (args: SyncUiEventArgs): void => {\r\n    /* istanbul ignore next */\r\n    if (this._componentUnmounting)\r\n      return;\r\n\r\n    /* istanbul ignore else */\r\n    if (this.props.eventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n      const boolValue = this.props.boolFunc();\r\n      /* istanbul ignore else */\r\n      if (this.state.boolValue !== boolValue) {\r\n        this.setState({ boolValue });\r\n      }\r\n    }\r\n  };\r\n\r\n  public override componentDidMount() {\r\n    /* istanbul ignore else */\r\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    /* istanbul ignore else */\r\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {\r\n      this._componentUnmounting = true;\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);\r\n    }\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private _hasNoChildren = (children: any) => React.Children.count(children) === 0;\r\n\r\n  public override render(): React.ReactNode {\r\n    const {\r\n      // do not bleed our props\r\n      children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars\r\n      // eslint-disable-next-line comma-dangle\r\n      ...otherProps // pass-through props\r\n    } = this.props;\r\n    const boolValue = this.state.boolValue;\r\n\r\n    return (\r\n      typeof children === \"function\" ?\r\n        children(boolValue, otherProps)\r\n        : /* istanbul ignore next */ !this._hasNoChildren(children)\r\n          ? React.Children.only(children)\r\n          : null\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module SyncUi
  */
-import { UiSyncEvent } from "@itwin/appui-abstract";
+import { UiSyncEvent, UiSyncEventArgs } from "@itwin/appui-abstract";
 import { IModelConnection } from "@itwin/core-frontend";
 /** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
  * @public
@@ -15,7 +15,11 @@ export declare enum SyncUiEventId {
     ActiveContentChanged = "activecontentchanged",
     /** The active view maintained by the ViewManager has changed. */
     ActiveViewportChanged = "activeviewportchanged",
-    /** Backstage has been toggled. */
+    /** Backstage has been closed.
+     * @deprecated in 1.x. Use BackstageEvent instead
+     */
+    BackstageCloseEvent = "backstagecloseevent",
+    /** Backstage has been closed. */
     BackstageEvent = "backstageevent",
     /** A Content Layout has been activated.  */
     ContentLayoutActivated = "contentlayoutactivated",
@@ -33,8 +37,14 @@ export declare enum SyncUiEventId {
     NavigationAidActivated = "navigationaidactivated",
     /** An InteractiveTool has been activated via the ToolAdmin. */
     ToolActivated = "toolactivated",
+    /** A Task has been activated.
+     * @deprecated in 3.0. */
+    TaskActivated = "taskactivated",
     /** The state of a Widget has changed. */
     WidgetStateChanged = "widgetstatechanged",
+    /** A Workflow has been activated.
+     * @deprecated in 3.0. */
+    WorkflowActivated = "workflowactivated",
     /** The SelectionSet for the active IModelConnection has changed. */
     SelectionSetChanged = "selectionsetchanged",
     /** The list of settings providers registered with SettingsManager has changed. */
@@ -43,8 +53,20 @@ export declare enum SyncUiEventId {
     ViewStateChanged = "viewstatechanged",
     /** The current object the reads and write UI State has changed. */
     UiStateStorageChanged = "uistatestoragechanged",
-    ShowHideManagerSettingChange = "show-hide-setting-change"
+    ShowHideManagerSettingChange = "show-hide-setting-change",
+    /** The list of feature overrides applied has been changed
+     * @alpha
+    */
+    FeatureOverridesChanged = "featureoverrideschanged"
 }
+/** SyncUi Event arguments. Contains a set of lower case event Ids.
+ * @public @deprecated in 3.0. Use UiSyncEventArgs in appui-abstract instead
+ */
+export declare type SyncUiEventArgs = UiSyncEventArgs;
+/** SyncUi Event class.
+ * @public @deprecated in 3.0. Use UiSyncEvent in appui-abstract instead
+ */
+export declare type SyncUiEvent = UiSyncEvent;
 /** This class is used to send eventIds to interested UI components so the component can determine if it needs
  * to refresh its display by calling setState on itself.
  * @public
@@ -59,7 +81,7 @@ export declare class SyncUiEventDispatcher {
     /** Return set of event ids that will be sent to listeners/. */
     static get syncEventIds(): Set<string>;
     /** Return SyncUiEvent so callers can register an event callback. */
-    static get onSyncUiEvent(): UiSyncEvent;
+    static get onSyncUiEvent(): SyncUiEvent;
     /** Immediately trigger sync event processing. */
     static dispatchImmediateSyncUiEvent(eventId: string): void;
     /** Save eventId in Set for processing. */
@@ -69,6 +91,7 @@ export declare class SyncUiEventDispatcher {
     /** Checks to see if an eventId of interest is contained in the set of eventIds */
     static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]): boolean;
     private static _dispatchViewChange;
+    private static _dispatchFeatureOverridesChange;
     /** Initializes the Monitoring of Events that trigger dispatching sync events */
     static initialize(): void;
     private static selectionChangedHandler;

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SyncUiEventDispatcher.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqB,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEvE,OAAO,EAAa,gBAAgB,EAAkD,MAAM,sBAAsB,CAAC;AAcnH;;GAEG;AACH,oBAAY,aAAa;IACvB,yCAAyC;IACzC,0BAA0B,+BAA+B;IACzD,qCAAqC;IACrC,uBAAuB,4BAA4B;IACnD,8EAA8E;IAC9E,oBAAoB,yBAAyB;IAC7C,iEAAiE;IACjE,qBAAqB,0BAA0B;IAC/C,kCAAkC;IAClC,cAAc,mBAAmB;IACjC,4CAA4C;IAC5C,sBAAsB,2BAA2B;IACjD,4EAA4E;IAC5E,uBAAuB,4BAA4B;IACnD,kCAAkC;IAClC,oBAAoB,yBAAyB;IAC7C,yEAAyE;IACzE,eAAe,oBAAoB;IACnC,oDAAoD;IACpD,sBAAsB,2BAA2B;IACjD,gDAAgD;IAChD,kBAAkB,uBAAuB;IACzC,0CAA0C;IAC1C,sBAAsB,2BAA2B;IACjD,+DAA+D;IAC/D,aAAa,kBAAkB;IAC/B,yCAAyC;IACzC,kBAAkB,uBAAuB;IACzC,oEAAoE;IACpE,mBAAmB,wBAAwB;IAC3C,kFAAkF;IAClF,wBAAwB,6BAA6B;IACrD,mFAAmF;IACnF,gBAAgB,qBAAqB;IACrC,mEAAmE;IACnE,qBAAqB,0BAA0B;IAC/C,4BAA4B,6BAA6B;CAC1D;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA2B;IAC5D,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAa;IACpD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAyB;IAChE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAS;IAEnC,wCAAwC;WAE1B,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpD,+DAA+D;IAC/D,WAAkB,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAE5C;IAED,oEAAoE;IACpE,WAAkB,aAAa,IAAI,WAAW,CAE7C;IAED,iDAAiD;WACnC,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIjE,0CAA0C;WAC5B,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQxD,oDAAoD;WACtC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAQ5D,kFAAkF;WACpE,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE;IAK/E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC,gFAAgF;WAClE,UAAU;IAkExB,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAItC,qFAAqF;WACvE,qBAAqB,CAAC,gBAAgB,EAAE,gBAAgB;IAKtE,0FAA0F;WAC5E,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB;CA+C5E"}
+{"version":3,"file":"SyncUiEventDispatcher.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqB,WAAW,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExF,OAAO,EAAa,gBAAgB,EAAkD,MAAM,sBAAsB,CAAC;AAiBnH;;GAEG;AACH,oBAAY,aAAa;IACvB,yCAAyC;IACzC,0BAA0B,+BAA+B;IACzD,qCAAqC;IACrC,uBAAuB,4BAA4B;IACnD,8EAA8E;IAC9E,oBAAoB,yBAAyB;IAC7C,iEAAiE;IACjE,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C,iCAAiC;IACjC,cAAc,mBAAmB;IACjC,4CAA4C;IAC5C,sBAAsB,2BAA2B;IACjD,4EAA4E;IAC5E,uBAAuB,4BAA4B;IACnD,kCAAkC;IAClC,oBAAoB,yBAAyB;IAC7C,yEAAyE;IACzE,eAAe,oBAAoB;IACnC,oDAAoD;IACpD,sBAAsB,2BAA2B;IACjD,gDAAgD;IAChD,kBAAkB,uBAAuB;IACzC,0CAA0C;IAC1C,sBAAsB,2BAA2B;IACjD,+DAA+D;IAC/D,aAAa,kBAAkB;IAC/B;6BACyB;IACzB,aAAa,kBAAkB;IAC/B,yCAAyC;IACzC,kBAAkB,uBAAuB;IACzC;6BACyB;IACzB,iBAAiB,sBAAsB;IACvC,oEAAoE;IACpE,mBAAmB,wBAAwB;IAC3C,kFAAkF;IAClF,wBAAwB,6BAA6B;IACrD,mFAAmF;IACnF,gBAAgB,qBAAqB;IACrC,mEAAmE;IACnE,qBAAqB,0BAA0B;IAC/C,4BAA4B,6BAA6B;IACzD;;MAEE;IACF,uBAAuB,4BAA4B;CACpD;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC;AAE9C;;GAEG;AACH,oBAAY,WAAW,GAAG,WAAW,CAAC;AAEtC;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA2B;IAC5D,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAa;IACpD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAyB;IAChE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAS;IAEnC,wCAAwC;WAE1B,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpD,+DAA+D;IAC/D,WAAkB,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAE5C;IAED,oEAAoE;IAEpE,WAAkB,aAAa,IAAI,WAAW,CAE7C;IAED,iDAAiD;WACnC,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIjE,0CAA0C;WAC5B,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQxD,oDAAoD;WACtC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAQ5D,kFAAkF;WACpE,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE;IAK/E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAKlC,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAI9C,gFAAgF;WAClE,UAAU;IAgFxB,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAItC,qFAAqF;WACvE,qBAAqB,CAAC,gBAAgB,EAAE,gBAAgB;IAKtE,0FAA0F;WAC5E,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB;CA+C5E"}

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js

@@ -10,15 +10,18 @@ import { Logger } from "@itwin/core-bentley";
 import { IModelApp } from "@itwin/core-frontend";
 import { getInstancesCount } from "@itwin/presentation-common";
 import { Presentation } from "@itwin/presentation-frontend";
+// cSpell:ignore configurableui
+import { Backstage } from "../backstage/Backstage";
 import { ContentViewManager } from "../content/ContentViewManager";
 import { FrontstageManager } from "../frontstage/FrontstageManager";
 import { SessionStateActionId } from "../redux/SessionState";
 import { UiFramework } from "../UiFramework";
-// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstageevent, contentlayoutactivated, contentcontrolactivated,
+import { WorkflowManager } from "../workflow/Workflow";
+// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstagecloseevent, backstageevent, contentlayoutactivated, contentcontrolactivated,
 // cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged
 // cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating
 // cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged
-// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged configurableui
+// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged
 /** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
  * @public
  */
@@ -32,7 +35,11 @@ export var SyncUiEventId;
     SyncUiEventId["ActiveContentChanged"] = "activecontentchanged";
     /** The active view maintained by the ViewManager has changed. */
     SyncUiEventId["ActiveViewportChanged"] = "activeviewportchanged";
-    /** Backstage has been toggled. */
+    /** Backstage has been closed.
+     * @deprecated in 1.x. Use BackstageEvent instead
+     */
+    SyncUiEventId["BackstageCloseEvent"] = "backstagecloseevent";
+    /** Backstage has been closed. */
     SyncUiEventId["BackstageEvent"] = "backstageevent";
     /** A Content Layout has been activated.  */
     SyncUiEventId["ContentLayoutActivated"] = "contentlayoutactivated";
@@ -50,8 +57,14 @@ export var SyncUiEventId;
     SyncUiEventId["NavigationAidActivated"] = "navigationaidactivated";
     /** An InteractiveTool has been activated via the ToolAdmin. */
     SyncUiEventId["ToolActivated"] = "toolactivated";
+    /** A Task has been activated.
+     * @deprecated in 3.0. */
+    SyncUiEventId["TaskActivated"] = "taskactivated";
     /** The state of a Widget has changed. */
     SyncUiEventId["WidgetStateChanged"] = "widgetstatechanged";
+    /** A Workflow has been activated.
+     * @deprecated in 3.0. */
+    SyncUiEventId["WorkflowActivated"] = "workflowactivated";
     /** The SelectionSet for the active IModelConnection has changed. */
     SyncUiEventId["SelectionSetChanged"] = "selectionsetchanged";
     /** The list of settings providers registered with SettingsManager has changed. */
@@ -61,6 +74,10 @@ export var SyncUiEventId;
     /** The current object the reads and write UI State has changed. */
     SyncUiEventId["UiStateStorageChanged"] = "uistatestoragechanged";
     SyncUiEventId["ShowHideManagerSettingChange"] = "show-hide-setting-change";
+    /** The list of feature overrides applied has been changed
+     * @alpha
+    */
+    SyncUiEventId["FeatureOverridesChanged"] = "featureoverrideschanged";
 })(SyncUiEventId || (SyncUiEventId = {}));
 /** This class is used to send eventIds to interested UI components so the component can determine if it needs
  * to refresh its display by calling setState on itself.
@@ -77,6 +94,7 @@ export class SyncUiEventDispatcher {
         return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;
     }
     /** Return SyncUiEvent so callers can register an event callback. */
+    // eslint-disable-next-line deprecation/deprecation
     static get onSyncUiEvent() {
         return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;
     }
@@ -108,6 +126,10 @@ export class SyncUiEventDispatcher {
     static _dispatchViewChange() {
         SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);
     }
+    // istanbul ignore next
+    static _dispatchFeatureOverridesChange() {
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FeatureOverridesChanged);
+    }
     /** Initializes the Monitoring of Events that trigger dispatching sync events */
     static initialize() {
         // clear any registered listeners - this should only be encountered in unit test scenarios
@@ -136,9 +158,15 @@ export class SyncUiEventDispatcher {
         this._unregisterListenerFuncs.push(FrontstageManager.onWidgetStateChangedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);
         }));
-        this._unregisterListenerFuncs.push(UiFramework.backstageManager.onToggled.addListener(() => {
+        this._unregisterListenerFuncs.push(Backstage.onBackstageEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);
         }));
+        this._unregisterListenerFuncs.push(WorkflowManager.onTaskActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.TaskActivated); // eslint-disable-line deprecation/deprecation
+        }));
+        this._unregisterListenerFuncs.push(WorkflowManager.onWorkflowActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WorkflowActivated); // eslint-disable-line deprecation/deprecation
+        }));
         this._unregisterListenerFuncs.push(ContentViewManager.onActiveContentChangedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);
         }));
@@ -154,11 +182,17 @@ export class SyncUiEventDispatcher {
                     // istanbul ignore next
                     if (args.previous.onViewChanged && typeof args.previous.onViewChanged.removeListener === "function") // not set during unit test
                         args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);
+                    // istanbul ignore next
+                    if (args.previous.onFeatureOverridesChanged && typeof args.previous.onFeatureOverridesChanged.removeListener === "function") // not set during unit test
+                        args.previous.onFeatureOverridesChanged.removeListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
                 }
                 // istanbul ignore next
                 if (args.current) {
                     if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === "function") // not set during unit test
                         args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);
+                    // istanbul ignore next
+                    if (args.current.onFeatureOverridesChanged && typeof args.current.onFeatureOverridesChanged.addListener === "function") // not set during unit test
+                        args.current.onFeatureOverridesChanged.addListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
                 }
             }));
         }

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"SyncUiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAe,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAoE,MAAM,sBAAsB,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAkB,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAsB,YAAY,EAA4B,MAAM,8BAA8B,CAAC;AAC1G,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAA8B,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,yJAAyJ;AACzJ,yJAAyJ;AACzJ,2JAA2J;AAC3J,wHAAwH;AACxH,6HAA6H;AAE7H;;GAEG;AACH,MAAM,CAAN,IAAY,aAsCX;AAtCD,WAAY,aAAa;IACvB,yCAAyC;IACzC,0EAAyD,CAAA;IACzD,qCAAqC;IACrC,oEAAmD,CAAA;IACnD,8EAA8E;IAC9E,8DAA6C,CAAA;IAC7C,iEAAiE;IACjE,gEAA+C,CAAA;IAC/C,kCAAkC;IAClC,kDAAiC,CAAA;IACjC,4CAA4C;IAC5C,kEAAiD,CAAA;IACjD,4EAA4E;IAC5E,oEAAmD,CAAA;IACnD,kCAAkC;IAClC,8DAA6C,CAAA;IAC7C,yEAAyE;IACzE,oDAAmC,CAAA;IACnC,oDAAoD;IACpD,kEAAiD,CAAA;IACjD,gDAAgD;IAChD,0DAAyC,CAAA;IACzC,0CAA0C;IAC1C,kEAAiD,CAAA;IACjD,+DAA+D;IAC/D,gDAA+B,CAAA;IAC/B,yCAAyC;IACzC,0DAAyC,CAAA;IACzC,oEAAoE;IACpE,4DAA2C,CAAA;IAC3C,kFAAkF;IAClF,sEAAqD,CAAA;IACrD,mFAAmF;IACnF,sDAAqC,CAAA;IACrC,mEAAmE;IACnE,gEAA+C,CAAA;IAC/C,0EAAyD,CAAA;AAC3D,CAAC,EAtCW,aAAa,KAAb,aAAa,QAsCxB;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAMhC,wCAAwC;IACxC,0BAA0B;IACnB,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,qBAAqB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,+DAA+D;IACxD,MAAM,KAAK,YAAY;QAC5B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,YAAY,CAAC;IAC/D,CAAC;IAED,oEAAoE;IAC7D,MAAM,KAAK,aAAa;QAC7B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CAAC;IAChE,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,4BAA4B,CAAC,OAAe;QACxD,qBAAqB,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;IACjF,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6DAA6D,CAAC,CAAC;YAChH,OAAO;SACR;QACD,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB,CAAC,QAAkB;QACnD,qBAAqB;QACrB,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,+DAA+D,CAAC,CAAC;SACnH;QACD,qBAAqB,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,kBAAkB,CAAC,QAAqB,EAAE,aAAuB;QAC7E,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC9F,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,mBAAmB;QAChC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC/F,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,UAAU;QACtB,0FAA0F;QAC1F,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACnG,qBAAqB,CAAC,mBAAmB,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC3F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YACzF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC9F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;QACjG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YACzF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YACjG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,uBAAuB;QACvB,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE;YACtC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC,IAAiC,EAAE,EAAE;gBACnI,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAElG,2FAA2F;gBAC3F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;oBAC/B,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAA,8DAA8D;iBACtG;qBAAM;oBACL,uBAAuB;oBACvB,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,KAAK,UAAU,EAAG,2BAA2B;wBAC/H,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;iBACzF;gBACD,uBAAuB;gBACvB,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,KAAK,UAAU,EAAE,2BAA2B;wBACzH,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;iBACrF;YACH,CAAC,CAAC,CAAC,CAAC;SACL;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,GAAsB;QAC3D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAClG,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,qBAAqB,CAAC,gBAAkC;QACpE,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACtG,qBAAqB,CAAC,uBAAuB,IAAI,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;IACnG,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,0BAA0B,CAAC,gBAAkC;QACzE,IAAI,qBAAqB,CAAC,uBAAuB;YAC/C,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;QAElD,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YACpE,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;YAC/E,OAAO;SACR;QAED,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACtG,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACnG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAEvH,8JAA8J;QAC9J,qBAAqB,CAAC,uBAAuB,GAAG,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,IAA8B,EAAE,QAA4B,EAAE,EAAE;YAClK,qBAAqB;YACrB,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;gBACpB,sCAAsC;gBACtC,OAAO;aACR;YACD,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjE,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;YACjD,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEH,IAAI;YACF,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,eAAiC,EAAE,EAAE;gBAC5G,uBAAuB;gBACvB,IAAI,eAAe,EAAE;oBACnB,MAAM,kBAAkB,GAAiC,EAAE,CAAC;oBAC5D,eAAe,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC/D,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAAC;iBACzG;YACH,CAAC,CAAC,CAAC;YAEH,MAAM,oBAAoB,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;YACvE,IAAI,oBAAoB,EAAE;gBACxB,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,QAAQ,EAAE;oBAC9C,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC;iBACpG;qBAAM;oBACL,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;iBACjG;aACF;SACF;QAAC,MAAM,GAAG;IAEb,CAAC;;AAjLc,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE7C,8CAAwB,GAAsB,EAAE,CAAC;AACjD,iCAAW,GAAG,KAAK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SyncUi\r\n */\r\n\r\nimport { UiEventDispatcher, UiSyncEvent } from \"@itwin/appui-abstract\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { IModelApp, IModelConnection, SelectedViewportChangedArgs, SelectionSetEvent } from \"@itwin/core-frontend\";\r\nimport { getInstancesCount, SelectionScope } from \"@itwin/presentation-common\";\r\nimport { ISelectionProvider, Presentation, SelectionChangeEventArgs } from \"@itwin/presentation-frontend\";\r\nimport { ContentViewManager } from \"../content/ContentViewManager\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { PresentationSelectionScope, SessionStateActionId } from \"../redux/SessionState\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstageevent, contentlayoutactivated, contentcontrolactivated,\r\n// cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged\r\n// cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating\r\n// cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged\r\n// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged configurableui\r\n\r\n/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.\r\n * @public\r\n */\r\nexport enum SyncUiEventId {\r\n  /** AccuDraw compass mode has changed. */\r\n  AccuDrawCompassModeChanged = \"accudrawcompassmodechanged\",\r\n  /** AccuDraw rotation has changed. */\r\n  AccuDrawRotationChanged = \"accudrawrotationchanged\",\r\n  /** The active content as maintained by the ContentViewManager has changed. */\r\n  ActiveContentChanged = \"activecontentchanged\",\r\n  /** The active view maintained by the ViewManager has changed. */\r\n  ActiveViewportChanged = \"activeviewportchanged\",\r\n  /** Backstage has been toggled. */\r\n  BackstageEvent = \"backstageevent\",\r\n  /** A Content Layout has been activated.  */\r\n  ContentLayoutActivated = \"contentlayoutactivated\",\r\n  /** A Content Control maintained by FrontstageManager has been activated. */\r\n  ContentControlActivated = \"contentcontrolactivated\",\r\n  /** A Frontstage is activating. */\r\n  FrontstageActivating = \"frontstageactivating\",\r\n  /** A Frontstage has been activated and the content has been assigned. */\r\n  FrontstageReady = \"frontstageready\",\r\n  /** A Modal Frontstage has been opened or closed. */\r\n  ModalFrontstageChanged = \"modalfrontstagechanged\",\r\n  /** A Modal Dialog has been opened or closed. */\r\n  ModalDialogChanged = \"modaldialogchanged\",\r\n  /** A NavigationAid has been activated. */\r\n  NavigationAidActivated = \"navigationaidactivated\",\r\n  /** An InteractiveTool has been activated via the ToolAdmin. */\r\n  ToolActivated = \"toolactivated\",\r\n  /** The state of a Widget has changed. */\r\n  WidgetStateChanged = \"widgetstatechanged\",\r\n  /** The SelectionSet for the active IModelConnection has changed. */\r\n  SelectionSetChanged = \"selectionsetchanged\",\r\n  /** The list of settings providers registered with SettingsManager has changed. */\r\n  SettingsProvidersChanged = \"settingsproviderschanged\",\r\n  /** The current view state has changed (used by view undo/redo toolbar buttons). */\r\n  ViewStateChanged = \"viewstatechanged\",\r\n  /** The current object the reads and write UI State has changed. */\r\n  UiStateStorageChanged = \"uistatestoragechanged\",\r\n  ShowHideManagerSettingChange = \"show-hide-setting-change\",\r\n}\r\n\r\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\r\n * to refresh its display by calling setState on itself.\r\n * @public\r\n */\r\nexport class SyncUiEventDispatcher {\r\n  private static _uiEventDispatcher = new UiEventDispatcher();\r\n  private static _unregisterListenerFunc?: () => void;\r\n  private static _unregisterListenerFuncs: Array<() => void> = [];\r\n  private static initialized = false;\r\n\r\n  /** @internal - used for testing only */\r\n  /* istanbul ignore next */\r\n  public static setTimeoutPeriod(period: number): void {\r\n    SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);\r\n  }\r\n\r\n  /** Return set of event ids that will be sent to listeners/. */\r\n  public static get syncEventIds(): Set<string> {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;\r\n  }\r\n\r\n  /** Return SyncUiEvent so callers can register an event callback. */\r\n  public static get onSyncUiEvent(): UiSyncEvent {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;\r\n  }\r\n\r\n  /** Immediately trigger sync event processing. */\r\n  public static dispatchImmediateSyncUiEvent(eventId: string): void {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);\r\n  }\r\n\r\n  /** Save eventId in Set for processing. */\r\n  public static dispatchSyncUiEvent(eventId: string): void {\r\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`);\r\n      return;\r\n    }\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);\r\n  }\r\n\r\n  /** Save multiple eventIds in Set for processing. */\r\n  public static dispatchSyncUiEvents(eventIds: string[]): void {\r\n    // istanbul ignore if\r\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`);\r\n    }\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);\r\n  }\r\n\r\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\r\n  public static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(eventIds, idsOfInterest);\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private static _dispatchViewChange() {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);\r\n  }\r\n\r\n  /** Initializes the Monitoring of Events that trigger dispatching sync events */\r\n  public static initialize() {\r\n    // clear any registered listeners - this should only be encountered in unit test scenarios\r\n    this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onContentControlActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onContentLayoutActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onFrontstageActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onFrontstageReadyEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onModalFrontstageChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onNavigationAidActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onToolActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onWidgetStateChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.backstageManager.onToggled.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(ContentViewManager.onActiveContentChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);\r\n    }));\r\n\r\n    // istanbul ignore else\r\n    if (IModelApp && IModelApp.viewManager) {\r\n      this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args: SelectedViewportChangedArgs) => {\r\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);\r\n\r\n        // if this is the first view being opened up start the default tool so tool admin is happy.\r\n        if (undefined === args.previous) {\r\n          IModelApp.toolAdmin.startDefaultTool();// eslint-disable-line @typescript-eslint/no-floating-promises\r\n        } else {\r\n          // istanbul ignore next\r\n          if (args.previous.onViewChanged && typeof args.previous.onViewChanged.removeListener === \"function\")  // not set during unit test\r\n            args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);\r\n        }\r\n        // istanbul ignore next\r\n        if (args.current) {\r\n          if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === \"function\") // not set during unit test\r\n            args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);\r\n        }\r\n      }));\r\n    }\r\n  }\r\n\r\n  private static selectionChangedHandler(_ev: SelectionSetEvent) {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);\r\n  }\r\n\r\n  /** This should be called by IModelApp when the active IModelConnection is closed. */\r\n  public static clearConnectionEvents(iModelConnection: IModelConnection) {\r\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    SyncUiEventDispatcher._unregisterListenerFunc && SyncUiEventDispatcher._unregisterListenerFunc();\r\n  }\r\n\r\n  /** This should be called by IModelApp when the active IModelConnection is established. */\r\n  public static initializeConnectionEvents(iModelConnection: IModelConnection) {\r\n    if (SyncUiEventDispatcher._unregisterListenerFunc)\r\n      SyncUiEventDispatcher._unregisterListenerFunc();\r\n\r\n    if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {\r\n      UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);\r\n      return;\r\n    }\r\n\r\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    (iModelConnection.iModelId) ? UiFramework.setActiveIModelId(iModelConnection.iModelId) : /* istanbul ignore next */ \"\";\r\n\r\n    // listen for changes from presentation rules selection manager (this is done once an iModelConnection is available to ensure Presentation.selection is valid)\r\n    SyncUiEventDispatcher._unregisterListenerFunc = Presentation.selection.selectionChange.addListener((args: SelectionChangeEventArgs, provider: ISelectionProvider) => {\r\n      // istanbul ignore if\r\n      if (args.level !== 0) {\r\n        // don't need to handle sub-selections\r\n        return;\r\n      }\r\n      const selection = provider.getSelection(args.imodel, args.level);\r\n      const numSelected = getInstancesCount(selection);\r\n      UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, numSelected);\r\n    });\r\n\r\n    try {\r\n      Presentation.selection.scopes.getSelectionScopes(iModelConnection).then((availableScopes: SelectionScope[]) => { // eslint-disable-line @typescript-eslint/no-floating-promises\r\n        // istanbul ignore else\r\n        if (availableScopes) {\r\n          const presentationScopes: PresentationSelectionScope[] = [];\r\n          availableScopes.map((scope) => presentationScopes.push(scope));\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetAvailableSelectionScopes, presentationScopes);\r\n        }\r\n      });\r\n\r\n      const activeSelectionScope = Presentation.selection.scopes.activeScope;\r\n      if (activeSelectionScope) {\r\n        if (typeof (activeSelectionScope) === \"object\") {\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, activeSelectionScope.id);\r\n        } else {\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, activeSelectionScope);\r\n        }\r\n      }\r\n    } catch { }\r\n\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"SyncUiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAgC,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAoE,MAAM,sBAAsB,CAAC;AACnH,OAAO,EAAE,iBAAiB,EAAkB,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAsB,YAAY,EAA4B,MAAM,8BAA8B,CAAC;AAC1G,+BAA+B;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAA8B,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,8KAA8K;AAC9K,yJAAyJ;AACzJ,2JAA2J;AAC3J,wHAAwH;AACxH,8GAA8G;AAE9G;;GAEG;AACH,MAAM,CAAN,IAAY,aAoDX;AApDD,WAAY,aAAa;IACvB,yCAAyC;IACzC,0EAAyD,CAAA;IACzD,qCAAqC;IACrC,oEAAmD,CAAA;IACnD,8EAA8E;IAC9E,8DAA6C,CAAA;IAC7C,iEAAiE;IACjE,gEAA+C,CAAA;IAC/C;;OAEG;IACH,4DAA2C,CAAA;IAC3C,iCAAiC;IACjC,kDAAiC,CAAA;IACjC,4CAA4C;IAC5C,kEAAiD,CAAA;IACjD,4EAA4E;IAC5E,oEAAmD,CAAA;IACnD,kCAAkC;IAClC,8DAA6C,CAAA;IAC7C,yEAAyE;IACzE,oDAAmC,CAAA;IACnC,oDAAoD;IACpD,kEAAiD,CAAA;IACjD,gDAAgD;IAChD,0DAAyC,CAAA;IACzC,0CAA0C;IAC1C,kEAAiD,CAAA;IACjD,+DAA+D;IAC/D,gDAA+B,CAAA;IAC/B;6BACyB;IACzB,gDAA+B,CAAA;IAC/B,yCAAyC;IACzC,0DAAyC,CAAA;IACzC;6BACyB;IACzB,wDAAuC,CAAA;IACvC,oEAAoE;IACpE,4DAA2C,CAAA;IAC3C,kFAAkF;IAClF,sEAAqD,CAAA;IACrD,mFAAmF;IACnF,sDAAqC,CAAA;IACrC,mEAAmE;IACnE,gEAA+C,CAAA;IAC/C,0EAAyD,CAAA;IACzD;;MAEE;IACF,oEAAmD,CAAA;AACrD,CAAC,EApDW,aAAa,KAAb,aAAa,QAoDxB;AAYD;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAMhC,wCAAwC;IACxC,0BAA0B;IACnB,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,qBAAqB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,+DAA+D;IACxD,MAAM,KAAK,YAAY;QAC5B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,YAAY,CAAC;IAC/D,CAAC;IAED,oEAAoE;IACpE,mDAAmD;IAC5C,MAAM,KAAK,aAAa;QAC7B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CAAC;IAChE,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,4BAA4B,CAAC,OAAe;QACxD,qBAAqB,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;IACjF,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6DAA6D,CAAC,CAAC;YAChH,OAAO;SACR;QACD,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB,CAAC,QAAkB;QACnD,qBAAqB;QACrB,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,+DAA+D,CAAC,CAAC;SACnH;QACD,qBAAqB,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,kBAAkB,CAAC,QAAqB,EAAE,aAAuB;QAC7E,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC9F,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,mBAAmB;QAChC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC/F,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,+BAA+B;QAC5C,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IACtG,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,UAAU;QACtB,0FAA0F;QAC1F,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACnG,qBAAqB,CAAC,mBAAmB,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC3F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YACzF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC9F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;QACjG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC7E,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YACvF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,8CAA8C;QAC3I,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC3F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;QAC/I,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YACjG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,uBAAuB;QACvB,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE;YACtC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC,IAAiC,EAAE,EAAE;gBACnI,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAElG,2FAA2F;gBAC3F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;oBAC/B,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAA,8DAA8D;iBACtG;qBAAM;oBACL,uBAAuB;oBACvB,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,KAAK,UAAU,EAAG,2BAA2B;wBAC/H,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;oBACxF,uBAAuB;oBACvB,IAAI,IAAI,CAAC,QAAQ,CAAC,yBAAyB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,cAAc,KAAK,UAAU,EAAG,2BAA2B;wBACvJ,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,cAAc,CAAC,qBAAqB,CAAC,+BAA+B,CAAC,CAAC;iBACjH;gBACD,uBAAuB;gBACvB,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,KAAK,UAAU,EAAE,2BAA2B;wBACzH,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;oBACpF,uBAAuB;oBACvB,IAAI,IAAI,CAAC,OAAO,CAAC,yBAAyB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,KAAK,UAAU,EAAE,2BAA2B;wBACjJ,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,CAAC,qBAAqB,CAAC,+BAA+B,CAAC,CAAC;iBAC7G;YACH,CAAC,CAAC,CAAC,CAAC;SACL;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,GAAsB;QAC3D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAClG,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,qBAAqB,CAAC,gBAAkC;QACpE,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACtG,qBAAqB,CAAC,uBAAuB,IAAI,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;IACnG,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,0BAA0B,CAAC,gBAAkC;QACzE,IAAI,qBAAqB,CAAC,uBAAuB;YAC/C,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;QAElD,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YACpE,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;YAC/E,OAAO;SACR;QAED,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACtG,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;QACnG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAEvH,8JAA8J;QAC9J,qBAAqB,CAAC,uBAAuB,GAAG,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,IAA8B,EAAE,QAA4B,EAAE,EAAE;YAClK,qBAAqB;YACrB,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;gBACpB,sCAAsC;gBACtC,OAAO;aACR;YACD,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjE,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;YACjD,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEH,IAAI;YACF,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,eAAiC,EAAE,EAAE;gBAC5G,uBAAuB;gBACvB,IAAI,eAAe,EAAE;oBACnB,MAAM,kBAAkB,GAAiC,EAAE,CAAC;oBAC5D,eAAe,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC/D,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAAC;iBACzG;YACH,CAAC,CAAC,CAAC;YAEH,MAAM,oBAAoB,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;YACvE,IAAI,oBAAoB,EAAE;gBACxB,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,QAAQ,EAAE;oBAC9C,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC;iBACpG;qBAAM;oBACL,WAAW,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;iBACjG;aACF;SACF;QAAC,MAAM,GAAE;IAEZ,CAAC;;AArMc,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE7C,8CAAwB,GAAsB,EAAE,CAAC;AACjD,iCAAW,GAAG,KAAK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SyncUi\r\n */\r\n\r\nimport { UiEventDispatcher, UiSyncEvent, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { IModelApp, IModelConnection, SelectedViewportChangedArgs, SelectionSetEvent } from \"@itwin/core-frontend\";\r\nimport { getInstancesCount, SelectionScope } from \"@itwin/presentation-common\";\r\nimport { ISelectionProvider, Presentation, SelectionChangeEventArgs } from \"@itwin/presentation-frontend\";\r\n// cSpell:ignore configurableui\r\nimport { Backstage } from \"../backstage/Backstage\";\r\nimport { ContentViewManager } from \"../content/ContentViewManager\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { PresentationSelectionScope, SessionStateActionId } from \"../redux/SessionState\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { WorkflowManager } from \"../workflow/Workflow\";\r\n\r\n// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstagecloseevent, backstageevent, contentlayoutactivated, contentcontrolactivated,\r\n// cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged\r\n// cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating\r\n// cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged\r\n// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged\r\n\r\n/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.\r\n * @public\r\n */\r\nexport enum SyncUiEventId {\r\n  /** AccuDraw compass mode has changed. */\r\n  AccuDrawCompassModeChanged = \"accudrawcompassmodechanged\",\r\n  /** AccuDraw rotation has changed. */\r\n  AccuDrawRotationChanged = \"accudrawrotationchanged\",\r\n  /** The active content as maintained by the ContentViewManager has changed. */\r\n  ActiveContentChanged = \"activecontentchanged\",\r\n  /** The active view maintained by the ViewManager has changed. */\r\n  ActiveViewportChanged = \"activeviewportchanged\",\r\n  /** Backstage has been closed.\r\n   * @deprecated in 1.x. Use BackstageEvent instead\r\n   */\r\n  BackstageCloseEvent = \"backstagecloseevent\",\r\n  /** Backstage has been closed. */\r\n  BackstageEvent = \"backstageevent\",\r\n  /** A Content Layout has been activated.  */\r\n  ContentLayoutActivated = \"contentlayoutactivated\",\r\n  /** A Content Control maintained by FrontstageManager has been activated. */\r\n  ContentControlActivated = \"contentcontrolactivated\",\r\n  /** A Frontstage is activating. */\r\n  FrontstageActivating = \"frontstageactivating\",\r\n  /** A Frontstage has been activated and the content has been assigned. */\r\n  FrontstageReady = \"frontstageready\",\r\n  /** A Modal Frontstage has been opened or closed. */\r\n  ModalFrontstageChanged = \"modalfrontstagechanged\",\r\n  /** A Modal Dialog has been opened or closed. */\r\n  ModalDialogChanged = \"modaldialogchanged\",\r\n  /** A NavigationAid has been activated. */\r\n  NavigationAidActivated = \"navigationaidactivated\",\r\n  /** An InteractiveTool has been activated via the ToolAdmin. */\r\n  ToolActivated = \"toolactivated\",\r\n  /** A Task has been activated.\r\n   * @deprecated in 3.0. */\r\n  TaskActivated = \"taskactivated\",\r\n  /** The state of a Widget has changed. */\r\n  WidgetStateChanged = \"widgetstatechanged\",\r\n  /** A Workflow has been activated.\r\n   * @deprecated in 3.0. */\r\n  WorkflowActivated = \"workflowactivated\",\r\n  /** The SelectionSet for the active IModelConnection has changed. */\r\n  SelectionSetChanged = \"selectionsetchanged\",\r\n  /** The list of settings providers registered with SettingsManager has changed. */\r\n  SettingsProvidersChanged = \"settingsproviderschanged\",\r\n  /** The current view state has changed (used by view undo/redo toolbar buttons). */\r\n  ViewStateChanged = \"viewstatechanged\",\r\n  /** The current object the reads and write UI State has changed. */\r\n  UiStateStorageChanged = \"uistatestoragechanged\",\r\n  ShowHideManagerSettingChange = \"show-hide-setting-change\",\r\n  /** The list of feature overrides applied has been changed\r\n   * @alpha\r\n  */\r\n  FeatureOverridesChanged = \"featureoverrideschanged\"\r\n}\r\n\r\n/** SyncUi Event arguments. Contains a set of lower case event Ids.\r\n * @public @deprecated in 3.0. Use UiSyncEventArgs in appui-abstract instead\r\n */\r\nexport type SyncUiEventArgs = UiSyncEventArgs;\r\n\r\n/** SyncUi Event class.\r\n * @public @deprecated in 3.0. Use UiSyncEvent in appui-abstract instead\r\n */\r\nexport type SyncUiEvent = UiSyncEvent;\r\n\r\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\r\n * to refresh its display by calling setState on itself.\r\n * @public\r\n */\r\nexport class SyncUiEventDispatcher {\r\n  private static _uiEventDispatcher = new UiEventDispatcher();\r\n  private static _unregisterListenerFunc?: () => void;\r\n  private static _unregisterListenerFuncs: Array<() => void> = [];\r\n  private static initialized = false;\r\n\r\n  /** @internal - used for testing only */\r\n  /* istanbul ignore next */\r\n  public static setTimeoutPeriod(period: number): void {\r\n    SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);\r\n  }\r\n\r\n  /** Return set of event ids that will be sent to listeners/. */\r\n  public static get syncEventIds(): Set<string> {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;\r\n  }\r\n\r\n  /** Return SyncUiEvent so callers can register an event callback. */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public static get onSyncUiEvent(): SyncUiEvent {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;\r\n  }\r\n\r\n  /** Immediately trigger sync event processing. */\r\n  public static dispatchImmediateSyncUiEvent(eventId: string): void {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);\r\n  }\r\n\r\n  /** Save eventId in Set for processing. */\r\n  public static dispatchSyncUiEvent(eventId: string): void {\r\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`);\r\n      return;\r\n    }\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);\r\n  }\r\n\r\n  /** Save multiple eventIds in Set for processing. */\r\n  public static dispatchSyncUiEvents(eventIds: string[]): void {\r\n    // istanbul ignore if\r\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`);\r\n    }\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);\r\n  }\r\n\r\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\r\n  public static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\r\n    return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(eventIds, idsOfInterest);\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private static _dispatchViewChange() {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private static _dispatchFeatureOverridesChange() {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FeatureOverridesChanged);\r\n  }\r\n\r\n  /** Initializes the Monitoring of Events that trigger dispatching sync events */\r\n  public static initialize() {\r\n    // clear any registered listeners - this should only be encountered in unit test scenarios\r\n    this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onContentControlActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onContentLayoutActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onFrontstageActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onFrontstageReadyEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onModalFrontstageChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onNavigationAidActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onToolActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(FrontstageManager.onWidgetStateChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(Backstage.onBackstageEvent.addListener(() => { // eslint-disable-line deprecation/deprecation\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(WorkflowManager.onTaskActivatedEvent.addListener(() => { // eslint-disable-line deprecation/deprecation\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.TaskActivated); // eslint-disable-line deprecation/deprecation\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(WorkflowManager.onWorkflowActivatedEvent.addListener(() => { // eslint-disable-line deprecation/deprecation\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WorkflowActivated); // eslint-disable-line deprecation/deprecation\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(ContentViewManager.onActiveContentChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);\r\n    }));\r\n\r\n    // istanbul ignore else\r\n    if (IModelApp && IModelApp.viewManager) {\r\n      this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args: SelectedViewportChangedArgs) => {\r\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);\r\n\r\n        // if this is the first view being opened up start the default tool so tool admin is happy.\r\n        if (undefined === args.previous) {\r\n          IModelApp.toolAdmin.startDefaultTool();// eslint-disable-line @typescript-eslint/no-floating-promises\r\n        } else {\r\n          // istanbul ignore next\r\n          if (args.previous.onViewChanged && typeof args.previous.onViewChanged.removeListener === \"function\")  // not set during unit test\r\n            args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);\r\n          // istanbul ignore next\r\n          if (args.previous.onFeatureOverridesChanged && typeof args.previous.onFeatureOverridesChanged.removeListener === \"function\")  // not set during unit test\r\n            args.previous.onFeatureOverridesChanged.removeListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);\r\n        }\r\n        // istanbul ignore next\r\n        if (args.current) {\r\n          if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === \"function\") // not set during unit test\r\n            args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);\r\n          // istanbul ignore next\r\n          if (args.current.onFeatureOverridesChanged && typeof args.current.onFeatureOverridesChanged.addListener === \"function\") // not set during unit test\r\n            args.current.onFeatureOverridesChanged.addListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);\r\n        }\r\n      }));\r\n    }\r\n  }\r\n\r\n  private static selectionChangedHandler(_ev: SelectionSetEvent) {\r\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);\r\n  }\r\n\r\n  /** This should be called by IModelApp when the active IModelConnection is closed. */\r\n  public static clearConnectionEvents(iModelConnection: IModelConnection) {\r\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    SyncUiEventDispatcher._unregisterListenerFunc && SyncUiEventDispatcher._unregisterListenerFunc();\r\n  }\r\n\r\n  /** This should be called by IModelApp when the active IModelConnection is established. */\r\n  public static initializeConnectionEvents(iModelConnection: IModelConnection) {\r\n    if (SyncUiEventDispatcher._unregisterListenerFunc)\r\n      SyncUiEventDispatcher._unregisterListenerFunc();\r\n\r\n    if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {\r\n      UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);\r\n      return;\r\n    }\r\n\r\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);\r\n    (iModelConnection.iModelId) ? UiFramework.setActiveIModelId(iModelConnection.iModelId) : /* istanbul ignore next */ \"\";\r\n\r\n    // listen for changes from presentation rules selection manager (this is done once an iModelConnection is available to ensure Presentation.selection is valid)\r\n    SyncUiEventDispatcher._unregisterListenerFunc = Presentation.selection.selectionChange.addListener((args: SelectionChangeEventArgs, provider: ISelectionProvider) => {\r\n      // istanbul ignore if\r\n      if (args.level !== 0) {\r\n        // don't need to handle sub-selections\r\n        return;\r\n      }\r\n      const selection = provider.getSelection(args.imodel, args.level);\r\n      const numSelected = getInstancesCount(selection);\r\n      UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, numSelected);\r\n    });\r\n\r\n    try {\r\n      Presentation.selection.scopes.getSelectionScopes(iModelConnection).then((availableScopes: SelectionScope[]) => { // eslint-disable-line @typescript-eslint/no-floating-promises\r\n        // istanbul ignore else\r\n        if (availableScopes) {\r\n          const presentationScopes: PresentationSelectionScope[] = [];\r\n          availableScopes.map((scope) => presentationScopes.push(scope));\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetAvailableSelectionScopes, presentationScopes);\r\n        }\r\n      });\r\n\r\n      const activeSelectionScope = Presentation.selection.scopes.activeScope;\r\n      if (activeSelectionScope) {\r\n        if (typeof (activeSelectionScope) === \"object\") {\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, activeSelectionScope.id);\r\n        } else {\r\n          UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, activeSelectionScope);\r\n        }\r\n      }\r\n    } catch {}\r\n\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/toolbar/ActionButtonItem.d.ts

@@ -0,0 +1,18 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+/// <reference types="react" />
+import { ActionButton, OnItemExecutedFunc } from "@itwin/appui-abstract";
+/** Action button props
+ *  @internal
+ */
+interface ActionButtonProps {
+    item: ActionButton;
+    onItemExecuted?: OnItemExecutedFunc;
+}
+/** ActionItem toolbar Function component
+ * @internal
+ */
+export declare function ActionButtonItem(props: ActionButtonProps): JSX.Element;
+export {};
+//# sourceMappingURL=ActionButtonItem.d.ts.map

package/lib/esm/appui-react/toolbar/ActionButtonItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionButtonItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ActionButtonItem.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAGH,OAAO,EAAE,YAAY,EAAmD,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAM1H;;GAEG;AACH,UAAU,iBAAiB;IACzB,IAAI,EAAE,YAAY,CAAC;IACnB,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACrC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,eAiBxD"}

package/lib/esm/appui-react/toolbar/ActionButtonItem.js

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import * as React from "react";
+import { ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { BadgeUtilities } from "@itwin/core-react";
+import { Item } from "@itwin/appui-layout-react";
+import { ToolbarHelper } from "./ToolbarHelper";
+import { onEscapeSetFocusToHome } from "../hooks/useEscapeSetFocusToHome";
+/** ActionItem toolbar Function component
+ * @internal
+ */
+export function ActionButtonItem(props) {
+    const { item } = props;
+    const execute = () => {
+        item.execute();
+        if (props.onItemExecuted)
+            props.onItemExecuted(item);
+    };
+    return (React.createElement(Item // eslint-disable-line deprecation/deprecation
+    , { isActive: item.isActive, isDisabled: ConditionalBooleanValue.getValue(item.isDisabled), title: ConditionalStringValue.getValue(item.label), key: item.id, onClick: execute, onKeyDown: onEscapeSetFocusToHome, icon: ToolbarHelper.getIconReactNode(item), badge: BadgeUtilities.getComponentForBadgeType(item.badgeType) }));
+}
+//# sourceMappingURL=ActionButtonItem.js.map

package/lib/esm/appui-react/toolbar/ActionButtonItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionButtonItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ActionButtonItem.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAgB,uBAAuB,EAAE,sBAAsB,EAAsB,MAAM,uBAAuB,CAAC;AAC1H,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAU1E;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAwB;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,cAAc;YACtB,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,OAAO,CAAC,oBAAC,IAAI,CAAC,8CAA8C;QAC1D,QAAQ,EAAE,IAAI,CAAC,QAAQ,EACvB,UAAU,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,KAAK,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAClD,GAAG,EAAE,IAAI,CAAC,EAAE,EACZ,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,sBAAsB,EACjC,IAAI,EAAE,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAC1C,KAAK,EAAE,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,GAC9D,CAAC,CAAC;AACN,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { ActionButton, ConditionalBooleanValue, ConditionalStringValue, OnItemExecutedFunc } from \"@itwin/appui-abstract\";\r\nimport { BadgeUtilities } from \"@itwin/core-react\";\r\nimport { Item } from \"@itwin/appui-layout-react\";\r\nimport { ToolbarHelper } from \"./ToolbarHelper\";\r\nimport { onEscapeSetFocusToHome } from \"../hooks/useEscapeSetFocusToHome\";\r\n\r\n/** Action button props\r\n *  @internal\r\n */\r\ninterface ActionButtonProps {\r\n  item: ActionButton;\r\n  onItemExecuted?: OnItemExecutedFunc;\r\n}\r\n\r\n/** ActionItem toolbar Function component\r\n * @internal\r\n */\r\nexport function ActionButtonItem(props: ActionButtonProps) {\r\n  const { item } = props;\r\n  const execute = () => {\r\n    item.execute();\r\n    if (props.onItemExecuted)\r\n      props.onItemExecuted(item);\r\n  };\r\n  return (<Item // eslint-disable-line deprecation/deprecation\r\n    isActive={item.isActive}\r\n    isDisabled={ConditionalBooleanValue.getValue(item.isDisabled)}\r\n    title={ConditionalStringValue.getValue(item.label)}\r\n    key={item.id}\r\n    onClick={execute}\r\n    onKeyDown={onEscapeSetFocusToHome}\r\n    icon={ToolbarHelper.getIconReactNode(item)}\r\n    badge={BadgeUtilities.getComponentForBadgeType(item.badgeType)}\r\n  />);\r\n}\r\n"]}

package/lib/esm/appui-react/toolbar/ActionItemButton.d.ts

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module Item
+ */
+import * as React from "react";
+import { CommonProps, SizeProps } from "@itwin/core-react";
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { BaseItemState } from "../shared/ItemDefBase";
+/** Properties that must be specified for an [[ActionItemButton]] component
+ * @deprecated in 3.5. Props of a deprecated component.
+ * @public
+ */
+export interface ActionItemButtonProps extends CommonProps {
+    /** Action Button item definition containing the action information */
+    actionItem: ActionButtonItemDef;
+    /** Indicates whether the button is enabled or disabled */
+    isEnabled?: boolean;
+    /** Called when the button is initialized and the size is known */
+    onSizeKnown?: (size: SizeProps) => void;
+}
+/** A Toolbar button React Component that executes an action defined by a CommandItemDef or a ToolItemDef.
+ * @deprecated in 3.5. Use [ActionButton]($appui-abstract) instead.
+ * @public
+ */
+export declare class ActionItemButton extends React.Component<ActionItemButtonProps, BaseItemState> {
+    private _componentUnmounting;
+    /** @internal */
+    readonly state: Readonly<BaseItemState>;
+    constructor(props: ActionItemButtonProps);
+    private _handleSyncUiEvent;
+    /** @internal */
+    static getDerivedStateFromProps(props: ActionItemButtonProps, state: BaseItemState): BaseItemState | null;
+    /** @internal */
+    componentDidMount(): void;
+    /** @internal */
+    componentWillUnmount(): void;
+    private _execute;
+    /** @internal */
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=ActionItemButton.d.ts.map

package/lib/esm/appui-react/toolbar/ActionItemButton.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionItemButton.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ActionItemButton.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAkB,WAAW,EAAQ,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAIjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAKtD;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,sEAAsE;IACtE,UAAU,EAAE,mBAAmB,CAAC;IAChC,0DAA0D;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kEAAkE;IAClE,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACzC;AAaD;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,KAAK,CAAC,SAAS,CAAC,qBAAqB,EAAE,aAAa,CAAC;IACzF,OAAO,CAAC,oBAAoB,CAAS;IAErC,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;gBAE5C,KAAK,EAAE,qBAAqB;IAMxC,OAAO,CAAC,kBAAkB,CAsCxB;IAEF,gBAAgB;WACF,wBAAwB,CAAC,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,aAAa;IASzF,gBAAgB;IACA,iBAAiB;IAIjC,gBAAgB;IACA,oBAAoB;IAKpC,OAAO,CAAC,QAAQ,CAKd;IAEF,gBAAgB;IACA,MAAM,IAAI,KAAK,CAAC,SAAS;CAuB1C"}

package/lib/esm/appui-react/toolbar/ActionItemButton.js

@@ -0,0 +1,100 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+import * as React from "react";
+import { BadgeUtilities, Icon } from "@itwin/core-react";
+import { Item } from "@itwin/appui-layout-react";
+import { FrontstageManager } from "../frontstage/FrontstageManager";
+import { SyncUiEventDispatcher, SyncUiEventId } from "../syncui/SyncUiEventDispatcher";
+import { PropsHelper } from "../utils/PropsHelper";
+import { onEscapeSetFocusToHome } from "../hooks/useEscapeSetFocusToHome";
+/** Helper method to set state from props */
+const getItemStateFromProps = (props) => {
+    // Parent Component can only modify the isEnable state if the actionItem.isEnabled value is set to true.
+    return {
+        isEnabled: undefined !== props.isEnabled ? props.isEnabled && props.actionItem.isEnabled : props.actionItem.isEnabled,
+        isVisible: props.actionItem.isVisible,
+        isActive: undefined !== props.actionItem.isActive ? props.actionItem.isActive : /* istanbul ignore next */ false,
+    };
+};
+/** A Toolbar button React Component that executes an action defined by a CommandItemDef or a ToolItemDef.
+ * @deprecated in 3.5. Use [ActionButton]($appui-abstract) instead.
+ * @public
+ */
+export class ActionItemButton extends React.Component {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false;
+        this._handleSyncUiEvent = (args) => {
+            // istanbul ignore if
+            if (this._componentUnmounting)
+                return;
+            let refreshState = false;
+            let newState = { ...this.state };
+            // since this is a tool button automatically monitor the activation of tools so the active state of the button is updated.
+            if (args.eventIds.has(SyncUiEventId.ToolActivated)) {
+                newState.isActive = this.props.actionItem.id === FrontstageManager.activeToolId;
+                refreshState = true;
+            }
+            if (!refreshState && this.props.actionItem.stateSyncIds && this.props.actionItem.stateSyncIds.length > 0) // eslint-disable-line deprecation/deprecation
+                refreshState = this.props.actionItem.stateSyncIds.some((value) => args.eventIds.has(value.toLowerCase())); // eslint-disable-line deprecation/deprecation
+            if (refreshState) {
+                if (this.props.actionItem.stateFunc) // eslint-disable-line deprecation/deprecation
+                    newState = this.props.actionItem.stateFunc(newState); // eslint-disable-line deprecation/deprecation
+                if ((this.state.isActive !== newState.isActive) || (this.state.isEnabled !== newState.isEnabled) || (this.state.isVisible !== newState.isVisible)) {
+                    // update actionItem as it hold the 'truth' for all state
+                    /* istanbul ignore else */
+                    if (undefined !== newState.isVisible) // eslint-disable-line deprecation/deprecation
+                        this.props.actionItem.isVisible = newState.isVisible; // eslint-disable-line deprecation/deprecation
+                    /* istanbul ignore else */
+                    if (undefined !== newState.isActive)
+                        this.props.actionItem.isActive = newState.isActive;
+                    this.setState({
+                        isActive: newState.isActive,
+                        isEnabled: newState.isEnabled,
+                        isVisible: newState.isVisible,
+                    });
+                }
+            }
+        };
+        this._execute = () => {
+            // istanbul ignore else
+            if (this.props.actionItem.execute) {
+                this.props.actionItem.execute();
+            }
+        };
+        this.state = getItemStateFromProps(props);
+    }
+    /** @internal */
+    static getDerivedStateFromProps(props, state) {
+        const updatedState = getItemStateFromProps(props);
+        // istanbul ignore else
+        if (!PropsHelper.isShallowEqual(updatedState, state))
+            return updatedState;
+        return null;
+    }
+    /** @internal */
+    componentDidMount() {
+        SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+    }
+    /** @internal */
+    componentWillUnmount() {
+        this._componentUnmounting = true;
+        SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);
+    }
+    /** @internal */
+    render() {
+        if (!this.state.isVisible)
+            return null;
+        const { actionItem, ...props } = this.props;
+        const icon = React.createElement(Icon, { iconSpec: actionItem.iconSpec });
+        const badge = BadgeUtilities.getComponentForBadgeType(actionItem.badgeType);
+        return (React.createElement(Item // eslint-disable-line deprecation/deprecation
+        , { ...props, isActive: this.state.isActive, isDisabled: !this.state.isEnabled, title: actionItem.label, key: actionItem.getKey(), onClick: this._execute, onKeyDown: onEscapeSetFocusToHome, icon: icon, onSizeKnown: this.props.onSizeKnown, badge: badge }));
+    }
+}
+//# sourceMappingURL=ActionItemButton.js.map