@itwin/appui-abstract 3.6.0-dev.8 → 3.7.0-dev.1

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js

@@ -1,132 +1,132 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UiEventDispatcher = exports.UiSyncEvent = void 0;
-// cSpell:ignore configurableui
-const UiEvent_1 = require("./UiEvent");
-/** UiSync Event class.
- * @public
- */
-class UiSyncEvent extends UiEvent_1.UiEvent {
-}
-exports.UiSyncEvent = 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
- */
-class UiEventDispatcher {
-    constructor() {
-        this._eventIds = new Set();
-        this._eventIdAdded = false;
-        this._uiSyncEvent = new UiSyncEvent();
-        this._timeoutPeriod = 100;
-        this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;
-    }
-    /** @internal - used for testing only */
-    /* istanbul ignore next */
-    setTimeoutPeriod(period) {
-        this._timeoutPeriod = period;
-        this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);
-        if (this._secondaryTimeoutPeriod < 1)
-            this._secondaryTimeoutPeriod = 1;
-        if (this._syncEventTimerId) {
-            window.clearTimeout(this._syncEventTimerId);
-            this._syncEventTimerId = undefined;
-        }
-        if (this._eventIds)
-            this._eventIds.clear();
-        this._eventIdAdded = false;
-    }
-    /** The current timeout period */
-    get timeoutPeriod() {
-        return this._timeoutPeriod;
-    }
-    /** Return set of event ids that will be sent to listeners/. */
-    get syncEventIds() {
-        return this._eventIds;
-    }
-    /** Return UiSyncEvent so callers can register an event callback. */
-    get onSyncUiEvent() {
-        return this._uiSyncEvent;
-    }
-    /** Immediately trigger sync event processing. */
-    dispatchImmediateSyncUiEvent(eventId) {
-        const eventIds = new Set();
-        eventIds.add(eventId.toLowerCase());
-        this.onSyncUiEvent.emit({ eventIds });
-    }
-    /** Save eventId in Set for processing. */
-    dispatchSyncUiEvent(eventId) {
-        // istanbul ignore if
-        if (0 === this._timeoutPeriod) {
-            return;
-        }
-        this.syncEventIds.add(eventId.toLowerCase());
-        if (!this._syncEventTimerId) { // if there is not a timer active, create one
-            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
-        }
-        else {
-            this._eventIdAdded = true;
-        }
-    }
-    /** Save multiple eventIds in Set for processing. */
-    dispatchSyncUiEvents(eventIds) {
-        // istanbul ignore if
-        if (0 === this._timeoutPeriod) {
-            return;
-        }
-        eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));
-        // istanbul ignore else
-        if (!this._syncEventTimerId) { // if there is not a timer active, create one
-            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
-        }
-        else {
-            this._eventIdAdded = true;
-        }
-    }
-    /** Trigger registered event processing when timer has expired and no addition eventId are added. */
-    checkForAdditionalIds() {
-        /* istanbul ignore else */
-        if (!this._eventIdAdded) {
-            // istanbul ignore else
-            if (this._syncEventTimerId) {
-                window.clearTimeout(this._syncEventTimerId);
-                this._syncEventTimerId = undefined;
-            }
-            this._eventIdAdded = false;
-            // istanbul ignore else
-            if (this.syncEventIds.size > 0) {
-                const eventIds = new Set();
-                this.syncEventIds.forEach((value) => eventIds.add(value));
-                this._eventIds.clear();
-                this.onSyncUiEvent.emit({ eventIds });
-            }
-            return;
-        }
-        // istanbul ignore next
-        if (this._syncEventTimerId) {
-            window.clearTimeout(this._syncEventTimerId);
-            this._syncEventTimerId = undefined;
-        }
-        // istanbul ignore next
-        this._eventIdAdded = false;
-        // if events have been added before the initial timer expired wait half that time to see if events are still being added.
-        // istanbul ignore next
-        this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._secondaryTimeoutPeriod);
-    }
-    /** Checks to see if an eventId of interest is contained in the set of eventIds */
-    hasEventOfInterest(eventIds, idsOfInterest) {
-        /* istanbul ignore else */
-        if ((idsOfInterest.length > 0) && idsOfInterest.some((value) => eventIds.has(value.toLowerCase())))
-            return true;
-        return false;
-    }
-}
-exports.UiEventDispatcher = UiEventDispatcher;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiEventDispatcher = exports.UiSyncEvent = void 0;
+// cSpell:ignore configurableui
+const UiEvent_1 = require("./UiEvent");
+/** UiSync Event class.
+ * @public
+ */
+class UiSyncEvent extends UiEvent_1.UiEvent {
+}
+exports.UiSyncEvent = 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
+ */
+class UiEventDispatcher {
+    constructor() {
+        this._eventIds = new Set();
+        this._eventIdAdded = false;
+        this._uiSyncEvent = new UiSyncEvent();
+        this._timeoutPeriod = 100;
+        this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;
+    }
+    /** @internal - used for testing only */
+    /* istanbul ignore next */
+    setTimeoutPeriod(period) {
+        this._timeoutPeriod = period;
+        this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);
+        if (this._secondaryTimeoutPeriod < 1)
+            this._secondaryTimeoutPeriod = 1;
+        if (this._syncEventTimerId) {
+            window.clearTimeout(this._syncEventTimerId);
+            this._syncEventTimerId = undefined;
+        }
+        if (this._eventIds)
+            this._eventIds.clear();
+        this._eventIdAdded = false;
+    }
+    /** The current timeout period */
+    get timeoutPeriod() {
+        return this._timeoutPeriod;
+    }
+    /** Return set of event ids that will be sent to listeners/. */
+    get syncEventIds() {
+        return this._eventIds;
+    }
+    /** Return UiSyncEvent so callers can register an event callback. */
+    get onSyncUiEvent() {
+        return this._uiSyncEvent;
+    }
+    /** Immediately trigger sync event processing. */
+    dispatchImmediateSyncUiEvent(eventId) {
+        const eventIds = new Set();
+        eventIds.add(eventId.toLowerCase());
+        this.onSyncUiEvent.emit({ eventIds });
+    }
+    /** Save eventId in Set for processing. */
+    dispatchSyncUiEvent(eventId) {
+        // istanbul ignore if
+        if (0 === this._timeoutPeriod) {
+            return;
+        }
+        this.syncEventIds.add(eventId.toLowerCase());
+        if (!this._syncEventTimerId) { // if there is not a timer active, create one
+            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
+        }
+        else {
+            this._eventIdAdded = true;
+        }
+    }
+    /** Save multiple eventIds in Set for processing. */
+    dispatchSyncUiEvents(eventIds) {
+        // istanbul ignore if
+        if (0 === this._timeoutPeriod) {
+            return;
+        }
+        eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));
+        // istanbul ignore else
+        if (!this._syncEventTimerId) { // if there is not a timer active, create one
+            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
+        }
+        else {
+            this._eventIdAdded = true;
+        }
+    }
+    /** Trigger registered event processing when timer has expired and no addition eventId are added. */
+    checkForAdditionalIds() {
+        /* istanbul ignore else */
+        if (!this._eventIdAdded) {
+            // istanbul ignore else
+            if (this._syncEventTimerId) {
+                window.clearTimeout(this._syncEventTimerId);
+                this._syncEventTimerId = undefined;
+            }
+            this._eventIdAdded = false;
+            // istanbul ignore else
+            if (this.syncEventIds.size > 0) {
+                const eventIds = new Set();
+                this.syncEventIds.forEach((value) => eventIds.add(value));
+                this._eventIds.clear();
+                this.onSyncUiEvent.emit({ eventIds });
+            }
+            return;
+        }
+        // istanbul ignore next
+        if (this._syncEventTimerId) {
+            window.clearTimeout(this._syncEventTimerId);
+            this._syncEventTimerId = undefined;
+        }
+        // istanbul ignore next
+        this._eventIdAdded = false;
+        // if events have been added before the initial timer expired wait half that time to see if events are still being added.
+        // istanbul ignore next
+        this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._secondaryTimeoutPeriod);
+    }
+    /** Checks to see if an eventId of interest is contained in the set of eventIds */
+    hasEventOfInterest(eventIds, idsOfInterest) {
+        /* istanbul ignore else */
+        if ((idsOfInterest.length > 0) && idsOfInterest.some((value) => eventIds.has(value.toLowerCase())))
+            return true;
+        return false;
+    }
+}
+exports.UiEventDispatcher = UiEventDispatcher;
 //# sourceMappingURL=UiEventDispatcher.js.map

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/UiEventDispatcher.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,uCAAoC;AASpC;;GAEG;AACH,MAAa,WAAY,SAAQ,iBAAwB;CAAI;AAA7D,kCAA6D;AAE7D;;;GAGG;AACH,MAAa,iBAAiB;IAQ5B;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;QAC1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,wCAAwC;IACxC,0BAA0B;IACnB,gBAAgB,CAAC,MAAc;QACpC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,uBAAuB,GAAG,CAAC;YAClC,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,SAAS;YAChB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEzB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC7B,CAAC;IAED,iCAAiC;IACjC,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,+DAA+D;IAC/D,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,oEAAoE;IACpE,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,4BAA4B,CAAC,OAAe;QACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,0CAA0C;IACnC,mBAAmB,CAAC,OAAe;QACxC,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oDAAoD;IAC7C,oBAAoB,CAAC,QAAkB;QAC5C,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAClE,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oGAAoG;IAC7F,qBAAqB;QAC1B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,uBAAuB;YACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;YACD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,uBAAuB;YACvB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE;gBAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;gBACnC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;aACvC;YACD,OAAO;SACR;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,yHAAyH;QACzH,uBAAuB;QACvB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAClH,CAAC;IAED,kFAAkF;IAC3E,kBAAkB,CAAC,QAAqB,EAAE,aAAuB;QACtE,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACjH,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA5HD,8CA4HC","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 Utilities\r\n */\r\n\r\n// cSpell:ignore configurableui\r\nimport { UiEvent } from \"./UiEvent\";\r\n\r\n/** UiSync Event arguments. Contains a set of lower case event Ids.\r\n * @public\r\n */\r\nexport interface UiSyncEventArgs {\r\n  eventIds: Set<string>;\r\n}\r\n\r\n/** UiSync Event class.\r\n * @public\r\n */\r\nexport class UiSyncEvent extends UiEvent<UiSyncEventArgs> { }\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 UiEventDispatcher {\r\n  private _syncEventTimerId: number | undefined;\r\n  private _eventIds: Set<string>;\r\n  private _eventIdAdded;\r\n  private _uiSyncEvent: UiSyncEvent;\r\n  private _timeoutPeriod;\r\n  private _secondaryTimeoutPeriod;\r\n\r\n  constructor() {\r\n    this._eventIds = new Set<string>();\r\n    this._eventIdAdded = false;\r\n    this._uiSyncEvent = new UiSyncEvent();\r\n    this._timeoutPeriod = 100;\r\n    this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;\r\n  }\r\n\r\n  /** @internal - used for testing only */\r\n  /* istanbul ignore next */\r\n  public setTimeoutPeriod(period: number): void {\r\n    this._timeoutPeriod = period;\r\n    this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);\r\n    if (this._secondaryTimeoutPeriod < 1)\r\n      this._secondaryTimeoutPeriod = 1;\r\n    if (this._syncEventTimerId) {\r\n      window.clearTimeout(this._syncEventTimerId);\r\n      this._syncEventTimerId = undefined;\r\n    }\r\n    if (this._eventIds)\r\n      this._eventIds.clear();\r\n\r\n    this._eventIdAdded = false;\r\n  }\r\n\r\n  /** The current timeout period */\r\n  public get timeoutPeriod(): number {\r\n    return this._timeoutPeriod;\r\n  }\r\n  /** Return set of event ids that will be sent to listeners/. */\r\n  public get syncEventIds(): Set<string> {\r\n    return this._eventIds;\r\n  }\r\n\r\n  /** Return UiSyncEvent so callers can register an event callback. */\r\n  public get onSyncUiEvent(): UiSyncEvent {\r\n    return this._uiSyncEvent;\r\n  }\r\n\r\n  /** Immediately trigger sync event processing. */\r\n  public dispatchImmediateSyncUiEvent(eventId: string): void {\r\n    const eventIds = new Set<string>();\r\n    eventIds.add(eventId.toLowerCase());\r\n    this.onSyncUiEvent.emit({ eventIds });\r\n  }\r\n\r\n  /** Save eventId in Set for processing. */\r\n  public dispatchSyncUiEvent(eventId: string): void {\r\n    // istanbul ignore if\r\n    if (0 === this._timeoutPeriod) {\r\n      return;\r\n    }\r\n\r\n    this.syncEventIds.add(eventId.toLowerCase());\r\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\r\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\r\n    } else {\r\n      this._eventIdAdded = true;\r\n    }\r\n  }\r\n\r\n  /** Save multiple eventIds in Set for processing. */\r\n  public dispatchSyncUiEvents(eventIds: string[]): void {\r\n    // istanbul ignore if\r\n    if (0 === this._timeoutPeriod) {\r\n      return;\r\n    }\r\n\r\n    eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));\r\n    // istanbul ignore else\r\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\r\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\r\n    } else {\r\n      this._eventIdAdded = true;\r\n    }\r\n  }\r\n\r\n  /** Trigger registered event processing when timer has expired and no addition eventId are added. */\r\n  public checkForAdditionalIds() {\r\n    /* istanbul ignore else */\r\n    if (!this._eventIdAdded) {\r\n      // istanbul ignore else\r\n      if (this._syncEventTimerId) {\r\n        window.clearTimeout(this._syncEventTimerId);\r\n        this._syncEventTimerId = undefined;\r\n      }\r\n      this._eventIdAdded = false;\r\n      // istanbul ignore else\r\n      if (this.syncEventIds.size > 0) {\r\n        const eventIds = new Set<string>();\r\n        this.syncEventIds.forEach((value) => eventIds.add(value));\r\n        this._eventIds.clear();\r\n        this.onSyncUiEvent.emit({ eventIds });\r\n      }\r\n      return;\r\n    }\r\n\r\n    // istanbul ignore next\r\n    if (this._syncEventTimerId) {\r\n      window.clearTimeout(this._syncEventTimerId);\r\n      this._syncEventTimerId = undefined;\r\n    }\r\n    // istanbul ignore next\r\n    this._eventIdAdded = false;\r\n    // if events have been added before the initial timer expired wait half that time to see if events are still being added.\r\n    // istanbul ignore next\r\n    this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._secondaryTimeoutPeriod);\r\n  }\r\n\r\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\r\n  public hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\r\n    /* istanbul ignore else */\r\n    if ((idsOfInterest.length > 0) && idsOfInterest.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return true;\r\n    return false;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"UiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/UiEventDispatcher.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,uCAAoC;AASpC;;GAEG;AACH,MAAa,WAAY,SAAQ,iBAAwB;CAAI;AAA7D,kCAA6D;AAE7D;;;GAGG;AACH,MAAa,iBAAiB;IAQ5B;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;QAC1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,wCAAwC;IACxC,0BAA0B;IACnB,gBAAgB,CAAC,MAAc;QACpC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,uBAAuB,GAAG,CAAC;YAClC,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,SAAS;YAChB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEzB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC7B,CAAC;IAED,iCAAiC;IACjC,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,+DAA+D;IAC/D,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,oEAAoE;IACpE,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,4BAA4B,CAAC,OAAe;QACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,0CAA0C;IACnC,mBAAmB,CAAC,OAAe;QACxC,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oDAAoD;IAC7C,oBAAoB,CAAC,QAAkB;QAC5C,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAClE,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oGAAoG;IAC7F,qBAAqB;QAC1B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,uBAAuB;YACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;YACD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,uBAAuB;YACvB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE;gBAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;gBACnC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;aACvC;YACD,OAAO;SACR;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,yHAAyH;QACzH,uBAAuB;QACvB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAClH,CAAC;IAED,kFAAkF;IAC3E,kBAAkB,CAAC,QAAqB,EAAE,aAAuB;QACtE,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACjH,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA5HD,8CA4HC","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 Utilities\n */\n\n// cSpell:ignore configurableui\nimport { UiEvent } from \"./UiEvent\";\n\n/** UiSync Event arguments. Contains a set of lower case event Ids.\n * @public\n */\nexport interface UiSyncEventArgs {\n  eventIds: Set<string>;\n}\n\n/** UiSync Event class.\n * @public\n */\nexport class UiSyncEvent extends UiEvent<UiSyncEventArgs> { }\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 UiEventDispatcher {\n  private _syncEventTimerId: number | undefined;\n  private _eventIds: Set<string>;\n  private _eventIdAdded;\n  private _uiSyncEvent: UiSyncEvent;\n  private _timeoutPeriod;\n  private _secondaryTimeoutPeriod;\n\n  constructor() {\n    this._eventIds = new Set<string>();\n    this._eventIdAdded = false;\n    this._uiSyncEvent = new UiSyncEvent();\n    this._timeoutPeriod = 100;\n    this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;\n  }\n\n  /** @internal - used for testing only */\n  /* istanbul ignore next */\n  public setTimeoutPeriod(period: number): void {\n    this._timeoutPeriod = period;\n    this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);\n    if (this._secondaryTimeoutPeriod < 1)\n      this._secondaryTimeoutPeriod = 1;\n    if (this._syncEventTimerId) {\n      window.clearTimeout(this._syncEventTimerId);\n      this._syncEventTimerId = undefined;\n    }\n    if (this._eventIds)\n      this._eventIds.clear();\n\n    this._eventIdAdded = false;\n  }\n\n  /** The current timeout period */\n  public get timeoutPeriod(): number {\n    return this._timeoutPeriod;\n  }\n  /** Return set of event ids that will be sent to listeners/. */\n  public get syncEventIds(): Set<string> {\n    return this._eventIds;\n  }\n\n  /** Return UiSyncEvent so callers can register an event callback. */\n  public get onSyncUiEvent(): UiSyncEvent {\n    return this._uiSyncEvent;\n  }\n\n  /** Immediately trigger sync event processing. */\n  public dispatchImmediateSyncUiEvent(eventId: string): void {\n    const eventIds = new Set<string>();\n    eventIds.add(eventId.toLowerCase());\n    this.onSyncUiEvent.emit({ eventIds });\n  }\n\n  /** Save eventId in Set for processing. */\n  public dispatchSyncUiEvent(eventId: string): void {\n    // istanbul ignore if\n    if (0 === this._timeoutPeriod) {\n      return;\n    }\n\n    this.syncEventIds.add(eventId.toLowerCase());\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\n    } else {\n      this._eventIdAdded = true;\n    }\n  }\n\n  /** Save multiple eventIds in Set for processing. */\n  public dispatchSyncUiEvents(eventIds: string[]): void {\n    // istanbul ignore if\n    if (0 === this._timeoutPeriod) {\n      return;\n    }\n\n    eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));\n    // istanbul ignore else\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\n    } else {\n      this._eventIdAdded = true;\n    }\n  }\n\n  /** Trigger registered event processing when timer has expired and no addition eventId are added. */\n  public checkForAdditionalIds() {\n    /* istanbul ignore else */\n    if (!this._eventIdAdded) {\n      // istanbul ignore else\n      if (this._syncEventTimerId) {\n        window.clearTimeout(this._syncEventTimerId);\n        this._syncEventTimerId = undefined;\n      }\n      this._eventIdAdded = false;\n      // istanbul ignore else\n      if (this.syncEventIds.size > 0) {\n        const eventIds = new Set<string>();\n        this.syncEventIds.forEach((value) => eventIds.add(value));\n        this._eventIds.clear();\n        this.onSyncUiEvent.emit({ eventIds });\n      }\n      return;\n    }\n\n    // istanbul ignore next\n    if (this._syncEventTimerId) {\n      window.clearTimeout(this._syncEventTimerId);\n      this._syncEventTimerId = undefined;\n    }\n    // istanbul ignore next\n    this._eventIdAdded = false;\n    // if events have been added before the initial timer expired wait half that time to see if events are still being added.\n    // istanbul ignore next\n    this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._secondaryTimeoutPeriod);\n  }\n\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\n  public hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\n    /* istanbul ignore else */\n    if ((idsOfInterest.length > 0) && idsOfInterest.some((value: string): boolean => eventIds.has(value.toLowerCase())))\n      return true;\n    return false;\n  }\n}\n"]}

