InputFilter: apa itu, antarmuka InputFilter dan penyaringan di Android

Apa itu InputFilter dan untuk apa?

InputFilter adalah antarmuka fungsional dari paket android.text yang mendefinisikan satu metode filter(CharSequence source, int start, int end, Spanned dest, int dstart, int dend). Metode ini dipanggil secara otomatis setiap kali pengguna mencoba memasukkan, menempelkan, atau mengganti teks di EditText. Nilai yang dikembalikan menentukan apakah perubahan akan diterima, ditolak, atau dimodifikasi.

Tujuan utama InputFilter adalah mencegah masukan yang salah sebelum teks masuk ke kolom. Metode filter menerima enam parameter. Jika metode mengembalikan null, perubahan diterima tanpa perubahan. Jika mengembalikan string kosong “”, perubahan diblokir. InputFilter tidak mengubah sumber data asli, hanya mengembalikan versi yang difilter.

Cara kerja InputFilter

Misalnya, jika pengguna mencoba memasukkan huruf “a” ke kolom yang hanya mengizinkan angka, filter mengembalikan “” dan karakter tidak muncul. Jika memasukkan “123”, filter dapat mengembalikan “1-2-3” dengan menambahkan pemisah. InputFilter tidak mengubah sumber data asli, hanya mengembalikan versi yang difilter.

Filter standar di Android SDK

Android SDK menyediakan beberapa implementasi bawaan InputFilter. Yang paling umum adalah InputFilter.LengthFilter yang membatasi panjang maksimum teks. InputFilter.AllCaps mengonversi semua karakter yang dimasukkan menjadi huruf kapital.

Membuat InputFilter kustom

Untuk membuat filter kustom, Anda perlu mengimplementasikan antarmuka InputFilter dan menimpa metode filter. Contoh filter DigitsInputFilter melewati semua karakter teks yang dimasukkan dan hanya menyisakan angka.

class DigitsInputFilter : InputFilter {
    override fun filter(
        source: CharSequence?,
        start: Int,
        end: Int,
        dest: Spanned?,
        dstart: Int,
        dend: Int
    ): CharSequence? {
        val sb = StringBuilder()
        for (i in start until end) {
            val c = source?.get(i)
            if (c != null && Character.isDigit(c)) {
                sb.append(c)
            }
        }
        return if (sb.length == end - start) null else sb
    }
}

Skenario populer lainnya adalah filter yang melarang karakter khusus, digunakan di kolom nama pengguna, pencarian, dan tempat lain di mana karakter khusus tidak diizinkan.

Menerapkan InputFilter ke EditText

Filter diatur pada EditText melalui metode setFilters(InputFilter[]). Array filter menggantikan filter saat ini. Untuk menambahkan filter ke filter yang ada, ambil filter saat ini melalui getFilters(), buat array baru, dan atur kembali.

val editText = findViewById<EditText>(R.id.phone_input)
editText.filters = arrayOf(
    DigitsInputFilter(),
    InputFilter.LengthFilter(10)
)

Dalam contoh, dua filter diatur: DigitsInputFilter (hanya angka) dan LengthFilter (maksimum 10 karakter). Filter juga dapat diatur melalui atribut XML android:inputType.

InputFilter dan validasi masukan

InputFilter dan TextWatcher memiliki fungsi berbeda dan sering digunakan bersama. InputFilter bekerja pada tingkat masukan, TextWatcher bekerja setelah masukan. Kombinasi kedua pendekatan memberikan hasil terbaik.