InputFilter: vad är det, InputFilter-gränssnittet och filtrering i Android

Vad är InputFilter och varför behövs det?

InputFilter är ett funktionellt gränssnitt från paketet android.text som definierar en enda metod filter(CharSequence source, int start, int end, Spanned dest, int dstart, int dend). Den anropas automatiskt varje gång användaren försöker skriva in, klistra in eller ersätta text i EditText. Returvärdet avgör om ändringen accepteras, avvisas eller ändras.

Huvudsyftet med InputFilter är att förhindra felaktig inmatning innan texten når fältet. Metoden filter tar emot sex parametrar. Om metoden returnerar null accepteras ändringen utan ändringar. Om en tom sträng “” returneras blockeras ändringen. InputFilter ändrar inte den ursprungliga datakällan, utan returnerar bara den filtrerade versionen.

Hur InputFilter fungerar

Till exempel, om användaren försöker mata in bokstaven “a” i ett fält där endast siffror är tillåtna, returnerar filtret “” och tecknet visas inte. InputFilter ändrar inte den ursprungliga datakällan, utan returnerar bara den filtrerade versionen.

Standardfilter i Android SDK

Android SDK tillhandahåller flera inbyggda InputFilter-implementeringar. Den vanligaste är InputFilter.LengthFilter som begränsar maximal textlängd. InputFilter.AllCaps omvandlar alla inmatade tecken till versaler.

Skapa en anpassad InputFilter

För att skapa ett anpassat filter måste du implementera InputFilter-gränssnittet och åsidosätta filtermetoden. DigitsInputFilter-exemplet går igenom alla tecken i den inmatade texten och behåller endast siffror.

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

Ett annat populärt scenario är ett filter som förbjuder specialtecken, som används i användarnamn, sökning och andra platser där specialtecken inte är tillåtna.

Tillämpa InputFilter på EditText

Filter ställs in på EditText via metoden setFilters(InputFilter[]). Filterarrayen ersätter de aktuella filtren. För att lägga till ett filter till befintliga filter måste du hämta de aktuella filtren via getFilters(), skapa en ny array och ställa tillbaka den.

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

I exemplet ställs två filter in: DigitsInputFilter (endast siffror) och LengthFilter (maximalt 10 tecken). Filter kan också ställas in via XML-attributet android:inputType.

InputFilter och inmatningsvalidering

InputFilter och TextWatcher har olika funktioner och används ofta tillsammans. InputFilter arbetar på inmatningsnivå, TextWatcher arbetar efter inmatning. Kombinationen av båda tillvägagångssätten ger bäst resultat.