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
| Inherited constants |
From class Parcelable
Int |
CONTENTS_FILE_DESCRIPTOR
Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.
|
Int |
PARCELABLE_WRITE_RETURN_VALUE
Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.
|
|
| Public constructors |
|
Constructor.
|
| Public methods |
| Boolean |
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! |
|
| String! |
|
| String! |
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4
|
| String |
|
| String |
|
| Int |
|
| Int |
|
| Unit |
|
XML attributes
android:label
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:subtypeExtraValue
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
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
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.
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.
| 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
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
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 return true.
- It is symmetric: for any non-null reference values
x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
- It is transitive: for any non-null reference values
x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
- It is consistent: for any non-null reference values
x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
- For any non-null reference value
x, x.equals(null) should return false.
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. |
fun getExtraValue(): String!
| Return |
String! |
the extra value of the subtype |
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
fun getLocale(): String
Deprecated: Use getLanguageTag() instead.
| Return |
String |
the locale of the subtype This value cannot be null. |
getNameResId
fun getNameResId(): Int
| Return |
Int |
the name of the subtype |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
parcelableFlags: Int
): Unit
Properties
