@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/esm/appui-react/content/ContentGroup.d.ts

@@ -1,94 +1,94 @@
-/** @packageDocumentation
- * @module ContentView
- */
-import * as React from "react";
-import { ScreenViewport } from "@itwin/core-frontend";
-import { ContentLayoutProps } from "@itwin/appui-abstract";
-import { ConfigurableUiControlConstructor } from "../configurableui/ConfigurableUiControl";
-import { ContentControl } from "./ContentControl";
-import { FrontstageConfig } from "../frontstage/FrontstageConfig";
-/** Properties for content displayed in a content view
- * @public
- */
-export interface ContentProps {
-    /** A unique id for the Content View within the group */
-    id: string;
-    /** The class name or [[ConfigurableUiControlConstructor]] of the content control */
-    classId: string | ConfigurableUiControlConstructor;
-    /** Optional application data passed down to the Content View */
-    applicationData?: any;
-}
-/** Properties for a [[ContentGroup]]
- * @public
- */
-export interface ContentGroupProps {
-    /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */
-    id: string;
-    /** Content Layout Id or complete set of [[ContentLayoutProps]]  */
-    layout: ContentLayoutProps;
-    /** A collection of [[ContentProps]], one for each content view */
-    contents: ContentProps[];
-}
-/** Abstract class that can be implemented and specified by frontstage to dynamically construct
- * content group just prior to activating the frontstage.
- * @public
- */
-export declare abstract class ContentGroupProvider {
-    /** Return the contentGroup based on the `FrontstageConfig`. */
-    abstract contentGroup(config: FrontstageConfig): Promise<ContentGroup>;
-    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
-     * be to remove applicationData entries.
-     */
-    prepareToSaveProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
-    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
-     * Typically this may be to add applicationData to content entries.
-     */
-    applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
-    /** Allow provider to save any content group data before the stage deactivated. */
-    onFrontstageDeactivated(): Promise<void>;
-}
-/** Callback to process content properties during toJSON method
- * @public
- */
-export declare type ContentCallback = (content: ContentProps) => void;
-/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
- * @public
- */
-export declare class ContentGroup {
-    private static _sId;
-    groupId: string;
-    propsId: string;
-    layout: ContentLayoutProps;
-    contentPropsList: ContentProps[];
-    private _contentControls;
-    private _contentSetMap;
-    get id(): string;
-    constructor(contentGroupProps: ContentGroupProps);
-    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
-    getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined;
-    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
-    getContentControlById(id: string): ContentControl | undefined;
-    /** Gets the React nodes representing the Content Views in this Content Group. */
-    getContentNodes(): React.ReactNode[];
-    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
-    getControlFromElement(node: React.ReactNode): ContentControl | undefined;
-    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
-    refreshContentNodes(): void;
-    /** Gets an array of the content controls representing the Content Views. */
-    getContentControls(): ContentControl[];
-    /** Called when Frontstage is deactivated. */
-    onFrontstageDeactivated(): void;
-    /** Called when Frontstage is ready. */
-    onFrontstageReady(): void;
-    /** Clears the map of content controls. */
-    clearContentControls(): void;
-    /** Creates [[ContentGroupProps]] for JSON purposes
-     * @public
-     */
-    toJSON(contentCallback?: ContentCallback): ContentGroupProps;
-    /** Gets Viewports from Viewport Content Controls
-     * @internal
-     */
-    getViewports(): Array<ScreenViewport | undefined>;
-}
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import { ScreenViewport } from "@itwin/core-frontend";
+import { ContentLayoutProps } from "@itwin/appui-abstract";
+import { ConfigurableUiControlConstructor } from "../configurableui/ConfigurableUiControl";
+import { ContentControl } from "./ContentControl";
+import { FrontstageConfig } from "../frontstage/FrontstageConfig";
+/** Properties for content displayed in a content view
+ * @public
+ */
+export interface ContentProps {
+    /** A unique id for the Content View within the group */
+    id: string;
+    /** The class name or [[ConfigurableUiControlConstructor]] of the content control */
+    classId: string | ConfigurableUiControlConstructor;
+    /** Optional application data passed down to the Content View */
+    applicationData?: any;
+}
+/** Properties for a [[ContentGroup]]
+ * @public
+ */
+export interface ContentGroupProps {
+    /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */
+    id: string;
+    /** Content Layout Id or complete set of [[ContentLayoutProps]]  */
+    layout: ContentLayoutProps;
+    /** A collection of [[ContentProps]], one for each content view */
+    contents: ContentProps[];
+}
+/** Abstract class that can be implemented and specified by frontstage to dynamically construct
+ * content group just prior to activating the frontstage.
+ * @public
+ */
+export declare abstract class ContentGroupProvider {
+    /** Return the contentGroup based on the `FrontstageConfig`. */
+    abstract contentGroup(config: FrontstageConfig): Promise<ContentGroup>;
+    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
+     * be to remove applicationData entries.
+     */
+    prepareToSaveProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
+     * Typically this may be to add applicationData to content entries.
+     */
+    applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to save any content group data before the stage deactivated. */
+    onFrontstageDeactivated(): Promise<void>;
+}
+/** Callback to process content properties during toJSON method
+ * @public
+ */
+export type ContentCallback = (content: ContentProps) => void;
+/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
+ * @public
+ */
+export declare class ContentGroup {
+    private static _sId;
+    groupId: string;
+    propsId: string;
+    layout: ContentLayoutProps;
+    contentPropsList: ContentProps[];
+    private _contentControls;
+    private _contentSetMap;
+    get id(): string;
+    constructor(contentGroupProps: ContentGroupProps);
+    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
+    getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined;
+    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
+    getContentControlById(id: string): ContentControl | undefined;
+    /** Gets the React nodes representing the Content Views in this Content Group. */
+    getContentNodes(): React.ReactNode[];
+    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
+    getControlFromElement(node: React.ReactNode): ContentControl | undefined;
+    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
+    refreshContentNodes(): void;
+    /** Gets an array of the content controls representing the Content Views. */
+    getContentControls(): ContentControl[];
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated(): void;
+    /** Called when Frontstage is ready. */
+    onFrontstageReady(): void;
+    /** Clears the map of content controls. */
+    clearContentControls(): void;
+    /** Creates [[ContentGroupProps]] for JSON purposes
+     * @public
+     */
+    toJSON(contentCallback?: ContentCallback): ContentGroupProps;
+    /** Gets Viewports from Viewport Content Controls
+     * @internal
+     */
+    getViewports(): Array<ScreenViewport | undefined>;
+}
 //# sourceMappingURL=ContentGroup.d.ts.map

