@itwin/appui-react 4.0.0-dev.11 → 4.0.0-dev.13

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

@@ -1,79 +1,79 @@
-/** @packageDocumentation
- * @module SyncUi
- */
-import { UiSyncEvent } 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
- */
-export declare enum SyncUiEventId {
-    /** AccuDraw compass mode has changed. */
-    AccuDrawCompassModeChanged = "accudrawcompassmodechanged",
-    /** AccuDraw rotation has changed. */
-    AccuDrawRotationChanged = "accudrawrotationchanged",
-    /** The active content as maintained by the ContentViewManager has changed. */
-    ActiveContentChanged = "activecontentchanged",
-    /** The active view maintained by the ViewManager has changed. */
-    ActiveViewportChanged = "activeviewportchanged",
-    /** Backstage has been toggled. */
-    BackstageEvent = "backstageevent",
-    /** A Content Layout has been activated.  */
-    ContentLayoutActivated = "contentlayoutactivated",
-    /** A Content Control maintained by UiFramework.frontstages has been activated. */
-    ContentControlActivated = "contentcontrolactivated",
-    /** A Frontstage is activating. */
-    FrontstageActivating = "frontstageactivating",
-    /** A Frontstage has been activated and the content has been assigned. */
-    FrontstageReady = "frontstageready",
-    /** A Modal Frontstage has been opened or closed. */
-    ModalFrontstageChanged = "modalfrontstagechanged",
-    /** A Modal Dialog has been opened or closed. */
-    ModalDialogChanged = "modaldialogchanged",
-    /** A NavigationAid has been activated. */
-    NavigationAidActivated = "navigationaidactivated",
-    /** An InteractiveTool has been activated via the ToolAdmin. */
-    ToolActivated = "toolactivated",
-    /** The state of a Widget has changed. */
-    WidgetStateChanged = "widgetstatechanged",
-    /** The SelectionSet for the active IModelConnection has changed. */
-    SelectionSetChanged = "selectionsetchanged",
-    /** The list of settings providers registered with SettingsManager has changed. */
-    SettingsProvidersChanged = "settingsproviderschanged",
-    /** The current view state has changed (used by view undo/redo toolbar buttons). */
-    ViewStateChanged = "viewstatechanged",
-    /** The current object the reads and write UI State has changed. */
-    UiStateStorageChanged = "uistatestoragechanged",
-    ShowHideManagerSettingChange = "show-hide-setting-change"
-}
-/** 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
- */
-export declare class SyncUiEventDispatcher {
-    private static _uiEventDispatcher;
-    private static _unregisterListenerFunc?;
-    private static _unregisterListenerFuncs;
-    /** @internal - used for testing only */
-    static setTimeoutPeriod(period: number): void;
-    /** 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;
-    /** Immediately trigger sync event processing. */
-    static dispatchImmediateSyncUiEvent(eventId: string): void;
-    /** Save eventId in Set for processing. */
-    static dispatchSyncUiEvent(eventId: string): void;
-    /** Save multiple eventIds in Set for processing. */
-    static dispatchSyncUiEvents(eventIds: string[]): void;
-    /** 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;
-    /** Initializes the Monitoring of Events that trigger dispatching sync events */
-    static initialize(): void;
-    private static selectionChangedHandler;
-    /** This should be called by IModelApp when the active IModelConnection is closed. */
-    static clearConnectionEvents(iModelConnection: IModelConnection): void;
-    /** This should be called by IModelApp when the active IModelConnection is established. */
-    static initializeConnectionEvents(iModelConnection: IModelConnection): void;
-}
+/** @packageDocumentation
+ * @module SyncUi
+ */
+import { UiSyncEvent } 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
+ */
+export declare enum SyncUiEventId {
+    /** AccuDraw compass mode has changed. */
+    AccuDrawCompassModeChanged = "accudrawcompassmodechanged",
+    /** AccuDraw rotation has changed. */
+    AccuDrawRotationChanged = "accudrawrotationchanged",
+    /** The active content as maintained by the ContentViewManager has changed. */
+    ActiveContentChanged = "activecontentchanged",
+    /** The active view maintained by the ViewManager has changed. */
+    ActiveViewportChanged = "activeviewportchanged",
+    /** Backstage has been toggled. */
+    BackstageEvent = "backstageevent",
+    /** A Content Layout has been activated.  */
+    ContentLayoutActivated = "contentlayoutactivated",
+    /** A Content Control maintained by UiFramework.frontstages has been activated. */
+    ContentControlActivated = "contentcontrolactivated",
+    /** A Frontstage is activating. */
+    FrontstageActivating = "frontstageactivating",
+    /** A Frontstage has been activated and the content has been assigned. */
+    FrontstageReady = "frontstageready",
+    /** A Modal Frontstage has been opened or closed. */
+    ModalFrontstageChanged = "modalfrontstagechanged",
+    /** A Modal Dialog has been opened or closed. */
+    ModalDialogChanged = "modaldialogchanged",
+    /** A NavigationAid has been activated. */
+    NavigationAidActivated = "navigationaidactivated",
+    /** An InteractiveTool has been activated via the ToolAdmin. */
+    ToolActivated = "toolactivated",
+    /** The state of a Widget has changed. */
+    WidgetStateChanged = "widgetstatechanged",
+    /** The SelectionSet for the active IModelConnection has changed. */
+    SelectionSetChanged = "selectionsetchanged",
+    /** The list of settings providers registered with SettingsManager has changed. */
+    SettingsProvidersChanged = "settingsproviderschanged",
+    /** The current view state has changed (used by view undo/redo toolbar buttons). */
+    ViewStateChanged = "viewstatechanged",
+    /** The current object the reads and write UI State has changed. */
+    UiStateStorageChanged = "uistatestoragechanged",
+    ShowHideManagerSettingChange = "show-hide-setting-change"
+}
+/** 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
+ */
+export declare class SyncUiEventDispatcher {
+    private static _uiEventDispatcher;
+    private static _unregisterListenerFunc?;
+    private static _unregisterListenerFuncs;
+    /** @internal - used for testing only */
+    static setTimeoutPeriod(period: number): void;
+    /** 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;
+    /** Immediately trigger sync event processing. */
+    static dispatchImmediateSyncUiEvent(eventId: string): void;
+    /** Save eventId in Set for processing. */
+    static dispatchSyncUiEvent(eventId: string): void;
+    /** Save multiple eventIds in Set for processing. */
+    static dispatchSyncUiEvents(eventIds: string[]): void;
+    /** 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;
+    /** Initializes the Monitoring of Events that trigger dispatching sync events */
+    static initialize(): void;
+    private static selectionChangedHandler;
+    /** This should be called by IModelApp when the active IModelConnection is closed. */
+    static clearConnectionEvents(iModelConnection: IModelConnection): void;
+    /** This should be called by IModelApp when the active IModelConnection is established. */
+    static initializeConnectionEvents(iModelConnection: IModelConnection): void;
+}
 //# sourceMappingURL=SyncUiEventDispatcher.d.ts.map

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

