com.lowagie.text.pdf

Class PdfRectangle

public class PdfRectangle extends PdfArray

PdfRectangle is the PDF Rectangle object.

Rectangles are used to describe locations on the page and bounding boxes for several objects in PDF, such as fonts. A rectangle is represented as an array of four numbers, specifying the lower left x, lower left y, upper right x, and upper right y coordinates of the rectangle, in that order.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 7.1 (page 183).

See Also: Rectangle PdfArray

Field Summary
floatllx
lower left x
floatlly
lower left y
floaturx
upper right x
floatury
upper right y
Constructor Summary
PdfRectangle(float llx, float lly, float urx, float ury, int rotation)
Constructs a PdfRectangle-object.
PdfRectangle(float llx, float lly, float urx, float ury)
PdfRectangle(float urx, float ury, int rotation)
Constructs a PdfRectangle-object starting from the origin (0, 0).
PdfRectangle(float urx, float ury)
PdfRectangle(Rectangle rectangle, int rotation)
Constructs a PdfRectangle-object with a Rectangle-object.
PdfRectangle(Rectangle rectangle)
Method Summary
booleanadd(PdfObject object)
Overrides the add-method in PdfArray in order to prevent the adding of extra object to the array.
floatbottom()
Returns the lower left y-coordinate.
floatbottom(int margin)
Returns the lower left y-coordinate, considering a given margin.
RectanglegetRectangle()
Returns the high level version of this PdfRectangle
floatheight()
Returns the height of the rectangle.
floatleft()
Returns the lower left x-coordinate.
floatleft(int margin)
Returns the lower left x-coordinate, considering a given margin.
floatright()
Returns the upper right x-coordinate.
floatright(int margin)
Returns the upper right x-coordinate, considering a given margin.
PdfRectanglerotate()
Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.
floattop()
Returns the upper right y-coordinate.
floattop(int margin)
Returns the upper right y-coordinate, considering a given margin.
floatwidth()
Returns the width of the rectangle.

Field Detail

llx

private float llx
lower left x

lly

private float lly
lower left y

urx

private float urx
upper right x

ury

private float ury
upper right y

Constructor Detail

PdfRectangle

public PdfRectangle(float llx, float lly, float urx, float ury, int rotation)
Constructs a PdfRectangle-object.

Parameters: llx lower left x lly lower left y urx upper right x ury upper right y

Since: rugPdf0.10

PdfRectangle

public PdfRectangle(float llx, float lly, float urx, float ury)

PdfRectangle

public PdfRectangle(float urx, float ury, int rotation)
Constructs a PdfRectangle-object starting from the origin (0, 0).

Parameters: urx upper right x ury upper right y

PdfRectangle

public PdfRectangle(float urx, float ury)

PdfRectangle

public PdfRectangle(Rectangle rectangle, int rotation)
Constructs a PdfRectangle-object with a Rectangle-object.

Parameters: rectangle a Rectangle

PdfRectangle

public PdfRectangle(Rectangle rectangle)

Method Detail

add

public boolean add(PdfObject object)
Overrides the add-method in PdfArray in order to prevent the adding of extra object to the array.

Parameters: object PdfObject to add (will not be added here)

Returns: false

bottom

public float bottom()
Returns the lower left y-coordinate.

Returns: the lower left y-coordinate

bottom

public float bottom(int margin)
Returns the lower left y-coordinate, considering a given margin.

Parameters: margin a margin

Returns: the lower left y-coordinate

getRectangle

public Rectangle getRectangle()
Returns the high level version of this PdfRectangle

Returns: this PdfRectangle translated to class Rectangle

height

public float height()
Returns the height of the rectangle.

Returns: a height

left

public float left()
Returns the lower left x-coordinate.

Returns: the lower left x-coordinate

left

public float left(int margin)
Returns the lower left x-coordinate, considering a given margin.

Parameters: margin a margin

Returns: the lower left x-coordinate

right

public float right()
Returns the upper right x-coordinate.

Returns: the upper right x-coordinate

right

public float right(int margin)
Returns the upper right x-coordinate, considering a given margin.

Parameters: margin a margin

Returns: the upper right x-coordinate

rotate

public PdfRectangle rotate()
Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.

Returns: a PdfRectangle

top

public float top()
Returns the upper right y-coordinate.

Returns: the upper right y-coordinate

top

public float top(int margin)
Returns the upper right y-coordinate, considering a given margin.

Parameters: margin a margin

Returns: the upper right y-coordinate

width

public float width()
Returns the width of the rectangle.

Returns: a width