package/lib/esm/appui-react/content/ContentGroup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContentGroup.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAW,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAA0B,gCAAgC,EAA6B,MAAM,yCAAyC,CAAC;AAE9I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAGlE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,oFAAoF;IACpF,OAAO,EAAE,MAAM,GAAG,gCAAgC,CAAC;IACnD,gEAAgE;IAChE,eAAe,CAAC,EAAE,GAAG,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mKAAmK;IACnK,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,8BAAsB,oBAAoB;IACxC,+DAA+D;IAC/D,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAEtE;;OAEG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB;IAI9D;;OAEG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,iBAAiB;IAIpE,kFAAkF;IACrE,uBAAuB;CACrC;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACxC,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,cAAc,CAAqC;IAE3D,IAAW,EAAE,WAEZ;gBAEW,iBAAiB,EAAE,iBAAiB;IAQhD,sFAAsF;IAC/E,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IA+BhG,wEAAwE;IACjE,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIpE,iFAAiF;IAC1E,eAAe,IAAI,KAAK,CAAC,SAAS,EAAE;IAgB3C,kGAAkG;IAC3F,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,cAAc,GAAG,SAAS;IAc/E,uFAAuF;IAChF,mBAAmB;IAI1B,4EAA4E;IACrE,kBAAkB,IAAI,cAAc,EAAE;IAa7C,6CAA6C;IACtC,uBAAuB,IAAI,IAAI;IAItC,uCAAuC;IAChC,iBAAiB,IAAI,IAAI;IAEhC,0CAA0C;IACnC,oBAAoB,IAAI,IAAI;IAInC;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,iBAAiB;IAuBnE;;OAEG;IACI,YAAY,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;CAczD"}
+{"version":3,"file":"ContentGroup.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAW,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAA0B,gCAAgC,EAA6B,MAAM,yCAAyC,CAAC;AAE9I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAGlE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,oFAAoF;IACpF,OAAO,EAAE,MAAM,GAAG,gCAAgC,CAAC;IACnD,gEAAgE;IAChE,eAAe,CAAC,EAAE,GAAG,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mKAAmK;IACnK,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,8BAAsB,oBAAoB;IACxC,+DAA+D;aAC/C,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAE7E;;OAEG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB;IAI9D;;OAEG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,iBAAiB;IAIpE,kFAAkF;IACrE,uBAAuB;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACxC,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,cAAc,CAAqC;IAE3D,IAAW,EAAE,WAEZ;gBAEW,iBAAiB,EAAE,iBAAiB;IAQhD,sFAAsF;IAC/E,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IA+BhG,wEAAwE;IACjE,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIpE,iFAAiF;IAC1E,eAAe,IAAI,KAAK,CAAC,SAAS,EAAE;IAgB3C,kGAAkG;IAC3F,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,cAAc,GAAG,SAAS;IAc/E,uFAAuF;IAChF,mBAAmB;IAI1B,4EAA4E;IACrE,kBAAkB,IAAI,cAAc,EAAE;IAa7C,6CAA6C;IACtC,uBAAuB,IAAI,IAAI;IAItC,uCAAuC;IAChC,iBAAiB,IAAI,IAAI;IAEhC,0CAA0C;IACnC,oBAAoB,IAAI,IAAI;IAInC;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,iBAAiB;IAuBnE;;OAEG;IACI,YAAY,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;CAczD"}

package/lib/esm/appui-react/content/ContentGroup.js

