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

    Class MessageBoxComponent

    消息框组件类 - 用于显示确认、警告等消息对话框

    这个类继承自基础对话框组件,专门用于显示需要用户确认的消息。 它提供了标准的"是/否/取消"按钮组合,并处理用户的选择结果。

    主要功能:

    1. 显示消息内容和确认按钮
    2. 处理用户的选择(是/否/取消)
    3. 支持键盘快捷键操作
    4. 返回用户的选择结果

    MessageBox

    Hierarchy (View Summary)

    Index

    Constructors

    • 构造函数 - 初始化消息框组件

      调用父类构造函数并初始化消息框特有的属性:

      • result: 用户选择的结果("yes"/"no"/undefined)
      • message: 要显示的消息内容

      Returns MessageBoxComponent

    Properties

    styles: r = ...

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

    properties: {
        dialogTitle: { type: StringConstructor };
        draggable: { type: BooleanConstructor };
    } = ...

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

    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
    result: string
    message: string
    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

    • 组件更新完成回调 - 在组件DOM更新后触发

      重写父类的updated方法,在消息框组件更新完成后 派发"updated"事件通知外部。

      Returns void

    • "是"按钮点击回调 - 处理确认操作

      当用户点击"是"按钮时,设置结果为"yes"并关闭对话框。 这表示用户确认了操作。

      Returns void

    • "是"按钮键盘事件回调 - 处理空格键确认

      当"是"按钮获得焦点时,用户按下空格键也可以触发确认操作。 这提供了更好的键盘可访问性。

      Parameters

      • e: KeyboardEvent

        键盘事件对象

      Returns void

    • "否"按钮点击回调 - 处理拒绝操作

      当用户点击"否"按钮时,设置结果为"no"并关闭对话框。 这表示用户拒绝了操作。

      Returns void

    • "取消"按钮点击回调 - 处理取消操作

      当用户点击"取消"按钮时,设置结果为undefined并关闭对话框。 这表示用户取消了操作,不做任何改变。

      Returns void

    • 显示消息框 - 消息框的主要显示方法

      这是消息框组件的核心方法,负责完整的消息框显示流程:

      1. 设置消息内容
      2. 将组件添加到对话框容器
      3. 等待DOM更新并设置消息文本
      4. 启动基础对话框显示
      5. 清理并返回用户选择结果

      Parameters

      • e: any

      Returns Promise<string>

      用户选择结果:"yes"/"no"/undefined

    • 键盘按键事件回调 - 处理键盘快捷键

      支持以下键盘快捷键:

      • S键或Y键:相当于点击"是"按钮
      • N键:相当于点击"否"按钮

      这提供了更快速的用户交互方式。

      Parameters

      • e: KeyboardEvent

        键盘事件对象

      Returns Promise<void>

    • 初始化键盘事件 - 预留的键盘事件初始化方法

      这个方法目前为空,可能用于未来扩展键盘事件的初始化逻辑。

      Returns void

    • 渲染消息框模板 - 定义消息框的HTML结构

      返回消息框的HTML模板,包括:

      1. 基础对话框容器
      2. 消息显示区域
      3. 按钮操作区域(保存、不保存、取消)

      注意:模板中包含键盘事件监听,支持快捷键操作。

      Returns { _$litType$: any; strings: any; values: 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