Added in API level 1

InputFilter


interface InputFilter
android.text.InputFilter

InputFilters can be attached to Editables to constrain the changes that can be made to them.

Summary

Nested classes
open

This filter will capitalize all the lowercase and titlecase letters that are added through edits.

open

This filter will constrain edits not to make the length of the text greater than the specified length.

Public methods
abstract CharSequence!
filter(source: CharSequence!, start: Int, end: Int, dest: Spanned!, dstart: Int, dend: Int)

This method is called when the buffer is going to replace the range dstart … dend of dest with the new text from the range start … end of source.

Public methods

filter

Added in API level 1
abstract fun filter(
    source: CharSequence!,
    start: Int,
    end: Int,
    dest: Spanned!,
    dstart: Int,
    dend: Int
): CharSequence!

This method is called when the buffer is going to replace the range dstart … dend of dest with the new text from the range start … end of source. Return the CharSequence that you would like to have placed there instead, including an empty string if appropriate, or null to accept the original replacement. Be careful to not to reject 0-length replacements, as this is what happens when you delete text. Also beware that you should not attempt to make any changes to dest from this method; you may only examine it for context. Note: If source is an instance of Spanned or Spannable, the span objects in the source should be copied into the filtered result (i.e. the non-null return value). TextUtils#copySpansFrom can be used for convenience if the span boundary indices would be remaining identical relative to the source.