@itwin/appui-abstract 4.6.0-dev.22 → 4.6.0-dev.23

package/lib/esm/appui-abstract/UiAdmin.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA+C7E;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAA6B;CAAI;AAUrE;;GAEG;AACH,MAAa,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IAqPtC,CAAC;IAlPC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE;YAC9B,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,kCAAkC,CAA6B,CAAC;YACpH,KAAK,CAAC,QAAQ,GAAG,kBAAkB,CAAC;YACpC,MAAM,KAAK,CAAC;SACb;QAED,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAY,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE7D;;MAEE;IACK,WAAW,CAAC,CAAS,EAAE,CAAS,IAAW,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEpE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAgB,EAAE,YAA0B;QAC3G,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAgB,EAAE,OAAc,EAAE,eAAmC,EAAE,SAAuB,EACnI,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAgB,EAAE,YAA0B;QACvH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACpK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QAChJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACjJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACjJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAgB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACpM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAgB,EAAE,OAAc,EAAE,SAAuB,EACvF,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAgB,EAAE,OAAc,EAAE,eAAmC,EAAE,SAAuB,EAC9F,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAgB,EAAE,OAAc,EAAE,SAAuB,EACxF,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,AAAvB,CAAwB;SArOpD,OAAO","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 UiAdmin\r\n */\r\n\r\nimport { BentleyError, BentleyStatus, BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\r\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\r\nimport { RelativePosition } from \"./items/RelativePosition\";\r\nimport { PropertyDescription } from \"./properties/Description\";\r\nimport { Primitives } from \"./properties/PrimitiveTypes\";\r\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\r\nimport { PropertyRecord } from \"./properties/Record\";\r\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\r\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\r\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\r\n\r\ninterface XAndY { readonly x: number, readonly y: number }\r\n\r\ninterface BentleyErrorWithCategory extends BentleyError {\r\n  category: string;\r\n}\r\n\r\n/** The Generic UI Event args contains information useful for any UI message\r\n * @public\r\n */\r\nexport interface GenericUiEventArgs {\r\n  uiComponentId: string;\r\n}\r\n\r\n/** Optional props to pass to the Dialog control that is generated.\r\n * @public\r\n */\r\nexport interface DialogProps {\r\n  /** Indicates whether the user can resize dialog with cursor. */\r\n  resizable?: boolean;\r\n  /** Indicates whether the user can move dialog with cursor.*/\r\n  movable?: boolean;\r\n  /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  width?: string | number;\r\n  /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  height?: string | number;\r\n  /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minWidth?: string | number;\r\n  /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minHeight?: string | number;\r\n  /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxWidth?: string | number;\r\n  /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxHeight?: string | number;\r\n}\r\n\r\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\r\n * @public\r\n */\r\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\r\n\r\n/** Flags that control enabling/disabling certain UI features\r\n * @public\r\n */\r\nexport interface UiFlags {\r\n  /** if true then Ctrl+F2 will show popup key-in palette */\r\n  allowKeyinPalette?: boolean;\r\n}\r\n\r\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\r\n * @public\r\n */\r\nexport class UiAdmin {\r\n  private _featureFlags: UiFlags = {};\r\n  private static _messagePresenter?: MessagePresenter;\r\n\r\n  /** The MessagePresenter used to display messages. */\r\n  public static get messagePresenter(): MessagePresenter {\r\n    if (!UiAdmin._messagePresenter) {\r\n      const error = new BentleyError(BentleyStatus.ERROR, \"UiAdmin.messagePresenter not set\") as BentleyErrorWithCategory;\r\n      error.category = \"messagePresenter\";\r\n      throw error;\r\n    }\r\n\r\n    return UiAdmin._messagePresenter;\r\n  }\r\n  public static set messagePresenter(mp: MessagePresenter) {\r\n    UiAdmin._messagePresenter = mp;\r\n  }\r\n\r\n  public get featureFlags(): UiFlags {\r\n    return { ...this._featureFlags }; // return copy so no direct access to modify value\r\n  }\r\n\r\n  public updateFeatureFlags(uiFlags: UiFlags) {\r\n    this._featureFlags = { ...this._featureFlags, ...uiFlags };\r\n  }\r\n\r\n  /** @internal */\r\n  public onInitialized() { }\r\n\r\n  /** Get the cursor X and Y position. */\r\n  public get cursorPosition(): XAndY { return { x: 0, y: 0 }; }\r\n\r\n  /** Create a PointProps object.\r\n  * @deprecated in 4.2.x. Please use @core/geometry [[XAndY]] or a custom implementation.\r\n  */\r\n  public createXAndY(x: number, y: number): XAndY { return { x, y }; }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public get isFocusOnHome(): boolean { return false; }\r\n\r\n  /** Sets focus to Home */\r\n  public setFocusToHome(): void { }\r\n\r\n  /** Show a context menu at a particular location.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the menu was displayed, false if the menu could not be displayed.\r\n   */\r\n  public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: XAndY, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show a Toolbar at a particular location.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\r\n   * @param _offset Offset of the Toolbar from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\r\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\r\n   */\r\n  public showToolbar(\r\n    _toolbarProps: AbstractToolbarProps, _location: XAndY, _offset: XAndY, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the toolbar. */\r\n  public hideToolbar(): boolean { return false; }\r\n\r\n  /** Show a menu button at a particular location. A menu button opens a context menu.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the button was displayed, false if the button could not be displayed.\r\n   */\r\n  public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: XAndY, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides a menu button.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @return true if the menu was hidden, false if the menu could not be hidden.\r\n   */\r\n  public hideMenuButton(_id: string): boolean { return false; }\r\n\r\n  /** Show a calculator at a particular location.\r\n   * @param _initialValue Value initially displayed in the calculator.\r\n   * @param _resultIcon Icon displayed to the left of the value.\r\n   * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the calculator was displayed, false if the calculator could not be displayed.\r\n   */\r\n  public showCalculator(_initialValue: number, _resultIcon: string, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the calculator. */\r\n  public hideCalculator(): boolean { return false; }\r\n\r\n  /** Show an input editor for an angle value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showAngleEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a length value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showLengthEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a height value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showHeightEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a primitive value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _propertyDescription Description of the primitive value property.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: XAndY, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the input editor. */\r\n  public hideInputEditor(): boolean { return false; }\r\n\r\n  /** Show an HTML element at a particular location.\r\n   * @param _displayElement The HTMLElement to display\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the display element from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\r\n   * @return true if the display element was displayed, false if the display element could not be displayed.\r\n   */\r\n  public showHTMLElement(\r\n    _displayElement: HTMLElement, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the HTML Element. */\r\n  public hideHTMLElement(): boolean { return false; }\r\n\r\n  /** Show a Card containing content, a title and a toolbar at a particular location.\r\n   * @param _content The HTMLElement of the content to display\r\n   * @param _title Title to display at the top of the card.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Card, relative to the origin of anchorElement or the window.\r\n   * @param _offset Offset of the Card from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\r\n   * @return true if the Card was displayed, false if the Card could not be displayed.\r\n   */\r\n  public showCard(\r\n    _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\r\n    _location: XAndY, _offset: XAndY, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the Card. */\r\n  public hideCard(): boolean { return false; }\r\n\r\n  /** Opens a Tool Settings Ui popup at a particular location.\r\n   * @param _dataProvider The UiDataProvider for the tool settings\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the tool settings from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openToolSettingsPopup(\r\n    _dataProvider: UiDataProvider, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Tool Settings Ui popup. */\r\n  public closeToolSettingsPopup(): boolean { return false; }\r\n\r\n  /** Show the Keyin Palette to display all support Tool key-ins.\r\n   * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\r\n   * @return true if the Keyin Palette was displayed, false if it could not be displayed.\r\n   */\r\n  public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\r\n\r\n  /** Hides the Keyin Palette. */\r\n  public hideKeyinPalette(): boolean { return false; }\r\n\r\n  /** Send a UI event */\r\n  public static sendUiEvent(args: GenericUiEventArgs) {\r\n    UiAdmin.onGenericUiEvent.emit(args);\r\n  }\r\n  /** GenericUiEvent  */\r\n  public static readonly onGenericUiEvent = new GenericUiEvent();\r\n\r\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\r\n   * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\r\n   * @param _title Specify title for dialog.\r\n   * @param _isModal Specify if the dialog is opened as a modal or modeless.\r\n   * @param _id Id of the dialog that is used to close it.\r\n   * @param _optionalProps Optional props for Dialog construction.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\r\n    _optionalProps?: DialogProps): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Dialog with a given Id. */\r\n  public closeDialog(_dialogId: string): boolean { return false; }\r\n}\r\n"]}
+{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA+C7E;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAA6B;CAAI;AAUrE;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IAqPtC,CAAC;IAlPC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,kCAAkC,CAA6B,CAAC;YACpH,KAAK,CAAC,QAAQ,GAAG,kBAAkB,CAAC;YACpC,MAAM,KAAK,CAAC;QACd,CAAC;QAED,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAY,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE7D;;MAEE;IACK,WAAW,CAAC,CAAS,EAAE,CAAS,IAAW,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEpE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAgB,EAAE,YAA0B;QAC3G,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAgB,EAAE,OAAc,EAAE,eAAmC,EAAE,SAAuB,EACnI,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAgB,EAAE,YAA0B;QACvH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACpK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QAChJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACjJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAgB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACjJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAgB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACpM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAgB,EAAE,OAAc,EAAE,SAAuB,EACvF,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAgB,EAAE,OAAc,EAAE,eAAmC,EAAE,SAAuB,EAC9F,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAgB,EAAE,OAAc,EAAE,SAAuB,EACxF,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,AAAvB,CAAwB","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 UiAdmin\r\n */\r\n\r\nimport { BentleyError, BentleyStatus, BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\r\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\r\nimport { RelativePosition } from \"./items/RelativePosition\";\r\nimport { PropertyDescription } from \"./properties/Description\";\r\nimport { Primitives } from \"./properties/PrimitiveTypes\";\r\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\r\nimport { PropertyRecord } from \"./properties/Record\";\r\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\r\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\r\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\r\n\r\ninterface XAndY { readonly x: number, readonly y: number }\r\n\r\ninterface BentleyErrorWithCategory extends BentleyError {\r\n  category: string;\r\n}\r\n\r\n/** The Generic UI Event args contains information useful for any UI message\r\n * @public\r\n */\r\nexport interface GenericUiEventArgs {\r\n  uiComponentId: string;\r\n}\r\n\r\n/** Optional props to pass to the Dialog control that is generated.\r\n * @public\r\n */\r\nexport interface DialogProps {\r\n  /** Indicates whether the user can resize dialog with cursor. */\r\n  resizable?: boolean;\r\n  /** Indicates whether the user can move dialog with cursor.*/\r\n  movable?: boolean;\r\n  /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  width?: string | number;\r\n  /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  height?: string | number;\r\n  /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minWidth?: string | number;\r\n  /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  minHeight?: string | number;\r\n  /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxWidth?: string | number;\r\n  /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n  maxHeight?: string | number;\r\n}\r\n\r\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\r\n * @public\r\n */\r\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\r\n\r\n/** Flags that control enabling/disabling certain UI features\r\n * @public\r\n */\r\nexport interface UiFlags {\r\n  /** if true then Ctrl+F2 will show popup key-in palette */\r\n  allowKeyinPalette?: boolean;\r\n}\r\n\r\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\r\n * @public\r\n */\r\nexport class UiAdmin {\r\n  private _featureFlags: UiFlags = {};\r\n  private static _messagePresenter?: MessagePresenter;\r\n\r\n  /** The MessagePresenter used to display messages. */\r\n  public static get messagePresenter(): MessagePresenter {\r\n    if (!UiAdmin._messagePresenter) {\r\n      const error = new BentleyError(BentleyStatus.ERROR, \"UiAdmin.messagePresenter not set\") as BentleyErrorWithCategory;\r\n      error.category = \"messagePresenter\";\r\n      throw error;\r\n    }\r\n\r\n    return UiAdmin._messagePresenter;\r\n  }\r\n  public static set messagePresenter(mp: MessagePresenter) {\r\n    UiAdmin._messagePresenter = mp;\r\n  }\r\n\r\n  public get featureFlags(): UiFlags {\r\n    return { ...this._featureFlags }; // return copy so no direct access to modify value\r\n  }\r\n\r\n  public updateFeatureFlags(uiFlags: UiFlags) {\r\n    this._featureFlags = { ...this._featureFlags, ...uiFlags };\r\n  }\r\n\r\n  /** @internal */\r\n  public onInitialized() { }\r\n\r\n  /** Get the cursor X and Y position. */\r\n  public get cursorPosition(): XAndY { return { x: 0, y: 0 }; }\r\n\r\n  /** Create a PointProps object.\r\n  * @deprecated in 4.2.x. Please use @core/geometry [[XAndY]] or a custom implementation.\r\n  */\r\n  public createXAndY(x: number, y: number): XAndY { return { x, y }; }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public get isFocusOnHome(): boolean { return false; }\r\n\r\n  /** Sets focus to Home */\r\n  public setFocusToHome(): void { }\r\n\r\n  /** Show a context menu at a particular location.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the menu was displayed, false if the menu could not be displayed.\r\n   */\r\n  public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: XAndY, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show a Toolbar at a particular location.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\r\n   * @param _offset Offset of the Toolbar from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\r\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\r\n   */\r\n  public showToolbar(\r\n    _toolbarProps: AbstractToolbarProps, _location: XAndY, _offset: XAndY, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the toolbar. */\r\n  public hideToolbar(): boolean { return false; }\r\n\r\n  /** Show a menu button at a particular location. A menu button opens a context menu.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @param _menuItemsProps Properties of the menu items to display.\r\n   * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the button was displayed, false if the button could not be displayed.\r\n   */\r\n  public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: XAndY, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides a menu button.\r\n   * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n   * @return true if the menu was hidden, false if the menu could not be hidden.\r\n   */\r\n  public hideMenuButton(_id: string): boolean { return false; }\r\n\r\n  /** Show a calculator at a particular location.\r\n   * @param _initialValue Value initially displayed in the calculator.\r\n   * @param _resultIcon Icon displayed to the left of the value.\r\n   * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the calculator was displayed, false if the calculator could not be displayed.\r\n   */\r\n  public showCalculator(_initialValue: number, _resultIcon: string, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the calculator. */\r\n  public hideCalculator(): boolean { return false; }\r\n\r\n  /** Show an input editor for an angle value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showAngleEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a length value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showLengthEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a height value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showHeightEditor(_initialValue: number, _location: XAndY, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Show an input editor for a primitive value at a particular location.\r\n   * @param _initialValue Value initially displayed in the editor.\r\n   * @param _propertyDescription Description of the primitive value property.\r\n   * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n   * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n   * @param _onCancel Function called when the Cancel button or the Escape key  is pressed.\r\n   * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n   * @return true if the editor was displayed, false if the editor could not be displayed.\r\n   */\r\n  public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: XAndY, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the input editor. */\r\n  public hideInputEditor(): boolean { return false; }\r\n\r\n  /** Show an HTML element at a particular location.\r\n   * @param _displayElement The HTMLElement to display\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the display element from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\r\n   * @return true if the display element was displayed, false if the display element could not be displayed.\r\n   */\r\n  public showHTMLElement(\r\n    _displayElement: HTMLElement, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the HTML Element. */\r\n  public hideHTMLElement(): boolean { return false; }\r\n\r\n  /** Show a Card containing content, a title and a toolbar at a particular location.\r\n   * @param _content The HTMLElement of the content to display\r\n   * @param _title Title to display at the top of the card.\r\n   * @param _toolbarProps Properties of the Toolbar to display.\r\n   * @param _location Location of the Card, relative to the origin of anchorElement or the window.\r\n   * @param _offset Offset of the Card from the location.\r\n   * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\r\n   * @return true if the Card was displayed, false if the Card could not be displayed.\r\n   */\r\n  public showCard(\r\n    _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\r\n    _location: XAndY, _offset: XAndY, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Hides the Card. */\r\n  public hideCard(): boolean { return false; }\r\n\r\n  /** Opens a Tool Settings Ui popup at a particular location.\r\n   * @param _dataProvider The UiDataProvider for the tool settings\r\n   * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n   * @param _offset Offset of the tool settings from the location\r\n   * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\r\n   * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n   * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openToolSettingsPopup(\r\n    _dataProvider: UiDataProvider, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc,\r\n    _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Tool Settings Ui popup. */\r\n  public closeToolSettingsPopup(): boolean { return false; }\r\n\r\n  /** Show the Keyin Palette to display all support Tool key-ins.\r\n   * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\r\n   * @return true if the Keyin Palette was displayed, false if it could not be displayed.\r\n   */\r\n  public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\r\n\r\n  /** Hides the Keyin Palette. */\r\n  public hideKeyinPalette(): boolean { return false; }\r\n\r\n  /** Send a UI event */\r\n  public static sendUiEvent(args: GenericUiEventArgs) {\r\n    UiAdmin.onGenericUiEvent.emit(args);\r\n  }\r\n  /** GenericUiEvent  */\r\n  public static readonly onGenericUiEvent = new GenericUiEvent();\r\n\r\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\r\n   * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\r\n   * @param _title Specify title for dialog.\r\n   * @param _isModal Specify if the dialog is opened as a modal or modeless.\r\n   * @param _id Id of the dialog that is used to close it.\r\n   * @param _optionalProps Optional props for Dialog construction.\r\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n   */\r\n  public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\r\n    _optionalProps?: DialogProps): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Closes the Dialog with a given Id. */\r\n  public closeDialog(_dialogId: string): boolean { return false; }\r\n}\r\n"]}

