Android - An Open Handset Alliance Project

android.graphics
public class

android.graphics.Region

java.lang.Object
	android.graphics.Region	Parcelable

Nested Classes

Region.Op

Summary

Constants

			Value
Creator	CREATOR

Public Constructors

					Region()
					Create an empty region
					Region(Region region)
					Return a copy of the specified region
					Region(Rect r)
					Return a region set to the specified rectangle
					Region(int left, int top, int right, int bottom)
					Return a region set to the specified rectangle

Public Methods

	boolean	contains(int x, int y)
		Return true if the region contains the specified point
	Path	getBoundaryPath()
		Return the boundary of the region as a new Path.
	boolean	getBoundaryPath(Path path)
		Set the path to the boundary of the region.
	Rect	getBounds()
		Return a new Rect set to the bounds of the region.
	boolean	getBounds(Rect r)
		Set the Rect to the bounds of the region.
	boolean	isComplex()
		Return true if the region contains more than one rectangle
	boolean	isEmpty()
		Return true if this region is empty
	boolean	isRect()
		Return true if the region contains a single rectangle
	boolean	op(Region region1, Region region2, Op op)
		Set this region to the result of performing the Op on the specified regions.
	boolean	op(Region region, Op op)
		Perform the specified Op on this region and the specified region.
	boolean	op(Rect rect, Region region, Op op)
		Set this region to the result of performing the Op on the specified rect and region.
	boolean	op(Rect r, Op op)
		Perform the specified Op on this region and the specified rect.
	boolean	op(int left, int top, int right, int bottom, Op op)
		Perform the specified Op on this region and the specified rect.
	boolean	quickContains(Rect r)
		Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
	boolean	quickContains(int left, int top, int right, int bottom)
		Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
	boolean	quickReject(Rect r)
		Return true if the region is empty, or if the specified rectangle does not intersect the region.
	boolean	quickReject(int left, int top, int right, int bottom)
		Return true if the region is empty, or if the specified rectangle does not intersect the region.
	boolean	quickReject(Region rgn)
		Return true if the region is empty, or if the specified region does not intersect the region.
	boolean	set(Rect r)
		Set the region to the specified rectangle
	boolean	set(Region region)
		Set the region to the specified region.
	boolean	set(int left, int top, int right, int bottom)
		Set the region to the specified rectangle
	void	setEmpty()
		Set the region to the empty region
	boolean	setPath(Path path)
		Set the region to the area described by the path.
	boolean	setPath(Path path, Region clip)
		Set the region to the area described by the path, optionally clipped (if clip is not null).
	void	translate(int dx, int dy, Region dst)
		Set the dst region to the result of translating this region by [[]dx, dy].
	void	translate(int dx, int dy)
		Translate the region by [[]dx, dy].
final	boolean	union(Rect r)
	void	writeToParcel(Parcel p)
		Write the region and its pixels to the parcel.

Protected Methods

				void	finalize()
					Called by the virtual machine when there are no longer any (non-weak) references to the receiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.os.Parcelable

writeToParcel

Details

Constants

public static final Creator CREATOR

Public Constructors

public Region()

Create an empty region

public Region(Region region)

Return a copy of the specified region

public Region(Rect r)

Return a region set to the specified rectangle

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

Return a region set to the specified rectangle

Public Methods

public boolean contains(int x, int y)

Return true if the region contains the specified point

public Path getBoundaryPath()

Return the boundary of the region as a new Path. If the region is empty, the path will also be empty.

public boolean getBoundaryPath(Path path)

Set the path to the boundary of the region. If the region is empty, the path will also be empty.

public Rect getBounds()

Return a new Rect set to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

public boolean getBounds(Rect r)

Set the Rect to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

public boolean isComplex()

Return true if the region contains more than one rectangle

public boolean isEmpty()

Return true if this region is empty

public boolean isRect()

Return true if the region contains a single rectangle

public boolean op(Region region1, Region region2, Op op)

Set this region to the result of performing the Op on the specified regions. Return true if the result is not empty.

public boolean op(Region region, Op op)

Perform the specified Op on this region and the specified region. Return true if the result of the op is not empty.

public boolean op(Rect rect, Region region, Op op)

Set this region to the result of performing the Op on the specified rect and region. Return true if the result is not empty.

public boolean op(Rect r, Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

public boolean op(int left, int top, int right, int bottom, Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

public boolean quickContains(Rect r)

Return true if the region is a single rectangle (not complex) and it contains the specified rectangle. Returning false is not a guarantee that the rectangle is not contained by this region, but return true is a guarantee that the rectangle is contained by this region.

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

public boolean quickReject(Rect r)

Return true if the region is empty, or if the specified rectangle does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

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

public boolean quickReject(Region rgn)

Return true if the region is empty, or if the specified region does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

public boolean set(Rect r)

Set the region to the specified rectangle

public boolean set(Region region)

Set the region to the specified region.

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

Set the region to the specified rectangle

public void setEmpty()

Set the region to the empty region

public boolean setPath(Path path)

Set the region to the area described by the path. Return true if the resulting region is non-empty. This produces a region that is identical to the pixels that would be drawn by the path (with no antialiasing).

public boolean setPath(Path path, Region clip)

Set the region to the area described by the path, optionally clipped (if clip is not null). Return true if the resulting region is non-empty. This produces a region that is identical to the pixels that would be drawn by the path (with no antialiasing).

public void translate(int dx, int dy, Region dst)

Set the dst region to the result of translating this region by [dx, dy]. If this region is empty, then dst will be set to empty.

public void translate(int dx, int dy)

Translate the region by [dx, dy]. If the region is empty, do nothing.

public final boolean union(Rect r)

public void writeToParcel(Parcel p)

Write the region and its pixels to the parcel. The region can be rebuilt from the parcel by calling CREATOR.createFromParcel().

Parameters

p	Parcel object to write the region data into

Protected Methods

protected void finalize()

Called by the virtual machine when there are no longer any (non-weak) references to the receiver. Subclasses can use this facility to guarantee that any associated resources are cleaned up before the receiver is garbage collected. Uncaught exceptions which are thrown during the running of the method cause it to terminate immediately, but are otherwise ignored.

Note: The virtual machine assumes that the implementation in class Object is empty.

Throws

Throwable


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.graphics.Region

Nested Classes

Summary

Constants

Public Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Methods inherited from interface android.os.Parcelable

Details

Constants

public static final Creator CREATOR

Public Constructors

public Region()

public Region(Region region)

public Region(Rect r)

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

Public Methods

public boolean contains(int x, int y)

public Path getBoundaryPath()

public boolean getBoundaryPath(Path path)

public Rect getBounds()

public boolean getBounds(Rect r)

public boolean isComplex()

public boolean isEmpty()

public boolean isRect()

public boolean op(Region region1, Region region2, Op op)

public boolean op(Region region, Op op)

public boolean op(Rect rect, Region region, Op op)

public boolean op(Rect r, Op op)

public boolean op(int left, int top, int right, int bottom, Op op)

public boolean quickContains(Rect r)

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

public boolean quickReject(Rect r)

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

public boolean quickReject(Region rgn)

public boolean set(Rect r)

public boolean set(Region region)

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

public void setEmpty()

public boolean setPath(Path path)

public boolean setPath(Path path, Region clip)

public void translate(int dx, int dy, Region dst)

public void translate(int dx, int dy)

public final boolean union(Rect r)

public void writeToParcel(Parcel p)

Parameters

Protected Methods

protected void finalize()

Throws