TextAppearanceInfo
class TextAppearanceInfo : Parcelable
| kotlin.Any | |
| ↳ | android.view.inputmethod.TextAppearanceInfo |
Information about text appearance in an editor, passed through CursorAnchorInfo for use by InputMethodService.
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| String? |
Returns the font feature settings. |
| String? |
Returns the font variation settings. |
| Int |
Returns the color of the text selection highlight. |
| Int |
Returns the current color of the hint text. |
| Float |
Returns the text letter-spacing, which determines the spacing between characters. |
| Int |
Returns the line-break strategies for text wrapping. |
| Int |
Returns the line-break word strategies for text wrapping. |
| Int |
Returns the text color used to paint the links in the editor. |
| Int |
Returns the color of the text shadow. |
| Float |
Returns the horizontal offset (in pixels) of the text shadow. |
| Float |
Returns the vertical offset (in pixels) of the text shadow. |
| Float |
Returns the blur radius (in pixels) of the text shadow. |
| String? |
Returns the font family name if the |
| Int |
Returns the current text color of the editor. |
| Int |
Returns the weight of the text, or |
| LocaleList |
Returns the |
| Float |
Returns the extent by which text should be stretched horizontally. |
| Float |
Returns the text size (in pixels) for current editor. |
| Int |
Returns the style (normal, bold, italic, bold|italic) of the text. |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Returns whether the transformation method applied to the current editor is set to all caps. |
| Boolean |
Returns |
| Boolean |
Returns whether to expand linespacing based on fallback fonts. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<TextAppearanceInfo!> | |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
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
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons 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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getFontFeatureSettings
fun getFontFeatureSettings(): String?
Returns the font feature settings. Returns null if not specified.
getFontVariationSettings
fun getFontVariationSettings(): String?
Returns the font variation settings. Returns null if no variation is specified.
getHighlightTextColor
fun getHighlightTextColor(): Int
Returns the color of the text selection highlight.
getHintTextColor
fun getHintTextColor(): Int
Returns the current color of the hint text.
getLetterSpacing
fun getLetterSpacing(): Float
Returns the text letter-spacing, which determines the spacing between characters. The value is in 'EM' units. Normally, this value is 0.0.
getLineBreakStyle
fun getLineBreakStyle(): Int
Returns the line-break strategies for text wrapping.
getLineBreakWordStyle
fun getLineBreakWordStyle(): Int
Returns the line-break word strategies for text wrapping.
| Return | |
|---|---|
Int |
Value is one of the following: |
getLinkTextColor
fun getLinkTextColor(): Int
Returns the text color used to paint the links in the editor.
getShadowColor
fun getShadowColor(): Int
Returns the color of the text shadow.
getShadowDx
fun getShadowDx(): Float
Returns the horizontal offset (in pixels) of the text shadow.
The units of this value are pixels.
| Return | |
|---|---|
Float |
The units of this value are pixels. |
getShadowDy
fun getShadowDy(): Float
Returns the vertical offset (in pixels) of the text shadow.
The units of this value are pixels.
| Return | |
|---|---|
Float |
The units of this value are pixels. |
getShadowRadius
fun getShadowRadius(): Float
Returns the blur radius (in pixels) of the text shadow.
The units of this value are pixels.
| Return | |
|---|---|
Float |
The units of this value are pixels. |
getSystemFontFamilyName
fun getSystemFontFamilyName(): String?
Returns the font family name if the Typeface of the text is created from a system font family. Returns null if no Typeface is specified, or it is not created from a system font family.
getTextColor
fun getTextColor(): Int
Returns the current text color of the editor.
getTextFontWeight
fun getTextFontWeight(): Int
Returns the weight of the text, or FontStyle#FONT_WEIGHT_UNSPECIFIED when no Typeface is specified.
| Return | |
|---|---|
Int |
Value is between android.graphics.fonts.FontStyle#FONT_WEIGHT_UNSPECIFIED and android.graphics.fonts.FontStyle#FONT_WEIGHT_MAX inclusive |
getTextLocales
fun getTextLocales(): LocaleList
Returns the LocaleList of the text.
| Return | |
|---|---|
LocaleList |
This value cannot be null. |
getTextScaleX
fun getTextScaleX(): Float
Returns the extent by which text should be stretched horizontally. Returns 1.0 if not specified.
getTextSize
fun getTextSize(): Float
Returns the text size (in pixels) for current editor.
The units of this value are pixels.
| Return | |
|---|---|
Float |
The units of this value are pixels. |
getTextStyle
fun getTextStyle(): Int
Returns the style (normal, bold, italic, bold|italic) of the text. Returns Typeface.NORMAL when no Typeface is specified.
| Return | |
|---|---|
Int |
Value is one of the following: |
See Also
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isAllCaps
fun isAllCaps(): Boolean
Returns whether the transformation method applied to the current editor is set to all caps.
isElegantTextHeight
fun isElegantTextHeight(): Boolean
Returns true if the elegant height metrics flag is set. This setting selects font variants that have not been compacted to fit Latin-based vertical metrics, and also increases top and bottom bounds to provide more space.
isFallbackLineSpacing
fun isFallbackLineSpacing(): Boolean
Returns whether to expand linespacing based on fallback fonts.
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: 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 the following:
|