org.jemmy

Class Rectangle

java.lang.Object

org.jemmy.Rectangle

All Implemented Interfaces:

Serializable

public class Rectangle
extends Object
implements Serializable

Replacement for java.awt.Rectangle

Author:

mrkam

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	height The height of the Rectangle.
int	width The width of the Rectangle.
int	x The X coordinate of the upper-left corner of the Rectangle.
int	y The Y coordinate of the upper-left corner of the Rectangle.

Constructor Summary

Constructors

Constructor and Description
Rectangle() Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.
Rectangle(Dimension d) Constructs a new Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument.
Rectangle(double x, double y, double width, double height) Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.
Rectangle(int width, int height) Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are specified by the arguments of the same name.
Rectangle(int x, int y, int width, int height) Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.
Rectangle(Point p) Constructs a new Rectangle whose upper-left corner is the specified Point, and whose width and height are both zero.
Rectangle(Point p, Dimension d) Constructs a new Rectangle whose upper-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.
Rectangle(Rectangle r) Constructs a new Rectangle, initialized to match the values of the specified Rectangle.

Method Summary

Modifier and Type	Method and Description
void	add(int newx, int newy) Adds a point, specified by the integer arguments newx,newy to the bounds of this Rectangle.
void	add(Point pt) Adds the specified Point to the bounds of this Rectangle.
void	add(Rectangle r) Adds a Rectangle to this Rectangle.
boolean	contains(int x, int y) Checks whether or not this Rectangle contains the point at the specified location (x,y).
boolean	contains(int X, int Y, int W, int H) Checks whether this Rectangle entirely contains the Rectangle at the specified location (X,Y) with the specified dimensions (W,H).
boolean	contains(Point p) Checks whether or not this Rectangle contains the specified Point.
boolean	contains(Rectangle r) Checks whether or not this Rectangle entirely contains the specified Rectangle.
boolean	equals(Object obj) Checks whether two rectangles are equal.
Rectangle	getBounds() Gets the bounding Rectangle of this Rectangle.
double	getHeight() Returns the height of the bounding Rectangle in double precision.
Point	getLocation() Returns the location of this Rectangle.
Dimension	getSize() Gets the size of this Rectangle, represented by the returned Dimension.
double	getWidth() Returns the width of the bounding Rectangle in double precision.
double	getX() Returns the X coordinate of the bounding Rectangle in double precision.
double	getY() Returns the Y coordinate of the bounding Rectangle in double precision.
void	grow(int h, int v) Resizes the Rectangle both horizontally and vertically.
int	hashCode()
Rectangle	intersection(Rectangle r) Computes the intersection of this Rectangle with the specified Rectangle.
boolean	intersects(Rectangle r) Determines whether or not this Rectangle and the specified Rectangle intersect.
boolean	isEmpty()
static Rectangle	parseRectangle(String str) Parses given string to restore Rectangle instance from the string.
void	setBounds(int x, int y, int width, int height) Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.
void	setBounds(Rectangle r) Sets the bounding Rectangle of this Rectangle to match the specified Rectangle.
void	setLocation(int x, int y) Moves this Rectangle to the specified location.
void	setLocation(Point p) Moves this Rectangle to the specified location.
void	setRect(double x, double y, double width, double height) Sets the bounds of this Rectangle to the integer bounds which encompass the specified x, y, width, and height.
void	setSize(Dimension d) Sets the size of this Rectangle to match the specified Dimension.
void	setSize(int width, int height) Sets the size of this Rectangle to the specified width and height.
String	toString() Returns a String representing this Rectangle and its values.
void	translate(int dx, int dy) Translates this Rectangle the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.
Rectangle	union(Rectangle r) Computes the union of this Rectangle with the specified Rectangle.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

The X coordinate of the upper-left corner of the Rectangle.

See Also:

setLocation(int, int), getLocation()

y

public int y

The Y coordinate of the upper-left corner of the Rectangle.

See Also:

setLocation(int, int), getLocation()

width

public int width

The width of the Rectangle.

See Also:

setSize(int, int), getSize()

height

public int height

The height of the Rectangle.

See Also:

setSize(int, int), getSize()

Constructor Detail

Rectangle

public Rectangle()

Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.

Rectangle

public Rectangle(Rectangle r)

Constructs a new Rectangle, initialized to match the values of the specified Rectangle.

Parameters:

r - the Rectangle from which to copy initial values to a newly constructed Rectangle

Rectangle

public Rectangle(int x,
                 int y,
                 int width,
                 int height)

Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

