Skip to content

Most visited

Recently visited

navigation
Added in API level 1

DigitsKeyListener

public class DigitsKeyListener
extends NumberKeyListener

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


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

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.

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

DigitsKeyListener

Added in API level 1
DigitsKeyListener ()

Allocates a DigitsKeyListener that accepts the digits 0 through 9.

DigitsKeyListener

Added in API level 1
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.

Parameters
sign boolean
decimal boolean

Public methods

filter

Added in API level 1
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. 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 CharSequence
start int
end int
dest Spanned
dstart int
dend int
Returns
CharSequence

getInputType

Added in API level 3
int getInputType ()

Returns
int

getInstance

Added in API level 1
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.

Parameters
sign boolean
decimal boolean
Returns
DigitsKeyListener

getInstance

Added in API level 1
DigitsKeyListener getInstance ()

Returns a DigitsKeyListener that accepts the digits 0 through 9.

Returns
DigitsKeyListener

getInstance

Added in API level 1
DigitsKeyListener getInstance (String accepted)

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 String
Returns
DigitsKeyListener

Protected methods

getAcceptedChars

Added in API level 1
char[] getAcceptedChars ()

You can say which characters you can accept.

Returns
char[]
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.