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 ofKeyListener
, this class is only concerned
with hardware keyboards. Software input methods have no obligation to trigger
the methods in this class.
Summary
Inherited constants |
---|
Public constructors | |
---|---|
DigitsKeyListener()
This constructor is deprecated.
Use |
|
DigitsKeyListener(boolean sign, boolean decimal)
This constructor is deprecated.
Use |
|
DigitsKeyListener(Locale locale)
|
|
DigitsKeyListener(Locale locale, boolean sign, boolean decimal)
|
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 |
int
|
getInputType()
Returns the input type for the listener. |
static
DigitsKeyListener
|
getInstance(String accepted)
Returns a DigitsKeyListener that accepts only the characters that appear in the specified String. |
static
DigitsKeyListener
|
getInstance()
This method was deprecated
in API level 26.
Use |
static
DigitsKeyListener
|
getInstance(Locale locale)
Returns a DigitsKeyListener that accepts the locale-appropriate digits. |
static
DigitsKeyListener
|
getInstance(Locale locale, boolean sign, boolean decimal)
Returns a DigitsKeyListener that accepts the locale-appropriate digits, plus the locale-appropriate plus or minus sign (only at the beginning) and/or the locale-appropriate decimal separator (only one per field) if specified. |
static
DigitsKeyListener
|
getInstance(boolean sign, boolean decimal)
This method was deprecated
in API level 26.
Use |
Protected methods | |
---|---|
char[]
|
getAcceptedChars()
You can say which characters you can accept. |
Inherited methods | |
---|---|
Public constructors
DigitsKeyListener
public DigitsKeyListener ()
This constructor is deprecated.
Use DigitsKeyListener(java.util.Locale)
instead.
Allocates a DigitsKeyListener that accepts the ASCII digits 0 through 9.
DigitsKeyListener
public DigitsKeyListener (boolean sign, boolean decimal)
This constructor is deprecated.
Use DigitsKeyListener(java.util.Locale, boolean, boolean)
instead.
Allocates a DigitsKeyListener that accepts the ASCII digits 0 through 9, plus the ASCII plus or minus sign (only at the beginning) and/or the ASCII period ('.') as the decimal point (only one per field) if specified.
Parameters | |
---|---|
sign |
boolean |
decimal |
boolean |
DigitsKeyListener
public DigitsKeyListener (Locale locale)
Parameters | |
---|---|
locale |
Locale : This value may be null . |
DigitsKeyListener
public DigitsKeyListener (Locale locale, boolean sign, boolean decimal)
Parameters | |
---|---|
locale |
Locale : This value may be null . |
sign |
boolean |
decimal |
boolean |
Public methods
filter
public 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).
TextUtils#copySpansFrom
can be used for convenience if the
span boundary indices would be remaining identical relative to the source.
Parameters | |
---|---|
source |
CharSequence |
start |
int |
end |
int |
dest |
Spanned |
dstart |
int |
dend |
int |
Returns | |
---|---|
CharSequence |
getInputType
public int getInputType ()
Returns the input type for the listener.
Returns | |
---|---|
int |
getInstance
public static 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 : This value cannot be null . |
Returns | |
---|---|
DigitsKeyListener |
This value cannot be null . |
getInstance
public static DigitsKeyListener getInstance ()
This method was deprecated
in API level 26.
Use getInstance(java.util.Locale)
instead.
Returns a DigitsKeyListener that accepts the ASCII digits 0 through 9.
Returns | |
---|---|
DigitsKeyListener |
This value cannot be null . |
getInstance
public static DigitsKeyListener getInstance (Locale locale)
Returns a DigitsKeyListener that accepts the locale-appropriate digits.
Parameters | |
---|---|
locale |
Locale : This value may be null . |
Returns | |
---|---|
DigitsKeyListener |
This value cannot be null . |
getInstance
public static DigitsKeyListener getInstance (Locale locale, boolean sign, boolean decimal)
Returns a DigitsKeyListener that accepts the locale-appropriate digits, plus the locale-appropriate plus or minus sign (only at the beginning) and/or the locale-appropriate decimal separator (only one per field) if specified.
Parameters | |
---|---|
locale |
Locale : This value may be null . |
sign |
boolean |
decimal |
boolean |
Returns | |
---|---|
DigitsKeyListener |
This value cannot be null . |
getInstance
public static DigitsKeyListener getInstance (boolean sign, boolean decimal)
This method was deprecated
in API level 26.
Use getInstance(java.util.Locale, boolean, boolean)
instead.
Returns a DigitsKeyListener that accepts the ASCII digits 0 through 9, plus the ASCII plus or minus sign (only at the beginning) and/or the ASCII period ('.') as the decimal point (only one per field) if specified.
Parameters | |
---|---|
sign |
boolean |
decimal |
boolean |
Returns | |
---|---|
DigitsKeyListener |
This value cannot be null . |
Protected methods
getAcceptedChars
protected char[] getAcceptedChars ()
You can say which characters you can accept.
Returns | |
---|---|
char[] |
This value cannot be null . |