@@ -1,185 +1,186 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module SyncUi
- */
-import { UiEventDispatcher } from "@itwin/appui-abstract";
-import { Logger } from "@itwin/core-bentley";
-import { IModelApp } from "@itwin/core-frontend";
-import { SessionStateActionId } from "../redux/SessionState";
-import { UiFramework } from "../UiFramework";
-// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, 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
-/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
- * @public
- */
-export var SyncUiEventId;
-(function (SyncUiEventId) {
-    /** AccuDraw compass mode has changed. */
-    SyncUiEventId["AccuDrawCompassModeChanged"] = "accudrawcompassmodechanged";
-    /** AccuDraw rotation has changed. */
-    SyncUiEventId["AccuDrawRotationChanged"] = "accudrawrotationchanged";
-    /** The active content as maintained by the ContentViewManager has changed. */
-    SyncUiEventId["ActiveContentChanged"] = "activecontentchanged";
-    /** The active view maintained by the ViewManager has changed. */
-    SyncUiEventId["ActiveViewportChanged"] = "activeviewportchanged";
-    /** Backstage has been toggled. */
-    SyncUiEventId["BackstageEvent"] = "backstageevent";
-    /** A Content Layout has been activated.  */
-    SyncUiEventId["ContentLayoutActivated"] = "contentlayoutactivated";
-    /** A Content Control maintained by UiFramework.frontstages has been activated. */
-    SyncUiEventId["ContentControlActivated"] = "contentcontrolactivated";
-    /** A Frontstage is activating. */
-    SyncUiEventId["FrontstageActivating"] = "frontstageactivating";
-    /** A Frontstage has been activated and the content has been assigned. */
-    SyncUiEventId["FrontstageReady"] = "frontstageready";
-    /** A Modal Frontstage has been opened or closed. */
-    SyncUiEventId["ModalFrontstageChanged"] = "modalfrontstagechanged";
-    /** A Modal Dialog has been opened or closed. */
-    SyncUiEventId["ModalDialogChanged"] = "modaldialogchanged";
-    /** A NavigationAid has been activated. */
-    SyncUiEventId["NavigationAidActivated"] = "navigationaidactivated";
-    /** An InteractiveTool has been activated via the ToolAdmin. */
-    SyncUiEventId["ToolActivated"] = "toolactivated";
-    /** The state of a Widget has changed. */
-    SyncUiEventId["WidgetStateChanged"] = "widgetstatechanged";
-    /** The SelectionSet for the active IModelConnection has changed. */
-    SyncUiEventId["SelectionSetChanged"] = "selectionsetchanged";
-    /** The list of settings providers registered with SettingsManager has changed. */
-    SyncUiEventId["SettingsProvidersChanged"] = "settingsproviderschanged";
-    /** The current view state has changed (used by view undo/redo toolbar buttons). */
-    SyncUiEventId["ViewStateChanged"] = "viewstatechanged";
-    /** The current object the reads and write UI State has changed. */
-    SyncUiEventId["UiStateStorageChanged"] = "uistatestoragechanged";
-    SyncUiEventId["ShowHideManagerSettingChange"] = "show-hide-setting-change";
-})(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.
- * @public
- */
-export class SyncUiEventDispatcher {
-    /** @internal - used for testing only */
-    /* istanbul ignore next */
-    static setTimeoutPeriod(period) {
-        SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);
-    }
-    /** Return set of event ids that will be sent to listeners/. */
-    static get syncEventIds() {
-        return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;
-    }
-    /** Return SyncUiEvent so callers can register an event callback. */
-    static get onSyncUiEvent() {
-        return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;
-    }
-    /** Immediately trigger sync event processing. */
-    static dispatchImmediateSyncUiEvent(eventId) {
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);
-    }
-    /** Save eventId in Set for processing. */
-    static dispatchSyncUiEvent(eventId) {
-        if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {
-            Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`);
-            return;
-        }
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);
-    }
-    /** Save multiple eventIds in Set for processing. */
-    static dispatchSyncUiEvents(eventIds) {
-        // istanbul ignore if
-        if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {
-            Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`);
-        }
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);
-    }
-    /** Checks to see if an eventId of interest is contained in the set of eventIds */
-    static hasEventOfInterest(eventIds, idsOfInterest) {
-        return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(eventIds, idsOfInterest);
-    }
-    // istanbul ignore next
-    static _dispatchViewChange() {
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);
-    }
-    /** 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
-        this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {
-            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onToolActivatedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.backstage.onToggled.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.content.onActiveContentChangedEvent.addListener(() => {
-            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);
-        }));
-        // istanbul ignore else
-        if (IModelApp && IModelApp.viewManager) {
-            this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args) => {
-                SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);
-                // if this is the first view being opened up start the default tool so tool admin is happy.
-                if (undefined === args.previous) {
-                    IModelApp.toolAdmin.startDefaultTool(); // eslint-disable-line @typescript-eslint/no-floating-promises
-                }
-                else {
-                    // 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.current) {
-                    if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === "function") // not set during unit test
-                        args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);
-                }
-            }));
-        }
-    }
-    static selectionChangedHandler(_ev) {
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);
-    }
-    /** This should be called by IModelApp when the active IModelConnection is closed. */
-    static clearConnectionEvents(iModelConnection) {
-        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
-        SyncUiEventDispatcher._unregisterListenerFunc && SyncUiEventDispatcher._unregisterListenerFunc();
-    }
-    /** This should be called by IModelApp when the active IModelConnection is established. */
-    static initializeConnectionEvents(iModelConnection) {
-        if (SyncUiEventDispatcher._unregisterListenerFunc)
-            SyncUiEventDispatcher._unregisterListenerFunc();
-        if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {
-            UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);
-            return;
-        }
-        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
-        iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);
-        iModelConnection.iModelId && UiFramework.setActiveIModelId(iModelConnection.iModelId);
-    }
-}
-SyncUiEventDispatcher._uiEventDispatcher = new UiEventDispatcher();
-SyncUiEventDispatcher._unregisterListenerFuncs = [];
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module SyncUi
+ */
+import { UiEventDispatcher } from "@itwin/appui-abstract";
+import { Logger } from "@itwin/core-bentley";
+import { IModelApp } from "@itwin/core-frontend";
+import { SessionStateActionId } from "../redux/SessionState";
+import { UiFramework } from "../UiFramework";
+// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, 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
+/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
+ * @public
+ */
+export var SyncUiEventId;
+(function (SyncUiEventId) {
+    /** AccuDraw compass mode has changed. */
+    SyncUiEventId["AccuDrawCompassModeChanged"] = "accudrawcompassmodechanged";
+    /** AccuDraw rotation has changed. */
+    SyncUiEventId["AccuDrawRotationChanged"] = "accudrawrotationchanged";
+    /** The active content as maintained by the ContentViewManager has changed. */
+    SyncUiEventId["ActiveContentChanged"] = "activecontentchanged";
+    /** The active view maintained by the ViewManager has changed. */
+    SyncUiEventId["ActiveViewportChanged"] = "activeviewportchanged";
+    /** Backstage has been toggled. */
+    SyncUiEventId["BackstageEvent"] = "backstageevent";
+    /** A Content Layout has been activated.  */
+    SyncUiEventId["ContentLayoutActivated"] = "contentlayoutactivated";
+    /** A Content Control maintained by UiFramework.frontstages has been activated. */
+    SyncUiEventId["ContentControlActivated"] = "contentcontrolactivated";
+    /** A Frontstage is activating. */
+    SyncUiEventId["FrontstageActivating"] = "frontstageactivating";
+    /** A Frontstage has been activated and the content has been assigned. */
+    SyncUiEventId["FrontstageReady"] = "frontstageready";
+    /** A Modal Frontstage has been opened or closed. */
+    SyncUiEventId["ModalFrontstageChanged"] = "modalfrontstagechanged";
+    /** A Modal Dialog has been opened or closed. */
+    SyncUiEventId["ModalDialogChanged"] = "modaldialogchanged";
+    /** A NavigationAid has been activated. */
+    SyncUiEventId["NavigationAidActivated"] = "navigationaidactivated";
+    /** An InteractiveTool has been activated via the ToolAdmin. */
+    SyncUiEventId["ToolActivated"] = "toolactivated";
+    /** The state of a Widget has changed. */
+    SyncUiEventId["WidgetStateChanged"] = "widgetstatechanged";
+    /** The SelectionSet for the active IModelConnection has changed. */
+    SyncUiEventId["SelectionSetChanged"] = "selectionsetchanged";
+    /** The list of settings providers registered with SettingsManager has changed. */
+    SyncUiEventId["SettingsProvidersChanged"] = "settingsproviderschanged";
+    /** The current view state has changed (used by view undo/redo toolbar buttons). */
+    SyncUiEventId["ViewStateChanged"] = "viewstatechanged";
+    /** The current object the reads and write UI State has changed. */
+    SyncUiEventId["UiStateStorageChanged"] = "uistatestoragechanged";
+    SyncUiEventId["ShowHideManagerSettingChange"] = "show-hide-setting-change";
+})(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.
+ * @public
+ */
+class SyncUiEventDispatcher {
+    /** @internal - used for testing only */
+    /* istanbul ignore next */
+    static setTimeoutPeriod(period) {
+        SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);
+    }
+    /** Return set of event ids that will be sent to listeners/. */
+    static get syncEventIds() {
+        return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;
+    }
+    /** Return SyncUiEvent so callers can register an event callback. */
+    static get onSyncUiEvent() {
+        return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;
+    }
+    /** Immediately trigger sync event processing. */
+    static dispatchImmediateSyncUiEvent(eventId) {
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);
+    }
+    /** Save eventId in Set for processing. */
+    static dispatchSyncUiEvent(eventId) {
+        if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {
+            Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`);
+            return;
+        }
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);
+    }
+    /** Save multiple eventIds in Set for processing. */
+    static dispatchSyncUiEvents(eventIds) {
+        // istanbul ignore if
+        if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {
+            Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`);
+        }
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);
+    }
+    /** Checks to see if an eventId of interest is contained in the set of eventIds */
+    static hasEventOfInterest(eventIds, idsOfInterest) {
+        return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(eventIds, idsOfInterest);
+    }
+    // istanbul ignore next
+    static _dispatchViewChange() {
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);
+    }
+    /** 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
+        this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onToolActivatedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.backstage.onToggled.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);
+        }));
+        this._unregisterListenerFuncs.push(UiFramework.content.onActiveContentChangedEvent.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);
+        }));
+        // istanbul ignore else
+        if (IModelApp && IModelApp.viewManager) {
+            this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args) => {
+                SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);
+                // if this is the first view being opened up start the default tool so tool admin is happy.
+                if (undefined === args.previous) {
+                    IModelApp.toolAdmin.startDefaultTool(); // eslint-disable-line @typescript-eslint/no-floating-promises
+                }
+                else {
+                    // 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.current) {
+                    if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === "function") // not set during unit test
+                        args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);
+                }
+            }));
+        }
+    }
+    static selectionChangedHandler(_ev) {
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);
+    }
+    /** This should be called by IModelApp when the active IModelConnection is closed. */
+    static clearConnectionEvents(iModelConnection) {
+        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
+        SyncUiEventDispatcher._unregisterListenerFunc && SyncUiEventDispatcher._unregisterListenerFunc();
+    }
+    /** This should be called by IModelApp when the active IModelConnection is established. */
+    static initializeConnectionEvents(iModelConnection) {
+        if (SyncUiEventDispatcher._unregisterListenerFunc)
+            SyncUiEventDispatcher._unregisterListenerFunc();
+        if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {
+            UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);
+            return;
+        }
+        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
+        iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);
+        iModelConnection.iModelId && UiFramework.setActiveIModelId(iModelConnection.iModelId);
+    }
+}
+SyncUiEventDispatcher._uiEventDispatcher = new UiEventDispatcher();
+SyncUiEventDispatcher._unregisterListenerFuncs = [];
+export { SyncUiEventDispatcher };
 //# sourceMappingURL=SyncUiEventDispatcher.js.map

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,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,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,kFAAkF;IAClF,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;IAKhC,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,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACzG,qBAAqB,CAAC,mBAAmB,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YACjG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YACpG,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,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAClF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,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,gBAAgB,CAAC,QAAQ,IAAI,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxF,CAAC;;AA/Ic,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE7C,8CAAwB,GAAsB,EAAE,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 { 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 UiFramework.frontstages 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\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(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onToolActivatedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.backstage.onToggled.addListener(() => {\r\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);\r\n    }));\r\n\r\n    this._unregisterListenerFuncs.push(UiFramework.content.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);\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,EAAe,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAoE,MAAM,sBAAsB,CAAC;AACnH,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,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,kFAAkF;IAClF,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,MAAa,qBAAqB;IAKhC,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,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACzG,qBAAqB,CAAC,mBAAmB,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YACjG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACxG,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/F,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YACpG,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,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAClF,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClG,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,gBAAgB,CAAC,QAAQ,IAAI,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxF,CAAC;;AA/Ic,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE7C,8CAAwB,GAAsB,EAAE,CAAC;SAHrD,qBAAqB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module SyncUi\n */\n\nimport { UiEventDispatcher, UiSyncEvent } from \"@itwin/appui-abstract\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { IModelApp, IModelConnection, SelectedViewportChangedArgs, SelectionSetEvent } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { UiFramework } from \"../UiFramework\";\n\n// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstageevent, contentlayoutactivated, contentcontrolactivated,\n// cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged\n// cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating\n// cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged\n// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged configurableui\n\n/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.\n * @public\n */\nexport enum SyncUiEventId {\n  /** AccuDraw compass mode has changed. */\n  AccuDrawCompassModeChanged = \"accudrawcompassmodechanged\",\n  /** AccuDraw rotation has changed. */\n  AccuDrawRotationChanged = \"accudrawrotationchanged\",\n  /** The active content as maintained by the ContentViewManager has changed. */\n  ActiveContentChanged = \"activecontentchanged\",\n  /** The active view maintained by the ViewManager has changed. */\n  ActiveViewportChanged = \"activeviewportchanged\",\n  /** Backstage has been toggled. */\n  BackstageEvent = \"backstageevent\",\n  /** A Content Layout has been activated.  */\n  ContentLayoutActivated = \"contentlayoutactivated\",\n  /** A Content Control maintained by UiFramework.frontstages has been activated. */\n  ContentControlActivated = \"contentcontrolactivated\",\n  /** A Frontstage is activating. */\n  FrontstageActivating = \"frontstageactivating\",\n  /** A Frontstage has been activated and the content has been assigned. */\n  FrontstageReady = \"frontstageready\",\n  /** A Modal Frontstage has been opened or closed. */\n  ModalFrontstageChanged = \"modalfrontstagechanged\",\n  /** A Modal Dialog has been opened or closed. */\n  ModalDialogChanged = \"modaldialogchanged\",\n  /** A NavigationAid has been activated. */\n  NavigationAidActivated = \"navigationaidactivated\",\n  /** An InteractiveTool has been activated via the ToolAdmin. */\n  ToolActivated = \"toolactivated\",\n  /** The state of a Widget has changed. */\n  WidgetStateChanged = \"widgetstatechanged\",\n  /** The SelectionSet for the active IModelConnection has changed. */\n  SelectionSetChanged = \"selectionsetchanged\",\n  /** The list of settings providers registered with SettingsManager has changed. */\n  SettingsProvidersChanged = \"settingsproviderschanged\",\n  /** The current view state has changed (used by view undo/redo toolbar buttons). */\n  ViewStateChanged = \"viewstatechanged\",\n  /** The current object the reads and write UI State has changed. */\n  UiStateStorageChanged = \"uistatestoragechanged\",\n  ShowHideManagerSettingChange = \"show-hide-setting-change\",\n}\n\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\n * to refresh its display by calling setState on itself.\n * @public\n */\nexport class SyncUiEventDispatcher {\n  private static _uiEventDispatcher = new UiEventDispatcher();\n  private static _unregisterListenerFunc?: () => void;\n  private static _unregisterListenerFuncs: Array<() => void> = [];\n\n  /** @internal - used for testing only */\n  /* istanbul ignore next */\n  public static setTimeoutPeriod(period: number): void {\n    SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);\n  }\n\n  /** Return set of event ids that will be sent to listeners/. */\n  public static get syncEventIds(): Set<string> {\n    return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;\n  }\n\n  /** Return SyncUiEvent so callers can register an event callback. */\n  public static get onSyncUiEvent(): UiSyncEvent {\n    return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;\n  }\n\n  /** Immediately trigger sync event processing. */\n  public static dispatchImmediateSyncUiEvent(eventId: string): void {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);\n  }\n\n  /** Save eventId in Set for processing. */\n  public static dispatchSyncUiEvent(eventId: string): void {\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`);\n      return;\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);\n  }\n\n  /** Save multiple eventIds in Set for processing. */\n  public static dispatchSyncUiEvents(eventIds: string[]): void {\n    // istanbul ignore if\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(UiFramework.loggerCategory(this), `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`);\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);\n  }\n\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\n  public static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\n    return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(eventIds, idsOfInterest);\n  }\n\n  // istanbul ignore next\n  private static _dispatchViewChange() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewStateChanged);\n  }\n\n  /** Initializes the Monitoring of Events that trigger dispatching sync events */\n  public static initialize() {\n    // clear any registered listeners - this should only be encountered in unit test scenarios\n    this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {\n      SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onToolActivatedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.backstage.onToggled.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);\n    }));\n\n    this._unregisterListenerFuncs.push(UiFramework.content.onActiveContentChangedEvent.addListener(() => {\n      SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);\n    }));\n\n    // istanbul ignore else\n    if (IModelApp && IModelApp.viewManager) {\n      this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args: SelectedViewportChangedArgs) => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);\n\n        // if this is the first view being opened up start the default tool so tool admin is happy.\n        if (undefined === args.previous) {\n          IModelApp.toolAdmin.startDefaultTool();// eslint-disable-line @typescript-eslint/no-floating-promises\n        } else {\n          // istanbul ignore next\n          if (args.previous.onViewChanged && typeof args.previous.onViewChanged.removeListener === \"function\")  // not set during unit test\n            args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);\n        }\n        // istanbul ignore next\n        if (args.current) {\n          if (args.current.onViewChanged && typeof args.current.onViewChanged.addListener === \"function\") // not set during unit test\n            args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);\n        }\n      }));\n    }\n  }\n\n  private static selectionChangedHandler(_ev: SelectionSetEvent) {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is closed. */\n  public static clearConnectionEvents(iModelConnection: IModelConnection) {\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\n    SyncUiEventDispatcher._unregisterListenerFunc && SyncUiEventDispatcher._unregisterListenerFunc();\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is established. */\n  public static initializeConnectionEvents(iModelConnection: IModelConnection) {\n    if (SyncUiEventDispatcher._unregisterListenerFunc)\n      SyncUiEventDispatcher._unregisterListenerFunc();\n\n    if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {\n      UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);\n      return;\n    }\n\n    iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);\n    iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);\n    iModelConnection.iModelId && UiFramework.setActiveIModelId(iModelConnection.iModelId);\n  }\n}\n"]}