SpellCheckerSubtype
public
final
class
SpellCheckerSubtype
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.view.textservice.SpellCheckerSubtype |
This class is used to specify meta information of a subtype contained in a spell checker. Subtype can describe locale (e.g. en_US, fr_FR...) used for settings.
See also:
Summary
XML attributes | |
---|---|
android:label |
The name of the subtype. |
android:languageTag |
The BCP-47 Language Tag of the subtype. |
android:subtypeExtraValue |
The extra value of the subtype. |
android:subtypeId |
The unique id for the subtype. |
android:subtypeLocale |
The locale of the subtype. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<SpellCheckerSubtype> |
CREATOR
|
Public constructors | |
---|---|
SpellCheckerSubtype(int nameId, String locale, String extraValue)
This constructor is deprecated.
There is no public API that requires developers to directly instantiate custom
|
Public methods | |
---|---|
boolean
|
containsExtraValueKey(String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
CharSequence
|
getDisplayName(Context context, String packageName, ApplicationInfo appInfo)
|
String
|
getExtraValue()
|
String
|
getExtraValueOf(String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
String
|
getLanguageTag()
|
String
|
getLocale()
This method was deprecated
in API level 24.
Use |
int
|
getNameResId()
|
int
|
hashCode()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int parcelableFlags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
XML attributes
android:label
The name of the subtype.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:languageTag
The BCP-47 Language Tag of the subtype. This replaces
SpellChecker_Subtype_subtypeLocale
.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:subtypeExtraValue
The extra value of the subtype. This string can be any string and will be passed to the SpellChecker.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:subtypeId
The unique id for the subtype. The text service (spell checker) framework keeps track
of enabled subtypes by ID. When the spell checker package gets upgraded, enabled IDs
will stay enabled even if other attributes are different. If the ID is unspecified or
explicitly specified to 0 in XML resources,
Arrays.hashCode(new Object[] {subtypeLocale, extraValue})
will be used instead.
May be an integer value, such as "100
".
android:subtypeLocale
The locale of the subtype. This string should be a locale (for example, en_US and
fr_FR). This is also used by the framework to know the supported locales
of the spell checker. SpellCheckerSubtype.getLocale()
returns the value specified in this attribute.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
Fields
Public constructors
SpellCheckerSubtype
public SpellCheckerSubtype (int nameId, String locale, String extraValue)
This constructor is deprecated.
There is no public API that requires developers to directly instantiate custom
SpellCheckerSubtype
objects right now. Hence only the system is expected to be able
to instantiate SpellCheckerSubtype
object.
Constructor.
Parameters | |
---|---|
nameId |
int : The name of the subtype |
locale |
String : The locale supported by the subtype |
extraValue |
String : The extra value of the subtype |
Public methods
containsExtraValueKey
public boolean containsExtraValueKey (String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4
Parameters | |
---|---|
key |
String : the key of extra value |
Returns | |
---|---|
boolean |
the subtype contains specified the extra value |
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
Parameters | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getDisplayName
public CharSequence getDisplayName (Context context, String packageName, ApplicationInfo appInfo)
Parameters | |
---|---|
context |
Context : Context will be used for getting Locale and PackageManager. |
packageName |
String : The package name of the spell checker |
appInfo |
ApplicationInfo : The application info of the spell checker |
Returns | |
---|---|
CharSequence |
a display name for this subtype. The string resource of the label (mSubtypeNameResId) can have only one %s in it. If there is, the %s part will be replaced with the locale's display name by the formatter. If there is not, this method simply returns the string specified by mSubtypeNameResId. If mSubtypeNameResId is not specified (== 0), it's up to the framework to generate an appropriate display name. |
getExtraValue
public String getExtraValue ()
Returns | |
---|---|
String |
the extra value of the subtype |
getExtraValueOf
public String getExtraValueOf (String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4
Parameters | |
---|---|
key |
String : the key of extra value |
Returns | |
---|---|
String |
the value of the specified key |
getLanguageTag
public String getLanguageTag ()
Returns | |
---|---|
String |
the BCP-47 Language Tag of the subtype. Returns an empty string when no Language Tag
is specified.
This value cannot be null . |
See also:
getLocale
public String getLocale ()
This method was deprecated
in API level 24.
Use getLanguageTag()
instead.
Returns | |
---|---|
String |
the locale of the subtype
This value cannot be null . |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns | |
---|---|
int |
a hash code value for this object. |
writeToParcel
public void writeToParcel (Parcel dest, int parcelableFlags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : The Parcel in which the object should be written.
This value cannot be null . |
parcelableFlags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.