package/lib/cjs/appui-abstract/utils/callbacks.d.ts

@@ -1,21 +1,21 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { Primitives } from "../properties/PrimitiveTypes";
-/** Signature for number onCommit function.
- * @public
- */
-export declare type OnNumberCommitFunc = (value: number) => void;
-/** Signature for value onCommit function.
- * @public
- */
-export declare type OnValueCommitFunc = (value: Primitives.Value) => void;
-/** Signature for onCancel function.
- * @public
- */
-export declare type OnCancelFunc = () => void;
-/** Signature for onItemExecuted function.
- * @public
- */
-export declare type OnItemExecutedFunc = (item: any) => void;
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { Primitives } from "../properties/PrimitiveTypes";
+/** Signature for number onCommit function.
+ * @public
+ */
+export declare type OnNumberCommitFunc = (value: number) => void;
+/** Signature for value onCommit function.
+ * @public
+ */
+export declare type OnValueCommitFunc = (value: Primitives.Value) => void;
+/** Signature for onCancel function.
+ * @public
+ */
+export declare type OnCancelFunc = () => void;
+/** Signature for onItemExecuted function.
+ * @public
+ */
+export declare type OnItemExecutedFunc = (item: any) => void;
 //# sourceMappingURL=callbacks.d.ts.map

