Added in API level 34

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 TextAppearanceInfo.

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

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 Typeface of the text is created from a system font family.

Int

Returns the current text color of the editor.

Int

Returns the weight of the text, or FontStyle#FONT_WEIGHT_UNSPECIFIED when no Typeface is specified.

LocaleList

Returns the LocaleList of the text.

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

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 true if the elegant height metrics flag is set.

Boolean

Returns whether to expand linespacing based on fallback fonts.

String

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

Added in API level 34
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

Added in API level 34
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.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getFontFeatureSettings

Added in API level 34
fun getFontFeatureSettings(): String?

Returns the font feature settings. Returns null if not specified.

getFontVariationSettings

Added in API level 34
fun getFontVariationSettings(): String?

Returns the font variation settings. Returns null if no variation is specified.

getHighlightTextColor

Added in API level 34
fun getHighlightTextColor(): Int

Returns the color of the text selection highlight.

getHintTextColor

Added in API level 34
fun getHintTextColor(): Int

Returns the current color of the hint text.

getLetterSpacing

Added in API level 34
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.

getLinkTextColor

Added in API level 34
fun getLinkTextColor(): Int

Returns the text color used to paint the links in the editor.

getShadowColor

Added in API level 34
fun getShadowColor(): Int

Returns the color of the text shadow.

getShadowDx

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
fun getTextColor(): Int

Returns the current text color of the editor.

getTextFontWeight

Added in API level 34
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

Added in API level 34
fun getTextLocales(): LocaleList

Returns the LocaleList of the text.

Return
LocaleList This value cannot be null.

getTextScaleX

Added in API level 34
fun getTextScaleX(): Float

Returns the extent by which text should be stretched horizontally. Returns 1.0 if not specified.

getTextSize

Added in API level 34
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

Added in API level 34
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:

hashCode

Added in API level 34
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 hashCode method must consistently return the same integer, provided no information used in equals 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 the hashCode 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 the hashCode 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.
Return
Int a hash code value for this object.

isAllCaps

Added in API level 34
fun isAllCaps(): Boolean

Returns whether the transformation method applied to the current editor is set to all caps.

isElegantTextHeight

Added in API level 34
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

Added in API level 34
fun isFallbackLineSpacing(): Boolean

Returns whether to expand linespacing based on fallback fonts.

toString

Added in API level 34
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 34
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:

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<TextAppearanceInfo!>