ej.microui.display

Class Rectangle

java.lang.Object

ej.microui.display.Rectangle

public class Rectangle
extends java.lang.Object

A rectangle with 4 coordinates.

Field Summary

Fields

Modifier and Type	Field and Description
static Rectangle	NULL_RECTANGLE Denotes an empty rectangle.

Constructor Summary

Constructors

Constructor and Description
Rectangle(int x1, int y1, int x2, int y2) Creates a rectangle specifying its 4 coordinates.
Rectangle(Rectangle rectangle) Creates a rectangle from another one.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Rectangle rectangleCandidate) Checks whether a rectangle is included or equal to this rectangle.
int	getHeight() Gets the height of this rectangle.
int	getSize() Gets the size of the rectangle.
int	getWidth() Gets the width of this rectangle.
int	getX1() Gets the left x coordinate.
int	getX2() Gets the right x coordinate.
int	getY1() Gets the top y coordinate.
int	getY2() Gets the bottom y coordinate.
boolean	isEmpty() Tells whether the rectangle is empty.
boolean	isEqual(Rectangle rectangleCandidate) Tells whether a rectangle is equal to this rectangle.
void	setX1(int x) Sets the left x.
void	setX2(int x) Sets the right x.
void	setY1(int y) Sets the top y.
void	setY2(int y) Sets the bottom y.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_RECTANGLE

public static final Rectangle NULL_RECTANGLE

Denotes an empty rectangle. Prevents the use of null rectangles.

Constructor Detail

Rectangle

public Rectangle(int x1,
                 int y1,
                 int x2,
                 int y2)

Creates a rectangle specifying its 4 coordinates.

Parameters:

x1 - the left x coordinate

y1 - the top y coordinate

x2 - the right x coordinate

y2 - the bottom y coordinate

Rectangle

public Rectangle(Rectangle rectangle)

Creates a rectangle from another one.

Parameters:

rectangle - the rectangle to copy

Method Detail

getX1

public int getX1()

Gets the left x coordinate.

Returns:

the left x.

getY1

public int getY1()

Gets the top y coordinate.

Returns:

the top y.

getX2

public int getX2()

Gets the right x coordinate.

Returns:

the right x.

getY2

public int getY2()

Gets the bottom y coordinate.

Returns:

the bottom y.

setX1

public void setX1(int x)

Sets the left x.

Parameters:

x - the x to set.

setY1

public void setY1(int y)

Sets the top y.

Parameters:

y - the y to set.

setX2

public void setX2(int x)

Sets the right x.

Parameters:

x - the x to set.

setY2

public void setY2(int y)

Sets the bottom y.

Parameters:

y - the y to set.

getWidth

public int getWidth()

Gets the width of this rectangle.

Returns:

the width

getHeight

public int getHeight()

Gets the height of this rectangle.

Returns:

the height

contains

public boolean contains(Rectangle rectangleCandidate)

Checks whether a rectangle is included or equal to this rectangle.

Parameters:

rectangleCandidate - the rectangle to check

Returns:

true if the given rectangle is included in this one, false otherwise

isEqual

public boolean isEqual(Rectangle rectangleCandidate)

Tells whether a rectangle is equal to this rectangle.

Parameters:

rectangleCandidate - the rectangle to check

Returns:

true if the given rectangle is equal to this one, false otherwise

isEmpty

public boolean isEmpty()

Tells whether the rectangle is empty.

Returns:

true if the rectangle has a null area

getSize

public int getSize()

Gets the size of the rectangle.

Returns:

rectangle width x rectangle height