net.sf.mmm.client.ui.api.common

Class Rectangle

java.lang.Object

net.sf.mmm.util.lang.api.AbstractDatatype

net.sf.mmm.client.ui.api.common.Point

net.sf.mmm.client.ui.api.common.Rectangle

All Implemented Interfaces:

Serializable, Datatype

public class Rectangle
extends Point

This is the Datatype for a 2-dimensional rectangle measured in pixels.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	height
private static long	serialVersionUID UID for serialization.
private int	width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rectangle() The constructor for de-serialization in GWT.
	Rectangle(int x, int y, int width, int height) The constructor.

Method Summary

Modifier and Type	Method and Description
Rectangle	clipTo(Rectangle clippingArea, boolean move) This method calculates a clipped variant from this Rectangle that fits inside the given clippingArea.
boolean	equals(Object obj)
int	getHeight()
int	getWidth()
int	getX2()
int	getY2()
int	hashCode()
Rectangle	moveBy(int dx, int dy) Creates a new Rectangle of this moved from its current position relatively by the to the given dx and dy coordinate offsets.
Rectangle	moveBy(Point p) Creates a new Rectangle of this moved from its current position relatively by the to the given Point.
Rectangle	moveTo(int newX, int newY) Creates a new Rectangle of this moved to the point given by x and y.
Rectangle	moveTo(Point p) Creates a new Rectangle of this moved to the given Point.
Rectangle	resize(int dx, int dy, Direction direction, int minWidth, int minHeight) Calculates a new Rectangle from this resized by dx and dy in the given Direction.

Methods inherited from class net.sf.mmm.client.ui.api.common.Point

getX, getY, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

width

private int width

See Also:

getWidth()

height

private int height

See Also:

getHeight()

Constructor Detail

Rectangle

protected Rectangle()

The constructor for de-serialization in GWT.

Rectangle

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

The constructor.

Parameters:

x - is the x-position.

y - is the y-position.

width - is the width.

height - is the height.

Method Detail

moveTo

public Rectangle moveTo(Point p)

Creates a new Rectangle of this moved to the given Point.

Parameters:

p - is the Point to move to.

Returns:

a new Rectangle with the same size and located at the given Point.

moveTo

public Rectangle moveTo(int newX,
                        int newY)

Creates a new Rectangle of this moved to the point given by x and y.

Parameters:

newX - is the new x-position.

newY - is the new y-position.

Returns:

a new Rectangle with the same size and located at the given point.

moveBy

public Rectangle moveBy(Point p)

Creates a new Rectangle of this moved from its current position relatively by the to the given Point.

Parameters:

p - is the Point with the delta-coordinate to move by.

Returns:

a new Rectangle with the same size and moved by the given Point.

moveBy

public Rectangle moveBy(int dx,
                        int dy)

Creates a new Rectangle of this moved from its current position relatively by the to the given dx and dy coordinate offsets.

Parameters:

dx - is the value to add to the x-position. May be negative to move left.

dy - is the value to add to the y-position. May be negative to move up.

Returns:

a new Rectangle with the same size and moved by the given offset.

clipTo

public Rectangle clipTo(Rectangle clippingArea,
                        boolean move)

This method calculates a clipped variant from this Rectangle that fits inside the given clippingArea.

Parameters:

clippingArea - is the Rectangle the result has to fit in.

move - - if true that try to avoid resizing the resulting Rectangle by moving towards the top left of the clippingArea, false otherwise (if resizing is appreciated).

Returns:

the clipped Rectangle fitting inside the clippingArea.

resize

public Rectangle resize(int dx,
                        int dy,
                        Direction direction,
                        int minWidth,
                        int minHeight)

Calculates a new Rectangle from this resized by dx and dy in the given Direction.

Parameters:

dx - is the delta offset for the x-position.

dy - is the delta offset for the y-position.

direction - is the Direction where to resize.

minWidth - is the minimum width.

minHeight - is the minimum height.

Returns:

the resized Rectangle.

getWidth

public int getWidth()

Returns:

the width of this Rectangle in pixel.

getHeight

public int getHeight()

Returns:

the height of this Rectangle in pixel.

getX2

public int getX2()

Returns:

the x-position of the bottom right edge of this Rectangle.

getY2

public int getY2()

Returns:

the y-position of the bottom right edge of this Rectangle.

hashCode

public int hashCode()

Overrides:

hashCode in class Point

equals

public boolean equals(Object obj)

Overrides:

equals in class Point