FontVariationAxis


public final class FontVariationAxis
extends Object

java.lang.Object
   ↳ android.graphics.fonts.FontVariationAxis


Class that holds information about single font variation axis.

Summary

Public constructors

FontVariationAxis(String tagString, float styleValue)

Construct FontVariationAxis.

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

static FontVariationAxis[] fromFontVariationSettings(String settings)

Construct FontVariationAxis array from font variation settings.

float getStyleValue()

Returns the style value associated to the given axis for this font.

String getTag()

Returns the variable font axis tag associated to this axis.

int hashCode()

Returns a hash code value for the object.

static String toFontVariationSettings(FontVariationAxis[] axes)

Stringify the array of FontVariationAxis.

String toString()

Returns a valid font variation setting string for this object.

Inherited methods

Public constructors

FontVariationAxis

Added in API level 26
public FontVariationAxis (String tagString, 
                float styleValue)

Construct FontVariationAxis. The axis tag must contain four ASCII characters. Tag string that are longer or shorter than four characters, or contains characters outside of U+0020..U+007E are invalid.

Parameters
tagString String: This value cannot be null.

styleValue float

Throws
IllegalArgumentException If given tag string is invalid.

Public methods

equals

Added in API level 26
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: This value may be null.

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

fromFontVariationSettings

Added in API level 26
public static FontVariationAxis[] fromFontVariationSettings (String settings)

Construct FontVariationAxis array from font variation settings. The settings string is constructed from multiple pairs of axis tag and style values. The axis tag must contain four ASCII characters and must be wrapped with single quotes (U+0027) or double quotes (U+0022). Axis strings that are longer or shorter than four characters, or contain characters outside of U+0020..U+007E are invalid. If a specified axis name is not defined in the font, the settings will be ignored.

   FontVariationAxis.fromFontVariationSettings("'wdth' 1.0");
   FontVariationAxis.fromFontVariationSettings("'AX  ' 1.0, 'FB  ' 2.0");
 

Parameters
settings String: font variation settings. This value may be null.

Returns
FontVariationAxis[] FontVariationAxis[] the array of parsed font variation axis. null if settings has no font variation settings.

Throws
IllegalArgumentException If given string is not a valid font variation settings format.

getStyleValue

Added in API level 26
public float getStyleValue ()

Returns the style value associated to the given axis for this font.

Returns
float

getTag

Added in API level 26
public String getTag ()

Returns the variable font axis tag associated to this axis.

Returns
String

hashCode

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

toFontVariationSettings

Added in API level 26
public static String toFontVariationSettings (FontVariationAxis[] axes)

Stringify the array of FontVariationAxis.

Parameters
axes FontVariationAxis: an array of FontVariationAxis. This value may be null.

Returns
String String a valid font variation settings string. This value cannot be null.

toString

Added in API level 26
public String toString ()

Returns a valid font variation setting string for this object.

Returns
String This value cannot be null.