Added in API level 29

Summary: Inherited Constants | Fields | Methods | Inherited Methods

Insets

Kotlin |Java

public final class Insets
extends Object implements Parcelable

java.lang.Object
↳	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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<Insets>`	`CREATOR`
`public static final Insets`	`NONE`
`public final int`	`bottom`
`public final int`	`left`
`public final int`	`right`
`public final int`	`top`

Public methods
`static Insets`	`add(Insets a, Insets b)` Add two Insets.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Two Insets instances are equal iff they belong to the same class and their fields are pairwise equal.
`int`	`hashCode()` Returns a hash code value for the object.
`static Insets`	`max(Insets a, Insets b)` Retrieves the maximum of two Insets.
`static Insets`	`min(Insets a, Insets b)` Retrieves the minimum of two Insets.
`static Insets`	`of(int left, int top, int right, int bottom)` Return an Insets instance with the appropriate values.
`static Insets`	`of(Rect r)` Return an Insets instance with the appropriate values.
`static Insets`	`subtract(Insets a, Insets b)` Subtract two Insets.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 29

public static final Creator<Insets> CREATOR

NONE

Added in API level 29

public static final Insets NONE

bottom

Added in API level 29

public final int bottom

left

Added in API level 29

public final int left

right

Added in API level 29

public final int right

top

Added in API level 29

public final int top

Public methods

add

Added in API level 29

public static Insets add (Insets a, 
                Insets b)

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`.

Returns
`Insets`	a + b, i. e. all insets on every side are added together. This value cannot be `null`.

describeContents

Added in API level 29

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 29

public boolean equals (Object o)

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

Parameters
`o`	`Object`: the object to compare this instance with.

Returns
`boolean`	true iff this object is equal `o`

hashCode

Added in API level 29

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.

max

Added in API level 29

public static Insets max (Insets a, 
                Insets b)

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`.

Returns
`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

public static Insets min (Insets a, 
                Insets b)

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`.

Returns
`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

public static Insets of (int left, 
                int top, 
                int right, 
                int bottom)

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

Returns
`Insets`	Insets instance with the appropriate values This value cannot be `null`.

of

Added in API level 29

public static Insets of (Rect r)

Return an Insets instance with the appropriate values.

Parameters
`r`	`Rect`: the rectangle from which to take the values This value may be `null`.

Returns
`Insets`	an Insets instance with the appropriate values This value cannot be `null`.

subtract

Added in API level 29

public static Insets subtract (Insets a, 
                Insets b)

Subtract two Insets.

Parameters
`a`	`Insets`: The minuend. This value cannot be `null`.
`b`	`Insets`: The subtrahend. This value cannot be `null`.

Returns
`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

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 29

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`out`	`Parcel`: 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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES