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

    Class CommandLine

    完整命令行界面组件类 - 整合历史记录和提示符的完整命令行界面

    这个组件是CAD系统命令行界面的主要组件,整合了历史记录显示和命令输入功能。 提供完整的命令行交互体验,包括自动完成、焦点管理、消息显示等。

    主要功能:

    1. 整合历史记录和提示符组件
    2. 管理命令行的整体状态
    3. 处理自动完成功能
    4. 管理焦点和用户交互
    5. 提供消息显示和历史记录管理
    6. 支持占位符文本设置

    CommandLine

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    styles: r = ...

    定义组件样式 - 使用 Lit 官方推荐的静态属性写法

    DEFAULT_PLACEHOLDER: string
    historyEle: HistoryEle = null
    promptEle: PromptEle = null
    renderRoot: any

    Accessors

    • get observedAttributes(): any[]

      Returns any[]

    • get updateComplete(): any

      Returns any

    Methods

    • 添加自动完成组件

      将自动完成组件添加到Shadow DOM中,并初始隐藏

      Parameters

      • autoCompleteElement: any

        自动完成组件元素

      Returns void

    • 组件连接到DOM时的回调 在组件被添加到DOM时调用

      Returns void

    • 组件更新时的回调

      Parameters

      • changedProperties: Map<PropertyKey, unknown>

        更新的属性映射

      Returns void

    • 首次更新完成后的回调 查询DOM元素(替代装饰器方式)

      Returns void

    • 设置焦点到命令行输入框

      先移除当前焦点,然后将焦点设置到提示符输入框

      Returns void

    • 将当前命令行内容写入历史记录

      获取提示符的完整内容并添加到历史记录中

      Returns void

    • 刷新提示符

      重置提示符状态并设置默认占位符文本

      Returns void

    • 清空提示符输入内容

      Returns void

    • 在历史记录中显示取消文本

      Returns void

    • 滚动历史记录到底部

      Returns void

    • 写入消息到历史记录

      智能处理消息格式,避免重复的换行符

      Parameters

      • message: string

        要写入的消息内容

      Returns void

    • 清空历史记录

      Returns void

    • 设置提示符文本

      Parameters

      • captionText: string

        新的提示符文本

      Returns void

    • 获取当前提示符文本

      Returns string

      当前的提示符文本,如果不存在则返回空字符串

    • 输入事件回调函数 当前为空实现,预留用于处理输入事件

      Returns void

    • 清空占位符文本

      Returns void

    • 设置默认占位符文本

      Returns void

    • 设置自定义占位符文本

      Parameters

      • placeholderText: string

        占位符文本内容

      Returns void

    • 渲染组件的HTML模板

      创建包含历史记录和提示符的完整命令行界面结构。 使用网格布局将历史记录区域和提示符区域分开。

      Returns { _$litType$: any; strings: any; values: any[] }

      HTML模板结果

    • Parameters

      • t: any

      Returns void

    • 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

      Returns any

    • Returns void

    • Returns void

    • Parameters

      • t: any

      Returns any[]

    • Parameters

      • t: any
      • e: any

      Returns string

    • Returns void

    • Parameters

      • t: any

      Returns void

    • Parameters

      • t: any

      Returns void

    • Returns void

    • Parameters

      • t: any

      Returns void

    • Parameters

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

      Returns void

    • 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

    • Returns void

    • Parameters

      • t: any

      Returns boolean

    • Parameters

      • t: any

      Returns void

    • Returns ShadowRoot