width - the width of the Rectangle

height - the height of the Rectangle

Rectangle

public Rectangle(int width,
                 int height)

Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are specified by the arguments of the same name.

Parameters:

width - the width of the Rectangle

height - the height of the Rectangle

Rectangle

public Rectangle(Point p,
                 Dimension d)

Constructs a new Rectangle whose upper-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.

Parameters:

p - a Point that is the upper-left corner of the Rectangle

d - a Dimension, representing the width and height of the Rectangle

Rectangle

public Rectangle(Point p)

Constructs a new Rectangle whose upper-left corner is the specified Point, and whose width and height are both zero.

Parameters:

p - a Point that is the top left corner of the Rectangle

Rectangle

public Rectangle(Dimension d)

Constructs a new Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument.

Parameters:

d - a Dimension, specifying width and height

Rectangle

public Rectangle(double x,
                 double y,
                 double width,
                 double height)

Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name. All double values are rounded and stored as int values.

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

width - the width of the Rectangle

height - the height of the Rectangle

Method Detail

getX

public double getX()

Returns the X coordinate of the bounding Rectangle in double precision.

Returns:

the X coordinate of the bounding Rectangle.

getY

public double getY()

Returns the Y coordinate of the bounding Rectangle in double precision.

Returns:

the Y coordinate of the bounding Rectangle.

getWidth

public double getWidth()

Returns the width of the bounding Rectangle in double precision.

Returns:

the width of the bounding Rectangle.

getHeight

public double getHeight()

Returns the height of the bounding Rectangle in double precision.

Returns:

the height of the bounding Rectangle.

getBounds

public Rectangle getBounds()

Gets the bounding Rectangle of this Rectangle.

Returns:

a new Rectangle, equal to the bounding Rectangle for this Rectangle.

See Also:

setBounds(Rectangle), setBounds(int, int, int, int)

setBounds

public void setBounds(Rectangle r)

Sets the bounding Rectangle of this Rectangle to match the specified Rectangle.

Parameters:

r - the specified Rectangle

See Also:

getBounds()

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

Parameters:

x - the new X coordinate for the upper-left corner of this Rectangle

y - the new Y coordinate for the upper-left corner of this Rectangle

width - the new width for this Rectangle

height - the new height for this Rectangle

See Also:

getBounds()

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)

Sets the bounds of this Rectangle to the integer bounds which encompass the specified x, y, width, and height. If the parameters specify a Rectangle that exceeds the maximum range of integers, the result will be the best representation of the specified Rectangle intersected with the maximum integer bounds.

Parameters:

x - the X coordinate of the upper-left corner of the specified rectangle

y - the Y coordinate of the upper-left corner of the specified rectangle

width - the width of the specified rectangle

height - the new height of the specified rectangle

getLocation

public Point getLocation()

Returns the location of this Rectangle.

Returns:

the Point that is the upper-left corner of this Rectangle.

See Also:

setLocation(Point), setLocation(int, int)

setLocation

public void setLocation(Point p)

Moves this Rectangle to the specified location.

Parameters:

p - the Point specifying the new location for this Rectangle

See Also:

getLocation()

setLocation

public void setLocation(int x,
                        int y)

Moves this Rectangle to the specified location.

Parameters:

x - the X coordinate of the new location

y - the Y coordinate of the new location

See Also:

getLocation()

translate

public void translate(int dx,
                      int dy)

Translates this Rectangle the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.

Parameters:

dx - the distance to move this Rectangle along the X axis

dy - the distance to move this Rectangle along the Y axis

See Also:

setLocation(int, int), setLocation(org.jemmy.Point)

getSize

public Dimension getSize()

Gets the size of this Rectangle, represented by the returned Dimension.

Returns:

a Dimension, representing the size of this Rectangle.

See Also:

setSize(Dimension), setSize(int, int)

setSize

public void setSize(Dimension d)

Sets the size of this Rectangle to match the specified Dimension.

Parameters:

d - the new size for the Dimension object

See Also:

getSize()

setSize

public void setSize(int width,
                    int height)

Sets the size of this Rectangle to the specified width and height.

Parameters:

width - the new width for this Rectangle

height - the new height for this Rectangle

See Also:

getSize()

contains

public boolean contains(Point p)

Checks whether or not this Rectangle contains the specified Point.

Parameters:

p - the Point to test

Returns:

true if the specified Point is inside this Rectangle; false otherwise.

contains

public boolean contains(int x,
                        int y)

Checks whether or not this Rectangle contains the point at the specified location (x,y).

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

