@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/appui-abstract/dialogs/DialogItem.js

@@ -1,68 +1,68 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Dialog
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DialogProperty = void 0;
-/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).
- * @public
- */
-class DialogProperty {
-    constructor(description, _value, _displayValue, _isDisabled) {
-        this.description = description;
-        this._value = _value;
-        this._displayValue = _displayValue;
-        this._isDisabled = _isDisabled;
-    }
-    get isDisabled() {
-        return !!this._isDisabled;
-    }
-    set isDisabled(val) {
-        this._isDisabled = val;
-    }
-    get value() {
-        return this._value;
-    }
-    set value(val) {
-        this._value = val;
-    }
-    get name() {
-        return this.description.name;
-    }
-    set displayValue(val) {
-        this._displayValue = val;
-    }
-    get displayValue() {
-        return this._displayValue;
-    }
-    get dialogItemValue() {
-        // istanbul ignore else
-        if (typeof this._value === "string" || typeof this._value === "number" || typeof this._value === "undefined" || typeof this._value === "boolean" || this._value instanceof Date)
-            return {
-                value: this._value,
-                displayValue: this._displayValue,
-            };
-        // istanbul ignore next
-        throw new Error("Not valid primitive type");
-    }
-    set dialogItemValue(val) {
-        this._value = val.value;
-        this._displayValue = val.displayValue;
-    }
-    get syncItem() {
-        const isDisabled = this._isDisabled;
-        return { propertyName: this.name, value: this.dialogItemValue, isDisabled };
-    }
-    get item() {
-        return { propertyName: this.name, value: this.dialogItemValue };
-    }
-    toDialogItem(editorPosition, lockProperty) {
-        return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };
-    }
-}
-exports.DialogProperty = DialogProperty;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Dialog
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DialogProperty = void 0;
+/** [[DialogProperty]] is a generic helper class that assists working with properties used by UiLayoutDataProvider implementations (i.e. Tool Settings and Dynamic Dialogs).
+ * @public
+ */
+class DialogProperty {
+    constructor(description, _value, _displayValue, _isDisabled) {
+        this.description = description;
+        this._value = _value;
+        this._displayValue = _displayValue;
+        this._isDisabled = _isDisabled;
+    }
+    get isDisabled() {
+        return !!this._isDisabled;
+    }
+    set isDisabled(val) {
+        this._isDisabled = val;
+    }
+    get value() {
+        return this._value;
+    }
+    set value(val) {
+        this._value = val;
+    }
+    get name() {
+        return this.description.name;
+    }
+    set displayValue(val) {
+        this._displayValue = val;
+    }
+    get displayValue() {
+        return this._displayValue;
+    }
+    get dialogItemValue() {
+        // istanbul ignore else
+        if (typeof this._value === "string" || typeof this._value === "number" || typeof this._value === "undefined" || typeof this._value === "boolean" || this._value instanceof Date)
+            return {
+                value: this._value,
+                displayValue: this._displayValue,
+            };
+        // istanbul ignore next
+        throw new Error("Not valid primitive type");
+    }
+    set dialogItemValue(val) {
+        this._value = val.value;
+        this._displayValue = val.displayValue;
+    }
+    get syncItem() {
+        const isDisabled = this._isDisabled;
+        return { propertyName: this.name, value: this.dialogItemValue, isDisabled };
+    }
+    get item() {
+        return { propertyName: this.name, value: this.dialogItemValue };
+    }
+    toDialogItem(editorPosition, lockProperty) {
+        return { value: this.dialogItemValue, property: this.description, editorPosition, isDisabled: this._isDisabled, lockProperty };
+    }
+}
+exports.DialogProperty = DialogProperty;
 //# sourceMappingURL=DialogItem.js.map

