Added in API level 34

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

TextAppearanceInfo

---

Kotlin |Java

public final class TextAppearanceInfo
extends Object implements Parcelable

java.lang.Object
↳	android.view.inputmethod.TextAppearanceInfo

---

Information about text appearance in an editor, passed through CursorAnchorInfo for use by InputMethodService.

See also:

• TextView
• Paint
• CursorAnchorInfo.Builder.setTextAppearanceInfo(TextAppearanceInfo)
• CursorAnchorInfo.getTextAppearanceInfo()

Summary

Nested classes
class	TextAppearanceInfo.Builder Builder for TextAppearanceInfo.

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<TextAppearanceInfo>	CREATOR

Public methods
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.
String	getFontFeatureSettings() Returns the font feature settings.
String	getFontVariationSettings() Returns the font variation settings.
int	getHighlightTextColor() Returns the color of the text selection highlight.
int	getHintTextColor() Returns the current color of the hint text.
float	getLetterSpacing() Returns the text letter-spacing, which determines the spacing between characters.
int	getLineBreakStyle() Returns the line-break strategies for text wrapping.
int	getLineBreakWordStyle() Returns the line-break word strategies for text wrapping.
int	getLinkTextColor() Returns the text color used to paint the links in the editor.
int	getShadowColor() Returns the color of the text shadow.
float	getShadowDx() Returns the horizontal offset (in pixels) of the text shadow.
float	getShadowDy() Returns the vertical offset (in pixels) of the text shadow.
float	getShadowRadius() Returns the blur radius (in pixels) of the text shadow.
String	getSystemFontFamilyName() Returns the font family name if the Typeface of the text is created from a system font family.
int	getTextColor() Returns the current text color of the editor.
int	getTextFontWeight() Returns the weight of the text, or FontStyle#FONT_WEIGHT_UNSPECIFIED when no Typeface is specified.
LocaleList	getTextLocales() Returns the LocaleList of the text.
float	getTextScaleX() Returns the extent by which text should be stretched horizontally.
float	getTextSize() Returns the text size (in pixels) for current editor.
int	getTextStyle() Returns the style (normal, bold, italic, bold|italic) of the text.
int	hashCode() Returns a hash code value for the object.
boolean	isAllCaps() Returns whether the transformation method applied to the current editor is set to all caps.
boolean	isElegantTextHeight() Returns true if the elegant height metrics flag is set.
boolean	isFallbackLineSpacing() Returns whether to expand linespacing based on fallback fonts.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34

public static final Creator<TextAppearanceInfo> CREATOR

Public methods

describeContents

Added in API level 34

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

Added in API level 34

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 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
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getFontFeatureSettings

Added in API level 34

public String getFontFeatureSettings ()

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

Returns
String

See also:

• Paint.getFontFeatureSettings()

getFontVariationSettings

Added in API level 34

public String getFontVariationSettings ()

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

Returns
String

See also:

• Paint.getFontVariationSettings()

getHighlightTextColor

Added in API level 34

public int getHighlightTextColor ()

Returns the color of the text selection highlight.

Returns
int

See also:

• TextView.getHighlightColor()

getHintTextColor

Added in API level 34

public int getHintTextColor ()

Returns the current color of the hint text.

Returns
int

See also:

• TextView.getCurrentHintTextColor()

getLetterSpacing

Added in API level 34

public float getLetterSpacing ()

Returns the text letter-spacing, which determines the spacing between characters. The value is in 'EM' units. Normally, this value is 0.0.

Returns
float

getLineBreakStyle

Added in API level 34

public int getLineBreakStyle ()

Returns the line-break strategies for text wrapping.

Returns
int	Value is LineBreakConfig.LINE_BREAK_STYLE_NONE, LineBreakConfig.LINE_BREAK_STYLE_LOOSE, LineBreakConfig.LINE_BREAK_STYLE_NORMAL, LineBreakConfig.LINE_BREAK_STYLE_STRICT, LineBreakConfig.LINE_BREAK_STYLE_UNSPECIFIED, LineBreakConfig.LINE_BREAK_STYLE_NO_BREAK, or LineBreakConfig.LINE_BREAK_STYLE_AUTO

