Stay organized with collections Save and categorize content based on your preferences.

TextAppearanceInfo

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.

Summary

Nested classes

class TextAppearanceInfo.Builder

Builder for TextAppearanceInfo

Inherited constants

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

Fields

CREATOR

public static final Creator<TextAppearanceInfo> CREATOR

Public methods

describeContents

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

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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

public String getFontFeatureSettings ()

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

Returns
String

getFontVariationSettings

public String getFontVariationSettings ()

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

Returns
String

getHighlightTextColor

public int getHighlightTextColor ()

Returns the color of the text selection highlight.

Returns
int

getHintTextColor

public int getHintTextColor ()

Returns the current color of the hint text.

Returns
int

getLetterSpacing

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

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, or LineBreakConfig.LINE_BREAK_STYLE_STRICT

getLineBreakWordStyle

public int getLineBreakWordStyle ()

Returns the line-break word strategies for text wrapping.

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

getLinkTextColor

public int getLinkTextColor ()

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

Returns
int

getShadowColor

public int getShadowColor ()

Returns the color of the text shadow.

Returns
int

getShadowDx

public float getShadowDx ()

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

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

getShadowDy

public float getShadowDy ()

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

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

getShadowRadius

public float getShadowRadius ()

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

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

getSystemFontFamilyName

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

getTextColor

public int getTextColor ()

Returns the current text color of the editor.

Returns
int

getTextFontWeight

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

public LocaleList getTextLocales ()

Returns the LocaleList of the text.

Returns
LocaleList This value cannot be null.

getTextScaleX

public float getTextScaleX ()

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

Returns
float

getTextSize

public float getTextSize ()

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

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

getTextStyle

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:

hashCode

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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
int a hash code value for this object.

isAllCaps

public boolean isAllCaps ()

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

Returns
boolean

isElegantTextHeight

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

isFallbackLineSpacing

public boolean isFallbackLineSpacing ()

Returns whether to expand linespacing based on fallback fonts.

Returns
boolean

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

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