Added in API level 1
Deprecated in API level 35

PhoneNumberFormattingTextWatcher


open class PhoneNumberFormattingTextWatcher : TextWatcher
kotlin.Any
   ↳ android.telephony.PhoneNumberFormattingTextWatcher

Watches a android.widget.TextView and if a phone number is entered will format it.

Stop formatting when the user

  • Inputs non-dialable characters
  • Removes the separator in the middle of string.

The formatting will be restarted once the text is cleared.

Summary

Public constructors

The formatting is based on the current system locale and future locale changes may not take effect on this instance.

The formatting is based on the given countryCode.

Public methods
open Unit

This method is called to notify you that, somewhere within s, the text has been changed.

open Unit
beforeTextChanged(s: CharSequence!, start: Int, count: Int, after: Int)

This method is called to notify you that, within s, the count characters beginning at start are about to be replaced by new text with length after.

open Unit
onTextChanged(s: CharSequence!, start: Int, before: Int, count: Int)

This method is called to notify you that, within s, the count characters beginning at start have just replaced old text that had length before.

Public constructors

PhoneNumberFormattingTextWatcher

Added in API level 1
PhoneNumberFormattingTextWatcher()

The formatting is based on the current system locale and future locale changes may not take effect on this instance.

PhoneNumberFormattingTextWatcher

Added in API level 21
PhoneNumberFormattingTextWatcher(countryCode: String!)

The formatting is based on the given countryCode.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
countryCode String!: the ISO 3166-1 two-letter country code that indicates the country/region where the phone number is being entered.

Public methods

afterTextChanged

Added in API level 1
open fun afterTextChanged(s: Editable!): Unit

Deprecated: Deprecated in Java.

This method is called to notify you that, somewhere within s, the text has been changed. It is legitimate to make further changes to s from this callback, but be careful not to get yourself into an infinite loop, because any changes you make will cause this method to be called again recursively. (You are not told where the change took place because other afterTextChanged() methods may already have made other changes and invalidated the offsets. But if you need to know here, you can use Spannable.setSpan in onTextChanged to mark your place and then look up from here where the span ended up.

beforeTextChanged

Added in API level 1
open fun beforeTextChanged(
    s: CharSequence!,
    start: Int,
    count: Int,
    after: Int
): Unit

Deprecated: Deprecated in Java.

This method is called to notify you that, within s, the count characters beginning at start are about to be replaced by new text with length after. It is an error to attempt to make changes to s from this callback.

onTextChanged

Added in API level 1
open fun onTextChanged(
    s: CharSequence!,
    start: Int,
    before: Int,
    count: Int
): Unit

Deprecated: Deprecated in Java.

This method is called to notify you that, within s, the count characters beginning at start have just replaced old text that had length before. It is an error to attempt to make changes to s from this callback.