ToolUiProvider.tsx

/*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
 * @module ToolSettings
 */

import type * as React from "react";
import type { UiDataProvider } from "@itwin/appui-abstract";
import type { ConfigurableCreateInfo } from "../configurableui/ConfigurableUiControl";
import {
  ConfigurableUiControl,
  ConfigurableUiControlType,
} from "../configurableui/ConfigurableUiControl";
import type { ToolSettingsEntry } from "../widget-panels/ToolSettings";
import type { SyncToolSettingsPropertiesEventArgs } from "../framework/FrameworkToolSettings";

/**
 * ToolUiProvider provides the Tool Settings and/or Tool Assistance UI for a tool.
 * The ToolUiProvider is registered for the tool id via UiFramework.controls.register.
 * @public
 */
export class ToolUiProvider extends ConfigurableUiControl {
  private _toolSettingsNode: React.ReactNode;
  private _horizontalToolSettingNodes: ToolSettingsEntry[] | undefined;
  protected _dataProvider: UiDataProvider | undefined;
  constructor(info: ConfigurableCreateInfo, options: any) {
    super(info, options);
  }

  public override get uniqueId(): string {
    return `${this.constructor.name}[${super.uniqueId}]`;
  }

  /** A React node that holds tool settings when shown in a rectangular area (i.e. not in Horizontal area at top of application window.) */
  public get toolSettingsNode(): React.ReactNode {
    return this._toolSettingsNode;
  }
  public set toolSettingsNode(r: React.ReactNode) {
    this._toolSettingsNode = r;
  }

  /** An array of entries to load into the horizontal tool settings
   * @public
   */
  public get horizontalToolSettingNodes(): ToolSettingsEntry[] | undefined {
    return this._horizontalToolSettingNodes;
  }
  public set horizontalToolSettingNodes(r: ToolSettingsEntry[] | undefined) {
    this._horizontalToolSettingNodes = r;
  }

  /** The UiDataProvider class */
  public get dataProvider(): UiDataProvider | undefined {
    return this._dataProvider;
  }
  public set dataProvider(d: UiDataProvider | undefined) {
    this._dataProvider = d;
  }

  /** Gets the type of ConfigurableUiControl, which is 'ToolUiProvider' in this case */
  public getType(): ConfigurableUiControlType {
    return ConfigurableUiControlType.ToolUiProvider;
  }

  public syncToolSettingsProperties(
    _args: SyncToolSettingsPropertiesEventArgs
  ): void {}
  public reloadPropertiesFromTool(): void {}
}