Added in API level 1

FontMetricsInt


open class FontMetricsInt
kotlin.Any
   ↳ android.graphics.Paint.FontMetricsInt

Convenience method for callers that want to have FontMetrics values as integers.

Summary

Public constructors

Public methods
open Boolean
equals(other: Any?)

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

open Int

Returns a hash code value for the object.

open Unit
set(fontMetrics: Paint.FontMetrics)

Set values from FontMetrics with rounding accordingly.

open Unit
set(fontMetricsInt: Paint.FontMetricsInt)

Set values from FontMetricsInt.

open String

Returns a string representation of the object.

Properties
Int

The recommended distance above the baseline for singled spaced text.

Int

The maximum distance below the baseline for the lowest glyph in the font at a given text size.

Int

The recommended distance below the baseline for singled spaced text.

Int

The recommended additional space to add between lines of text.

Int

The maximum distance above the baseline for the tallest glyph in the font at a given text size.

Public constructors

FontMetricsInt

FontMetricsInt()

Public methods

equals

Added in API level 1
open 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 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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 1
open 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 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.
Return
Int a hash code value for this object.

set

Added in API level 35
open fun set(fontMetrics: Paint.FontMetrics): Unit

Set values from FontMetrics with rounding accordingly.

Parameters
fontMetrics Paint.FontMetrics: a font metrics.
This value cannot be null.

set

Added in API level 35
open fun set(fontMetricsInt: Paint.FontMetricsInt): Unit

Set values from FontMetricsInt.

Parameters
fontMetricsInt Paint.FontMetricsInt: a font metrics.
This value cannot be null.

toString

Added in API level 1
open fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

Properties

ascent

Added in API level 1
var ascent: Int

The recommended distance above the baseline for singled spaced text.

bottom

Added in API level 1
var bottom: Int

The maximum distance below the baseline for the lowest glyph in the font at a given text size.

descent

Added in API level 1
var descent: Int

The recommended distance below the baseline for singled spaced text.

leading

Added in API level 1
var leading: Int

The recommended additional space to add between lines of text.

top

Added in API level 1
var top: Int

The maximum distance above the baseline for the tallest glyph in the font at a given text size.