跳至主要内容

MaskedTextField

在 ChatGPT 中打开
阴影 dwc-textfield 24.10
Java API

MaskedTextField 组件提供了一个可配置的文本输入,强制执行格式规则和验证。它非常适合需要结构化输入的应用,如财务、电子商务和医疗保健系统。

基础

MaskedTextField 可以带参数或不带参数进行实例化。您可以定义初始值、标签、占位符文本和在值改变时的监听器。

MaskedTextField field = new MaskedTextField("账户 ID");
field.setMask("ZZZZ-0000")
.setHelperText("掩码: ZZZZ-0000 - 例如: SAVE-2025")

掩码规则

MaskedTextField 使用掩码格式化文本输入——一个定义每个位置允许哪些字符的字符串。这确保了像电话号码、邮政编码和身份证格式等的一致、结构化输入。

支持的掩码字符

字符描述
X任何可打印字符
a任何字母字符(大写或小写)
A任何字母字符;小写字母转换为大写
0任何数字(0-9)
z任何数字或字母(大写或小写)
Z任何数字或字母;小写字母转换为大写

掩码中的所有其他字符都被视为字面值,必须准确输入。 例如,像 XX@XX 这样的掩码要求用户在中间输入 @

  • 无效字符 被默默忽略。
  • 短输入 用空格填充。
  • 长输入 被截断以适应掩码。

示例

field.setMask("(000) 000-0000");     // 示例: (123) 456-7890
field.setMask("A00 000"); // 示例: A1B 2C3 (加拿大邮政编码)
field.setMask("ZZZZ-0000"); // 示例: ABCD-1234
field.setMask("0000-0000-0000-0000");// 示例: 1234-5678-9012-3456
允许完整输入

如果掩码仅包含 X,该字段的行为类似于标准的 TextField,允许任何可打印的输入。 这在您希望保留格式能力而不应用严格的字符规则时非常有用。

显示代码

验证模式

虽然掩码定义了输入的结构,您可以将其与验证模式结合使用,以强制执行更具体的输入规则。这为客户端验证添加了一层额外的正则表达式检查。

使用 setPattern() 方法应用自定义正则表达式:

field.setPattern("[A-Za-z0-9]{10}"); // 强制执行 10 字符的字母数字代码

这确保输入不仅匹配掩码,还符合定义的结构,例如长度或允许的字符。

这在以下情况下特别有用:

  • 掩码允许的灵活性过大
  • 您希望强制执行精确长度或特定格式(例如十六进制、Base64、UUID)
正则表达式格式

模式必须是有效的 JavaScript 正则表达式,如 RegExp 类型所用。更多详细信息可见 HTML 模式属性文档

恢复值

MaskedTextField 包含一个恢复功能,将字段的值重置为预定义或原始状态。 这对于撤销用户更改或恢复默认输入非常有用。

field.setRestoreValue("ABC123");
field.restoreValue();

恢复值的方法

  • 通过编程,调用 restoreValue()
  • 通过键盘,按 ESC(这是默认的恢复键,除非通过事件监听器覆盖)

您可以使用 setRestoreValue() 设置要恢复的值。如果没有设置恢复值,字段将在呈现时恢复为初始值。

显示代码

MaskedTextFieldSpinner

MaskedTextFieldSpinner 通过添加旋转控制来扩展 MaskedTextField,允许用户在预定义值列表中循环选择。 这改善了用户体验,适用于输入应限制为一组固定的有效选项的情况。

显示代码

关键功能

  • 选项列表支持
    使用 setOptions() 将旋转器填充为有效字符串值的列表:

    spinner.setOptions(List.of("选项 A", "选项 B", "选项 C"));
  • 编程旋转
    使用 spinUp()spinDown() 在选项之间移动:

    spinner.spinUp();   // 选择下一个选项
    spinner.spinDown(); // 选择上一个选项
  • 索引控制
    使用以下方式设置或检索当前选择索引:

    spinner.setOptionIndex(1);
    int current = spinner.getOptionIndex();
  • 掩码兼容性
    完全继承 MaskedTextField 的所有格式、掩码规则和模式验证。

样式

Loading...