[Android] EditTextに入力される文字数やパターンをInputFilterで制限する-Androidアプリ個人開発者の実践的アドバイス集

EditTextに入力される文字数やパターンの制限をするには、EditTextの`.filters`プロパティに制約を与えます。
  
## LengthFilterで入力文字数を制限

XMLでもビューに`android:maxLength="NUM"`を設定することで入力文字数制限の制約は設定できますが、他の制限もする場合には、プログラム内で記述する方が一貫性があって管理しやすく良いでしょう。
  
入力文字数制限には、`InputFilter.LengthFilter`メソッドを使います。これはEditTextのような入力フィールドに設定されるテキストの最大長を制限するためのフィルタです。指定された長さを超える場合、入力が制限されて追加の文字は入力されません。
  
## InputFilterと正規表現で入力パターンの制限をするカスタムフィルタの実装
  
カスタムフィルタを実装することで、特定の条件のみ入力を受け付ける、または特定の条件で入力を無効にすることができます。
  
具体的には、InputFilter インターフェースの filter メソッドを実装します。このメソッドは、入力されたテキストの一部をフィルタ処理する役割を持ちます。
  
このメソッドは以下のような引数を持ちます。

- `source`: 新しく入力されたテキストの一部分
- `start`: source 内のテキストの開始位置
- `end`: source 内のテキストの終了位置
- `dest`: 現在のテキストフィールドの内容
- `dstart`: dest 内の変更が開始される位置
- `dend`: dest 内の変更が終了する位置

以下にkotlinでのコード例を示します。この例では、入力されたテキストを取得し、テキストが条件にマッチする場合は入力を受け付け（nullを返します）、マッチしない場合は入力を無効にします。（空文字（""）を返します）

```kotlin
InputFilter { source, start, end, dest, dstart, dend ->
    val input = dest.subSequence(0, dstart).toString() + source.subSequence(start, end) +
                dest.subSequence(dend, dest.length).toString()
    if (input.matches("<何かのマッチ条件>".toRegex())) {
        null // accept input
    } else {
        "" // disable input
    }
}
```

`val input = dest...`の行の説明を補足すると、ここではEditTextなどのテキストフィールドへの入力が変更された場合に、現在のテキストフィールドの内容 (`dest`) と新しく入力されたテキスト (`source`) を結合して、最終的な入力結果を生成しています。

- `dest.subSequence(0, dstart)`: dest の先頭から dstart までの部分文字列を取得します。
- `source.subSequence(start, end)`: source の start から end までの部分文字列を取得します。
- `dest.subSequence(dend, dest.length)`: dest の dend から末尾までの部分文字列を取得します。

上記の3つの部分文字列を連結し、最終的な入力結果である input を生成します。

この処理により、テキストフィールドの特定の位置に挿入または削除が行われた場合でも、正しい入力結果が保持されます。

<br>
  
## EditTextに数値のみが入力され、かつ最初の文字が0で始まらないように制限されるカスタムフィルタ例
  
このカスタムフィルタは、以下の場合にのみ入力を受け付け、それ以外の場合は入力が無効になります。
- 入力されたテキストが数値（0-9）のみ
- かつ最初の文字が0で始まっていない

私の[日数計算アプリ](https://play.google.com/store/apps/details?id=io.github.hirotakatakayama.daychecker)の日数入力で活用しているkotlinコード例が以下のようになります。
  
5文字の入力文字数制限もかけているため、`mutableList`にフィルタの設定を追加し、最後にEditTextの.filtersプロパティに設定しています。

```kotlin
val filters = mutableListOf<InputFilter>()
filters.add(InputFilter.LengthFilter(5))
filters.add(InputFilter { source, start, end, dest, dstart, dend ->
    val input = dest.subSequence(0, dstart).toString() + source.subSequence(start, end) +
                dest.subSequence(dend, dest.length).toString()
    if (input.matches("^\\d*".toRegex()) && !input.matches("^0\\d.*".toRegex())) {
        null
    } else {
        ""
    }
})
EditText.filters = filters.toTypedArray()
```

[Android] EditTextに入力される文字数やパターンをInputFilterで制限する

0 件のコメント:

コメントを投稿

このブログを検索

ラベル

自己紹介

人気の投稿

不正行為を報告

リリースしたAndroidアプリ