com.itextpdf.kernel.geom

Class Rectangle

java.lang.Object

com.itextpdf.kernel.geom.Rectangle

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PageSize

public class Rectangle
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected float	height
protected float	width
protected float	x
protected float	y

Constructor Summary

Constructors

Constructor and Description
Rectangle(float width, float height)
Rectangle(float x, float y, float width, float height)
Rectangle(Rectangle rect)

Method Summary

Modifier and Type	Method and Description
Rectangle> T	applyMargins(float topIndent, float rightIndent, float bottomIndent, float leftIndent, boolean reverse)
Rectangle	clone() Gets the copy of this rectangle.
Rectangle	decreaseHeight(float extra) Decreases the height of rectangle by the given value.
boolean	equalsWithEpsilon(Rectangle that)
boolean	equalsWithEpsilon(Rectangle that, float eps)
float	getBottom() Gets the Y coordinate of the lower edge of the rectangle.
static Rectangle	getCommonRectangle(Rectangle... rectangles) Calculates the common rectangle which includes all the input rectangles.
float	getHeight() Gets the height of rectangle.
float	getLeft() Gets the X coordinate of the left edge of the rectangle.
float	getRight() Gets the X coordinate of the right edge of the rectangle.
float	getTop() Gets the Y coordinate of the upper edge of the rectangle.
float	getWidth() Gets the width of rectangle.
float	getX() Gets the X coordinate of lower left point.
float	getY() Gets the Y coordinate of lower left point.
Rectangle	increaseHeight(float extra) Increases the height of rectangle by the given value.
boolean	intersectsLine(float x1, float y1, float x2, float y2)
Rectangle	moveDown(float move)
Rectangle	moveLeft(float move)
Rectangle	moveRight(float move)
Rectangle	moveUp(float move)
Rectangle	setBbox(float llx, float lly, float urx, float ury) Sets the rectangle by the coordinates, specifying its lower left and upper right points.
Rectangle	setHeight(float height) Sets the height of rectangle.
Rectangle	setWidth(float width) Sets the width of rectangle.
Rectangle	setX(float x) Sets the X coordinate of lower left point.
Rectangle	setY(float y) Sets the Y coordinate of lower left point.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

x

protected float x

y

protected float y

width

protected float width

height

protected float height

Constructor Detail

Rectangle

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

Rectangle

public Rectangle(float width,
                 float height)

Rectangle

public Rectangle(Rectangle rect)

Method Detail

getCommonRectangle

public static Rectangle getCommonRectangle(Rectangle... rectangles)

Calculates the common rectangle which includes all the input rectangles.

Parameters:

rectangles - list of input rectangles.

Returns:

common rectangle.

setBbox

public Rectangle setBbox(float llx,
                         float lly,
                         float urx,
                         float ury)

Sets the rectangle by the coordinates, specifying its lower left and upper right points. May be used in chain.

Note: this method will normalize coordinates, so the rectangle will have non negative width and height, and its x and y coordinates specified lower left point.

Parameters:

llx - the X coordinate of lower left point

lly - the Y coordinate of lower left point

urx - the X coordinate of upper right point

ury - the Y coordinate of upper right point

Returns:

this Rectangle instance.

getX

public float getX()

Gets the X coordinate of lower left point.

Returns:

the X coordinate of lower left point.

setX

public Rectangle setX(float x)

Sets the X coordinate of lower left point. May be used in chain.

Parameters:

x - the X coordinate of lower left point to be set.

Returns:

this Rectangle instance.

getY

public float getY()

Gets the Y coordinate of lower left point.

Returns:

the Y coordinate of lower left point.

setY

public Rectangle setY(float y)

Sets the Y coordinate of lower left point. May be used in chain.

Parameters:

y - the Y coordinate of lower left point to be set.

Returns:

this Rectangle instance.

getWidth

public float getWidth()

Gets the width of rectangle.

Returns:

the width of rectangle.

setWidth

public Rectangle setWidth(float width)

Sets the width of rectangle. May be used in chain.

Parameters:

width - the the width of rectangle to be set.

Returns:

this Rectangle instance.

getHeight

public float getHeight()

Gets the height of rectangle.

Returns:

the height of rectangle.

setHeight

public Rectangle setHeight(float height)

Sets the height of rectangle. May be used in chain.

Parameters:

height - the the width of rectangle to be set.

Returns:

this Rectangle instance.

increaseHeight

public Rectangle increaseHeight(float extra)

Increases the height of rectangle by the given value. May be used in chain.

Parameters:

extra - the value of the extra height to be added.

Returns:

this Rectangle instance.

decreaseHeight

public Rectangle decreaseHeight(float extra)

Decreases the height of rectangle by the given value. May be used in chain.

Parameters:

extra - the value of the extra height to be subtracted.

Returns:

this Rectangle instance.

getLeft

public float getLeft()

Gets the X coordinate of the left edge of the rectangle. Same as: getX().

Returns:

the X coordinate of the left edge of the rectangle.

getRight

public float getRight()

Gets the X coordinate of the right edge of the rectangle. Same as: getX() + getWidth().

Returns:

the X coordinate of the right edge of the rectangle.

getTop

public float getTop()

Gets the Y coordinate of the upper edge of the rectangle. Same as: getY() + getHeight().

Returns:

the Y coordinate of the upper edge of the rectangle.

getBottom

public float getBottom()

Gets the Y coordinate of the lower edge of the rectangle. Same as: getY().

Returns:

the Y coordinate of the lower edge of the rectangle.

moveDown

public Rectangle moveDown(float move)

moveUp

public Rectangle moveUp(float move)

moveRight

public Rectangle moveRight(float move)

moveLeft

public Rectangle moveLeft(float move)

applyMargins

public Rectangle> T applyMargins(float topIndent,
                                            float rightIndent,
                                            float bottomIndent,
                                            float leftIndent,
                                            boolean reverse)

intersectsLine

public boolean intersectsLine(float x1,
                              float y1,
                              float x2,
                              float y2)

toString

public String toString()

Overrides:

toString in class Object

clone

public Rectangle clone()

Gets the copy of this rectangle.

Overrides:

clone in class Object

Returns:

the copied rectangle.

equalsWithEpsilon

public boolean equalsWithEpsilon(Rectangle that)

equalsWithEpsilon

public boolean equalsWithEpsilon(Rectangle that,
                                 float eps)