InputFilter: co to je, rozhraní InputFilter a filtrování v Androidu

Co je InputFilter a k čemu slouží?

InputFilter je funkční rozhraní z balíčku android.text, které definuje jedinou metodu filter(CharSequence source, int start, int end, Spanned dest, int dstart, int dend). Je voláno automaticky pokaždé, když se uživatel pokusí zadat, vložit nebo nahradit text v EditText. Návratová hodnota určuje, zda bude změna přijata, odmítnuta nebo upravena.

Hlavním účelem InputFilter je zabránění nesprávnému vstupu před tím, než se text dostane do pole. Metoda filter přijímá šest parametrů. Pokud metoda vrátí null, změna je přijata beze změn. Pokud vrátí prázdný řetězec „“, změna je blokována. InputFilter nemění původní zdroj dat, pouze vrací filtrovanou verzi.

Jak InputFilter funguje

Například, pokud se uživatel pokusí vložit písmeno „a“ do pole, kde jsou povoleny pouze číslice, filtr vrátí „“ a znak se neobjeví. InputFilter nemění původní zdroj dat, pouze vrací filtrovanou verzi.

Standardní filtry v Android SDK

Android SDK poskytuje několik vestavěných implementací InputFilter. Nejrozšířenější je InputFilter.LengthFilter, který omezuje maximální délku textu. InputFilter.AllCaps převádí všechny zadávané znaky na velká písmena.

Vytvoření vlastního InputFilter

Pro vytvoření vlastního filtru je třeba implementovat rozhraní InputFilter a přepsat metodu filter. Příklad filtru DigitsInputFilter prochází všechny znaky zadávaného textu a ponechává pouze číslice.

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
    }
}

Dalším oblíbeným scénářem je filtr zakazující speciální znaky, používaný v polích uživatelského jména, vyhledávání a dalších místech, kde speciální znaky nejsou povoleny.

Použití InputFilter na EditText

Filtry se nastavují na EditText pomocí metody setFilters(InputFilter[]). Pole filtrů nahrazuje aktuální filtry. Pro přidání filtru k existujícím je třeba získat aktuální filtry přes getFilters(), vytvořit nové pole a nastavit jej zpět.

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

V příkladu jsou nastaveny dva filtry: DigitsInputFilter (pouze číslice) a LengthFilter (maximálně 10 znaků). Filtry lze také nastavit pomocí XML atributu android:inputType.

InputFilter a validace vstupu

InputFilter a TextWatcher mají různé funkce a často se používají společně. InputFilter pracuje na úrovni vstupu, TextWatcher pracuje po vstupu. Kombinace obou přístupů dává nejlepší výsledek.