InputFilter: wat is het, de InputFilter-interface en filtering in Android

Wat is InputFilter en waarvoor dient het?

InputFilter is een functionele interface uit het android.text-pakket die één methode filter(CharSequence source, int start, int end, Spanned dest, int dstart, int dend) definieert. Deze wordt automatisch aangeroepen telkens wanneer de gebruiker tekst probeert in te voeren, te plakken of te vervangen in EditText. De retourwaarde bepaalt of de wijziging wordt geaccepteerd, geweigerd of gewijzigd.

Het belangrijkste doel van InputFilter is het voorkomen van onjuiste invoer voordat de tekst in het veld terechtkomt. Methode filter ontvangt zes parameters. Als de methode null retourneert, wordt de wijziging zonder wijzigingen geaccepteerd. Als een lege string „“ wordt geretourneerd, wordt de wijziging geblokkeerd. InputFilter wijzigt de oorspronkelijke gegevensbron niet, maar retourneert alleen de gefilterde versie.

Hoe InputFilter werkt

Als de gebruiker bijvoorbeeld probeert de letter „a“ in te voeren in een veld waar alleen cijfers zijn toegestaan, retourneert de filter „“ en verschijnt het teken niet. InputFilter wijzigt de oorspronkelijke gegevensbron niet, maar retourneert alleen de gefilterde versie. Android past de geretourneerde waarde zelf toe op Editable.

Standaardfilters in Android SDK

Android SDK biedt verschillende ingebouwde InputFilter-implementaties. De meest voorkomende is InputFilter.LengthFilter, die de maximale tekstlengte beperkt. InputFilter.AllCaps converteert alle ingevoerde tekens naar hoofdletters.

Een aangepaste InputFilter maken

Om een aangepaste filter te maken, moet u de InputFilter-interface implementeren en de filtermethode overschrijven. Het DigitsInputFilter-voorbeeld doorloopt alle tekens van de ingevoerde tekst en behoudt alleen cijfers.

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

Een ander populair scenario is een filter dat speciale tekens verbiedt, gebruikt in gebruikersnaamvelden, zoekopdrachten en andere plaatsen waar speciale tekens niet zijn toegestaan.

InputFilter toepassen op EditText

Filters worden op EditText ingesteld via de methode setFilters(InputFilter[]). De filterarray vervangt de huidige filters. Om een filter aan bestaande filters toe te voegen, moet u de huidige filters ophalen via getFilters(), een nieuwe array maken en deze terugzetten.

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

In het voorbeeld worden twee filters ingesteld: DigitsInputFilter (alleen cijfers) en LengthFilter (maximaal 10 tekens). Filters kunnen ook worden ingesteld via het XML-attribuut android:inputType.

InputFilter en invoervalidatie

InputFilter en TextWatcher hebben verschillende functies en worden vaak samen gebruikt. InputFilter werkt op invoerniveau, TextWatcher werkt na invoer. De combinatie van beide benaderingen geeft het beste resultaat.