SpellCheckerSubtype
class SpellCheckerSubtype : Parcelable
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.
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 | |||||
---|---|---|---|---|---|
|
Public constructors | |
---|---|
SpellCheckerSubtype(nameId: Int, locale: String!, extraValue: String!) Constructor. |
Public methods | |
---|---|
Boolean |
containsExtraValueKey(key: String!) The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
Int | |
Boolean |
Indicates whether some other object is "equal to" this one. |
CharSequence! |
getDisplayName(context: Context!, packageName: String!, appInfo: ApplicationInfo!) |
String! | |
String! |
getExtraValueOf(key: String!) The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
String | |
String | |
Int | |
Int |
hashCode() |
Unit |
writeToParcel(dest: Parcel, parcelableFlags: Int) |
Properties | |
---|---|
static Parcelable.Creator<SpellCheckerSubtype!> |
XML attributes
android:label
android:label
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
android:languageTag
android.R.styleable#SpellChecker_Subtype_subtypeLocale
.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:subtypeExtraValue
android:subtypeExtraValue
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:subtypeId
android:subtypeId
Arrays.hashCode(new Object[] {subtypeLocale, extraValue})
will be used instead.
May be an integer value, such as "100
".
android:subtypeLocale
android:subtypeLocale
android.view.textservice.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;
Public constructors
SpellCheckerSubtype
SpellCheckerSubtype(
nameId: Int,
locale: String!,
extraValue: String!)
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.
Public methods
containsExtraValueKey
fun containsExtraValueKey(key: String!): Boolean
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 |
Return | |
---|---|
Boolean |
the subtype contains specified the extra value |
describeContents
fun describeContents(): Int
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
equals
fun equals(other: Any?): Boolean
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 | |
---|---|
obj |
the reference object with which to compare. |
o |
This value may be null . |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getDisplayName
fun getDisplayName(
context: Context!,
packageName: String!,
appInfo: ApplicationInfo!
): CharSequence!
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 |
Return | |
---|---|
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
fun getExtraValue(): String!
Return | |
---|---|
String! |
the extra value of the subtype |
getExtraValueOf
fun getExtraValueOf(key: String!): String!
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 |
Return | |
---|---|
String! |
the value of the specified key |
getLanguageTag
fun getLanguageTag(): String
Return | |
---|---|
String |
the BCP-47 Language Tag of the subtype. Returns an empty string when no Language Tag is specified. This value cannot be null . |
getLocale
fungetLocale(): String
Deprecated: Use getLanguageTag()
instead.
Return | |
---|---|
String |
the locale of the subtype This value cannot be null . |
writeToParcel
fun writeToParcel(
dest: Parcel,
parcelableFlags: Int
): Unit
Parameters | |
---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null . |
flags |
Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |