Most visited

Recently visited

Results for

Summary: Ctors | Methods | Inherited Methods

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

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

FontVariationAxis

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

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`: This value may be `null`.

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

fromFontVariationSettings

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

public float getStyleValue ()

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

Returns
`float`

getTag

public String getTag ()

Returns the variable font axis tag associated to this axis.

Returns
`String`

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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

toFontVariationSettings

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

public String toString ()

Returns a valid font variation setting string for this object.

Returns
`String`	This value cannot be `null`.