to top

Added in API level 1

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
? Examples	DigitsKeyListener() Allocates a DigitsKeyListener that accepts the digits 0 through 9.
? Examples	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
? Examples	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`.
? Examples	int	getInputType()
? Examples	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.
? Examples	static DigitsKeyListener	getInstance() Returns a DigitsKeyListener that accepts the digits 0 through 9.
? Examples	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

static long	adjustMetaAfterKeypress(long state) Call this method after you handle a keypress so that the meta state will be reset to unshifted (if it is not still down) or primed to be reset to unshifted (once it is released).
static void	adjustMetaAfterKeypress( Spannable content) Call this method after you handle a keypress so that the meta state will be reset to unshifted (if it is not still down) or primed to be reset to unshifted (once it is released).
static void	clearMetaKeyState( Editable content, int states)
void	clearMetaKeyState( View view, Editable content, int states)
long	clearMetaKeyState(long state, int which) Clears the state of the specified meta key if it is locked.
final static int	getMetaState( CharSequence text) Gets the state of the meta keys.
final static int	getMetaState(long state, int meta) Gets the state of a particular meta key.
final static int	getMetaState(long state) Gets the state of the meta keys.
final static int	getMetaState( CharSequence text, int meta) Gets the state of a particular meta key.
static long	handleKeyDown(long state, int keyCode, KeyEvent event) Handles presses of the meta keys.
static long	handleKeyUp(long state, int keyCode, KeyEvent event) Handles release of the meta keys.
static boolean	isMetaTracker( CharSequence text, Object what) Returns true if this object is one that this class would use to keep track of any meta state in the specified text.
static boolean	isSelectingMetaTracker( CharSequence text, Object what) Returns true if this object is one that this class would use to keep track of the selecting meta state in the specified text.
boolean	onKeyDown( View view, Editable content, int keyCode, KeyEvent event) Handles presses of the meta keys.
boolean	onKeyUp( View view, Editable content, int keyCode, KeyEvent event) Handles release of the meta keys.
static void	resetLockedMeta( Spannable content) Call this if you are a method that ignores the locked meta state (arrow keys, for example) and you handle a key.
static long	resetLockedMeta(long state) Call this if you are a method that ignores the locked meta state (arrow keys, for example) and you handle a key.
static void	resetMetaState( Spannable text) Resets all meta state to inactive.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.text.InputFilter

From interface android.text.method.KeyListener

abstract void	clearMetaKeyState( View view, Editable content, int states) Remove the given shift states from the edited text.
abstract int	getInputType() Return the type of text that this key listener is manipulating, as per `InputType`.
abstract boolean	onKeyDown( View view, Editable text, int keyCode, KeyEvent event) If the key listener wants to handle this key, return true, otherwise return false and the caller (i.e.
abstract boolean	onKeyOther( View view, Editable text, KeyEvent event) If the key listener wants to other kinds of key events, return true, otherwise return false and the caller (i.e.
abstract boolean	onKeyUp( View view, Editable text, int keyCode, KeyEvent event) If the key listener wants to handle this key release, return true, otherwise return false and the caller (i.e.

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.

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.

public int getInputType ()

Added in API level 3

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.

public static DigitsKeyListener getInstance ()

Added in API level 1

Returns a DigitsKeyListener that accepts the digits 0 through 9.

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.

Protected Methods

protected char[] getAcceptedChars ()

Added in API level 1

You can say which characters you can accept.

Results

Interfaces

Classes

Enums

DigitsKeyListener

Class Overview

Summary

Public Constructors

public DigitsKeyListener ()

public DigitsKeyListener (boolean sign, boolean decimal)

Public Methods

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

public int getInputType ()

public static DigitsKeyListener getInstance (boolean sign, boolean decimal)

public static DigitsKeyListener getInstance ()

public static DigitsKeyListener getInstance (String accepted)

Protected Methods

protected char[] getAcceptedChars ()