de.slothsoft.charts

Class Area

java.lang.Object

de.slothsoft.charts.Area

public class Area
extends Object

A simple class representing an area with start and end point. Nothing special here.

Since:

0.1.0

Author:

Stef Schulz

Constructor Summary

Constructors

Constructor and Description
Area() Constructor that sets start and end points to 0|0.
Area(double endX, double endY) Constructor that sets start point to 0|0.
Area(double startX, double startY, double endX, double endY) Constructor.

Method Summary

Modifier and Type	Method and Description
double	calculateHeight() Calculates this areas height from getStartY() and getEndY().
double	calculateWidth() Calculates this areas width from getStartX() and getEndX().
boolean	containsPoint(double x, double y) Returns true, if this area contains the point.
Area	copy() Creates a copy of this class.
Area	endX(double newEndX)
Area	endY(double newEndY)
boolean	equals(Object obj)
double	getEndX()
double	getEndY()
double	getStartX()
double	getStartY()
int	hashCode()
void	move(double xIncrement, double yIncrement) Moves the area.
void	setEndX(double endX)
void	setEndY(double endY)
void	setStartX(double startX)
void	setStartY(double startY)
Area	startX(double newStartX)
Area	startY(double newStartY)
String	toString()
Area	unite(Area area) Returns an area surrounding this area and the one coming in.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Area

public Area()

Constructor that sets start and end points to 0|0.

Area

public Area(double endX,
            double endY)

Constructor that sets start point to 0|0.

Parameters:

endX - end point's X

endY - end point's Y

Area

public Area(double startX,
            double startY,
            double endX,
            double endY)

Constructor.

Parameters:

startX - start point's X

startY - start point's Y

endX - end point's X

endY - end point's Y

Method Detail

calculateWidth

public double calculateWidth()

Calculates this areas width from getStartX() and getEndX().

Returns:

the width

Since:

0.2.0

calculateHeight

public double calculateHeight()

Calculates this areas height from getStartY() and getEndY().

Returns:

the width

Since:

0.2.0

unite

public Area unite(Area area)

Returns an area surrounding this area and the one coming in.

Parameters:

area - the area to unite with

Returns:

the union area

containsPoint

public boolean containsPoint(double x,
                             double y)

Returns true, if this area contains the point.

Parameters:

x - point's x

y - point's y

Returns:

true or false

move

public void move(double xIncrement,
                 double yIncrement)

Moves the area.

Parameters:

xIncrement - the x movement

yIncrement - the y movement

getEndX

public double getEndX()

endX

public Area endX(double newEndX)

setEndX

public void setEndX(double endX)

getEndY

public double getEndY()

endY

public Area endY(double newEndY)

setEndY

public void setEndY(double endY)

getStartX

public double getStartX()

startX

public Area startX(double newStartX)

setStartX

public void setStartX(double startX)

getStartY

public double getStartY()

startY

public Area startY(double newStartY)

setStartY

public void setStartY(double startY)

toString

public String toString()

Overrides:

toString in class Object

copy

public Area copy()

Creates a copy of this class.

Returns:

an equal copy

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object