See also:

• TextView.setLineBreakStyle(int)

getLineBreakWordStyle

Added in API level 34

public int getLineBreakWordStyle ()

Returns the line-break word strategies for text wrapping.

Returns
int	Value is LineBreakConfig.LINE_BREAK_WORD_STYLE_NONE, LineBreakConfig.LINE_BREAK_WORD_STYLE_PHRASE, LineBreakConfig.LINE_BREAK_WORD_STYLE_UNSPECIFIED, or LineBreakConfig.LINE_BREAK_WORD_STYLE_AUTO

See also:

• TextView.setLineBreakWordStyle(int)

getLinkTextColor

Added in API level 34

public int getLinkTextColor ()

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

Returns
int

See also:

• TextView.getLinkTextColors()

getShadowColor

Added in API level 34

public int getShadowColor ()

Returns the color of the text shadow.

Returns
int

See also:

• Paint.setShadowLayer(float, float, float, int)

getShadowDx

Added in API level 34

public float getShadowDx ()

Returns the horizontal offset (in pixels) of the text shadow.
The units of this value are pixels.

Returns
float	The units of this value are pixels. {}

See also:

• Paint.setShadowLayer(float, float, float, int)

getShadowDy

Added in API level 34

public float getShadowDy ()

Returns the vertical offset (in pixels) of the text shadow.
The units of this value are pixels.

Returns
float	The units of this value are pixels. {}

See also:

• Paint.setShadowLayer(float, float, float, int)

getShadowRadius

Added in API level 34

public float getShadowRadius ()

Returns the blur radius (in pixels) of the text shadow.
The units of this value are pixels.

Returns
float	The units of this value are pixels. {}

See also:

• Paint.setShadowLayer(float, float, float, int)

getSystemFontFamilyName

Added in API level 34

public String getSystemFontFamilyName ()

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.

Returns
String

See also:

• Typeface.getSystemFontFamilyName()

getTextColor

Added in API level 34

public int getTextColor ()

Returns the current text color of the editor.

Returns
int

See also:

• TextView.getCurrentTextColor()

getTextFontWeight

Added in API level 34

public int getTextFontWeight ()

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

Returns
int	Value is between FontStyle.FONT_WEIGHT_UNSPECIFIED and FontStyle.FONT_WEIGHT_MAX inclusive

getTextLocales

Added in API level 34

public LocaleList getTextLocales ()

Returns the LocaleList of the text.

Returns
LocaleList	This value cannot be null.

getTextScaleX

Added in API level 34

public float getTextScaleX ()

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

Returns
float

getTextSize

Added in API level 34

public float getTextSize ()

Returns the text size (in pixels) for current editor.
The units of this value are pixels.

Returns
float	The units of this value are pixels. {}

getTextStyle

Added in API level 34

public int getTextStyle ()

Returns the style (normal, bold, italic, bold|italic) of the text. Returns Typeface.NORMAL when no Typeface is specified.

Returns
int	Value is Typeface.NORMAL, Typeface.BOLD, Typeface.ITALIC, or Typeface.BOLD_ITALIC

See also:

• Typeface

hashCode

Added in API level 34

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

Returns
int	a hash code value for this object.

isAllCaps

Added in API level 34

public boolean isAllCaps ()

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

Returns
boolean

See also:

• TextView.setAllCaps(boolean)
• TextView.setTransformationMethod(TransformationMethod)

isElegantTextHeight

Added in API level 34

public boolean isElegantTextHeight ()

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.

Returns
boolean

See also:

• Paint.isElegantTextHeight()

isFallbackLineSpacing

Added in API level 34

public boolean isFallbackLineSpacing ()

Returns whether to expand linespacing based on fallback fonts.

Returns
boolean

See also:

• TextView.setFallbackLineSpacing(boolean)

toString

Added in API level 34

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES