FontVariationAxis
class FontVariationAxis
| kotlin.Any | |
| ↳ | android.graphics.fonts.FontVariationAxis |
Class that holds information about single font variation axis.
Summary
| Public constructors | |
|---|---|
FontVariationAxis(tagString: String, styleValue: Float)Construct FontVariationAxis. |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| static Array<FontVariationAxis!>? |
fromFontVariationSettings(settings: String?)Construct FontVariationAxis array from font variation settings. |
| Float |
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(axes: Array<FontVariationAxis!>?)Stringify the array of FontVariationAxis. |
| String |
toString()Returns a valid font variation setting string for this object. |
Public constructors
FontVariationAxis
FontVariationAxis(
tagString: String,
styleValue: Float)
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. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
If given tag string is invalid. |
Public methods
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. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
fromFontVariationSettings
static fun fromFontVariationSettings(settings: String?): Array<FontVariationAxis!>?
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. |
| Return | |
|---|---|
Array<FontVariationAxis!>? |
FontVariationAxis[] the array of parsed font variation axis. null if settings has no font variation settings. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
If given string is not a valid font variation settings format. |
getStyleValue
fun getStyleValue(): Float
Returns the style value associated to the given axis for this font.
getTag
fun getTag(): String!
Returns the variable font axis tag associated to this axis.
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. |
toFontVariationSettings
static fun toFontVariationSettings(axes: Array<FontVariationAxis!>?): String
Stringify the array of FontVariationAxis.
| Parameters | |
|---|---|
axes |
Array<FontVariationAxis!>?: an array of FontVariationAxis. This value may be null. |
| Return | |
|---|---|
String |
String a valid font variation settings string. This value cannot be null. |
toString
fun toString(): String
Returns a valid font variation setting string for this object.
| Return | |
|---|---|
String |
This value cannot be null. |