@@ -1,170 +1,171 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module ContentView
- */
-import { UiError } from "@itwin/appui-abstract";
-import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
-import { UiFramework } from "../UiFramework";
-import { InternalConfigurableUiManager } from "../configurableui/InternalConfigurableUiManager";
-/** Abstract class that can be implemented and specified by frontstage to dynamically construct
- * content group just prior to activating the frontstage.
- * @public
- */
-export class ContentGroupProvider {
-    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
-     * be to remove applicationData entries.
-     */
-    prepareToSaveProps(contentGroupProps) {
-        return contentGroupProps;
-    }
-    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
-     * Typically this may be to add applicationData to content entries.
-     */
-    applyUpdatesToSavedProps(contentGroupProps) {
-        return contentGroupProps;
-    }
-    /** Allow provider to save any content group data before the stage deactivated. */
-    async onFrontstageDeactivated() { }
-}
-/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
- * @public
- */
-export class ContentGroup {
-    constructor(contentGroupProps) {
-        this._contentControls = new Map();
-        this._contentSetMap = new Map();
-        this.layout = { ...contentGroupProps.layout };
-        this.propsId = contentGroupProps.id;
-        // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls
-        this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;
-        this.contentPropsList = contentGroupProps.contents;
-    }
-    get id() {
-        return this.groupId;
-    }
-    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
-    getContentControl(contentProps, _index) {
-        // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`
-        const id = `${contentProps.id}::${this.groupId}`;
-        let contentControl;
-        if (!this._contentControls.get(contentProps.id)) {
-            let usedClassId = "";
-            if (typeof contentProps.classId === "string") {
-                if (!this._contentControls.get(contentProps.id) && UiFramework.controls.isRegistered(contentProps.classId)) {
-                    contentControl = UiFramework.controls.create(contentProps.classId, id, contentProps.applicationData, contentProps.id);
-                    usedClassId = contentProps.classId;
-                }
-            }
-            else {
-                const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);
-                contentControl = new contentProps.classId(info, contentProps.applicationData);
-                usedClassId = contentProps.classId.name;
-            }
-            if (contentControl) {
-                if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {
-                    throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);
-                }
-                contentControl.initialize();
-                this._contentControls.set(contentProps.id, contentControl);
-            }
-        }
-        return this._contentControls.get(contentProps.id);
-    }
-    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
-    getContentControlById(id) {
-        return this._contentControls.get(id);
-    }
-    /** Gets the React nodes representing the Content Views in this Content Group. */
-    getContentNodes() {
-        const contentNodes = new Array();
-        this._contentSetMap.clear();
-        this.contentPropsList.forEach((contentProps, index) => {
-            const control = this.getContentControl(contentProps, index);
-            if (control) {
-                contentNodes.push(control.reactNode);
-                this._contentSetMap.set(control.controlId, control);
-            }
-        });
-        return contentNodes;
-    }
-    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
-    getControlFromElement(node) {
-        if (this._contentSetMap.size === 0)
-            this.getContentNodes();
-        if (node && node.key) {
-            const key = node.key;
-            // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id
-            const controlId = key.split("::", 1)[0];
-            return this._contentSetMap.get(controlId);
-        }
-        return undefined;
-    }
-    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
-    refreshContentNodes() {
-        this._contentSetMap.clear();
-    }
-    /** Gets an array of the content controls representing the Content Views. */
-    getContentControls() {
-        const contentControls = new Array();
-        this.contentPropsList.forEach((contentProps, index) => {
-            const control = this.getContentControl(contentProps, index);
-            if (control) {
-                contentControls.push(control);
-            }
-        });
-        return contentControls;
-    }
-    /** Called when Frontstage is deactivated. */
-    onFrontstageDeactivated() {
-        this.clearContentControls();
-    }
-    /** Called when Frontstage is ready. */
-    onFrontstageReady() { }
-    /** Clears the map of content controls. */
-    clearContentControls() {
-        this._contentControls.clear();
-    }
-    /** Creates [[ContentGroupProps]] for JSON purposes
-     * @public
-     */
-    toJSON(contentCallback) {
-        const contentGroupProps = {
-            id: this.propsId,
-            layout: this.layout,
-            contents: this.contentPropsList,
-        };
-        contentGroupProps.contents.forEach((content, index) => {
-            if (typeof content.classId !== "string") {
-                const classId = InternalConfigurableUiManager.getConstructorClassId(content.classId);
-                if (classId !== undefined)
-                    content.classId = classId;
-                else
-                    throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);
-                if (contentCallback)
-                    contentCallback(content);
-            }
-        });
-        return contentGroupProps;
-    }
-    /** Gets Viewports from Viewport Content Controls
-     * @internal
-     */
-    getViewports() {
-        const contentControls = this.getContentControls();
-        const viewports = new Array();
-        contentControls.forEach((control) => {
-            if (control.isViewport && control.viewport) {
-                viewports.push(control.viewport);
-            }
-            else {
-                viewports.push(undefined);
-            }
-        });
-        return viewports;
-    }
-}
-ContentGroup._sId = 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ContentView
+ */
+import { UiError } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { UiFramework } from "../UiFramework";
+import { InternalConfigurableUiManager } from "../configurableui/InternalConfigurableUiManager";
+/** Abstract class that can be implemented and specified by frontstage to dynamically construct
+ * content group just prior to activating the frontstage.
+ * @public
+ */
+export class ContentGroupProvider {
+    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
+     * be to remove applicationData entries.
+     */
+    prepareToSaveProps(contentGroupProps) {
+        return contentGroupProps;
+    }
+    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
+     * Typically this may be to add applicationData to content entries.
+     */
+    applyUpdatesToSavedProps(contentGroupProps) {
+        return contentGroupProps;
+    }
+    /** Allow provider to save any content group data before the stage deactivated. */
+    async onFrontstageDeactivated() { }
+}
+/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
+ * @public
+ */
+class ContentGroup {
+    get id() {
+        return this.groupId;
+    }
+    constructor(contentGroupProps) {
+        this._contentControls = new Map();
+        this._contentSetMap = new Map();
+        this.layout = { ...contentGroupProps.layout };
+        this.propsId = contentGroupProps.id;
+        // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls
+        this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;
+        this.contentPropsList = contentGroupProps.contents;
+    }
+    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
+    getContentControl(contentProps, _index) {
+        // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`
+        const id = `${contentProps.id}::${this.groupId}`;
+        let contentControl;
+        if (!this._contentControls.get(contentProps.id)) {
+            let usedClassId = "";
+            if (typeof contentProps.classId === "string") {
+                if (!this._contentControls.get(contentProps.id) && UiFramework.controls.isRegistered(contentProps.classId)) {
+                    contentControl = UiFramework.controls.create(contentProps.classId, id, contentProps.applicationData, contentProps.id);
+                    usedClassId = contentProps.classId;
+                }
+            }
+            else {
+                const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);
+                contentControl = new contentProps.classId(info, contentProps.applicationData);
+                usedClassId = contentProps.classId.name;
+            }
+            if (contentControl) {
+                if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {
+                    throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);
+                }
+                contentControl.initialize();
+                this._contentControls.set(contentProps.id, contentControl);
+            }
+        }
+        return this._contentControls.get(contentProps.id);
+    }
+    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
+    getContentControlById(id) {
+        return this._contentControls.get(id);
+    }
+    /** Gets the React nodes representing the Content Views in this Content Group. */
+    getContentNodes() {
+        const contentNodes = new Array();
+        this._contentSetMap.clear();
+        this.contentPropsList.forEach((contentProps, index) => {
+            const control = this.getContentControl(contentProps, index);
+            if (control) {
+                contentNodes.push(control.reactNode);
+                this._contentSetMap.set(control.controlId, control);
+            }
+        });
+        return contentNodes;
+    }
+    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
+    getControlFromElement(node) {
+        if (this._contentSetMap.size === 0)
+            this.getContentNodes();
+        if (node && node.key) {
+            const key = node.key;
+            // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id
+            const controlId = key.split("::", 1)[0];
+            return this._contentSetMap.get(controlId);
+        }
+        return undefined;
+    }
+    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
+    refreshContentNodes() {
+        this._contentSetMap.clear();
+    }
+    /** Gets an array of the content controls representing the Content Views. */
+    getContentControls() {
+        const contentControls = new Array();
+        this.contentPropsList.forEach((contentProps, index) => {
+            const control = this.getContentControl(contentProps, index);
+            if (control) {
+                contentControls.push(control);
+            }
+        });
+        return contentControls;
+    }
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated() {
+        this.clearContentControls();
+    }
+    /** Called when Frontstage is ready. */
+    onFrontstageReady() { }
+    /** Clears the map of content controls. */
+    clearContentControls() {
+        this._contentControls.clear();
+    }
+    /** Creates [[ContentGroupProps]] for JSON purposes
+     * @public
+     */
+    toJSON(contentCallback) {
+        const contentGroupProps = {
+            id: this.propsId,
+            layout: this.layout,
+            contents: this.contentPropsList,
+        };
+        contentGroupProps.contents.forEach((content, index) => {
+            if (typeof content.classId !== "string") {
+                const classId = InternalConfigurableUiManager.getConstructorClassId(content.classId);
+                if (classId !== undefined)
+                    content.classId = classId;
+                else
+                    throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);
+                if (contentCallback)
+                    contentCallback(content);
+            }
+        });
+        return contentGroupProps;
+    }
+    /** Gets Viewports from Viewport Content Controls
+     * @internal
+     */
+    getViewports() {
+        const contentControls = this.getContentControls();
+        const viewports = new Array();
+        contentControls.forEach((control) => {
+            if (control.isViewport && control.viewport) {
+                viewports.push(control.viewport);
+            }
+            else {
+                viewports.push(undefined);
+            }
+        });
+        return viewports;
+    }
+}
+ContentGroup._sId = 0;
+export { ContentGroup };
 //# sourceMappingURL=ContentGroup.js.map