package/lib/cjs/appui-abstract/utils/callbacks.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=callbacks.js.map

package/lib/cjs/appui-abstract/utils/callbacks.js.map

@@ -1 +1 @@
-{"version":3,"file":"callbacks.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/callbacks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Utilities\r\n */\r\n\r\nimport { Primitives } from \"../properties/PrimitiveTypes\";\r\n\r\n/** Signature for number onCommit function.\r\n * @public\r\n */\r\nexport type OnNumberCommitFunc = (value: number) => void;\r\n\r\n/** Signature for value onCommit function.\r\n * @public\r\n */\r\nexport type OnValueCommitFunc = (value: Primitives.Value) => void;\r\n\r\n/** Signature for onCancel function.\r\n * @public\r\n */\r\nexport type OnCancelFunc = () => void;\r\n\r\n/** Signature for onItemExecuted function.\r\n * @public\r\n */\r\nexport type OnItemExecutedFunc = (item: any) => void;\r\n"]}
+{"version":3,"file":"callbacks.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/callbacks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Utilities\n */\n\nimport { Primitives } from \"../properties/PrimitiveTypes\";\n\n/** Signature for number onCommit function.\n * @public\n */\nexport type OnNumberCommitFunc = (value: number) => void;\n\n/** Signature for value onCommit function.\n * @public\n */\nexport type OnValueCommitFunc = (value: Primitives.Value) => void;\n\n/** Signature for onCancel function.\n * @public\n */\nexport type OnCancelFunc = () => void;\n\n/** Signature for onItemExecuted function.\n * @public\n */\nexport type OnItemExecutedFunc = (item: any) => void;\n"]}