Returns:

true if the point (x,y) is inside this Rectangle; false otherwise.

contains

public boolean contains(Rectangle r)

Checks whether or not this Rectangle entirely contains the specified Rectangle.

Parameters:

r - the specified Rectangle

Returns:

true if the Rectangle is contained entirely inside this Rectangle; false otherwise

contains

public boolean contains(int X,
                        int Y,
                        int W,
                        int H)

Checks whether this Rectangle entirely contains the Rectangle at the specified location (X,Y) with the specified dimensions (W,H).

Parameters:

X - the specified X coordinate

Y - the specified Y coordinate

W - the width of the Rectangle

H - the height of the Rectangle

Returns:

true if the Rectangle specified by (X, Y, W, H) is entirely enclosed inside this Rectangle; false otherwise.

intersects

public boolean intersects(Rectangle r)

Determines whether or not this Rectangle and the specified Rectangle intersect. Two rectangles intersect if their intersection is nonempty.

Parameters:

r - the specified Rectangle

Returns:

true if the specified Rectangle and this Rectangle intersect; false otherwise.

intersection

public Rectangle intersection(Rectangle r)

Computes the intersection of this Rectangle with the specified Rectangle. Returns a new Rectangle that represents the intersection of the two rectangles. If the two rectangles do not intersect, the result will be an empty rectangle.

Parameters:

r - the specified Rectangle

Returns:

the largest Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectangles do not intersect, an empty rectangle.

union

public Rectangle union(Rectangle r)

Computes the union of this Rectangle with the specified Rectangle. Returns a new Rectangle that represents the union of the two rectangles.

If either Rectangle has any dimension less than zero the rules for non-existant rectangles apply. If only one has a dimension less than zero, then the result will be a copy of the other Rectangle. If both have dimension less than zero, then the result will have at least one dimension less than zero.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.

Parameters:

r - the specified Rectangle

Returns:

the smallest Rectangle containing both the specified Rectangle and this Rectangle.

add

public void add(int newx,
                int newy)

Adds a point, specified by the integer arguments newx,newy to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the specified coordinates and width and height equal to zero.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore, if the added point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead:

     r.add(newx, newy, 1, 1);
 

Parameters:

newx - the X coordinate of the new point

newy - the Y coordinate of the new point

add

public void add(Point pt)

Adds the specified Point to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the coordinates of the specified Point and width and height equal to zero.

After adding a Point, a call to contains with the added Point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore if the added Point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that Point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead:

     r.add(pt.x, pt.y, 1, 1);
 

Parameters:

pt - the new Point to add to this Rectangle

add

public void add(Rectangle r)

Adds a Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.

If either Rectangle has any dimension less than 0, the result will have the dimensions of the other Rectangle. If both Rectangles have at least one dimension less than 0, the result will have at least one dimension less than 0.

If either Rectangle has one or both dimensions equal to 0, the result along those axes with 0 dimensions will be equivalent to the results obtained by adding the corresponding origin coordinate to the result rectangle along that axis, similar to the operation of the add(Point) method, but contribute no further dimension beyond that.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.

Parameters:

r - the specified Rectangle

grow

public void grow(int h,
                 int v)

Resizes the Rectangle both horizontally and vertically.

This method modifies the Rectangle so that it is h units larger on both the left and right side, and v units larger at both the top and bottom.

The new Rectangle has (x - h, y - v) as its upper-left corner, width of (width + 2h), and a height of (height + 2v).

If negative values are supplied for h and v, the size of the Rectangle decreases accordingly. The grow method will check for integer overflow and underflow, but does not check whether the resulting values of width and height grow from negative to non-negative or shrink from non-negative to negative.

Parameters:

h - the horizontal expansion

v - the vertical expansion

isEmpty

public boolean isEmpty()

equals

public boolean equals(Object obj)

Checks whether two rectangles are equal.

The result is true if and only if the argument is not null and is a Rectangle object that has the same upper-left corner, width, and height as this Rectangle.

Overrides:

equals in class Object

Parameters:

obj - the Object to compare with this Rectangle

Returns:

true if the objects are equal; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a String representing this Rectangle and its values.

Overrides:

toString in class Object

Returns:

a String representing this Rectangle object's coordinate and size values.

parseRectangle

public static Rectangle parseRectangle(String str)

Parses given string to restore Rectangle instance from the string. String assumed to be previously created using Rectangle.toString() method.

Parameters:

str - String to parse.

Returns:

Recreated Rectangle instance.