FormatEditText 项目教程

FormatEditText 项目教程

FormatEditText格式化输入框，可用来格式化数字、金额、号码等; FormatEditText can be used as a formatted text input box项目地址:https://gitcode.com/gh_mirrors/fo/FormatEditText

1. 项目介绍

FormatEditText 是一个用于 Android 的开源库，旨在提供自动格式化输入文本的功能。它扩展了 AppCompatEditText，能够实时自动格式化日期、信用卡号码、电话号码等内容。对于更复杂的格式化需求，用户可以创建自己的 MaskingInputFilter。

2. 项目快速启动

安装步骤

1. 添加 JitPack 仓库：在项目的 build.gradle 文件中添加 JitPack 仓库。

   allprojects {
       repositories {
           maven { url 'https://jitpack.io' }
       }
   }
   

2. 添加依赖：在应用的 build.gradle 文件中添加 FormatEditText 依赖。

   dependencies {
       implementation 'com.github.dkzwm:FormatEditText:1.0.2-beta'
   }
   

使用示例

在布局文件中使用 FormatEditText：

<com.dkzwm.widget.FormatEditText
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:text="@[viewModel.formattedText]"
    app:onFormattedTextChanged="@[viewModel::onFormattedTextChanged]"
    app:onUnformattedValueChanged="@[viewModel::onUnformattedValueChanged]"
    app:inputMask="##/##/####"
    app:inputMaskPlaceholder="#" />

在代码中设置监听器：

FormatEditText formatEditText = findViewById(R.id.formatEditText);
formatEditText.setOnFormattedTextChangedListener(new FormatEditText.OnFormattedTextChangedListener() {
    @Override
    public void onFormattedTextChanged(String formattedText) {
        // 处理格式化后的文本变化
    }
});

formatEditText.setOnUnformattedValueChangedListener(new FormatEditText.OnUnformattedValueChangedListener() {
    @Override
    public void onUnformattedValueChanged(String unformattedValue) {
        // 处理未格式化的原始文本变化
    }
});

3. 应用案例和最佳实践

案例1：日期格式化

假设你需要用户输入日期，并希望自动格式化为 MM/DD/YYYY 格式：

<com.dkzwm.widget.FormatEditText
    android:id="@+id/dateEditText"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:inputMask="##/##/####"
    app:inputMaskPlaceholder="#" />

案例2：信用卡号码格式化

假设你需要用户输入信用卡号码，并希望自动格式化为 XXXX-XXXX-XXXX-XXXX 格式：

<com.dkzwm.widget.FormatEditText
    android:id="@+id/creditCardEditText"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:inputMask="####-####-####-####"
    app:inputMaskPlaceholder="#" />

最佳实践

• 自定义格式化：对于复杂的格式化需求，可以创建自定义的 MaskingInputFilter。
• 实时反馈：通过监听 onFormattedTextChanged 和 onUnformattedValueChanged，可以实时获取格式化和未格式化的文本，便于进行进一步处理。

4. 典型生态项目

• AutoFormatEditText：一个扩展自 AppCompatEditText 的组件，用于处理自动实时格式化内容。
• MaskingInputFilter：用于创建自定义输入过滤器的工具类，适用于更复杂的格式化需求。

通过这些模块的组合，FormatEditText 能够满足各种输入格式化的需求，提升用户体验。

FormatEditText格式化输入框，可用来格式化数字、金额、号码等; FormatEditText can be used as a formatted text input box项目地址:https://gitcode.com/gh_mirrors/fo/FormatEditText