Android APIs
public final class

Rect

extends Object
implements Parcelable
java.lang.Object
   ↳ android.graphics.Rect

Class Overview

Rect holds four integer coordinates for a rectangle. The rectangle is represented by the coordinates of its 4 edges (left, top, right bottom). These fields can be accessed directly. Use width() and height() to retrieve the rectangle's width and height. Note: most methods do not check to see that the coordinates are sorted correctly (i.e. left <= right and top <= bottom).

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<Rect> CREATOR
public int bottom
public int left
public int right
public int top
Public Constructors
Rect()
Create a new empty Rect.
Rect(int left, int top, int right, int bottom)
Create a new rectangle with the specified coordinates.
Rect(Rect r)
Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
Public Methods
final int centerX()
final int centerY()
boolean contains(int x, int y)
Returns true if (x,y) is inside the rectangle.
boolean contains(int left, int top, int right, int bottom)
Returns true iff the 4 specified sides of a rectangle are inside or equal to this rectangle.
boolean contains(Rect r)
Returns true iff the specified rectangle r is inside or equal to this rectangle.
int describeContents()
Parcelable interface methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
final float exactCenterX()
final float exactCenterY()
String flattenToString()
Return a string representation of the rectangle in a well-defined format.
int hashCode()
Returns an integer hash code for this object.
final int height()
void inset(int dx, int dy)
Inset the rectangle by (dx,dy).
boolean intersect(Rect r)
If the specified rectangle intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
boolean intersect(int left, int top, int right, int bottom)
If the rectangle specified by left,top,right,bottom intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
boolean intersects(int left, int top, int right, int bottom)
Returns true if this rectangle intersects the specified rectangle.
static boolean intersects(Rect a, Rect b)
Returns true iff the two specified rectangles intersect.
final boolean isEmpty()
Returns true if the rectangle is empty (left >= right or top >= bottom)
void offset(int dx, int dy)
Offset the rectangle by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.
void offsetTo(int newLeft, int newTop)
Offset the rectangle to a specific (left, top) position, keeping its width and height the same.
void readFromParcel(Parcel in)
Set the rectangle's coordinates from the data stored in the specified parcel.
void set(int left, int top, int right, int bottom)
Set the rectangle's coordinates to the specified values.
void set(Rect src)
Copy the coordinates from src into this rectangle.
void setEmpty()
Set the rectangle to (0,0,0,0)
boolean setIntersect(Rect a, Rect b)
If rectangles a and b intersect, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
void sort()
Swap top/bottom or left/right if there are flipped (i.e.
String toShortString()
Return a string representation of the rectangle in a compact form.
String toString()
Returns a string containing a concise, human-readable description of this object.
static Rect unflattenFromString(String str)
Returns a Rect from a string of the form returned by flattenToString(), or null if the string is not of that form.
void union(int left, int top, int right, int bottom)
Update this Rect to enclose itself and the specified rectangle.
void union(Rect r)
Update this Rect to enclose itself and the specified rectangle.
void union(int x, int y)
Update this Rect to enclose itself and the [x,y] coordinate.
final int width()
void writeToParcel(Parcel out, int flags)
Write this rectangle to the specified parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<Rect> CREATOR

Added in API level 1

public int bottom

Added in API level 1

public int left

Added in API level 1

public int right

Added in API level 1

public int top

Added in API level 1

Public Constructors

public Rect ()

Added in API level 1

Create a new empty Rect. All coordinates are initialized to 0.

public Rect (int left, int top, int right, int bottom)

Added in API level 1

Create a new rectangle with the specified coordinates. Note: no range checking is performed, so the caller must ensure that left <= right and top <= bottom.

Parameters
left int: The X coordinate of the left side of the rectangle
top int: The Y coordinate of the top of the rectangle
right int: The X coordinate of the right side of the rectangle
bottom int: The Y coordinate of the bottom of the rectangle

public Rect (Rect r)

Added in API level 1

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters
r Rect: The rectangle whose coordinates are copied into the new rectangle.

Public Methods

public final int centerX ()

Added in API level 1

Returns
int the horizontal center of the rectangle. If the computed value is fractional, this method returns the largest integer that is less than the computed value.

public final int centerY ()

Added in API level 1

Returns
int the vertical center of the rectangle. If the computed value is fractional, this method returns the largest integer that is less than the computed value.

public boolean contains (int x, int y)

Added in API level 1

Returns true if (x,y) is inside the rectangle. The left and top are considered to be inside, while the right and bottom are not. This means that for a x,y to be contained: left <= x < right and top <= y < bottom. An empty rectangle never contains any point.

Parameters
x int: The X coordinate of the point being tested for containment
y int: The Y coordinate of the point being tested for containment
Returns
boolean true iff (x,y) are contained by the rectangle, where containment means left <= x < right and top <= y < bottom

public boolean contains (int left, int top, int right, int bottom)

Added in API level 1

Returns true iff the 4 specified sides of a rectangle are inside or equal to this rectangle. i.e. is this rectangle a superset of the specified rectangle. An empty rectangle never contains another rectangle.

Parameters
left int: The left side of the rectangle being tested for containment
top int: The top of the rectangle being tested for containment
right int: The right side of the rectangle being tested for containment
bottom int: The bottom of the rectangle being tested for containment
Returns
boolean true iff the the 4 specified sides of a rectangle are inside or equal to this rectangle

public boolean contains (Rect r)

Added in API level 1

Returns true iff the specified rectangle r is inside or equal to this rectangle. An empty rectangle never contains another rectangle.

Parameters
r Rect: The rectangle being tested for containment.
Returns
boolean true iff the specified rectangle r is inside or equal to this rectangle

public int describeContents ()

Added in API level 1

Parcelable interface methods

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public final float exactCenterX ()

Added in API level 1

Returns
float the exact horizontal center of the rectangle as a float.

public final float exactCenterY ()

Added in API level 1

Returns
float the exact vertical center of the rectangle as a float.

public String flattenToString ()

Added in API level 7

Return a string representation of the rectangle in a well-defined format.

You can later recover the Rect from this string through unflattenFromString(String).

Returns
String Returns a new String of the form "left top right bottom"

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public final int height ()

Added in API level 1

Returns
int the rectangle's height. This does not check for a valid rectangle (i.e. top <= bottom) so the result may be negative.

public void inset (int dx, int dy)

Added in API level 1

Inset the rectangle by (dx,dy). If dx is positive, then the sides are moved inwards, making the rectangle narrower. If dx is negative, then the sides are moved outwards, making the rectangle wider. The same holds true for dy and the top and bottom.

Parameters
dx int: The amount to add(subtract) from the rectangle's left(right)
dy int: The amount to add(subtract) from the rectangle's top(bottom)

public boolean intersect (Rect r)

Added in API level 1

If the specified rectangle intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. To just test for intersection, use intersects()

Parameters
r Rect: The rectangle being intersected with this rectangle.
Returns
boolean true if the specified rectangle and this rectangle intersect (and this rectangle is then set to that intersection) else return false and do not change this rectangle.

public boolean intersect (int left, int top, int right, int bottom)

Added in API level 1

If the rectangle specified by left,top,right,bottom intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. Note: To just test for intersection, use intersects(Rect, Rect).

Parameters
left int: The left side of the rectangle being intersected with this rectangle
top int: The top of the rectangle being intersected with this rectangle
right int: The right side of the rectangle being intersected with this rectangle.
bottom int: The bottom of the rectangle being intersected with this rectangle.
Returns
boolean true if the specified rectangle and this rectangle intersect (and this rectangle is then set to that intersection) else return false and do not change this rectangle.

public boolean intersects (int left, int top, int right, int bottom)

Added in API level 1

Returns true if this rectangle intersects the specified rectangle. In no event is this rectangle modified. No check is performed to see if either rectangle is empty. To record the intersection, use intersect() or setIntersect().

Parameters
left int: The left side of the rectangle being tested for intersection
top int: The top of the rectangle being tested for intersection
right int: The right side of the rectangle being tested for intersection
bottom int: The bottom of the rectangle being tested for intersection
Returns
boolean true iff the specified rectangle intersects this rectangle. In no event is this rectangle modified.

public static boolean intersects (Rect a, Rect b)

Added in API level 1

Returns true iff the two specified rectangles intersect. In no event are either of the rectangles modified. To record the intersection, use intersect(Rect) or setIntersect(Rect, Rect).

Parameters
a Rect: The first rectangle being tested for intersection
b Rect: The second rectangle being tested for intersection
Returns
boolean true iff the two specified rectangles intersect. In no event are either of the rectangles modified.

public final boolean isEmpty ()

Added in API level 1

Returns true if the rectangle is empty (left >= right or top >= bottom)

Returns
boolean

public void offset (int dx, int dy)

Added in API level 1

Offset the rectangle by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.

Parameters
dx int: The amount to add to the rectangle's left and right coordinates
dy int: The amount to add to the rectangle's top and bottom coordinates

public void offsetTo (int newLeft, int newTop)

Added in API level 1

Offset the rectangle to a specific (left, top) position, keeping its width and height the same.

Parameters
newLeft int: The new "left" coordinate for the rectangle
newTop int: The new "top" coordinate for the rectangle

public void readFromParcel (Parcel in)

Added in API level 1

Set the rectangle's coordinates from the data stored in the specified parcel. To write a rectangle to a parcel, call writeToParcel().

Parameters
in Parcel: The parcel to read the rectangle's coordinates from

public void set (int left, int top, int right, int bottom)

Added in API level 1

Set the rectangle's coordinates to the specified values. Note: no range checking is performed, so it is up to the caller to ensure that left <= right and top <= bottom.

Parameters
left int: The X coordinate of the left side of the rectangle
top int: The Y coordinate of the top of the rectangle
right int: The X coordinate of the right side of the rectangle
bottom int: The Y coordinate of the bottom of the rectangle

public void set (Rect src)

Added in API level 1

Copy the coordinates from src into this rectangle.

Parameters
src Rect: The rectangle whose coordinates are copied into this rectangle.

public void setEmpty ()

Added in API level 1

Set the rectangle to (0,0,0,0)

public boolean setIntersect (Rect a, Rect b)

Added in API level 1

If rectangles a and b intersect, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. To just test for intersection, use intersects()

Parameters
a Rect: The first rectangle being intersected with
b Rect: The second rectangle being intersected with
Returns
boolean true iff the two specified rectangles intersect. If they do, set this rectangle to that intersection. If they do not, return false and do not change this rectangle.

public void sort ()

Added in API level 1

Swap top/bottom or left/right if there are flipped (i.e. left > right and/or top > bottom). This can be called if the edges are computed separately, and may have crossed over each other. If the edges are already correct (i.e. left <= right and top <= bottom) then nothing is done.

public String toShortString ()

Added in API level 3

Return a string representation of the rectangle in a compact form.

Returns
String

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public static Rect unflattenFromString (String str)

Added in API level 7

Returns a Rect from a string of the form returned by flattenToString(), or null if the string is not of that form.

Parameters
str String
Returns
Rect

public void union (int left, int top, int right, int bottom)

Added in API level 1

Update this Rect to enclose itself and the specified rectangle. If the specified rectangle is empty, nothing is done. If this rectangle is empty it is set to the specified rectangle.

Parameters
left int: The left edge being unioned with this rectangle
top int: The top edge being unioned with this rectangle
right int: The right edge being unioned with this rectangle
bottom int: The bottom edge being unioned with this rectangle

public void union (Rect r)

Added in API level 1

Update this Rect to enclose itself and the specified rectangle. If the specified rectangle is empty, nothing is done. If this rectangle is empty it is set to the specified rectangle.

Parameters
r Rect: The rectangle being unioned with this rectangle

public void union (int x, int y)

Added in API level 1

Update this Rect to enclose itself and the [x,y] coordinate. There is no check to see that this rectangle is non-empty.

Parameters
x int: The x coordinate of the point to add to the rectangle
y int: The y coordinate of the point to add to the rectangle

public final int width ()

Added in API level 1

Returns
int the rectangle's width. This does not check for a valid rectangle (i.e. left <= right) so the result may be negative.

public void writeToParcel (Parcel out, int flags)

Added in API level 1

Write this rectangle to the specified parcel. To restore a rectangle from a parcel, use readFromParcel()

Parameters
out Parcel: The parcel to write the rectangle's coordinates into
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.