Added in API level 29

Insets

class Insets : Parcelable
kotlin.Any
   ↳ android.graphics.Insets

An Insets instance holds four integer offsets which describe changes to the four edges of a Rectangle. By convention, positive values move edges towards the centre of the rectangle.

Insets are immutable so may be treated as values.

Summary

Inherited constants
Public methods
static Insets
add(a: Insets, b: Insets)

Add two Insets.

Int

Boolean
equals(other: Any?)

Two Insets instances are equal iff they belong to the same class and their fields are pairwise equal.

Int

static Insets
max(a: Insets, b: Insets)

Retrieves the maximum of two Insets.

static Insets
min(a: Insets, b: Insets)

Retrieves the minimum of two Insets.

static Insets
of(left: Int, top: Int, right: Int, bottom: Int)

Return an Insets instance with the appropriate values.

static Insets
of(r: Rect?)

Return an Insets instance with the appropriate values.

static Insets

Subtract two Insets.

String

Unit
writeToParcel(out: Parcel, flags: Int)

Properties
static Parcelable.Creator<Insets!>

static Insets

Int

Int

Int

Int

Public methods

add

Added in API level 29
static fun add(
    a: Insets,
    b: Insets
): Insets

Add two Insets.

Parameters
a Insets: The first Insets to add. This value cannot be null.
b Insets: The second Insets to add. This value cannot be null.
Return
Insets a + b, i. e. all insets on every side are added together. This value cannot be null.

describeContents

Added in API level 29
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 29
fun equals(other: Any?): Boolean

Two Insets instances are equal iff they belong to the same class and their fields are pairwise equal.

Parameters
obj the reference object with which to compare.
o the object to compare this instance with.
Return
Boolean true iff this object is equal o

hashCode

Added in API level 29
fun hashCode(): Int
Return
Int a hash code value for this object.

max

Added in API level 29
static fun max(
    a: Insets,
    b: Insets
): Insets

Retrieves the maximum of two Insets.

Parameters
a Insets: The first Insets. This value cannot be null.
b Insets: The second Insets. This value cannot be null.
Return
Insets max(a, b), i. e. the larger of every inset on every side is taken for the result. This value cannot be null.

min

Added in API level 29
static fun min(
    a: Insets,
    b: Insets
): Insets

Retrieves the minimum of two Insets.

Parameters
a Insets: The first Insets. This value cannot be null.
b Insets: The second Insets. This value cannot be null.
Return
Insets min(a, b), i. e. the smaller of every inset on every side is taken for the result. This value cannot be null.

of

Added in API level 29
static fun of(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Insets

Return an Insets instance with the appropriate values.

Parameters
left Int: the left inset
top Int: the top inset
right Int: the right inset
bottom Int: the bottom inset
Return
Insets Insets instance with the appropriate values This value cannot be null.

of

Added in API level 29
static fun of(r: Rect?): Insets

Return an Insets instance with the appropriate values.

Parameters
r Rect?: the rectangle from which to take the values This value may be null.
Return
Insets an Insets instance with the appropriate values This value cannot be null.

subtract

Added in API level 29
static fun subtract(
    a: Insets,
    b: Insets
): Insets

Subtract two Insets.

Parameters
a Insets: The minuend. This value cannot be null.
b Insets: The subtrahend. This value cannot be null.
Return
Insets a - b, i. e. all insets on every side are subtracted from each other. This value cannot be null.

toString

Added in API level 29
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 29
fun writeToParcel(
    out: Parcel,
    flags: Int
): Unit
Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 29
static val CREATOR: Parcelable.Creator<Insets!>

NONE

Added in API level 29
static val NONE: Insets

bottom

Added in API level 29
val bottom: Int

left

Added in API level 29
val left: Int
Added in API level 29
val right: Int

top

Added in API level 29
val top: Int