package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Dialog
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-import { DialogPropertyItem, DialogPropertySyncItem } from "./DialogItem";
-/** Sync UI Control Properties Event class.
- * @public
- */
-export declare class SyncPropertiesChangeEvent extends BeUiEvent<SyncPropertiesChangeEventArgs> {
-}
-/** [[UiDataProvider]] Abstract class that allows property values to be passed between hosting API and UI.
- * @public
- */
-export declare abstract class UiDataProvider {
-    /** Called by UI to inform data provider of changes. */
-    processChangesInUi(_properties: DialogPropertyItem[]): PropertyChangeResult;
-    /** Get Sync UI Control Properties Event */
-    onSyncPropertiesChangeEvent: SyncPropertiesChangeEvent;
-    onItemsReloadedEvent: BeUiEvent<void>;
-    /** Called by UI to validate a property value */
-    validateProperty(_item: DialogPropertyItem): PropertyChangeResult;
-    /** Called to sync properties synchronously if a UiDataProvider is active for the UI */
-    syncProperties(syncProperties: DialogPropertySyncItem[]): void;
-    /** Called to inform listener that the UiDataProvider has updated values for the UI */
-    fireSyncPropertiesEvent(syncProperties: DialogPropertySyncItem[]): void;
-    /** Called to inform listeners that new properties are ready for display in UI.
-     */
-    fireItemsReloadedEvent(): void;
-    /** Used to pass properties between a tool and an explicity defined UI dialog. See method supplyDialogItems in [[UiLayoutDataProvider]] for supplying
-     * properties that will be used to dynamically create and layout control in a Dialog or Widget.
-     */
-    supplyAvailableProperties(): DialogPropertyItem[];
-}
-/** Sync UI Control Properties Event Args interface.
- * @public
- */
-export interface SyncPropertiesChangeEventArgs {
-    properties: DialogPropertySyncItem[];
-}
-/** Status of Proposed property changes from UI to UiDataProvider
- * @public
- */
-export declare enum PropertyChangeStatus {
-    /** Property Change(s) Succeeded */
-    Success = 0,
-    /** Error Processing Property Change(s) */
-    Error = 2
-}
-/** Interface used by UiDataProvider to report change status (validation) to UI.
- * @public
- */
-export interface PropertyChangeResult {
-    errorMsg?: string;
-    status: PropertyChangeStatus;
-}
+/** @packageDocumentation
+ * @module Dialog
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { DialogPropertyItem, DialogPropertySyncItem } from "./DialogItem";
+/** Sync UI Control Properties Event class.
+ * @public
+ */
+export declare class SyncPropertiesChangeEvent extends BeUiEvent<SyncPropertiesChangeEventArgs> {
+}
+/** [[UiDataProvider]] Abstract class that allows property values to be passed between hosting API and UI.
+ * @public
+ */
+export declare abstract class UiDataProvider {
+    /** Called by UI to inform data provider of changes. */
+    processChangesInUi(_properties: DialogPropertyItem[]): PropertyChangeResult;
+    /** Get Sync UI Control Properties Event */
+    onSyncPropertiesChangeEvent: SyncPropertiesChangeEvent;
+    onItemsReloadedEvent: BeUiEvent<void>;
+    /** Called by UI to validate a property value */
+    validateProperty(_item: DialogPropertyItem): PropertyChangeResult;
+    /** Called to sync properties synchronously if a UiDataProvider is active for the UI */
+    syncProperties(syncProperties: DialogPropertySyncItem[]): void;
+    /** Called to inform listener that the UiDataProvider has updated values for the UI */
+    fireSyncPropertiesEvent(syncProperties: DialogPropertySyncItem[]): void;
+    /** Called to inform listeners that new properties are ready for display in UI.
+     */
+    fireItemsReloadedEvent(): void;
+    /** Used to pass properties between a tool and an explicity defined UI dialog. See method supplyDialogItems in [[UiLayoutDataProvider]] for supplying
+     * properties that will be used to dynamically create and layout control in a Dialog or Widget.
+     */
+    supplyAvailableProperties(): DialogPropertyItem[];
+}
+/** Sync UI Control Properties Event Args interface.
+ * @public
+ */
+export interface SyncPropertiesChangeEventArgs {
+    properties: DialogPropertySyncItem[];
+}
+/** Status of Proposed property changes from UI to UiDataProvider
+ * @public
+ */
+export declare enum PropertyChangeStatus {
+    /** Property Change(s) Succeeded */
+    Success = 0,
+    /** Error Processing Property Change(s) */
+    Error = 2
+}
+/** Interface used by UiDataProvider to report change status (validation) to UI.
+ * @public
+ */
+export interface PropertyChangeResult {
+    errorMsg?: string;
+    status: PropertyChangeStatus;
+}
 //# sourceMappingURL=UiDataProvider.d.ts.map

package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js

@@ -1,67 +1,67 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Dialog
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyChangeStatus = exports.UiDataProvider = exports.SyncPropertiesChangeEvent = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/** Sync UI Control Properties Event class.
- * @public
- */
-class SyncPropertiesChangeEvent extends core_bentley_1.BeUiEvent {
-}
-exports.SyncPropertiesChangeEvent = SyncPropertiesChangeEvent;
-/** [[UiDataProvider]] Abstract class that allows property values to be passed between hosting API and UI.
- * @public
- */
-// istanbul ignore next
-class UiDataProvider {
-    constructor() {
-        /** Get Sync UI Control Properties Event */
-        this.onSyncPropertiesChangeEvent = new SyncPropertiesChangeEvent();
-        this.onItemsReloadedEvent = new core_bentley_1.BeUiEvent();
-    }
-    /** Called by UI to inform data provider of changes. */
-    processChangesInUi(_properties) {
-        throw (new Error("Derived UiDataProvider must implement this method to apply changes to a bulk set of properties."));
-    }
-    /** Called by UI to validate a property value */
-    validateProperty(_item) {
-        return { status: PropertyChangeStatus.Success };
-    }
-    /** Called to sync properties synchronously if a UiDataProvider is active for the UI */
-    syncProperties(syncProperties) {
-        this.fireSyncPropertiesEvent(syncProperties);
-    }
-    /** Called to inform listener that the UiDataProvider has updated values for the UI */
-    fireSyncPropertiesEvent(syncProperties) {
-        this.onSyncPropertiesChangeEvent.emit({ properties: syncProperties });
-    }
-    /** Called to inform listeners that new properties are ready for display in UI.
-     */
-    fireItemsReloadedEvent() {
-        this.onItemsReloadedEvent.emit();
-    }
-    /** Used to pass properties between a tool and an explicity defined UI dialog. See method supplyDialogItems in [[UiLayoutDataProvider]] for supplying
-     * properties that will be used to dynamically create and layout control in a Dialog or Widget.
-     */
-    supplyAvailableProperties() {
-        throw (new Error("Derived UiDataProvider that want to use DialogPropertyItems must implement this method. Not for use with dynamic UI controls."));
-    }
-}
-exports.UiDataProvider = UiDataProvider;
-/** Status of Proposed property changes from UI to UiDataProvider
- * @public
- */
-var PropertyChangeStatus;
-(function (PropertyChangeStatus) {
-    /** Property Change(s) Succeeded */
-    PropertyChangeStatus[PropertyChangeStatus["Success"] = 0] = "Success";
-    /** Error Processing Property Change(s) */
-    PropertyChangeStatus[PropertyChangeStatus["Error"] = 2] = "Error";
-})(PropertyChangeStatus = exports.PropertyChangeStatus || (exports.PropertyChangeStatus = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Dialog
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyChangeStatus = exports.UiDataProvider = exports.SyncPropertiesChangeEvent = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/** Sync UI Control Properties Event class.
+ * @public
+ */
+class SyncPropertiesChangeEvent extends core_bentley_1.BeUiEvent {
+}
+exports.SyncPropertiesChangeEvent = SyncPropertiesChangeEvent;
+/** [[UiDataProvider]] Abstract class that allows property values to be passed between hosting API and UI.
+ * @public
+ */
+// istanbul ignore next
+class UiDataProvider {
+    constructor() {
+        /** Get Sync UI Control Properties Event */
+        this.onSyncPropertiesChangeEvent = new SyncPropertiesChangeEvent();
+        this.onItemsReloadedEvent = new core_bentley_1.BeUiEvent();
+    }
+    /** Called by UI to inform data provider of changes. */
+    processChangesInUi(_properties) {
+        throw (new Error("Derived UiDataProvider must implement this method to apply changes to a bulk set of properties."));
+    }
+    /** Called by UI to validate a property value */
+    validateProperty(_item) {
+        return { status: PropertyChangeStatus.Success };
+    }
+    /** Called to sync properties synchronously if a UiDataProvider is active for the UI */
+    syncProperties(syncProperties) {
+        this.fireSyncPropertiesEvent(syncProperties);
+    }
+    /** Called to inform listener that the UiDataProvider has updated values for the UI */
+    fireSyncPropertiesEvent(syncProperties) {
+        this.onSyncPropertiesChangeEvent.emit({ properties: syncProperties });
+    }
+    /** Called to inform listeners that new properties are ready for display in UI.
+     */
+    fireItemsReloadedEvent() {
+        this.onItemsReloadedEvent.emit();
+    }
+    /** Used to pass properties between a tool and an explicity defined UI dialog. See method supplyDialogItems in [[UiLayoutDataProvider]] for supplying
+     * properties that will be used to dynamically create and layout control in a Dialog or Widget.
+     */
+    supplyAvailableProperties() {
+        throw (new Error("Derived UiDataProvider that want to use DialogPropertyItems must implement this method. Not for use with dynamic UI controls."));
+    }
+}
+exports.UiDataProvider = UiDataProvider;
+/** Status of Proposed property changes from UI to UiDataProvider
+ * @public
+ */
+var PropertyChangeStatus;
+(function (PropertyChangeStatus) {
+    /** Property Change(s) Succeeded */
+    PropertyChangeStatus[PropertyChangeStatus["Success"] = 0] = "Success";
+    /** Error Processing Property Change(s) */
+    PropertyChangeStatus[PropertyChangeStatus["Error"] = 2] = "Error";
+})(PropertyChangeStatus = exports.PropertyChangeStatus || (exports.PropertyChangeStatus = {}));
 //# sourceMappingURL=UiDataProvider.js.map

package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts

@@ -1,98 +1,98 @@
-/** @packageDocumentation
- * @module Dialog
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-import { PropertyRecord } from "../properties/Record";
-import { BaseDialogItem, DialogItem, DialogPropertyItem, DialogPropertySyncItem } from "./DialogItem";
-import { PropertyChangeResult, UiDataProvider } from "./UiDataProvider";
-/** Enum for button types. Determines button label, and default button style.
- * @public
- */
-export declare enum DialogButtonType {
-    None = "",
-    Close = "close",
-    OK = "ok",
-    Cancel = "cancel",
-    Yes = "yes",
-    No = "no",
-    Retry = "retry",
-    Next = "next",
-    Previous = "previous"
-}
-/** Enum for button style.
- * @public
- */
-export declare enum DialogButtonStyle {
-    None = "",
-    Primary = "iui-cta",
-    Hollow = "iui-default",
-    Blue = "iui-high-visibility"
-}
-/** Interface for a dialog button in a button cluster
- * @public
- */
-export interface DialogButtonDef {
-    /** type of button */
-    type: DialogButtonType;
-    /** Triggered on button click */
-    onClick: () => void;
-    /** Which button style to decorate button width */
-    buttonStyle?: DialogButtonStyle;
-    /** Disable the button */
-    disabled?: boolean;
-    /** Custom label */
-    label?: string;
-    /** Custom CSS class */
-    className?: string;
-}
-/** [[DialogRow]] is the interface that groups dialog items into rows for building UI
- * @public
- */
-export interface DialogRow {
-    priority: number;
-    items: DialogItem[];
-}
-/**
- * @public
- */
-export declare abstract class UiLayoutDataProvider extends UiDataProvider {
-    private _items;
-    /** Applies changes from one or more properties - some dialogs will use this to send a bulk set of changes back to the provider */
-    processChangesInUi(properties: DialogPropertyItem[]): PropertyChangeResult;
-    /** Applies change of a single property - this is the default method used when property editors are dynamically generated. */
-    applyUiPropertyChange: (_updatedValue: DialogPropertySyncItem) => void;
-    private _rows;
-    /** Array of dialog rows */
-    get rows(): DialogRow[];
-    protected loadItemsInternal(items: ReadonlyArray<DialogItem> | undefined): void;
-    /** Called by UI to request available properties that can be bound to user supplied UI components (See Tool1UiProvider for example). */
-    supplyDialogItems(): DialogItem[] | undefined;
-    get items(): ReadonlyArray<DialogItem>;
-    /** Called to inform listeners that new properties are ready for display in UI. */
-    reloadDialogItems(emitEvent?: boolean): void;
-    /**
-     * @internal
-     */
-    layoutDialogRows(): DialogRow[];
-    /** Determines if a dialog item editor wants a label */
-    static editorWantsLabel(item: DialogItem): boolean;
-    /** Determines if a dialog items has an associated lock property */
-    static hasAssociatedLockProperty(item: DialogItem): boolean;
-    /** Gets the disabled state for a given dialog item */
-    static getItemDisabledState(baseDialogItem: BaseDialogItem): boolean;
-    /** Gets a property record for a given dialog item */
-    static getPropertyRecord: (dialogItem: BaseDialogItem) => PropertyRecord;
-    /** Determines if a dialog row only contains button group editors */
-    static onlyContainButtonGroupEditors(row: DialogRow): boolean;
-}
-/** [[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
- */
-export declare abstract class DialogLayoutDataProvider extends UiLayoutDataProvider {
-    onButtonsReloadedEvent: BeUiEvent<void>;
-    /** Called to inform listeners that modal dialog button data needs to be refreshed. */
-    fireDialogButtonsReloadEvent(): void;
-    supplyButtonData(): DialogButtonDef[] | undefined;
-}
+/** @packageDocumentation
+ * @module Dialog
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { PropertyRecord } from "../properties/Record";
+import { BaseDialogItem, DialogItem, DialogPropertyItem, DialogPropertySyncItem } from "./DialogItem";
+import { PropertyChangeResult, UiDataProvider } from "./UiDataProvider";
+/** Enum for button types. Determines button label, and default button style.
+ * @public
+ */
+export declare enum DialogButtonType {
+    None = "",
+    Close = "close",
+    OK = "ok",
+    Cancel = "cancel",
+    Yes = "yes",
+    No = "no",
+    Retry = "retry",
+    Next = "next",
+    Previous = "previous"
+}
+/** Enum for button style.
+ * @public
+ */
+export declare enum DialogButtonStyle {
+    None = "",
+    Primary = "iui-cta",
+    Hollow = "iui-default",
+    Blue = "iui-high-visibility"
+}
+/** Interface for a dialog button in a button cluster
+ * @public
+ */
+export interface DialogButtonDef {
+    /** type of button */
+    type: DialogButtonType;
+    /** Triggered on button click */
+    onClick: () => void;
+    /** Which button style to decorate button width */
+    buttonStyle?: DialogButtonStyle;
+    /** Disable the button */
+    disabled?: boolean;
+    /** Custom label */
+    label?: string;
+    /** Custom CSS class */
+    className?: string;
+}
+/** [[DialogRow]] is the interface that groups dialog items into rows for building UI
+ * @public
+ */
+export interface DialogRow {
+    priority: number;
+    items: DialogItem[];
+}
+/**
+ * @public
+ */
+export declare abstract class UiLayoutDataProvider extends UiDataProvider {
+    private _items;
+    /** Applies changes from one or more properties - some dialogs will use this to send a bulk set of changes back to the provider */
+    processChangesInUi(properties: DialogPropertyItem[]): PropertyChangeResult;
+    /** Applies change of a single property - this is the default method used when property editors are dynamically generated. */
+    applyUiPropertyChange: (_updatedValue: DialogPropertySyncItem) => void;
+    private _rows;
+    /** Array of dialog rows */
+    get rows(): DialogRow[];
+    protected loadItemsInternal(items: ReadonlyArray<DialogItem> | undefined): void;
+    /** Called by UI to request available properties that can be bound to user supplied UI components (See Tool1UiProvider for example). */
+    supplyDialogItems(): DialogItem[] | undefined;
+    get items(): ReadonlyArray<DialogItem>;
+    /** Called to inform listeners that new properties are ready for display in UI. */
+    reloadDialogItems(emitEvent?: boolean): void;
+    /**
+     * @internal
+     */
+    layoutDialogRows(): DialogRow[];
+    /** Determines if a dialog item editor wants a label */
+    static editorWantsLabel(item: DialogItem): boolean;
+    /** Determines if a dialog items has an associated lock property */
+    static hasAssociatedLockProperty(item: DialogItem): boolean;
+    /** Gets the disabled state for a given dialog item */
+    static getItemDisabledState(baseDialogItem: BaseDialogItem): boolean;
+    /** Gets a property record for a given dialog item */
+    static getPropertyRecord: (dialogItem: BaseDialogItem) => PropertyRecord;
+    /** Determines if a dialog row only contains button group editors */
+    static onlyContainButtonGroupEditors(row: DialogRow): boolean;
+}
+/** [[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
+ */
+export declare abstract class DialogLayoutDataProvider extends UiLayoutDataProvider {
+    onButtonsReloadedEvent: BeUiEvent<void>;
+    /** Called to inform listeners that modal dialog button data needs to be refreshed. */
+    fireDialogButtonsReloadEvent(): void;
+    supplyButtonData(): DialogButtonDef[] | undefined;
+}
 //# sourceMappingURL=UiLayoutDataProvider.d.ts.map