WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Class LayerTransparencyDialog

    图层透明度对话框组件类 - 用于设置CAD图层透明度的对话框

    这个类继承自基础对话框组件,专门用于图层透明度的设置功能。 它提供了一个带验证功能的数值输入界面,用于设置图层的透明度值。

    主要功能:

    1. 透明度值输入 - 提供数值输入框用于输入透明度值
    2. 输入验证 - 验证输入的透明度值是否在有效范围内
    3. 特殊值支持 - 支持ByLayer、ByBlock等特殊透明度设置
    4. 实时反馈 - 提供实时的验证反馈信息
    5. 自动选择 - 自动选中输入框中的文本便于编辑
    6. 结果返回 - 返回用户设置的透明度值

    LayerTransparencyDialog

    Hierarchy (View Summary)

    Index

    Constructors

    • 构造函数 - 初始化图层透明度对话框组件

      调用父类构造函数并初始化图层透明度对话框特有的属性:

      • result: 用户设置的透明度结果
      • disableByLayerAndByBlock: 是否禁用特殊透明度选项
      • value: 输入框的默认值

      Returns LayerTransparencyDialog

    Properties

    dialogTitle: string
    draggable: boolean

    The draggable property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.

    MDN Reference

    isDragging: boolean
    dragStartX: number
    dragStartY: number
    dialogStartX: number
    dialogStartY: number
    offsetX: number
    offsetY: number
    mouseX: number
    mouseY: number
    properties: {
        dialogTitle: { type: StringConstructor };
        draggable: { type: BooleanConstructor };
        disableByLayerAndByBlock: { type: BooleanConstructor };
        value: { type: StringConstructor };
    } = ...

    定义响应式属性 - 使用静态属性

    result: number
    disableByLayerAndByBlock: boolean
    value: string
    firstValue: string
    styles: r = ...

    定义组件样式 - 使用静态属性

    renderRoot: any

    Accessors

    • get isSuspended(): boolean

      检查对话框是否处于暂停状态

      Returns boolean

    • get observedAttributes(): any[]

      Returns any[]

    • get updateComplete(): any

      Returns any

    Methods

    • 鼠标移动事件回调 - 跟踪鼠标位置

      当鼠标在对话框内移动时,记录当前鼠标的屏幕坐标。 这些坐标用于在对话框关闭后恢复鼠标位置, 确保用户体验的连续性。

      Parameters

      • event: MouseEvent

        鼠标移动事件对象

      Returns void

    • 顶部标题栏鼠标按下事件 - 开始拖拽

      当用户在对话框顶部标题栏按下鼠标时触发, 初始化拖拽操作的相关状态。

      Parameters

      • event: MouseEvent

        鼠标按下事件对象

      Returns void

    • 全局鼠标移动事件 - 处理拖拽移动

      Parameters

      • event: MouseEvent

        鼠标移动事件对象

      Returns void

    • 全局鼠标释放事件 - 结束拖拽

      Parameters

      • event: MouseEvent

        鼠标释放事件对象

      Returns void

    • 处理拖拽移动 - 更新对话框位置

      Parameters

      • event: MouseEvent

        鼠标事件对象

      Returns void

    • 检查元素是否为可拖拽区域

      Parameters

      • element: Element

        要检查的元素

      Returns boolean

      是否为可拖拽区域

    • 等待组件更新完成 - 异步等待DOM更新

      返回一个Promise,该Promise在组件完成下一次更新后resolve。 这对于需要确保DOM已经更新的操作非常有用。

      Returns Promise<void>

      在组件更新完成后resolve的Promise

    • 启动基础对话框 - 对话框显示的主要流程

      这是对话框显示的核心方法,处理完整的对话框生命周期:

      1. 设置对话框标题
      2. 将对话框添加到指定容器
      3. 记录当前鼠标位置
      4. 等待DOM更新完成
      5. 显示对话框
      6. 清理和恢复鼠标事件

      Parameters

      • e: any

      Returns Promise<void>

    • 触发鼠标移动事件 - 恢复鼠标状态

      在对话框关闭后,模拟一个鼠标移动事件来恢复画布的鼠标状态。 这确保了对话框关闭后,画布能够正确响应鼠标位置。

      Returns void

    • 显示基础对话框 - 显示模态对话框并等待关闭

      这个方法负责实际显示对话框并返回一个Promise, 该Promise在对话框关闭时resolve。这允许调用者 异步等待对话框的完成。

      Returns Promise<boolean>

      在对话框关闭时resolve为true的Promise

    • 关闭按钮点击回调 - 处理对话框关闭按钮点击

      当用户点击对话框右上角的关闭按钮时调用。 它会派发一个"escape"事件(表示用户取消操作), 然后关闭对话框。

      Returns void

    • 关闭对话框 - 程序化关闭对话框

      提供一个简单的方法来程序化地关闭对话框, 不派发任何额外的事件。

      Returns void

    • 打开对话框 - 程序化打开模态对话框

      提供一个简单的方法来程序化地打开对话框, 使用 HTML

      元素的 showModal() 方法。

      Returns void

    • 暂停对话框 - 临时关闭模态对话框,允许用户操作CAD界面

      使用场景:在对话框中需要让用户在CAD界面上选择实体或拾取点时调用。 暂停后对话框会关闭,用户可以与CAD界面交互。 交互完成后调用 resume() 恢复对话框。

      Returns void

      // 暂停对话框
      this.baseDialog?.suspend();

      // 让用户在CAD界面选择实体
      const result = await Engine.editor.getSelections(options);

      // 恢复对话框
      this.baseDialog?.resume();
    • 恢复对话框 - 重新以模态方式打开对话框

      在调用 suspend() 后,用户完成CAD界面交互后调用此方法恢复对话框。 对话框会恢复到暂停前的位置。

      Returns void

    • 清理拖拽状态 - 移除全局事件监听器

      在对话框关闭时调用,确保不会遗留全局事件监听器

      Returns void

    • 首次更新完成回调 - 在组件首次渲染后调用

      目前为空实现,可用于初始化透明度设置或其他配置。

      Returns void

    • 组件更新完成回调 - 在组件更新后设置焦点、选择文本并验证

      这个方法在组件每次更新完成后调用:

      1. 派发更新完成事件
      2. 设置输入框焦点
      3. 自动选中输入框中的文本
      4. 验证当前输入的透明度值

      Returns void

    • 启动透明度对话框 - 显示图层透明度设置对话框的主要方法

      这是图层透明度对话框组件的核心方法,负责完整的透明度设置对话框显示流程:

      1. 设置初始值和配置
      2. 将组件添加到对话框容器
      3. 等待DOM更新完成
      4. 启动基础对话框显示
      5. 清理并返回用户设置结果

      Parameters

      • e: string = "ByLayer"

        初始的透明度值,默认为"ByLayer"

      • i: boolean = !0

        是否禁用特殊透明度选项,默认为true

      Returns Promise<number>

      用户设置的透明度值结果

    • 确定按钮点击回调 - 处理用户点击确定按钮

      当用户点击确定按钮时,验证输入的透明度值, 如果有效则设置为结果并关闭对话框。

      Returns void

    • 取消按钮点击回调 - 处理用户点击取消按钮

      当用户点击取消按钮时,清空结果并关闭对话框。

      Returns void

    • 设置确定按钮禁用状态 - 控制确定按钮的可用性并更新视觉反馈

      根据透明度值的有效性来启用或禁用确定按钮, 同时更新信息显示区域的样式类来提供视觉反馈。

      Parameters

      • t: boolean

        是否禁用按钮

      Returns void

    • 透明度检查 - 验证透明度值的有效性

      检查输入的透明度值是否符合以下规则:

      1. 支持文本形式的特殊值(ByLayer、ByBlock)
      2. 支持数值形式的特殊值(-1、-2)
      3. 数值范围必须在0-90之间
      4. 根据配置决定是否允许特殊值

      Parameters

      • t: string

        要检查的透明度值

      Returns number

      有效的透明度值,无效时返回undefined

    • 设置信息显示 - 在信息区域显示提示信息

      更新信息显示元素的内容,用于向用户显示验证结果或提示信息。

      Parameters

      • t: string

        要显示的信息文本

      Returns void

    • ByLayer按钮回调 - 处理用户选择ByLayer透明度

      当用户点击ByLayer按钮时,设置结果为-1并关闭对话框。 -1表示使用图层的透明度设置。

      Returns void

    • ByBlock按钮回调 - 处理用户选择ByBlock透明度

      当用户点击ByBlock按钮时,设置结果为-2并关闭对话框。 -2表示使用块的透明度设置。

      Returns void

    • 输入框按键回调 - 处理输入框的按键事件

      当用户在输入框中按下Enter键时,验证透明度值, 如果有效则确认输入并关闭对话框。

      Parameters

      • t: any

        键盘事件对象

      Returns void

    • 输入框内容变化回调 - 验证用户输入的透明度值

      当用户在输入框中输入内容时,实时验证透明度值的有效性。

      Returns void

    • 渲染图层透明度对话框模板 - 定义图层透明度对话框的HTML结构

      返回图层透明度对话框的完整HTML模板,包括:

      1. 基础对话框容器
      2. 输入区域(标题、输入框、信息显示)
      3. 按钮操作区域(ByLayer、确定按钮)

      Returns any

      图层透明度对话框的HTML模板

    • Parameters

      • t: any
      • e: {
            attribute: boolean;
            type: StringConstructor;
            converter: {
                toAttribute(t: any, e: any): any;
                fromAttribute(t: any, e: any): any;
            };
            reflect: boolean;
            hasChanged: (t: any, e: any) => boolean;
        } = y

      Returns void

    • Parameters

      • t: any
      • e: any
      • s: any

      Returns { get(): any; set(e: any): void; configurable: boolean; enumerable: boolean }

    • Parameters

      • t: any
      • e: any

      Returns string

    • Parameters

      • t: any
      • e: any

      Returns void

    • Parameters

      • t: any
      • e: any

      Returns void

    • Parameters

      • Optionalt: any
      • Optionale: any
      • Optionals: any

      Returns void

    • Parameters

      • t: any
      • e: any
      • s: any

      Returns void

    • Returns Promise<boolean>

    • Parameters

      • t: any

      Returns void

    • Parameters

      • t: any

      Returns void