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 two Insets. |
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
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 |
Retrieves the maximum of two Insets. |
| static Insets |
Retrieves the minimum of two Insets. |
| static Insets |
Return an Insets instance with the appropriate values. |
| static Insets |
Return an Insets instance with the appropriate values. |
| static Insets |
Subtract two Insets. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(out: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<Insets!> | |
| static Insets | |
| Int | |
| Int | |
| Int | |
| Int | |
Public methods
add
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
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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
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. |
max
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
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
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. |
of
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. |
subtract
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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
out: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| 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 the following:
|