package/lib/esm/appui-react/content/ContentGroup.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentGroup.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAsB,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAoC,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAC9I,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AA0BhG;;;GAGG;AACH,MAAM,OAAgB,oBAAoB;IAIxC;;OAEG;IACI,kBAAkB,CAAC,iBAAoC;QAC5D,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,iBAAoC;QAClE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,kFAAkF;IAC3E,KAAK,CAAC,uBAAuB,KAAK,CAAC;CAC3C;AAOD;;GAEG;AACH,MAAM,OAAO,YAAY;IAavB,YAAY,iBAAoC;QAPxC,qBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAC;QACrD,mBAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;QAOzD,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACpC,mIAAmI;QACnI,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IACrD,CAAC;IAVD,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAUD,sFAAsF;IAC/E,iBAAiB,CAAC,YAA0B,EAAE,MAAc;QACjE,wKAAwK;QACxK,MAAM,EAAE,GAAG,GAAG,YAAY,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,cAA0C,CAAC;QAE/C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE;YAC/C,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,IAAI,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ,EAAE;gBAC5C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;oBAC1G,cAAc,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAmB,CAAC;oBACxI,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;iBACpC;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;gBACxF,cAAc,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAmB,CAAC;gBAChG,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;aACzC;YAED,IAAI,cAAc,EAAE;gBAClB,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,QAAQ,EAAE;oBACrI,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6BAA6B,WAAW,qDAAqD,CAAC,CAAC;iBACpJ;gBACD,cAAc,CAAC,UAAU,EAAE,CAAC;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;aAC5D;SACF;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,wEAAwE;IACjE,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,iFAAiF;IAC1E,eAAe;QACpB,MAAM,YAAY,GAAsB,IAAI,KAAK,EAAmB,CAAC;QAErE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;aACrD;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,kGAAkG;IAC3F,qBAAqB,CAAC,IAAqB;QAChD,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;YAChC,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzB,IAAI,IAAI,IAAK,IAAgC,CAAC,GAAG,EAAE;YACjD,MAAM,GAAG,GAAK,IAAgC,CAAC,GAAc,CAAC;YAC9D,oFAAoF;YACpF,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC3C;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,uFAAuF;IAChF,mBAAmB;QACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,MAAM,eAAe,GAAqB,IAAI,KAAK,EAAkB,CAAC;QAEtE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,6CAA6C;IACtC,uBAAuB;QAC5B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC,0CAA0C;IACnC,oBAAoB;QACzB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAiC;QAC7C,MAAM,iBAAiB,GAAsB;YAC3C,EAAE,EAAE,IAAI,CAAC,OAAO;YAChB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,gBAAgB;SAChC,CAAC;QAEF,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,KAAa,EAAE,EAAE;YAC1E,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACvC,MAAM,OAAO,GAAG,6BAA6B,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrF,IAAI,OAAO,KAAK,SAAS;oBACvB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;;oBAE1B,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mCAAmC,KAAK,qCAAqC,CAAC,CAAC;gBAErI,IAAI,eAAe;oBACjB,eAAe,CAAC,OAAO,CAAC,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,SAAS,GAAG,IAAI,KAAK,EAA8B,CAAC;QAE1D,eAAe,CAAC,OAAO,CAAC,CAAC,OAAuB,EAAE,EAAE;YAClD,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE;gBAC1C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClC;iBAAM;gBACL,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;;AAnKc,iBAAI,GAAG,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 ContentView\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { ContentLayoutProps, UiError } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ContentControl } from \"./ContentControl\";\r\nimport { FrontstageConfig } from \"../frontstage/FrontstageConfig\";\r\nimport { InternalConfigurableUiManager } from \"../configurableui/InternalConfigurableUiManager\";\r\n\r\n/** Properties for content displayed in a content view\r\n * @public\r\n */\r\nexport interface ContentProps {\r\n  /** A unique id for the Content View within the group */\r\n  id: string;\r\n  /** The class name or [[ConfigurableUiControlConstructor]] of the content control */\r\n  classId: string | ConfigurableUiControlConstructor;\r\n  /** Optional application data passed down to the Content View */\r\n  applicationData?: any;\r\n}\r\n\r\n/** Properties for a [[ContentGroup]]\r\n * @public\r\n */\r\nexport interface ContentGroupProps {\r\n  /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */\r\n  id: string;\r\n  /** Content Layout Id or complete set of [[ContentLayoutProps]]  */\r\n  layout: ContentLayoutProps;\r\n  /** A collection of [[ContentProps]], one for each content view */\r\n  contents: ContentProps[];\r\n}\r\n\r\n/** Abstract class that can be implemented and specified by frontstage to dynamically construct\r\n * content group just prior to activating the frontstage.\r\n * @public\r\n */\r\nexport abstract class ContentGroupProvider {\r\n  /** Return the contentGroup based on the `FrontstageConfig`. */\r\n  abstract contentGroup(config: FrontstageConfig): Promise<ContentGroup>;\r\n\r\n  /** Allow provider to update any data stored in ContentGroupProps. Typically this may\r\n   * be to remove applicationData entries.\r\n   */\r\n  public prepareToSaveProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.\r\n   * Typically this may be to add applicationData to content entries.\r\n   */\r\n  public applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to save any content group data before the stage deactivated. */\r\n  public async onFrontstageDeactivated() { }\r\n}\r\n\r\n/** Callback to process content properties during toJSON method\r\n * @public\r\n */\r\nexport type ContentCallback = (content: ContentProps) => void;\r\n\r\n/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].\r\n * @public\r\n */\r\nexport class ContentGroup {\r\n  private static _sId = 0;\r\n  public groupId: string;\r\n  public propsId: string;\r\n  public layout: ContentLayoutProps;\r\n  public contentPropsList: ContentProps[];\r\n  private _contentControls = new Map<string, ContentControl>();\r\n  private _contentSetMap = new Map<string, ContentControl>();\r\n\r\n  public get id() {\r\n    return this.groupId;\r\n  }\r\n\r\n  constructor(contentGroupProps: ContentGroupProps) {\r\n    this.layout = { ...contentGroupProps.layout };\r\n    this.propsId = contentGroupProps.id;\r\n    // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls\r\n    this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;\r\n    this.contentPropsList = contentGroupProps.contents;\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */\r\n  public getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined {\r\n    // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`\r\n    const id = `${contentProps.id}::${this.groupId}`;\r\n    let contentControl: ContentControl | undefined;\r\n\r\n    if (!this._contentControls.get(contentProps.id)) {\r\n      let usedClassId: string = \"\";\r\n\r\n      if (typeof contentProps.classId === \"string\") {\r\n        if (!this._contentControls.get(contentProps.id) && UiFramework.controls.isRegistered(contentProps.classId)) {\r\n          contentControl = UiFramework.controls.create(contentProps.classId, id, contentProps.applicationData, contentProps.id) as ContentControl;\r\n          usedClassId = contentProps.classId;\r\n        }\r\n      } else {\r\n        const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);\r\n        contentControl = new contentProps.classId(info, contentProps.applicationData) as ContentControl;\r\n        usedClassId = contentProps.classId.name;\r\n      }\r\n\r\n      if (contentControl) {\r\n        if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {\r\n          throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);\r\n        }\r\n        contentControl.initialize();\r\n        this._contentControls.set(contentProps.id, contentControl);\r\n      }\r\n    }\r\n\r\n    return this._contentControls.get(contentProps.id);\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group with a given ID. */\r\n  public getContentControlById(id: string): ContentControl | undefined {\r\n    return this._contentControls.get(id);\r\n  }\r\n\r\n  /** Gets the React nodes representing the Content Views in this Content Group. */\r\n  public getContentNodes(): React.ReactNode[] {\r\n    const contentNodes: React.ReactNode[] = new Array<React.ReactNode>();\r\n\r\n    this._contentSetMap.clear();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentNodes.push(control.reactNode);\r\n        this._contentSetMap.set(control.controlId, control);\r\n      }\r\n    });\r\n\r\n    return contentNodes;\r\n  }\r\n\r\n  /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */\r\n  public getControlFromElement(node: React.ReactNode): ContentControl | undefined {\r\n    if (this._contentSetMap.size === 0)\r\n      this.getContentNodes();\r\n\r\n    if (node && (node as React.ReactElement<any>).key) {\r\n      const key = ((node as React.ReactElement<any>).key as string);\r\n      // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id\r\n      const controlId = key.split(\"::\", 1)[0];\r\n      return this._contentSetMap.get(controlId);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Refreshes the React nodes representing the Content Views in this Content Group.. */\r\n  public refreshContentNodes() {\r\n    this._contentSetMap.clear();\r\n  }\r\n\r\n  /** Gets an array of the content controls representing the Content Views. */\r\n  public getContentControls(): ContentControl[] {\r\n    const contentControls: ContentControl[] = new Array<ContentControl>();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentControls.push(control);\r\n      }\r\n    });\r\n\r\n    return contentControls;\r\n  }\r\n\r\n  /** Called when Frontstage is deactivated. */\r\n  public onFrontstageDeactivated(): void {\r\n    this.clearContentControls();\r\n  }\r\n\r\n  /** Called when Frontstage is ready. */\r\n  public onFrontstageReady(): void { }\r\n\r\n  /** Clears the map of content controls. */\r\n  public clearContentControls(): void {\r\n    this._contentControls.clear();\r\n  }\r\n\r\n  /** Creates [[ContentGroupProps]] for JSON purposes\r\n   * @public\r\n   */\r\n  public toJSON(contentCallback?: ContentCallback): ContentGroupProps {\r\n    const contentGroupProps: ContentGroupProps = {\r\n      id: this.propsId,\r\n      layout: this.layout,\r\n      contents: this.contentPropsList,\r\n    };\r\n\r\n    contentGroupProps.contents.forEach((content: ContentProps, index: number) => {\r\n      if (typeof content.classId !== \"string\") {\r\n        const classId = InternalConfigurableUiManager.getConstructorClassId(content.classId);\r\n        if (classId !== undefined)\r\n          content.classId = classId;\r\n        else\r\n          throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);\r\n\r\n        if (contentCallback)\r\n          contentCallback(content);\r\n      }\r\n    });\r\n\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Gets Viewports from Viewport Content Controls\r\n   * @internal\r\n   */\r\n  public getViewports(): Array<ScreenViewport | undefined> {\r\n    const contentControls = this.getContentControls();\r\n    const viewports = new Array<ScreenViewport | undefined>();\r\n\r\n    contentControls.forEach((control: ContentControl) => {\r\n      if (control.isViewport && control.viewport) {\r\n        viewports.push(control.viewport);\r\n      } else {\r\n        viewports.push(undefined);\r\n      }\r\n    });\r\n\r\n    return viewports;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ContentGroup.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAsB,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAoC,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAC9I,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AA0BhG;;;GAGG;AACH,MAAM,OAAgB,oBAAoB;IAIxC;;OAEG;IACI,kBAAkB,CAAC,iBAAoC;QAC5D,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,iBAAoC;QAClE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,kFAAkF;IAC3E,KAAK,CAAC,uBAAuB,KAAK,CAAC;CAC3C;AAOD;;GAEG;AACH,MAAa,YAAY;IASvB,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,YAAY,iBAAoC;QAPxC,qBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAC;QACrD,mBAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;QAOzD,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACpC,mIAAmI;QACnI,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IACrD,CAAC;IAED,sFAAsF;IAC/E,iBAAiB,CAAC,YAA0B,EAAE,MAAc;QACjE,wKAAwK;QACxK,MAAM,EAAE,GAAG,GAAG,YAAY,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,cAA0C,CAAC;QAE/C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE;YAC/C,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,IAAI,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ,EAAE;gBAC5C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;oBAC1G,cAAc,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAmB,CAAC;oBACxI,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;iBACpC;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;gBACxF,cAAc,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAmB,CAAC;gBAChG,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;aACzC;YAED,IAAI,cAAc,EAAE;gBAClB,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,QAAQ,EAAE;oBACrI,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6BAA6B,WAAW,qDAAqD,CAAC,CAAC;iBACpJ;gBACD,cAAc,CAAC,UAAU,EAAE,CAAC;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;aAC5D;SACF;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,wEAAwE;IACjE,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,iFAAiF;IAC1E,eAAe;QACpB,MAAM,YAAY,GAAsB,IAAI,KAAK,EAAmB,CAAC;QAErE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;aACrD;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,kGAAkG;IAC3F,qBAAqB,CAAC,IAAqB;QAChD,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;YAChC,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzB,IAAI,IAAI,IAAK,IAAgC,CAAC,GAAG,EAAE;YACjD,MAAM,GAAG,GAAK,IAAgC,CAAC,GAAc,CAAC;YAC9D,oFAAoF;YACpF,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC3C;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,uFAAuF;IAChF,mBAAmB;QACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,MAAM,eAAe,GAAqB,IAAI,KAAK,EAAkB,CAAC;QAEtE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,6CAA6C;IACtC,uBAAuB;QAC5B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC,0CAA0C;IACnC,oBAAoB;QACzB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAiC;QAC7C,MAAM,iBAAiB,GAAsB;YAC3C,EAAE,EAAE,IAAI,CAAC,OAAO;YAChB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,gBAAgB;SAChC,CAAC;QAEF,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,KAAa,EAAE,EAAE;YAC1E,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACvC,MAAM,OAAO,GAAG,6BAA6B,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrF,IAAI,OAAO,KAAK,SAAS;oBACvB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;;oBAE1B,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mCAAmC,KAAK,qCAAqC,CAAC,CAAC;gBAErI,IAAI,eAAe;oBACjB,eAAe,CAAC,OAAO,CAAC,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,SAAS,GAAG,IAAI,KAAK,EAA8B,CAAC;QAE1D,eAAe,CAAC,OAAO,CAAC,CAAC,OAAuB,EAAE,EAAE;YAClD,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE;gBAC1C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClC;iBAAM;gBACL,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;;AAnKc,iBAAI,GAAG,CAAC,AAAJ,CAAK;SADb,YAAY","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 * as React from \"react\";\r\nimport { ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { ContentLayoutProps, UiError } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ContentControl } from \"./ContentControl\";\r\nimport { FrontstageConfig } from \"../frontstage/FrontstageConfig\";\r\nimport { InternalConfigurableUiManager } from \"../configurableui/InternalConfigurableUiManager\";\r\n\r\n/** Properties for content displayed in a content view\r\n * @public\r\n */\r\nexport interface ContentProps {\r\n  /** A unique id for the Content View within the group */\r\n  id: string;\r\n  /** The class name or [[ConfigurableUiControlConstructor]] of the content control */\r\n  classId: string | ConfigurableUiControlConstructor;\r\n  /** Optional application data passed down to the Content View */\r\n  applicationData?: any;\r\n}\r\n\r\n/** Properties for a [[ContentGroup]]\r\n * @public\r\n */\r\nexport interface ContentGroupProps {\r\n  /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */\r\n  id: string;\r\n  /** Content Layout Id or complete set of [[ContentLayoutProps]]  */\r\n  layout: ContentLayoutProps;\r\n  /** A collection of [[ContentProps]], one for each content view */\r\n  contents: ContentProps[];\r\n}\r\n\r\n/** Abstract class that can be implemented and specified by frontstage to dynamically construct\r\n * content group just prior to activating the frontstage.\r\n * @public\r\n */\r\nexport abstract class ContentGroupProvider {\r\n  /** Return the contentGroup based on the `FrontstageConfig`. */\r\n  public abstract contentGroup(config: FrontstageConfig): Promise<ContentGroup>;\r\n\r\n  /** Allow provider to update any data stored in ContentGroupProps. Typically this may\r\n   * be to remove applicationData entries.\r\n   */\r\n  public prepareToSaveProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.\r\n   * Typically this may be to add applicationData to content entries.\r\n   */\r\n  public applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to save any content group data before the stage deactivated. */\r\n  public async onFrontstageDeactivated() { }\r\n}\r\n\r\n/** Callback to process content properties during toJSON method\r\n * @public\r\n */\r\nexport type ContentCallback = (content: ContentProps) => void;\r\n\r\n/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].\r\n * @public\r\n */\r\nexport class ContentGroup {\r\n  private static _sId = 0;\r\n  public groupId: string;\r\n  public propsId: string;\r\n  public layout: ContentLayoutProps;\r\n  public contentPropsList: ContentProps[];\r\n  private _contentControls = new Map<string, ContentControl>();\r\n  private _contentSetMap = new Map<string, ContentControl>();\r\n\r\n  public get id() {\r\n    return this.groupId;\r\n  }\r\n\r\n  constructor(contentGroupProps: ContentGroupProps) {\r\n    this.layout = { ...contentGroupProps.layout };\r\n    this.propsId = contentGroupProps.id;\r\n    // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls\r\n    this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;\r\n    this.contentPropsList = contentGroupProps.contents;\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */\r\n  public getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined {\r\n    // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`\r\n    const id = `${contentProps.id}::${this.groupId}`;\r\n    let contentControl: ContentControl | undefined;\r\n\r\n    if (!this._contentControls.get(contentProps.id)) {\r\n      let usedClassId: string = \"\";\r\n\r\n      if (typeof contentProps.classId === \"string\") {\r\n        if (!this._contentControls.get(contentProps.id) && UiFramework.controls.isRegistered(contentProps.classId)) {\r\n          contentControl = UiFramework.controls.create(contentProps.classId, id, contentProps.applicationData, contentProps.id) as ContentControl;\r\n          usedClassId = contentProps.classId;\r\n        }\r\n      } else {\r\n        const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);\r\n        contentControl = new contentProps.classId(info, contentProps.applicationData) as ContentControl;\r\n        usedClassId = contentProps.classId.name;\r\n      }\r\n\r\n      if (contentControl) {\r\n        if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {\r\n          throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);\r\n        }\r\n        contentControl.initialize();\r\n        this._contentControls.set(contentProps.id, contentControl);\r\n      }\r\n    }\r\n\r\n    return this._contentControls.get(contentProps.id);\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group with a given ID. */\r\n  public getContentControlById(id: string): ContentControl | undefined {\r\n    return this._contentControls.get(id);\r\n  }\r\n\r\n  /** Gets the React nodes representing the Content Views in this Content Group. */\r\n  public getContentNodes(): React.ReactNode[] {\r\n    const contentNodes: React.ReactNode[] = new Array<React.ReactNode>();\r\n\r\n    this._contentSetMap.clear();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentNodes.push(control.reactNode);\r\n        this._contentSetMap.set(control.controlId, control);\r\n      }\r\n    });\r\n\r\n    return contentNodes;\r\n  }\r\n\r\n  /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */\r\n  public getControlFromElement(node: React.ReactNode): ContentControl | undefined {\r\n    if (this._contentSetMap.size === 0)\r\n      this.getContentNodes();\r\n\r\n    if (node && (node as React.ReactElement<any>).key) {\r\n      const key = ((node as React.ReactElement<any>).key as string);\r\n      // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id\r\n      const controlId = key.split(\"::\", 1)[0];\r\n      return this._contentSetMap.get(controlId);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Refreshes the React nodes representing the Content Views in this Content Group.. */\r\n  public refreshContentNodes() {\r\n    this._contentSetMap.clear();\r\n  }\r\n\r\n  /** Gets an array of the content controls representing the Content Views. */\r\n  public getContentControls(): ContentControl[] {\r\n    const contentControls: ContentControl[] = new Array<ContentControl>();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentControls.push(control);\r\n      }\r\n    });\r\n\r\n    return contentControls;\r\n  }\r\n\r\n  /** Called when Frontstage is deactivated. */\r\n  public onFrontstageDeactivated(): void {\r\n    this.clearContentControls();\r\n  }\r\n\r\n  /** Called when Frontstage is ready. */\r\n  public onFrontstageReady(): void { }\r\n\r\n  /** Clears the map of content controls. */\r\n  public clearContentControls(): void {\r\n    this._contentControls.clear();\r\n  }\r\n\r\n  /** Creates [[ContentGroupProps]] for JSON purposes\r\n   * @public\r\n   */\r\n  public toJSON(contentCallback?: ContentCallback): ContentGroupProps {\r\n    const contentGroupProps: ContentGroupProps = {\r\n      id: this.propsId,\r\n      layout: this.layout,\r\n      contents: this.contentPropsList,\r\n    };\r\n\r\n    contentGroupProps.contents.forEach((content: ContentProps, index: number) => {\r\n      if (typeof content.classId !== \"string\") {\r\n        const classId = InternalConfigurableUiManager.getConstructorClassId(content.classId);\r\n        if (classId !== undefined)\r\n          content.classId = classId;\r\n        else\r\n          throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);\r\n\r\n        if (contentCallback)\r\n          contentCallback(content);\r\n      }\r\n    });\r\n\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Gets Viewports from Viewport Content Controls\r\n   * @internal\r\n   */\r\n  public getViewports(): Array<ScreenViewport | undefined> {\r\n    const contentControls = this.getContentControls();\r\n    const viewports = new Array<ScreenViewport | undefined>();\r\n\r\n    contentControls.forEach((control: ContentControl) => {\r\n      if (control.isViewport && control.viewport) {\r\n        viewports.push(control.viewport);\r\n      } else {\r\n        viewports.push(undefined);\r\n      }\r\n    });\r\n\r\n    return viewports;\r\n  }\r\n}\r\n"]}