Android APIs
public class

DigitsKeyListener

extends NumberKeyListener
java.lang.Object
   ↳ android.text.method.MetaKeyKeyListener
     ↳ android.text.method.BaseKeyListener
       ↳ android.text.method.NumberKeyListener
         ↳ android.text.method.DigitsKeyListener

Class Overview

For digits-only text entry

As for all implementations of KeyListener, this class is only concerned with hardware keyboards. Software input methods have no obligation to trigger the methods in this class.

Summary

[Expand]
Inherited Constants
From class android.text.method.MetaKeyKeyListener
Public Constructors
DigitsKeyListener()
Allocates a DigitsKeyListener that accepts the digits 0 through 9.
DigitsKeyListener(boolean sign, boolean decimal)
Allocates a DigitsKeyListener that accepts the digits 0 through 9, plus the minus sign (only at the beginning) and/or decimal point (only one per field) if specified.
Public Methods
CharSequence filter(CharSequence source, int start, int end, Spanned dest, int dstart, int dend)
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.
int getInputType()
static DigitsKeyListener getInstance(boolean sign, boolean decimal)
Returns a DigitsKeyListener that accepts the digits 0 through 9, plus the minus sign (only at the beginning) and/or decimal point (only one per field) if specified.
static DigitsKeyListener getInstance()
Returns a DigitsKeyListener that accepts the digits 0 through 9.
static DigitsKeyListener getInstance(String accepted)
Returns a DigitsKeyListener that accepts only the characters that appear in the specified String.
Protected Methods
char[] getAcceptedChars()
You can say which characters you can accept.
[Expand]
Inherited Methods
From class android.text.method.NumberKeyListener
From class android.text.method.BaseKeyListener
From class android.text.method.MetaKeyKeyListener
From class java.lang.Object
From interface android.text.InputFilter
From interface android.text.method.KeyListener

Public Constructors

public DigitsKeyListener ()

Added in API level 1

Allocates a DigitsKeyListener that accepts the digits 0 through 9.

public DigitsKeyListener (boolean sign, boolean decimal)

Added in API level 1

Allocates a DigitsKeyListener that accepts the digits 0 through 9, plus the minus sign (only at the beginning) and/or decimal point (only one per field) if specified.

Parameters
sign
decimal

Public Methods

public CharSequence filter (CharSequence source, int start, int end, Spanned dest, int dstart, int dend)

Added in API level 1

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). copySpansFrom(Spanned, int, int, Class, Spannable, int) can be used for convenience.

Parameters
source
start
end
dest
dstart
dend
Returns
CharSequence

public int getInputType ()

Added in API level 3

Returns
int

public static DigitsKeyListener getInstance (boolean sign, boolean decimal)

Added in API level 1

Returns a DigitsKeyListener that accepts the digits 0 through 9, plus the minus sign (only at the beginning) and/or decimal point (only one per field) if specified.

Parameters
sign
decimal
Returns
DigitsKeyListener

public static DigitsKeyListener getInstance ()

Added in API level 1

Returns a DigitsKeyListener that accepts the digits 0 through 9.

Returns
DigitsKeyListener

public static DigitsKeyListener getInstance (String accepted)

Added in API level 1

Returns a DigitsKeyListener that accepts only the characters that appear in the specified String. Note that not all characters may be available on every keyboard.

Parameters
accepted
Returns
DigitsKeyListener

Protected Methods

protected char[] getAcceptedChars ()

Added in API level 1

You can say which characters you can accept.

Returns
char[]