| java.lang.Object
 org.eclipse.swt.graphics.Resource
org.eclipse.swt.graphics.Region
| Region | | final public class Region extends Resource (Code) | | Instances of this class represent areas of an x-y coordinate
system that are aggregates of the areas covered by a number
of polygons.
Application code must explicitly invoke the Region.dispose()
method to release the operating system resources managed by each instance
when those instances are no longer required.
|
| Field Summary | |
| public int | handle
the OS resource for the region
(Warning: This field is platform dependent)
IMPORTANT: This field is not part of the SWT
public API. |
| Constructor Summary | |
| public | Region()
Constructs a new empty region. | | public | Region(Device device)
Constructs a new empty region.
You must dispose the region when it is no longer required. | | | Region(Device device, int handle)
|
| Method Summary | |
| public void | add(int[] pointArray)
Adds the given polygon to the collection of polygons
the receiver maintains to describe its area. | | public void | add(Rectangle rect)
Adds the given rectangle to the collection of polygons
the receiver maintains to describe its area. | | public void | add(int x, int y, int width, int height)
Adds the given rectangle to the collection of polygons
the receiver maintains to describe its area. | | public void | add(Region region)
Adds all of the polygons which make up the area covered
by the argument to the collection of polygons the receiver
maintains to describe its area. | | public static Region | carbon_new(Device device, int handle)
| | public boolean | contains(int x, int y)
Returns true if the point specified by the
arguments is inside the area specified by the receiver,
and false otherwise. | | public boolean | contains(Point pt)
Returns true if the given point is inside the
area specified by the receiver, and false
otherwise. | | public void | dispose()
Disposes of the operating system resources associated with
the region. | | public boolean | equals(Object object)
Compares the argument to the receiver, and returns true
if they represent the same object using a class
specific comparison. | | public Rectangle | getBounds()
Returns a rectangle which represents the rectangular
union of the collection of polygons the receiver
maintains to describe its area. | | public int | hashCode()
Returns an integer hash code for the receiver. | | public void | intersect(Rectangle rect)
Intersects the given rectangle to the collection of polygons
the receiver maintains to describe its area. | | public void | intersect(int x, int y, int width, int height)
Intersects the given rectangle to the collection of polygons
the receiver maintains to describe its area. | | public void | intersect(Region region)
Intersects all of the polygons which make up the area covered
by the argument to the collection of polygons the receiver
maintains to describe its area. | | public boolean | intersects(int x, int y, int width, int height)
Returns true if the rectangle described by the
arguments intersects with any of the polygons the receiver
maintains to describe its area, and false otherwise. | | public boolean | intersects(Rectangle rect)
Returns true if the given rectangle intersects
with any of the polygons the receiver maintains to describe
its area and false otherwise. | | public boolean | isDisposed()
Returns true if the region has been disposed,
and false otherwise. | | public boolean | isEmpty()
Returns true if the receiver does not cover any
area in the (x, y) coordinate plane, and false if
the receiver does cover some area in the plane. | | public void | subtract(int[] pointArray)
Subtracts the given polygon from the collection of polygons
the receiver maintains to describe its area. | | public void | subtract(Rectangle rect)
Subtracts the given rectangle from the collection of polygons
the receiver maintains to describe its area. | | public void | subtract(int x, int y, int width, int height)
Subtracts the given rectangle from the collection of polygons
the receiver maintains to describe its area. | | public void | subtract(Region region)
Subtracts all of the polygons which make up the area covered
by the argument from the collection of polygons the receiver
maintains to describe its area. | | public String | toString()
Returns a string containing a concise, human-readable
description of the receiver. | | public void | translate(int x, int y)
Translate all of the polygons the receiver maintains to describe
its area by the specified point. | | public void | translate(Point pt)
Translate all of the polygons the receiver maintains to describe
its area by the specified point. |
| handle | | public int handle(Code) | | the OS resource for the region
(Warning: This field is platform dependent)
IMPORTANT: This field is not part of the SWT
public API. It is marked public only so that it can be shared
within the packages provided by SWT. It is not available on all
platforms and should never be accessed from application code.
|
| Region | | public Region()(Code) | | Constructs a new empty region.
exception:
SWTError - - ERROR_NO_HANDLES if a handle could not be obtained for region creation
|
| Region | | public Region(Device device)(Code) | | Constructs a new empty region.
You must dispose the region when it is no longer required.
Parameters:
device - the device on which to allocate the region
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if device is null and there is no current device
exception:
SWTError - - ERROR_NO_HANDLES if a handle could not be obtained for region creation
See Also: Region.dispose
since:
3.0 |
| add | | public void add(int[] pointArray)(Code) | | Adds the given polygon to the collection of polygons
the receiver maintains to describe its area.
Parameters:
pointArray - points that describe the polygon to merge with the receiver
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| add | | public void add(Rectangle rect)(Code) | | Adds the given rectangle to the collection of polygons
the receiver maintains to describe its area.
Parameters:
rect - the rectangle to merge with the receiver
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
|
| add | | public void add(int x, int y, int width, int height)(Code) | | Adds the given rectangle to the collection of polygons
the receiver maintains to describe its area.
Parameters:
x - the x coordinate of the rectangle
Parameters:
y - the y coordinate of the rectangle
Parameters:
width - the width coordinate of the rectangle
Parameters:
height - the height coordinate of the rectangle
exception:
IllegalArgumentException - - ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.1 |
| add | | public void add(Region region)(Code) | | Adds all of the polygons which make up the area covered
by the argument to the collection of polygons the receiver
maintains to describe its area.
Parameters:
region - the region to merge
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the argument has been disposed
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
|
| contains | | public boolean contains(int x, int y)(Code) | | Returns true if the point specified by the
arguments is inside the area specified by the receiver,
and false otherwise.
Parameters:
x - the x coordinate of the point to test for containment
Parameters:
y - the y coordinate of the point to test for containment true if the region contains the point and false otherwise
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
|
| contains | | public boolean contains(Point pt)(Code) | | Returns true if the given point is inside the
area specified by the receiver, and false
otherwise.
Parameters:
pt - the point to test for containment true if the region contains the point and false otherwise
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
|
| dispose | | public void dispose()(Code) | | Disposes of the operating system resources associated with
the region. Applications must dispose of all regions which
they allocate.
|
| equals | | public boolean equals(Object object)(Code) | | Compares the argument to the receiver, and returns true
if they represent the same object using a class
specific comparison.
Parameters:
object - the object to compare with this object true if the object is the same as this object and false otherwise
See Also: Region.hashCode |
| getBounds | | public Rectangle getBounds()(Code) | | Returns a rectangle which represents the rectangular
union of the collection of polygons the receiver
maintains to describe its area.
a bounding rectangle for the region
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
See Also: Rectangle.union |
| hashCode | | public int hashCode()(Code) | | Returns an integer hash code for the receiver. Any two
objects that return true when passed to
equals must return the same value for this
method.
the receiver's hash
See Also: Region.equals |
| intersect | | public void intersect(Rectangle rect)(Code) | | Intersects the given rectangle to the collection of polygons
the receiver maintains to describe its area.
Parameters:
rect - the rectangle to intersect with the receiver
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| intersect | | public void intersect(int x, int y, int width, int height)(Code) | | Intersects the given rectangle to the collection of polygons
the receiver maintains to describe its area.
Parameters:
x - the x coordinate of the rectangle
Parameters:
y - the y coordinate of the rectangle
Parameters:
width - the width coordinate of the rectangle
Parameters:
height - the height coordinate of the rectangle
exception:
IllegalArgumentException - - ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.1 |
| intersect | | public void intersect(Region region)(Code) | | Intersects all of the polygons which make up the area covered
by the argument to the collection of polygons the receiver
maintains to describe its area.
Parameters:
region - the region to intersect
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the argument has been disposed
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| intersects | | public boolean intersects(int x, int y, int width, int height)(Code) | | Returns true if the rectangle described by the
arguments intersects with any of the polygons the receiver
maintains to describe its area, and false otherwise.
Parameters:
x - the x coordinate of the origin of the rectangle
Parameters:
y - the y coordinate of the origin of the rectangle
Parameters:
width - the width of the rectangle
Parameters:
height - the height of the rectangle true if the rectangle intersects with the receiver, and false otherwise
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
See Also: Rectangle.intersects(Rectangle) |
| intersects | | public boolean intersects(Rectangle rect)(Code) | | Returns true if the given rectangle intersects
with any of the polygons the receiver maintains to describe
its area and false otherwise.
Parameters:
rect - the rectangle to test for intersection true if the rectangle intersects with the receiver, and false otherwise
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
See Also: Rectangle.intersects(Rectangle) |
| isDisposed | | public boolean isDisposed()(Code) | | Returns true if the region has been disposed,
and false otherwise.
This method gets the dispose state for the region.
When a region has been disposed, it is an error to
invoke any other method using the region.
true when the region is disposed, and false otherwise |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if the receiver does not cover any
area in the (x, y) coordinate plane, and false if
the receiver does cover some area in the plane.
true if the receiver is empty, and false otherwise
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
|
| subtract | | public void subtract(int[] pointArray)(Code) | | Subtracts the given polygon from the collection of polygons
the receiver maintains to describe its area.
Parameters:
pointArray - points that describe the polygon to merge with the receiver
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| subtract | | public void subtract(Rectangle rect)(Code) | | Subtracts the given rectangle from the collection of polygons
the receiver maintains to describe its area.
Parameters:
rect - the rectangle to subtract from the receiver
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| subtract | | public void subtract(int x, int y, int width, int height)(Code) | | Subtracts the given rectangle from the collection of polygons
the receiver maintains to describe its area.
Parameters:
x - the x coordinate of the rectangle
Parameters:
y - the y coordinate of the rectangle
Parameters:
width - the width coordinate of the rectangle
Parameters:
height - the height coordinate of the rectangle
exception:
IllegalArgumentException - - ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.1 |
| subtract | | public void subtract(Region region)(Code) | | Subtracts all of the polygons which make up the area covered
by the argument from the collection of polygons the receiver
maintains to describe its area.
Parameters:
region - the region to subtract
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the argument has been disposed
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.0 |
| toString | | public String toString()(Code) | | Returns a string containing a concise, human-readable
description of the receiver.
a string representation of the receiver |
| translate | | public void translate(int x, int y)(Code) | | Translate all of the polygons the receiver maintains to describe
its area by the specified point.
Parameters:
x - the x coordinate of the point to translate
Parameters:
y - the y coordinate of the point to translate
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.1 |
| translate | | public void translate(Point pt)(Code) | | Translate all of the polygons the receiver maintains to describe
its area by the specified point.
Parameters:
pt - the point to translate
exception:
IllegalArgumentException - - ERROR_NULL_ARGUMENT - if the argument is null
exception:
SWTException - - ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
since:
3.1 |
|
|