package/lib/esm/appui-abstract/UiItemsManager.js

@@ -24,7 +24,7 @@ export var UiItemsApplicationAction;
  * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
  * @public
  */
-class UiItemsManager {
+export class UiItemsManager {
     /** For use in unit testing
      * @internal */
     static clearAllProviders() {
@@ -187,5 +187,4 @@ class UiItemsManager {
 UiItemsManager._registeredUiItemsProviders = new Map();
 /** Event raised any time a UiProvider is registered or unregistered. */
 UiItemsManager.onUiProviderRegisteredEvent = new BeEvent();
-export { UiItemsManager };
 //# sourceMappingURL=UiItemsManager.js.map

package/lib/esm/appui-abstract/UiItemsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAQpE,MAAM,cAAc,GAAG,+BAA+B,CAAC;AACvD;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAa,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;QACrF,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SACrF;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEhG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;SACzF;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAE7E,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACnG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,CAAC;SAVzG,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\n\r\nconst loggerCategory = \"appui-abstract.UiItemsManager\";\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\r\n */\r\nexport enum UiItemsApplicationAction {\r\n  /** Allow the change to the item */\r\n  Allow,\r\n  /** Disallow the change to the item */\r\n  Disallow,\r\n  /** Update the item during the change */\r\n  Update,\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AllowedUiItemProviderOverrides {\r\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\r\n   * @beta\r\n   */\r\n  providerId?: string;\r\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided\r\n   * @beta\r\n   */\r\n  stageUsages?: string[];\r\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided\r\n   * @beta\r\n  */\r\n  stageIds?: string[];\r\n}\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> |                                 // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> |                                                // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> |                                             // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;                  // eslint-disable-line @typescript-eslint/indent\r\n\r\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\r\ninterface UiItemProviderEntry {\r\n  provider: UiItemsProvider;\r\n  overrides?: UiItemProviderOverrides;\r\n}\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\r\n  }\r\n\r\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\r\n    const providerId = overrides?.providerId ?? uiProvider.id;\r\n\r\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\r\n      Logger.logInfo(loggerCategory, `UiItemsProvider (${providerId}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\r\n      Logger.logInfo(loggerCategory, `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(uiProviderId: string): void {\r\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n    Logger.logInfo(loggerCategory, `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n  }\r\n\r\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\r\n    // istanbul ignore else\r\n    const overrides = entry.overrides;\r\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\r\n      return false;\r\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const buttonItems: CommonToolbarItem[] = [];\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return buttonItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n          .forEach((spec: CommonToolbarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\r\n              buttonItems.push({ ...spec, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return statusBarItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n          .forEach((item: CommonStatusBarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              statusBarItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): BackstageItem[] {\r\n    const backstageItems: BackstageItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return backstageItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\r\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\r\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\r\n            // ignore duplicate ids\r\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              backstageItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return widgets;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n          .forEach((widget: AbstractWidgetProps) => {\r\n            // ignore duplicate ids\r\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\r\n              widgets.push({ ...widget, providerId });\r\n          });\r\n      }\r\n    });\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAQpE,MAAM,cAAc,GAAG,+BAA+B,CAAC;AACvD;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;QACrF,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;YAClD,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;QACtF,CAAC;aAAM,CAAC;YACN,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEhG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAE7E,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;gBACpG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;gBAChG,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;gBACzF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\n\r\nconst loggerCategory = \"appui-abstract.UiItemsManager\";\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\r\n */\r\nexport enum UiItemsApplicationAction {\r\n  /** Allow the change to the item */\r\n  Allow,\r\n  /** Disallow the change to the item */\r\n  Disallow,\r\n  /** Update the item during the change */\r\n  Update,\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AllowedUiItemProviderOverrides {\r\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\r\n   * @beta\r\n   */\r\n  providerId?: string;\r\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided\r\n   * @beta\r\n   */\r\n  stageUsages?: string[];\r\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided\r\n   * @beta\r\n  */\r\n  stageIds?: string[];\r\n}\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> |                                 // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> |                                                // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> |                                             // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;                  // eslint-disable-line @typescript-eslint/indent\r\n\r\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\r\ninterface UiItemProviderEntry {\r\n  provider: UiItemsProvider;\r\n  overrides?: UiItemProviderOverrides;\r\n}\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\r\n  }\r\n\r\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\r\n    const providerId = overrides?.providerId ?? uiProvider.id;\r\n\r\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\r\n      Logger.logInfo(loggerCategory, `UiItemsProvider (${providerId}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\r\n      Logger.logInfo(loggerCategory, `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(uiProviderId: string): void {\r\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n    Logger.logInfo(loggerCategory, `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n  }\r\n\r\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\r\n    // istanbul ignore else\r\n    const overrides = entry.overrides;\r\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\r\n      return false;\r\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const buttonItems: CommonToolbarItem[] = [];\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return buttonItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n          .forEach((spec: CommonToolbarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\r\n              buttonItems.push({ ...spec, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return statusBarItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n          .forEach((item: CommonStatusBarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              statusBarItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): BackstageItem[] {\r\n    const backstageItems: BackstageItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return backstageItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\r\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\r\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\r\n            // ignore duplicate ids\r\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              backstageItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return widgets;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n          .forEach((widget: AbstractWidgetProps) => {\r\n            // ignore duplicate ids\r\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\r\n              widgets.push({ ...widget, providerId });\r\n          });\r\n      }\r\n    });\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-abstract/backstage/BackstageItem.js

@@ -34,7 +34,7 @@ export const isStageLauncher = (item) => {
  * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
  * @public
  */
-class BackstageItemUtilities {
+export class BackstageItemUtilities {
 }
 /** Creates a stage launcher backstage item */
 BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides) => ({
@@ -60,5 +60,4 @@ BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority,
     subtitle,
     ...overrides,
 });
-export { BackstageItemUtilities };
 //# sourceMappingURL=BackstageItem.js.map

package/lib/esm/appui-abstract/backstage/BackstageItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4DD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC5G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC/G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,sBAAsB;;AACjC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,EACvG,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,EACvG,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;SA/BQ,sBAAsB","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 Backstage\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.6. Use type guards instead.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n   * allows extensions enough gaps to insert their own groups.\r\n   */\r\n  readonly groupPriority: number;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** optional data to be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageStageLauncher).stageId !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item */\r\n  public static createStageLauncher = (\r\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>, // eslint-disable-line deprecation/deprecation\r\n  ): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item */\r\n  public static createActionItem = (\r\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>, // eslint-disable-line deprecation/deprecation\r\n  ): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    execute,\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: itemId,\r\n    itemPriority,\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4DD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC5G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC/G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,sBAAsB;;AACjC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,EACvG,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,EACvG,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,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 Backstage\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.6. Use type guards instead.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n   * allows extensions enough gaps to insert their own groups.\r\n   */\r\n  readonly groupPriority: number;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** optional data to be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageStageLauncher).stageId !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item */\r\n  public static createStageLauncher = (\r\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>, // eslint-disable-line deprecation/deprecation\r\n  ): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item */\r\n  public static createActionItem = (\r\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>, // eslint-disable-line deprecation/deprecation\r\n  ): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    execute,\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: itemId,\r\n    itemPriority,\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}

package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAczE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAAoC;QAFxC,WAAM,GAAiC,EAAE,CAAC;QAgClD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAhCxF,uBAAuB;QACvB,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAC,KAAmC,EAAE,iBAA0B,EAAE,eAAwB;QACjH,IAAI,iBAAiB,IAAI,KAAK,EAAE;YAC9B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE;gBACzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEnG,uBAAuB;gBACvB,IAAI,YAAY;oBACd,KAAK,GAAG,YAAY,CAAC;aACxB;SACF;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,eAAe;YACjB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAmC;QAClD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAOD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAmC;QAClD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,WAAyD;QAClE,IAAI,UAAU,CAAC;QACf,IAAI,UAAU,CAAC,WAAW,CAAC;YACzB,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;aACxB;YACH,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;SAC5H;QACD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;QAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO;QACT,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,UAAU;SACd,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAyE;QACrF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3H,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAA+B;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC5C,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;aACF;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,4BAA4B,CAAC,KAA+B,EAAE,QAAqB;QACzF,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAEnD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YAEhC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBACnD,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,uBAAuB;oBACvB,IAAI,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;iBACzB;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,uBAAuB;oBACvB,IAAI,sBAAsB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;iBACzB;aACF;YAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC5B;QAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEM,oBAAoB,CAAC,QAAqB;QAC/C,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAE/F,uBAAuB;QACvB,IAAI,YAAY;YACd,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;CAEF","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 Backstage\r\n */\r\n\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Arguments of [[BackstageItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface BackstageItemsChangedArgs {\r\n  readonly items: ReadonlyArray<BackstageItem>;\r\n}\r\n\r\ntype InstanceOrArray<T> = T | ReadonlyArray<T>;\r\n\r\nconst isInstance = <T>(args: InstanceOrArray<T>): args is T => {\r\n  return !Array.isArray(args);\r\n};\r\n\r\n/**\r\n * Controls backstage items.\r\n * @internal\r\n */\r\nexport class BackstageItemsManager {\r\n  private _items: ReadonlyArray<BackstageItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<BackstageItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);\r\n      if (0 !== eventIds.length) {\r\n        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));\r\n\r\n        // istanbul ignore else\r\n        if (itemsUpdated)\r\n          items = updatedItems;\r\n      }\r\n    }\r\n\r\n    this._items = items;\r\n    if (sendItemChanged)\r\n      this.onItemsChanged.raiseEvent({ items });\r\n  }\r\n\r\n  /** load items but do not fire onItemsChanged\r\n   * @internal\r\n   */\r\n  public loadItems(items: ReadonlyArray<BackstageItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when backstage items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: BackstageItemsChangedArgs) => void>();\r\n\r\n  public get items(): ReadonlyArray<BackstageItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  /** @internal */\r\n  public add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>) {\r\n    let itemsToAdd;\r\n    if (isInstance(itemOrItems))\r\n      itemsToAdd = [itemOrItems];\r\n    else {\r\n      itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);\r\n    }\r\n    itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);\r\n    if (itemsToAdd.length === 0)\r\n      return;\r\n    const items = [\r\n      ...this._items,\r\n      ...itemsToAdd,\r\n    ];\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public remove(itemIdOrItemIds: BackstageItem[\"id\"] | ReadonlyArray<BackstageItem[\"id\"]>) {\r\n    const items = this._items.filter((item) => {\r\n      return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);\r\n    });\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[] {\r\n    const eventIds = new Set<string>();\r\n    items.forEach((item) => {\r\n      for (const [, entry] of Object.entries(item)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        }\r\n      }\r\n    });\r\n    return [...eventIds.values()];\r\n  }\r\n\r\n  private internalRefreshAffectedItems(items: readonly BackstageItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: BackstageItem[] } {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return { itemsUpdated: false, updatedItems: [] };\r\n\r\n    let updateRequired = false;\r\n\r\n    const newItems: BackstageItem[] = [];\r\n    for (const item of items) {\r\n      const updatedItem = { ...item };\r\n\r\n      for (const [, entry] of Object.entries(updatedItem)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalBooleanValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalStringValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        }\r\n      }\r\n\r\n      newItems.push(updatedItem);\r\n    }\r\n\r\n    return { itemsUpdated: updateRequired, updatedItems: newItems };\r\n  }\r\n\r\n  public refreshAffectedItems(eventIds: Set<string>) {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return;\r\n\r\n    const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);\r\n\r\n    // istanbul ignore else\r\n    if (itemsUpdated)\r\n      this.loadItemsInternal(updatedItems, false, true);\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"BackstageItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAczE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAAoC;QAFxC,WAAM,GAAiC,EAAE,CAAC;QAgClD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAhCxF,uBAAuB;QACvB,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAC,KAAmC,EAAE,iBAA0B,EAAE,eAAwB;QACjH,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEnG,uBAAuB;gBACvB,IAAI,YAAY;oBACd,KAAK,GAAG,YAAY,CAAC;YACzB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,eAAe;YACjB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAmC;QAClD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAOD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAmC;QAClD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,WAAyD;QAClE,IAAI,UAAU,CAAC;QACf,IAAI,UAAU,CAAC,WAAW,CAAC;YACzB,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;aACxB,CAAC;YACJ,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;QAC7H,CAAC;QACD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;QAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO;QACT,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,UAAU;SACd,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAyE;QACrF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3H,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAA+B;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;oBAC7C,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBACvF,CAAC;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE,CAAC;oBAC9E,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBACvF,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,4BAA4B,CAAC,KAA+B,EAAE,QAAqB;QACzF,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAEnD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YAEhC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACpD,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;oBAC7C,uBAAuB;oBACvB,IAAI,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;gBAC1B,CAAC;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE,CAAC;oBAC9E,uBAAuB;oBACvB,IAAI,sBAAsB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEM,oBAAoB,CAAC,QAAqB;QAC/C,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAE/F,uBAAuB;QACvB,IAAI,YAAY;YACd,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;CAEF","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 Backstage\r\n */\r\n\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Arguments of [[BackstageItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface BackstageItemsChangedArgs {\r\n  readonly items: ReadonlyArray<BackstageItem>;\r\n}\r\n\r\ntype InstanceOrArray<T> = T | ReadonlyArray<T>;\r\n\r\nconst isInstance = <T>(args: InstanceOrArray<T>): args is T => {\r\n  return !Array.isArray(args);\r\n};\r\n\r\n/**\r\n * Controls backstage items.\r\n * @internal\r\n */\r\nexport class BackstageItemsManager {\r\n  private _items: ReadonlyArray<BackstageItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<BackstageItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);\r\n      if (0 !== eventIds.length) {\r\n        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));\r\n\r\n        // istanbul ignore else\r\n        if (itemsUpdated)\r\n          items = updatedItems;\r\n      }\r\n    }\r\n\r\n    this._items = items;\r\n    if (sendItemChanged)\r\n      this.onItemsChanged.raiseEvent({ items });\r\n  }\r\n\r\n  /** load items but do not fire onItemsChanged\r\n   * @internal\r\n   */\r\n  public loadItems(items: ReadonlyArray<BackstageItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when backstage items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: BackstageItemsChangedArgs) => void>();\r\n\r\n  public get items(): ReadonlyArray<BackstageItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  /** @internal */\r\n  public add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>) {\r\n    let itemsToAdd;\r\n    if (isInstance(itemOrItems))\r\n      itemsToAdd = [itemOrItems];\r\n    else {\r\n      itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);\r\n    }\r\n    itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);\r\n    if (itemsToAdd.length === 0)\r\n      return;\r\n    const items = [\r\n      ...this._items,\r\n      ...itemsToAdd,\r\n    ];\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public remove(itemIdOrItemIds: BackstageItem[\"id\"] | ReadonlyArray<BackstageItem[\"id\"]>) {\r\n    const items = this._items.filter((item) => {\r\n      return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);\r\n    });\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[] {\r\n    const eventIds = new Set<string>();\r\n    items.forEach((item) => {\r\n      for (const [, entry] of Object.entries(item)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        }\r\n      }\r\n    });\r\n    return [...eventIds.values()];\r\n  }\r\n\r\n  private internalRefreshAffectedItems(items: readonly BackstageItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: BackstageItem[] } {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return { itemsUpdated: false, updatedItems: [] };\r\n\r\n    let updateRequired = false;\r\n\r\n    const newItems: BackstageItem[] = [];\r\n    for (const item of items) {\r\n      const updatedItem = { ...item };\r\n\r\n      for (const [, entry] of Object.entries(updatedItem)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalBooleanValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalStringValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        }\r\n      }\r\n\r\n      newItems.push(updatedItem);\r\n    }\r\n\r\n    return { itemsUpdated: updateRequired, updatedItems: newItems };\r\n  }\r\n\r\n  public refreshAffectedItems(eventIds: Set<string>) {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return;\r\n\r\n    const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);\r\n\r\n    // istanbul ignore else\r\n    if (itemsUpdated)\r\n      this.loadItemsInternal(updatedItems, false, true);\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-abstract/common/KeyboardKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardKey.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/common/KeyboardKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,WAAW;IACrB,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,UAAU;IAChB,KAAK,MAAM;IACX,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAG/C"}
+{"version":3,"file":"KeyboardKey.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/common/KeyboardKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,WAAW;IACrB,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,KAAK,UAAU;IAEf,MAAM,UAAU;IAChB,KAAK,MAAM;IACX,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAG/C"}

package/lib/esm/appui-abstract/common/KeyboardKey.js

@@ -41,6 +41,7 @@ export var SpecialKey;
     SpecialKey["ArrowUp"] = "ArrowUp";
     SpecialKey["ArrowDown"] = "ArrowDown";
     SpecialKey["Enter"] = "Enter";
+    // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
     SpecialKey["Return"] = "Enter";
     SpecialKey["Space"] = " ";
     SpecialKey["Backspace"] = "Backspace";

package/lib/esm/appui-abstract/common/KeyboardKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardKey.js","sourceRoot":"","sources":["../../../../src/appui-abstract/common/KeyboardKey.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,0BAAW,CAAA;AACb,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAuBX;AAvBD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,8BAAgB,CAAA;IAChB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,yBAAW,CAAA;IACX,iCAAmB,CAAA;AACrB,CAAC,EAvBW,UAAU,KAAV,UAAU,QAuBrB;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,mDAAmD;IACnD,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,SAAS,IAAI,GAAG,KAAK,UAAU,CAAC,UAAU,IAAI,GAAG,KAAK,UAAU,CAAC,OAAO,IAAI,GAAG,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;AACvI,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 Utilities\r\n */\r\n\r\n/** Enumeration for Function Keys\r\n * @public @deprecated in 4.3. Please use the `ts-key-enum` npm package or string literals.\r\n */\r\nexport enum FunctionKey {\r\n  F1 = \"F1\",\r\n  F2 = \"F2\",\r\n  F3 = \"F3\",\r\n  F4 = \"F4\",\r\n  F5 = \"F5\",\r\n  F6 = \"F6\",\r\n  F7 = \"F7\",\r\n  F8 = \"F8\",\r\n  F9 = \"F9\",\r\n  F10 = \"F10\",\r\n  F11 = \"F11\",\r\n  F12 = \"F12\",\r\n}\r\n\r\n/** Enumeration for Special Keys\r\n * @public @deprecated in 4.3. Please use the `ts-key-enum` npm package or string literals.\r\n */\r\nexport enum SpecialKey {\r\n  Home = \"Home\",\r\n  End = \"End\",\r\n  PageUp = \"PageUp\",\r\n  PageDown = \"PageDown\",\r\n  Escape = \"Escape\",\r\n  Delete = \"Delete\",\r\n  Insert = \"Insert\",\r\n  Tab = \"Tab\",\r\n  ArrowLeft = \"ArrowLeft\",\r\n  ArrowRight = \"ArrowRight\",\r\n  ArrowUp = \"ArrowUp\",\r\n  ArrowDown = \"ArrowDown\",\r\n  Enter = \"Enter\",\r\n  Return = \"Enter\",\r\n  Space = \" \",\r\n  Backspace = \"Backspace\",\r\n  Clear = \"Clear\",\r\n  Divide = \"Divide\",\r\n  Multiply = \"Multiply\",\r\n  Subtract = \"Subtract\",\r\n  Add = \"Add\",\r\n  Decimal = \"Decimal\",\r\n}\r\n\r\n/** Determines if a KeyboardEvent.key is an Arrow key\r\n * @public @deprecated in 4.3. Please use a custom implementation moving forward.\r\n */\r\nexport function isArrowKey(key: string): boolean {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  return (key === SpecialKey.ArrowLeft || key === SpecialKey.ArrowRight || key === SpecialKey.ArrowUp || key === SpecialKey.ArrowDown);\r\n}\r\n"]}
+{"version":3,"file":"KeyboardKey.js","sourceRoot":"","sources":["../../../../src/appui-abstract/common/KeyboardKey.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,0BAAW,CAAA;AACb,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAwBX;AAxBD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,uEAAuE;IACvE,8BAAgB,CAAA;IAChB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,yBAAW,CAAA;IACX,iCAAmB,CAAA;AACrB,CAAC,EAxBW,UAAU,KAAV,UAAU,QAwBrB;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,mDAAmD;IACnD,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,SAAS,IAAI,GAAG,KAAK,UAAU,CAAC,UAAU,IAAI,GAAG,KAAK,UAAU,CAAC,OAAO,IAAI,GAAG,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;AACvI,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 Utilities\r\n */\r\n\r\n/** Enumeration for Function Keys\r\n * @public @deprecated in 4.3. Please use the `ts-key-enum` npm package or string literals.\r\n */\r\nexport enum FunctionKey {\r\n  F1 = \"F1\",\r\n  F2 = \"F2\",\r\n  F3 = \"F3\",\r\n  F4 = \"F4\",\r\n  F5 = \"F5\",\r\n  F6 = \"F6\",\r\n  F7 = \"F7\",\r\n  F8 = \"F8\",\r\n  F9 = \"F9\",\r\n  F10 = \"F10\",\r\n  F11 = \"F11\",\r\n  F12 = \"F12\",\r\n}\r\n\r\n/** Enumeration for Special Keys\r\n * @public @deprecated in 4.3. Please use the `ts-key-enum` npm package or string literals.\r\n */\r\nexport enum SpecialKey {\r\n  Home = \"Home\",\r\n  End = \"End\",\r\n  PageUp = \"PageUp\",\r\n  PageDown = \"PageDown\",\r\n  Escape = \"Escape\",\r\n  Delete = \"Delete\",\r\n  Insert = \"Insert\",\r\n  Tab = \"Tab\",\r\n  ArrowLeft = \"ArrowLeft\",\r\n  ArrowRight = \"ArrowRight\",\r\n  ArrowUp = \"ArrowUp\",\r\n  ArrowDown = \"ArrowDown\",\r\n  Enter = \"Enter\",\r\n  // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values\r\n  Return = \"Enter\",\r\n  Space = \" \",\r\n  Backspace = \"Backspace\",\r\n  Clear = \"Clear\",\r\n  Divide = \"Divide\",\r\n  Multiply = \"Multiply\",\r\n  Subtract = \"Subtract\",\r\n  Add = \"Add\",\r\n  Decimal = \"Decimal\",\r\n}\r\n\r\n/** Determines if a KeyboardEvent.key is an Arrow key\r\n * @public @deprecated in 4.3. Please use a custom implementation moving forward.\r\n */\r\nexport function isArrowKey(key: string): boolean {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  return (key === SpecialKey.ArrowLeft || key === SpecialKey.ArrowRight || key === SpecialKey.ArrowUp || key === SpecialKey.ArrowDown);\r\n}\r\n"]}

package/lib/esm/appui-abstract/content/StandardContentLayouts.js

@@ -9,7 +9,7 @@
  * Class that define Standard Content Layouts that can be used to specify how the content is arranged in a frontstage.
  * @public
  */
-class StandardContentLayouts {
+export class StandardContentLayouts {
 }
 StandardContentLayouts.singleView = {
     id: "uia:singleView",
@@ -102,5 +102,4 @@ StandardContentLayouts.availableLayouts = [
     StandardContentLayouts.threeViewsTwoOnBottom,
     StandardContentLayouts.threeViewsTwoOnTop,
 ];
-export { StandardContentLayouts };
 //# sourceMappingURL=StandardContentLayouts.js.map

package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandardContentLayouts.js","sourceRoot":"","sources":["../../../../src/appui-abstract/content/StandardContentLayouts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAa,sBAAsB;;AACV,iCAAU,GAAuB;IACtD,EAAE,EAAE,gBAAgB;IACpB,WAAW,EAAE,qBAAqB;CACnC,CAAC;AAEqB,oCAAa,GAAuB;IACzD,EAAE,EAAE,mBAAmB;IACvB,WAAW,EAAE,+DAA+D;IAC5E,aAAa,EAAE;QACb,EAAE,EAAE,+BAA+B;QACnC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,GAAG;QAChB,YAAY,EAAE,GAAG;QACjB,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iCAAiC,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;QACzJ,KAAK,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,kCAAkC,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;KAC5J;CACF,CAAC;AAEqB,uCAAgB,GAAuB;IAC5D,EAAE,EAAE,sBAAsB;IAC1B,WAAW,EAAE,yBAAyB;IACtC,aAAa,EAAE;QACb,EAAE,EAAE,2BAA2B;QAC/B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,CAAC;KACT;CACF,CAAC;AACqB,yCAAkB,GAAuB;IAC9D,EAAE,EAAE,wBAAwB;IAC5B,WAAW,EAAE,0CAA0C;IACvD,eAAe,EAAE;QACf,EAAE,EAAE,6BAA6B;QACjC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEqB,0CAAmB,GAAuB;IAC/D,EAAE,EAAE,yBAAyB;IAC7B,WAAW,EAAE,wFAAwF;IACrG,aAAa,EAAE;QACb,EAAE,EAAE,yBAAyB;QAC7B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,8BAA8B,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;QACtJ,KAAK,EAAE,CAAC;KACT;CACF,CAAC;AAEqB,2CAAoB,GAAuB;IAChE,EAAE,EAAE,0BAA0B;IAC9B,WAAW,EAAE,wFAAwF;IACrG,aAAa,EAAE;QACb,EAAE,EAAE,0BAA0B;QAC9B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;KACzJ;CACF,CAAC;AAEqB,4CAAqB,GAAuB;IACjE,EAAE,EAAE,2BAA2B;IAC/B,WAAW,EAAE,4DAA4D;IACzE,eAAe,EAAE;QACf,EAAE,EAAE,qCAAqC;QACzC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,8BAA8B,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;KACvJ;CACF,CAAC;AAEqB,yCAAkB,GAAuB;IAC9D,EAAE,EAAE,wBAAwB;IAC5B,WAAW,EAAE,4DAA4D;IACzE,eAAe,EAAE;QACf,EAAE,EAAE,6BAA6B;QACjC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,2BAA2B,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;QAChJ,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEF,yDAAyD;AAClC,uCAAgB,GAAyB;IAC9D,sBAAsB,CAAC,UAAU;IACjC,sBAAsB,CAAC,aAAa;IACpC,sBAAsB,CAAC,gBAAgB;IACvC,sBAAsB,CAAC,kBAAkB;IACzC,sBAAsB,CAAC,mBAAmB;IAC1C,sBAAsB,CAAC,oBAAoB;IAC3C,sBAAsB,CAAC,qBAAqB;IAC5C,sBAAsB,CAAC,kBAAkB;CAC1C,CAAC;SAlGS,sBAAsB","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 ContentView\r\n */\r\n\r\nimport { ContentLayoutProps } from \"./ContentLayoutProps\";\r\n\r\n/**\r\n * Class that define Standard Content Layouts that can be used to specify how the content is arranged in a frontstage.\r\n * @public\r\n */\r\nexport class StandardContentLayouts {\r\n  public static readonly singleView: ContentLayoutProps = {\r\n    id: \"uia:singleView\",\r\n    description: \"Single Content View\",\r\n  };\r\n\r\n  public static readonly fourQuadrants: ContentLayoutProps = {\r\n    id: \"uia:fourQuadrants\",\r\n    description: \"Four Views, two stacked on the left, two stacked on the right\",\r\n    verticalSplit: {\r\n      id: \"uia:fourQuadrantVerticalSplit\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      minSizeLeft: 100,\r\n      minSizeRight: 100,\r\n      left: { horizontalSplit: { id: \"uia:fourQuadrantsLeftHorizontal\", percentage: 0.50, top: 0, bottom: 1, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n      right: { horizontalSplit: { id: \"uia:fourQuadrantsRightHorizontal\", percentage: 0.50, top: 2, bottom: 3, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly twoVerticalSplit: ContentLayoutProps = {\r\n    id: \"uia:twoVerticalSplit\",\r\n    description: \"Two Views, side by side\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsVerticalSplit\",\r\n      percentage: 0.50,\r\n      left: 0,\r\n      right: 1,\r\n    },\r\n  };\r\n  public static readonly twoHorizontalSplit: ContentLayoutProps = {\r\n    id: \"uia:twoHorizontalSplit\",\r\n    description: \"Two views, stack one on top of the other\",\r\n    horizontalSplit: {\r\n      id: \"uia:twoViewsHorizontalSplit\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: 0,\r\n      bottom: 1,\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnLeft: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnLeft\",\r\n    description: \"Three views, one on the right with the two on the left stacked one of top of the other\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsOnLeftSplit\",\r\n      percentage: 0.50,\r\n      left: { horizontalSplit: { id: \"uia:twoViewsOnLeftHorizontal\", percentage: 0.50, top: 0, bottom: 1, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n      right: 2,\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnRight: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnRight\",\r\n    description: \"Three views, one on the left with the two on the right stacked one of top of the other\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsOnRightSplit\",\r\n      percentage: 0.50,\r\n      left: 0,\r\n      right: { horizontalSplit: { id: \"uia:twoViewsOnRightHorizontal\", percentage: 0.50, top: 1, bottom: 2, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnBottom: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnBottom\",\r\n    description: \"Three Views, one on top and two side by side on the bottom\",\r\n    horizontalSplit: {\r\n      id: \"uia:threeViewsTwoOnBottomHorizontal\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: 0,\r\n      bottom: { verticalSplit: { id: \"uia:twoViewsOnBottomVertical\", percentage: 0.50, left: 1, right: 2, lock: false, minSizeLeft: 50, minSizeRight: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnTop: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnTop\",\r\n    description: \"Three Views, two side by side on top and one on the bottom\",\r\n    horizontalSplit: {\r\n      id: \"uia:twoViewsOnTopHorizontal\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: { verticalSplit: { id: \"uia:twoViewsOnTopVertical\", percentage: 0.50, left: 0, right: 1, lock: false, minSizeLeft: 50, minSizeRight: 50 } },\r\n      bottom: 2,\r\n    },\r\n  };\r\n\r\n  // provides and iterable list of standard content layouts\r\n  public static readonly availableLayouts: ContentLayoutProps[] = [\r\n    StandardContentLayouts.singleView,\r\n    StandardContentLayouts.fourQuadrants,\r\n    StandardContentLayouts.twoVerticalSplit,\r\n    StandardContentLayouts.twoHorizontalSplit,\r\n    StandardContentLayouts.threeViewsTwoOnLeft,\r\n    StandardContentLayouts.threeViewsTwoOnRight,\r\n    StandardContentLayouts.threeViewsTwoOnBottom,\r\n    StandardContentLayouts.threeViewsTwoOnTop,\r\n  ];\r\n\r\n}\r\n"]}
+{"version":3,"file":"StandardContentLayouts.js","sourceRoot":"","sources":["../../../../src/appui-abstract/content/StandardContentLayouts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAM,OAAO,sBAAsB;;AACV,iCAAU,GAAuB;IACtD,EAAE,EAAE,gBAAgB;IACpB,WAAW,EAAE,qBAAqB;CACnC,CAAC;AAEqB,oCAAa,GAAuB;IACzD,EAAE,EAAE,mBAAmB;IACvB,WAAW,EAAE,+DAA+D;IAC5E,aAAa,EAAE;QACb,EAAE,EAAE,+BAA+B;QACnC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,GAAG;QAChB,YAAY,EAAE,GAAG;QACjB,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,iCAAiC,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;QACzJ,KAAK,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,kCAAkC,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;KAC5J;CACF,CAAC;AAEqB,uCAAgB,GAAuB;IAC5D,EAAE,EAAE,sBAAsB;IAC1B,WAAW,EAAE,yBAAyB;IACtC,aAAa,EAAE;QACb,EAAE,EAAE,2BAA2B;QAC/B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,CAAC;KACT;CACF,CAAC;AACqB,yCAAkB,GAAuB;IAC9D,EAAE,EAAE,wBAAwB;IAC5B,WAAW,EAAE,0CAA0C;IACvD,eAAe,EAAE;QACf,EAAE,EAAE,6BAA6B;QACjC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEqB,0CAAmB,GAAuB;IAC/D,EAAE,EAAE,yBAAyB;IAC7B,WAAW,EAAE,wFAAwF;IACrG,aAAa,EAAE;QACb,EAAE,EAAE,yBAAyB;QAC7B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,8BAA8B,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;QACtJ,KAAK,EAAE,CAAC;KACT;CACF,CAAC;AAEqB,2CAAoB,GAAuB;IAChE,EAAE,EAAE,0BAA0B;IAC9B,WAAW,EAAE,wFAAwF;IACrG,aAAa,EAAE;QACb,EAAE,EAAE,0BAA0B;QAC9B,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE;KACzJ;CACF,CAAC;AAEqB,4CAAqB,GAAuB;IACjE,EAAE,EAAE,2BAA2B;IAC/B,WAAW,EAAE,4DAA4D;IACzE,eAAe,EAAE;QACf,EAAE,EAAE,qCAAqC;QACzC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,8BAA8B,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;KACvJ;CACF,CAAC;AAEqB,yCAAkB,GAAuB;IAC9D,EAAE,EAAE,wBAAwB;IAC5B,WAAW,EAAE,4DAA4D;IACzE,eAAe,EAAE;QACf,EAAE,EAAE,6BAA6B;QACjC,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,2BAA2B,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;QAChJ,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEF,yDAAyD;AAClC,uCAAgB,GAAyB;IAC9D,sBAAsB,CAAC,UAAU;IACjC,sBAAsB,CAAC,aAAa;IACpC,sBAAsB,CAAC,gBAAgB;IACvC,sBAAsB,CAAC,kBAAkB;IACzC,sBAAsB,CAAC,mBAAmB;IAC1C,sBAAsB,CAAC,oBAAoB;IAC3C,sBAAsB,CAAC,qBAAqB;IAC5C,sBAAsB,CAAC,kBAAkB;CAC1C,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 ContentView\r\n */\r\n\r\nimport { ContentLayoutProps } from \"./ContentLayoutProps\";\r\n\r\n/**\r\n * Class that define Standard Content Layouts that can be used to specify how the content is arranged in a frontstage.\r\n * @public\r\n */\r\nexport class StandardContentLayouts {\r\n  public static readonly singleView: ContentLayoutProps = {\r\n    id: \"uia:singleView\",\r\n    description: \"Single Content View\",\r\n  };\r\n\r\n  public static readonly fourQuadrants: ContentLayoutProps = {\r\n    id: \"uia:fourQuadrants\",\r\n    description: \"Four Views, two stacked on the left, two stacked on the right\",\r\n    verticalSplit: {\r\n      id: \"uia:fourQuadrantVerticalSplit\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      minSizeLeft: 100,\r\n      minSizeRight: 100,\r\n      left: { horizontalSplit: { id: \"uia:fourQuadrantsLeftHorizontal\", percentage: 0.50, top: 0, bottom: 1, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n      right: { horizontalSplit: { id: \"uia:fourQuadrantsRightHorizontal\", percentage: 0.50, top: 2, bottom: 3, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly twoVerticalSplit: ContentLayoutProps = {\r\n    id: \"uia:twoVerticalSplit\",\r\n    description: \"Two Views, side by side\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsVerticalSplit\",\r\n      percentage: 0.50,\r\n      left: 0,\r\n      right: 1,\r\n    },\r\n  };\r\n  public static readonly twoHorizontalSplit: ContentLayoutProps = {\r\n    id: \"uia:twoHorizontalSplit\",\r\n    description: \"Two views, stack one on top of the other\",\r\n    horizontalSplit: {\r\n      id: \"uia:twoViewsHorizontalSplit\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: 0,\r\n      bottom: 1,\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnLeft: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnLeft\",\r\n    description: \"Three views, one on the right with the two on the left stacked one of top of the other\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsOnLeftSplit\",\r\n      percentage: 0.50,\r\n      left: { horizontalSplit: { id: \"uia:twoViewsOnLeftHorizontal\", percentage: 0.50, top: 0, bottom: 1, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n      right: 2,\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnRight: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnRight\",\r\n    description: \"Three views, one on the left with the two on the right stacked one of top of the other\",\r\n    verticalSplit: {\r\n      id: \"uia:twoViewsOnRightSplit\",\r\n      percentage: 0.50,\r\n      left: 0,\r\n      right: { horizontalSplit: { id: \"uia:twoViewsOnRightHorizontal\", percentage: 0.50, top: 1, bottom: 2, lock: false, minSizeTop: 50, minSizeBottom: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnBottom: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnBottom\",\r\n    description: \"Three Views, one on top and two side by side on the bottom\",\r\n    horizontalSplit: {\r\n      id: \"uia:threeViewsTwoOnBottomHorizontal\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: 0,\r\n      bottom: { verticalSplit: { id: \"uia:twoViewsOnBottomVertical\", percentage: 0.50, left: 1, right: 2, lock: false, minSizeLeft: 50, minSizeRight: 50 } },\r\n    },\r\n  };\r\n\r\n  public static readonly threeViewsTwoOnTop: ContentLayoutProps = {\r\n    id: \"uia:threeViewsTwoOnTop\",\r\n    description: \"Three Views, two side by side on top and one on the bottom\",\r\n    horizontalSplit: {\r\n      id: \"uia:twoViewsOnTopHorizontal\",\r\n      percentage: 0.50,\r\n      lock: false,\r\n      top: { verticalSplit: { id: \"uia:twoViewsOnTopVertical\", percentage: 0.50, left: 0, right: 1, lock: false, minSizeLeft: 50, minSizeRight: 50 } },\r\n      bottom: 2,\r\n    },\r\n  };\r\n\r\n  // provides and iterable list of standard content layouts\r\n  public static readonly availableLayouts: ContentLayoutProps[] = [\r\n    StandardContentLayouts.singleView,\r\n    StandardContentLayouts.fourQuadrants,\r\n    StandardContentLayouts.twoVerticalSplit,\r\n    StandardContentLayouts.twoHorizontalSplit,\r\n    StandardContentLayouts.threeViewsTwoOnLeft,\r\n    StandardContentLayouts.threeViewsTwoOnRight,\r\n    StandardContentLayouts.threeViewsTwoOnBottom,\r\n    StandardContentLayouts.threeViewsTwoOnTop,\r\n  ];\r\n\r\n}\r\n"]}

package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js

@@ -38,7 +38,7 @@ export var DialogButtonStyle;
 /**
  * @public
  */
-class UiLayoutDataProvider extends UiDataProvider {
+export class UiLayoutDataProvider extends UiDataProvider {
     constructor() {
         super(...arguments);
         /** Applies change of a single property - this is the default method used when property editors are dynamically generated. */
@@ -145,7 +145,6 @@ UiLayoutDataProvider.getPropertyRecord = (dialogItem) => {
     record.isDisabled = UiLayoutDataProvider.getItemDisabledState(dialogItem);
     return record;
 };
-export { UiLayoutDataProvider };
 /** [[DialogLayoutDataProvider]] Abstract class that allows property values to be passed between hosting API and Dialog that generates and arranges components dynamically
  * including the buttons at the bottom of the dialog.
  * @public

package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiLayoutDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/UiLayoutDataProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAwB,wBAAwB,EAA6B,MAAM,4BAA4B,CAAC;AACvH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAkB,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAwB,oBAAoB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE9F;;GAEG;AACH,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,6BAAS,CAAA;IACT,mCAAe,CAAA;IACf,6BAAS,CAAA;IACT,qCAAiB,CAAA;IACjB,+BAAW,CAAA;IACX,6BAAS,CAAA;IACT,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,yCAAqB,CAAA;AACvB,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,8BAAS,CAAA;IACT,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,iDAA4B,CAAA;AAC9B,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4BD;;GAEG;AACH,MAAsB,oBAAqB,SAAQ,cAAc;IAAjE;;QAUE,6HAA6H;QAC7H,uBAAuB;QAChB,0BAAqB,GAAG,CAAC,aAAqC,EAAQ,EAAE;YAC7E,MAAM,CAAC,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC,CAAC;QAC1G,CAAC,CAAC;IA2GJ,CAAC;IAtHC,kIAAkI;IAClH,kBAAkB,CAAC,UAAgC;QACjE,gFAAgF;QAChF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvE,OAAO,EAAE,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC;IAClD,CAAC;IAUD,2BAA2B;IAC3B,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAES,iBAAiB,CAAC,KAA4C;QACtE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACvC,CAAC;IAED,uIAAuI;IACvI,uBAAuB;IAChB,iBAAiB;QACtB,MAAM,CAAC,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,EAAE;YAC7B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;SAClD;QACD,OAAO,IAAI,CAAC,MAAO,CAAC;IACtB,CAAC;IAED,kFAAkF;IAC3E,iBAAiB,CAAC,SAAS,GAAG,IAAI;QACvC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACjD,uBAAuB;QACvB,IAAI,SAAS;YACX,IAAI,CAAC,sBAAsB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,IAAI,GAAgB,EAAE,CAAC;QAE7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACrF,IAAI,GAAG,EAAE;gBACP,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACtB;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACzE;QACH,CAAC,CAAC,CAAC;QAEH,YAAY;QACZ,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QACnE,eAAe;QACf,IAAI,CAAC,OAAO,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;QAChJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,gBAAgB,CAAC,IAAgB;QAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;YACvD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAA2B,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAA8B,CAAC;YAC3K,uBAAuB;YACvB,IAAI,MAAM;gBACR,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,yBAAyB,CAAC,IAAgB;QACtD,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,cAA8B;QAC/D,MAAM,UAAU,GAAG,cAA4B,CAAC;QAChD,uBAAuB;QACvB,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS;YACnE,OAAO,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC;QACrC,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC;QAC5C,uBAAuB;QACvB,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC;QAErC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IACtB,CAAC;IAUD,oEAAoE;IAC7D,MAAM,CAAC,6BAA6B,CAAC,GAAc;QACxD,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE;YAC5B,uBAAuB;YACvB,IAAI,oBAAoB,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,kBAAkB,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC/L,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBD,qDAAqD;AACvC,sCAAiB,GAAG,CAAC,UAA0B,EAAkB,EAAE;IAC/E,MAAM,aAAa,GAAG,EAAE,WAAW,EAAE,mBAAmB,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,EAAE,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IACjJ,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,aAA+B,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxF,MAAM,CAAC,UAAU,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC;AAChB,CAAC,AAL8B,CAK7B;SA9GkB,oBAAoB;AA2H1C;;;GAGG;AACH,MAAM,OAAgB,wBAAyB,SAAQ,oBAAoB;IAA3E;;QACS,2BAAsB,GAAG,IAAI,SAAS,EAAQ,CAAC;IAgBxD,CAAC;IAdC,sFAAsF;IAC/E,4BAA4B;QACjC,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAEM,gBAAgB;QACrB,gCAAgC;QAChC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,uBAAuB;QACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAChE,uBAAuB;QACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { PropertyEditorParams, PropertyEditorParamTypes, SuppressLabelEditorParams } from \"../properties/EditorParams\";\r\nimport { PropertyRecord } from \"../properties/Record\";\r\nimport { PrimitiveValue, PropertyValueFormat } from \"../properties/Value\";\r\nimport { BaseDialogItem, DialogItem, DialogPropertyItem, DialogPropertySyncItem } from \"./DialogItem\";\r\nimport { PropertyChangeResult, PropertyChangeStatus, UiDataProvider } from \"./UiDataProvider\";\r\n\r\n/** Enum for button types. Determines button label, and default button style.\r\n * @public\r\n */\r\nexport enum DialogButtonType {\r\n  None = \"\",\r\n  Close = \"close\",\r\n  OK = \"ok\",\r\n  Cancel = \"cancel\",\r\n  Yes = \"yes\",\r\n  No = \"no\",\r\n  Retry = \"retry\",\r\n  Next = \"next\",\r\n  Previous = \"previous\"\r\n}\r\n\r\n/** Enum for button style.\r\n * @public\r\n */\r\nexport enum DialogButtonStyle {\r\n  None = \"\",\r\n  Primary = \"iui-cta\",\r\n  Hollow = \"iui-default\",\r\n  Blue = \"iui-high-visibility\",\r\n}\r\n\r\n/** Interface for a dialog button in a button cluster\r\n * @public\r\n */\r\nexport interface DialogButtonDef {\r\n  /** type of button */\r\n  type: DialogButtonType;\r\n  /** Triggered on button click */\r\n  onClick: () => void;\r\n  /** Which button style to decorate button width */\r\n  buttonStyle?: DialogButtonStyle;\r\n  /** Disable the button */\r\n  disabled?: boolean;\r\n  /** Custom label */\r\n  label?: string;\r\n  /** Custom CSS class */\r\n  className?: string;\r\n}\r\n\r\n/** [[DialogRow]] is the interface that groups dialog items into rows for building UI\r\n * @public\r\n */\r\nexport interface DialogRow {\r\n  priority: number;\r\n  items: DialogItem[];\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport abstract class UiLayoutDataProvider extends UiDataProvider {\r\n  private _items: ReadonlyArray<DialogItem> | undefined;\r\n\r\n  /** Applies changes from one or more properties - some dialogs will use this to send a bulk set of changes back to the provider */\r\n  public override processChangesInUi(properties: DialogPropertyItem[]): PropertyChangeResult {\r\n    // Default implementation is to just pass each property to applyUiPropertyChange\r\n    properties.forEach((property) => this.applyUiPropertyChange(property));\r\n    return { status: PropertyChangeStatus.Success };\r\n  }\r\n\r\n  /** Applies change of a single property - this is the default method used when property editors are dynamically generated. */\r\n  // istanbul ignore next\r\n  public applyUiPropertyChange = (_updatedValue: DialogPropertySyncItem): void => {\r\n    throw (new Error(\"Derived UiDataProvider should implement this to apply change to a single property.\"));\r\n  };\r\n\r\n  private _rows: DialogRow[] | undefined;\r\n\r\n  /** Array of dialog rows */\r\n  public get rows(): DialogRow[] {\r\n    if (!this._rows) {\r\n      this._rows = this.layoutDialogRows();\r\n    }\r\n    return this._rows;\r\n  }\r\n\r\n  protected loadItemsInternal(items: ReadonlyArray<DialogItem> | undefined) {\r\n    this._items = items ? items : [];\r\n    this._rows = this.layoutDialogRows();\r\n  }\r\n\r\n  /** Called by UI to request available properties that can be bound to user supplied UI components (See Tool1UiProvider for example). */\r\n  // istanbul ignore next\r\n  public supplyDialogItems(): DialogItem[] | undefined {\r\n    throw (new Error(\"Derived UiDataProvider must implement this method to supply set of properties.\"));\r\n  }\r\n\r\n  public get items(): ReadonlyArray<DialogItem> {\r\n    if (undefined === this._items) {\r\n      this.loadItemsInternal(this.supplyDialogItems());\r\n    }\r\n    return this._items!;\r\n  }\r\n\r\n  /** Called to inform listeners that new properties are ready for display in UI. */\r\n  public reloadDialogItems(emitEvent = true) {\r\n    this.loadItemsInternal(this.supplyDialogItems());\r\n    // istanbul ignore else\r\n    if (emitEvent)\r\n      this.fireItemsReloadedEvent();\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public layoutDialogRows(): DialogRow[] {\r\n    const rows: DialogRow[] = [];\r\n\r\n    this.items.forEach((item) => {\r\n      const row = rows.find((value) => value.priority === item.editorPosition.rowPriority);\r\n      if (row) {\r\n        row.items.push(item);\r\n      } else {\r\n        rows.push({ priority: item.editorPosition.rowPriority, items: [item] });\r\n      }\r\n    });\r\n\r\n    // sort rows\r\n    rows.sort((a: DialogRow, b: DialogRow) => a.priority - b.priority);\r\n    // sort records\r\n    rows.forEach((row: DialogRow) => row.items.sort((a: DialogItem, b: DialogItem) => a.editorPosition.columnIndex - b.editorPosition.columnIndex));\r\n    return rows;\r\n  }\r\n\r\n  /** Determines if a dialog item editor wants a label */\r\n  public static editorWantsLabel(item: DialogItem): boolean {\r\n    if (item.property.editor && item.property.editor.params) {\r\n      const params = item.property.editor.params.find((param: PropertyEditorParams) => param.type === PropertyEditorParamTypes.SuppressEditorLabel) as SuppressLabelEditorParams;\r\n      // istanbul ignore else\r\n      if (params)\r\n        return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Determines if a dialog items has an associated lock property */\r\n  public static hasAssociatedLockProperty(item: DialogItem): boolean {\r\n    return !!item.lockProperty;\r\n  }\r\n\r\n  /** Gets the disabled state for a given dialog item */\r\n  public static getItemDisabledState(baseDialogItem: BaseDialogItem): boolean {\r\n    const dialogItem = baseDialogItem as DialogItem;\r\n    // istanbul ignore else\r\n    if (dialogItem === undefined || dialogItem.lockProperty === undefined)\r\n      return !!baseDialogItem.isDisabled;\r\n    const value = dialogItem.lockProperty.value;\r\n    // istanbul ignore next\r\n    if (value === undefined)\r\n      return !!baseDialogItem.isDisabled;\r\n\r\n    return !value.value;\r\n  }\r\n\r\n  /** Gets a property record for a given dialog item */\r\n  public static getPropertyRecord = (dialogItem: BaseDialogItem): PropertyRecord => {\r\n    const propertyValue = { valueFormat: PropertyValueFormat.Primitive, value: dialogItem.value.value, displayValue: dialogItem.value.displayValue };\r\n    const record = new PropertyRecord(propertyValue as PrimitiveValue, dialogItem.property);\r\n    record.isDisabled = UiLayoutDataProvider.getItemDisabledState(dialogItem);\r\n    return record;\r\n  };\r\n\r\n  /** Determines if a dialog row only contains button group editors */\r\n  public static onlyContainButtonGroupEditors(row: DialogRow): boolean {\r\n    for (const item of row.items) {\r\n      // istanbul ignore else\r\n      if (UiLayoutDataProvider.hasAssociatedLockProperty(item) || undefined === item.property.editor || \"enum-buttongroup\" !== item.property.editor.name || UiLayoutDataProvider.editorWantsLabel(item))\r\n        return false;\r\n    }\r\n    return true;\r\n  }\r\n}\r\n\r\n/** [[DialogLayoutDataProvider]] Abstract class that allows property values to be passed between hosting API and Dialog that generates and arranges components dynamically\r\n * including the buttons at the bottom of the dialog.\r\n * @public\r\n */\r\nexport abstract class DialogLayoutDataProvider extends UiLayoutDataProvider {\r\n  public onButtonsReloadedEvent = new BeUiEvent<void>();\r\n\r\n  /** Called to inform listeners that modal dialog button data needs to be refreshed. */\r\n  public fireDialogButtonsReloadEvent() {\r\n    this.onButtonsReloadedEvent.emit();\r\n  }\r\n\r\n  public supplyButtonData(): DialogButtonDef[] | undefined {\r\n    // Derived class should override\r\n    const buttons: DialogButtonDef[] = [];\r\n    // istanbul ignore next\r\n    buttons.push({ type: DialogButtonType.OK, onClick: () => { } });\r\n    // istanbul ignore next\r\n    buttons.push({ type: DialogButtonType.Cancel, onClick: () => { } });\r\n    return buttons;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"UiLayoutDataProvider.js","sourceRoot":"","sources":["../../../../src/appui-abstract/dialogs/UiLayoutDataProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAwB,wBAAwB,EAA6B,MAAM,4BAA4B,CAAC;AACvH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAkB,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAwB,oBAAoB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE9F;;GAEG;AACH,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,6BAAS,CAAA;IACT,mCAAe,CAAA;IACf,6BAAS,CAAA;IACT,qCAAiB,CAAA;IACjB,+BAAW,CAAA;IACX,6BAAS,CAAA;IACT,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,yCAAqB,CAAA;AACvB,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,8BAAS,CAAA;IACT,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,iDAA4B,CAAA;AAC9B,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4BD;;GAEG;AACH,MAAM,OAAgB,oBAAqB,SAAQ,cAAc;IAAjE;;QAUE,6HAA6H;QAC7H,uBAAuB;QAChB,0BAAqB,GAAG,CAAC,aAAqC,EAAQ,EAAE;YAC7E,MAAM,CAAC,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC,CAAC;QAC1G,CAAC,CAAC;IA2GJ,CAAC;IAtHC,kIAAkI;IAClH,kBAAkB,CAAC,UAAgC;QACjE,gFAAgF;QAChF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvE,OAAO,EAAE,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC;IAClD,CAAC;IAUD,2BAA2B;IAC3B,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAES,iBAAiB,CAAC,KAA4C;QACtE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACvC,CAAC;IAED,uIAAuI;IACvI,uBAAuB;IAChB,iBAAiB;QACtB,MAAM,CAAC,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC,MAAO,CAAC;IACtB,CAAC;IAED,kFAAkF;IAC3E,iBAAiB,CAAC,SAAS,GAAG,IAAI;QACvC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACjD,uBAAuB;QACvB,IAAI,SAAS;YACX,IAAI,CAAC,sBAAsB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,IAAI,GAAgB,EAAE,CAAC;QAE7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACrF,IAAI,GAAG,EAAE,CAAC;gBACR,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,YAAY;QACZ,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QACnE,eAAe;QACf,IAAI,CAAC,OAAO,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;QAChJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,gBAAgB,CAAC,IAAgB;QAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAA2B,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAA8B,CAAC;YAC3K,uBAAuB;YACvB,IAAI,MAAM;gBACR,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,yBAAyB,CAAC,IAAgB;QACtD,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,cAA8B;QAC/D,MAAM,UAAU,GAAG,cAA4B,CAAC;QAChD,uBAAuB;QACvB,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS;YACnE,OAAO,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC;QACrC,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC;QAC5C,uBAAuB;QACvB,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC;QAErC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IACtB,CAAC;IAUD,oEAAoE;IAC7D,MAAM,CAAC,6BAA6B,CAAC,GAAc;QACxD,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC7B,uBAAuB;YACvB,IAAI,oBAAoB,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,kBAAkB,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC/L,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;;AAhBD,qDAAqD;AACvC,sCAAiB,GAAG,CAAC,UAA0B,EAAkB,EAAE;IAC/E,MAAM,aAAa,GAAG,EAAE,WAAW,EAAE,mBAAmB,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,EAAE,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IACjJ,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,aAA+B,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxF,MAAM,CAAC,UAAU,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC;AAChB,CAAC,AAL8B,CAK7B;AAaJ;;;GAGG;AACH,MAAM,OAAgB,wBAAyB,SAAQ,oBAAoB;IAA3E;;QACS,2BAAsB,GAAG,IAAI,SAAS,EAAQ,CAAC;IAgBxD,CAAC;IAdC,sFAAsF;IAC/E,4BAA4B;QACjC,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAEM,gBAAgB;QACrB,gCAAgC;QAChC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,uBAAuB;QACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAChE,uBAAuB;QACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Dialog\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { PropertyEditorParams, PropertyEditorParamTypes, SuppressLabelEditorParams } from \"../properties/EditorParams\";\r\nimport { PropertyRecord } from \"../properties/Record\";\r\nimport { PrimitiveValue, PropertyValueFormat } from \"../properties/Value\";\r\nimport { BaseDialogItem, DialogItem, DialogPropertyItem, DialogPropertySyncItem } from \"./DialogItem\";\r\nimport { PropertyChangeResult, PropertyChangeStatus, UiDataProvider } from \"./UiDataProvider\";\r\n\r\n/** Enum for button types. Determines button label, and default button style.\r\n * @public\r\n */\r\nexport enum DialogButtonType {\r\n  None = \"\",\r\n  Close = \"close\",\r\n  OK = \"ok\",\r\n  Cancel = \"cancel\",\r\n  Yes = \"yes\",\r\n  No = \"no\",\r\n  Retry = \"retry\",\r\n  Next = \"next\",\r\n  Previous = \"previous\"\r\n}\r\n\r\n/** Enum for button style.\r\n * @public\r\n */\r\nexport enum DialogButtonStyle {\r\n  None = \"\",\r\n  Primary = \"iui-cta\",\r\n  Hollow = \"iui-default\",\r\n  Blue = \"iui-high-visibility\",\r\n}\r\n\r\n/** Interface for a dialog button in a button cluster\r\n * @public\r\n */\r\nexport interface DialogButtonDef {\r\n  /** type of button */\r\n  type: DialogButtonType;\r\n  /** Triggered on button click */\r\n  onClick: () => void;\r\n  /** Which button style to decorate button width */\r\n  buttonStyle?: DialogButtonStyle;\r\n  /** Disable the button */\r\n  disabled?: boolean;\r\n  /** Custom label */\r\n  label?: string;\r\n  /** Custom CSS class */\r\n  className?: string;\r\n}\r\n\r\n/** [[DialogRow]] is the interface that groups dialog items into rows for building UI\r\n * @public\r\n */\r\nexport interface DialogRow {\r\n  priority: number;\r\n  items: DialogItem[];\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport abstract class UiLayoutDataProvider extends UiDataProvider {\r\n  private _items: ReadonlyArray<DialogItem> | undefined;\r\n\r\n  /** Applies changes from one or more properties - some dialogs will use this to send a bulk set of changes back to the provider */\r\n  public override processChangesInUi(properties: DialogPropertyItem[]): PropertyChangeResult {\r\n    // Default implementation is to just pass each property to applyUiPropertyChange\r\n    properties.forEach((property) => this.applyUiPropertyChange(property));\r\n    return { status: PropertyChangeStatus.Success };\r\n  }\r\n\r\n  /** Applies change of a single property - this is the default method used when property editors are dynamically generated. */\r\n  // istanbul ignore next\r\n  public applyUiPropertyChange = (_updatedValue: DialogPropertySyncItem): void => {\r\n    throw (new Error(\"Derived UiDataProvider should implement this to apply change to a single property.\"));\r\n  };\r\n\r\n  private _rows: DialogRow[] | undefined;\r\n\r\n  /** Array of dialog rows */\r\n  public get rows(): DialogRow[] {\r\n    if (!this._rows) {\r\n      this._rows = this.layoutDialogRows();\r\n    }\r\n    return this._rows;\r\n  }\r\n\r\n  protected loadItemsInternal(items: ReadonlyArray<DialogItem> | undefined) {\r\n    this._items = items ? items : [];\r\n    this._rows = this.layoutDialogRows();\r\n  }\r\n\r\n  /** Called by UI to request available properties that can be bound to user supplied UI components (See Tool1UiProvider for example). */\r\n  // istanbul ignore next\r\n  public supplyDialogItems(): DialogItem[] | undefined {\r\n    throw (new Error(\"Derived UiDataProvider must implement this method to supply set of properties.\"));\r\n  }\r\n\r\n  public get items(): ReadonlyArray<DialogItem> {\r\n    if (undefined === this._items) {\r\n      this.loadItemsInternal(this.supplyDialogItems());\r\n    }\r\n    return this._items!;\r\n  }\r\n\r\n  /** Called to inform listeners that new properties are ready for display in UI. */\r\n  public reloadDialogItems(emitEvent = true) {\r\n    this.loadItemsInternal(this.supplyDialogItems());\r\n    // istanbul ignore else\r\n    if (emitEvent)\r\n      this.fireItemsReloadedEvent();\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public layoutDialogRows(): DialogRow[] {\r\n    const rows: DialogRow[] = [];\r\n\r\n    this.items.forEach((item) => {\r\n      const row = rows.find((value) => value.priority === item.editorPosition.rowPriority);\r\n      if (row) {\r\n        row.items.push(item);\r\n      } else {\r\n        rows.push({ priority: item.editorPosition.rowPriority, items: [item] });\r\n      }\r\n    });\r\n\r\n    // sort rows\r\n    rows.sort((a: DialogRow, b: DialogRow) => a.priority - b.priority);\r\n    // sort records\r\n    rows.forEach((row: DialogRow) => row.items.sort((a: DialogItem, b: DialogItem) => a.editorPosition.columnIndex - b.editorPosition.columnIndex));\r\n    return rows;\r\n  }\r\n\r\n  /** Determines if a dialog item editor wants a label */\r\n  public static editorWantsLabel(item: DialogItem): boolean {\r\n    if (item.property.editor && item.property.editor.params) {\r\n      const params = item.property.editor.params.find((param: PropertyEditorParams) => param.type === PropertyEditorParamTypes.SuppressEditorLabel) as SuppressLabelEditorParams;\r\n      // istanbul ignore else\r\n      if (params)\r\n        return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Determines if a dialog items has an associated lock property */\r\n  public static hasAssociatedLockProperty(item: DialogItem): boolean {\r\n    return !!item.lockProperty;\r\n  }\r\n\r\n  /** Gets the disabled state for a given dialog item */\r\n  public static getItemDisabledState(baseDialogItem: BaseDialogItem): boolean {\r\n    const dialogItem = baseDialogItem as DialogItem;\r\n    // istanbul ignore else\r\n    if (dialogItem === undefined || dialogItem.lockProperty === undefined)\r\n      return !!baseDialogItem.isDisabled;\r\n    const value = dialogItem.lockProperty.value;\r\n    // istanbul ignore next\r\n    if (value === undefined)\r\n      return !!baseDialogItem.isDisabled;\r\n\r\n    return !value.value;\r\n  }\r\n\r\n  /** Gets a property record for a given dialog item */\r\n  public static getPropertyRecord = (dialogItem: BaseDialogItem): PropertyRecord => {\r\n    const propertyValue = { valueFormat: PropertyValueFormat.Primitive, value: dialogItem.value.value, displayValue: dialogItem.value.displayValue };\r\n    const record = new PropertyRecord(propertyValue as PrimitiveValue, dialogItem.property);\r\n    record.isDisabled = UiLayoutDataProvider.getItemDisabledState(dialogItem);\r\n    return record;\r\n  };\r\n\r\n  /** Determines if a dialog row only contains button group editors */\r\n  public static onlyContainButtonGroupEditors(row: DialogRow): boolean {\r\n    for (const item of row.items) {\r\n      // istanbul ignore else\r\n      if (UiLayoutDataProvider.hasAssociatedLockProperty(item) || undefined === item.property.editor || \"enum-buttongroup\" !== item.property.editor.name || UiLayoutDataProvider.editorWantsLabel(item))\r\n        return false;\r\n    }\r\n    return true;\r\n  }\r\n}\r\n\r\n/** [[DialogLayoutDataProvider]] Abstract class that allows property values to be passed between hosting API and Dialog that generates and arranges components dynamically\r\n * including the buttons at the bottom of the dialog.\r\n * @public\r\n */\r\nexport abstract class DialogLayoutDataProvider extends UiLayoutDataProvider {\r\n  public onButtonsReloadedEvent = new BeUiEvent<void>();\r\n\r\n  /** Called to inform listeners that modal dialog button data needs to be refreshed. */\r\n  public fireDialogButtonsReloadEvent() {\r\n    this.onButtonsReloadedEvent.emit();\r\n  }\r\n\r\n  public supplyButtonData(): DialogButtonDef[] | undefined {\r\n    // Derived class should override\r\n    const buttons: DialogButtonDef[] = [];\r\n    // istanbul ignore next\r\n    buttons.push({ type: DialogButtonType.OK, onClick: () => { } });\r\n    // istanbul ignore next\r\n    buttons.push({ type: DialogButtonType.Cancel, onClick: () => { } });\r\n    return buttons;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConditionalBooleanValue.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ConditionalBooleanValue.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAGlC;;;;;OAKG;IACH,YAA4B,QAAuB,EAAkB,YAAsB,EAAE,KAAe;QAAhF,aAAQ,GAAR,QAAQ,CAAe;QAAkB,iBAAY,GAAZ,YAAY,CAAU;QACzF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,oDAAoD;IACpD,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,IAAI,CAAC,MAAM,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,yDAAyD;IAClD,OAAO;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,IAAI,QAAQ,KAAK,IAAI,CAAC,MAAM,EAAE;YAC5B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0GAA0G;IACnG,MAAM,CAAC,YAAY,CAAC,gBAA+D,EAAE,QAAqB;QAC/G,IAAI,SAAS,KAAK,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,YAAY,uBAAuB,CAAC;YAC1F,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACnG,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,QAAQ,CAAC,gBAA+D;QACpF,IAAI,SAAS,KAAK,gBAAgB;YAChC,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,YAAY,uBAAuB;YACrD,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAEhC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\n/** Class used to return a boolean value. The boolean value is refreshed by using the specified function. The syncEventIds define one or more\r\n * eventIds that would require the testFunc to be rerun.\r\n * @public\r\n */\r\nexport class ConditionalBooleanValue {\r\n  private _value?: boolean;\r\n\r\n  /**\r\n   * Constructor for ConditionalBooleanValue. It is important that the same ConditionalBooleanValue instance is not used by multiple UI item definitions in order that the control's state is always rendered correctly.\r\n   * @param testFunc Function to run to retrieve the value for the conditional. This function is run when refresh method is called or if the value is not defined in the constructor.\r\n   * @param syncEventIds An array of eventId that should be monitored to determine when to run the refresh method.\r\n   * @param value The default value for the conditional value. If not specified then the function is run to set the value when the value is retrieved.\r\n   */\r\n  constructor(public readonly testFunc: () => boolean, public readonly syncEventIds: string[], value?: boolean) {\r\n    this._value = value;\r\n  }\r\n\r\n  /** The current boolean value of the conditional. */\r\n  public get value(): boolean {\r\n    if (undefined !== this._value)\r\n      return this._value;\r\n\r\n    this._value = this.testFunc();\r\n    return this._value;\r\n  }\r\n\r\n  /** Called to update the value by running the testFunc */\r\n  public refresh(): boolean {\r\n    const newValue = this.testFunc();\r\n    if (newValue !== this._value) {\r\n      this._value = newValue;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** helper function to process properties defined as type ConditionalBooleanValue | boolean | undefined */\r\n  public static refreshValue(conditionalValue: ConditionalBooleanValue | boolean | undefined, eventIds: Set<string>): boolean {\r\n    if (undefined === conditionalValue || !(conditionalValue instanceof ConditionalBooleanValue))\r\n      return false;\r\n\r\n    if (conditionalValue.syncEventIds.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return conditionalValue.refresh();\r\n\r\n    return false;\r\n  }\r\n\r\n  /** helper function to get boolean from a ConditionalBooleanValue | boolean | undefined */\r\n  public static getValue(conditionalValue: ConditionalBooleanValue | boolean | undefined): boolean {\r\n    if (undefined === conditionalValue)\r\n      return false;\r\n\r\n    if (conditionalValue instanceof ConditionalBooleanValue)\r\n      return conditionalValue.value;\r\n\r\n    return conditionalValue;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ConditionalBooleanValue.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ConditionalBooleanValue.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAGlC;;;;;OAKG;IACH,YAA4B,QAAuB,EAAkB,YAAsB,EAAE,KAAe;QAAhF,aAAQ,GAAR,QAAQ,CAAe;QAAkB,iBAAY,GAAZ,YAAY,CAAU;QACzF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,oDAAoD;IACpD,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,IAAI,CAAC,MAAM,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,yDAAyD;IAClD,OAAO;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,IAAI,QAAQ,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0GAA0G;IACnG,MAAM,CAAC,YAAY,CAAC,gBAA+D,EAAE,QAAqB;QAC/G,IAAI,SAAS,KAAK,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,YAAY,uBAAuB,CAAC;YAC1F,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACnG,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,QAAQ,CAAC,gBAA+D;QACpF,IAAI,SAAS,KAAK,gBAAgB;YAChC,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,YAAY,uBAAuB;YACrD,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAEhC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\n/** Class used to return a boolean value. The boolean value is refreshed by using the specified function. The syncEventIds define one or more\r\n * eventIds that would require the testFunc to be rerun.\r\n * @public\r\n */\r\nexport class ConditionalBooleanValue {\r\n  private _value?: boolean;\r\n\r\n  /**\r\n   * Constructor for ConditionalBooleanValue. It is important that the same ConditionalBooleanValue instance is not used by multiple UI item definitions in order that the control's state is always rendered correctly.\r\n   * @param testFunc Function to run to retrieve the value for the conditional. This function is run when refresh method is called or if the value is not defined in the constructor.\r\n   * @param syncEventIds An array of eventId that should be monitored to determine when to run the refresh method.\r\n   * @param value The default value for the conditional value. If not specified then the function is run to set the value when the value is retrieved.\r\n   */\r\n  constructor(public readonly testFunc: () => boolean, public readonly syncEventIds: string[], value?: boolean) {\r\n    this._value = value;\r\n  }\r\n\r\n  /** The current boolean value of the conditional. */\r\n  public get value(): boolean {\r\n    if (undefined !== this._value)\r\n      return this._value;\r\n\r\n    this._value = this.testFunc();\r\n    return this._value;\r\n  }\r\n\r\n  /** Called to update the value by running the testFunc */\r\n  public refresh(): boolean {\r\n    const newValue = this.testFunc();\r\n    if (newValue !== this._value) {\r\n      this._value = newValue;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** helper function to process properties defined as type ConditionalBooleanValue | boolean | undefined */\r\n  public static refreshValue(conditionalValue: ConditionalBooleanValue | boolean | undefined, eventIds: Set<string>): boolean {\r\n    if (undefined === conditionalValue || !(conditionalValue instanceof ConditionalBooleanValue))\r\n      return false;\r\n\r\n    if (conditionalValue.syncEventIds.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return conditionalValue.refresh();\r\n\r\n    return false;\r\n  }\r\n\r\n  /** helper function to get boolean from a ConditionalBooleanValue | boolean | undefined */\r\n  public static getValue(conditionalValue: ConditionalBooleanValue | boolean | undefined): boolean {\r\n    if (undefined === conditionalValue)\r\n      return false;\r\n\r\n    if (conditionalValue instanceof ConditionalBooleanValue)\r\n      return conditionalValue.value;\r\n\r\n    return conditionalValue;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConditionalStringValue.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ConditionalStringValue.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,sBAAsB;IAGjC;;;;;OAKG;IACH,YAA4B,YAA0B,EAAkB,YAAsB,EAAE,KAAc;QAAlF,iBAAY,GAAZ,YAAY,CAAc;QAAkB,iBAAY,GAAZ,YAAY,CAAU;QAC5F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,oDAAoD;IACpD,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,IAAI,CAAC,MAAM,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,6DAA6D;IACtD,OAAO;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACrC,IAAI,QAAQ,KAAK,IAAI,CAAC,MAAM,EAAE;YAC5B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,gBAA6D,EAAE,QAAqB;QAC7G,IAAI,SAAS,KAAK,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,YAAY,sBAAsB,CAAC;YACzF,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACnG,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,MAAM,CAAC,QAAQ,CAAC,gBAA6D;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,OAAO,SAAS,CAAC;QAEnB,IAAI,gBAAgB,YAAY,sBAAsB;YACpD,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAEhC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\n/** Class used to return a string value. The string value is refreshed by using the specified function. The syncEventIds define one or more\r\n * eventIds that would require the stringGetter function to be rerun.\r\n * @public\r\n */\r\nexport class ConditionalStringValue {\r\n  private _value?: string;\r\n\r\n  /**\r\n   * Constructor for ConditionalStringValue. It is important that the same ConditionalStringValue instance is not used by multiple UI item definitions in order that the control's state is always rendered correctly.\r\n   * @param stringGetter Function to run to retrieve the value for the conditional. This function is run when refresh method is called or if the value is not defined in the constructor.\r\n   * @param syncEventIds An array of eventId that should be monitored to determine when to run the refresh method.\r\n   * @param value The default value for the conditional value. If not specified then the function is run to set the value when the value is retrieved.\r\n   */\r\n  constructor(public readonly stringGetter: () => string, public readonly syncEventIds: string[], value?: string) {\r\n    this._value = value;\r\n  }\r\n\r\n  /** The current boolean value of the conditional. */\r\n  public get value(): string {\r\n    if (undefined !== this._value)\r\n      return this._value;\r\n\r\n    this._value = this.stringGetter();\r\n    return this._value;\r\n  }\r\n\r\n  /** Called to update the value by running the stringGetter */\r\n  public refresh(): boolean {\r\n    const newValue = this.stringGetter();\r\n    if (newValue !== this._value) {\r\n      this._value = newValue;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** helper function to process properties defined as type ConditionalStringValue | string | undefined\r\n   * Return true if the value was updated.\r\n   */\r\n  public static refreshValue(conditionalValue: ConditionalStringValue | string | undefined, eventIds: Set<string>): boolean {\r\n    if (undefined === conditionalValue || !(conditionalValue instanceof ConditionalStringValue))\r\n      return false;\r\n\r\n    if (conditionalValue.syncEventIds.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return conditionalValue.refresh();\r\n\r\n    return false;\r\n  }\r\n\r\n  /** helper function to get string from a ConditionalStringValue | string | undefined */\r\n  public static getValue(conditionalValue: ConditionalStringValue | string | undefined): string | undefined {\r\n    if (undefined === conditionalValue)\r\n      return undefined;\r\n\r\n    if (conditionalValue instanceof ConditionalStringValue)\r\n      return conditionalValue.value;\r\n\r\n    return conditionalValue;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ConditionalStringValue.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ConditionalStringValue.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,sBAAsB;IAGjC;;;;;OAKG;IACH,YAA4B,YAA0B,EAAkB,YAAsB,EAAE,KAAc;QAAlF,iBAAY,GAAZ,YAAY,CAAc;QAAkB,iBAAY,GAAZ,YAAY,CAAU;QAC5F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,oDAAoD;IACpD,IAAW,KAAK;QACd,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,IAAI,CAAC,MAAM,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,6DAA6D;IACtD,OAAO;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACrC,IAAI,QAAQ,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,gBAA6D,EAAE,QAAqB;QAC7G,IAAI,SAAS,KAAK,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,YAAY,sBAAsB,CAAC;YACzF,OAAO,KAAK,CAAC;QAEf,IAAI,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACnG,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,MAAM,CAAC,QAAQ,CAAC,gBAA6D;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,OAAO,SAAS,CAAC;QAEnB,IAAI,gBAAgB,YAAY,sBAAsB;YACpD,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAEhC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\n/** Class used to return a string value. The string value is refreshed by using the specified function. The syncEventIds define one or more\r\n * eventIds that would require the stringGetter function to be rerun.\r\n * @public\r\n */\r\nexport class ConditionalStringValue {\r\n  private _value?: string;\r\n\r\n  /**\r\n   * Constructor for ConditionalStringValue. It is important that the same ConditionalStringValue instance is not used by multiple UI item definitions in order that the control's state is always rendered correctly.\r\n   * @param stringGetter Function to run to retrieve the value for the conditional. This function is run when refresh method is called or if the value is not defined in the constructor.\r\n   * @param syncEventIds An array of eventId that should be monitored to determine when to run the refresh method.\r\n   * @param value The default value for the conditional value. If not specified then the function is run to set the value when the value is retrieved.\r\n   */\r\n  constructor(public readonly stringGetter: () => string, public readonly syncEventIds: string[], value?: string) {\r\n    this._value = value;\r\n  }\r\n\r\n  /** The current boolean value of the conditional. */\r\n  public get value(): string {\r\n    if (undefined !== this._value)\r\n      return this._value;\r\n\r\n    this._value = this.stringGetter();\r\n    return this._value;\r\n  }\r\n\r\n  /** Called to update the value by running the stringGetter */\r\n  public refresh(): boolean {\r\n    const newValue = this.stringGetter();\r\n    if (newValue !== this._value) {\r\n      this._value = newValue;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** helper function to process properties defined as type ConditionalStringValue | string | undefined\r\n   * Return true if the value was updated.\r\n   */\r\n  public static refreshValue(conditionalValue: ConditionalStringValue | string | undefined, eventIds: Set<string>): boolean {\r\n    if (undefined === conditionalValue || !(conditionalValue instanceof ConditionalStringValue))\r\n      return false;\r\n\r\n    if (conditionalValue.syncEventIds.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return conditionalValue.refresh();\r\n\r\n    return false;\r\n  }\r\n\r\n  /** helper function to get string from a ConditionalStringValue | string | undefined */\r\n  public static getValue(conditionalValue: ConditionalStringValue | string | undefined): string | undefined {\r\n    if (undefined === conditionalValue)\r\n      return undefined;\r\n\r\n    if (conditionalValue instanceof ConditionalStringValue)\r\n      return conditionalValue.value;\r\n\r\n    return conditionalValue;\r\n  }\r\n}\r\n"]}