Package com.lowagie.text.pdf
Class PdfRectangle
java.lang.Object
com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfArray
com.lowagie.text.pdf.PdfRectangle
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate float
lower left xprivate float
lower left yprivate float
upper right xprivate float
upper right y -
Constructor Summary
ConstructorsConstructorDescriptionPdfRectangle
(float urx, float ury) PdfRectangle
(float llx, float lly, float urx, float ury) PdfRectangle
(float llx, float lly, float urx, float ury, int rotation) Constructs aPdfRectangle
-object.PdfRectangle
(float urx, float ury, int rotation) Constructs aPdfRectangle
-object starting from the origin (0, 0).PdfRectangle
(PdfArray rectangle) To be used when the array contains 4 float numbers as pdf coordinates like RECT / BBoxPdfRectangle
(Rectangle rectangle) PdfRectangle
(Rectangle rectangle, int rotation) Constructs aPdfRectangle
-object with aRectangle
-object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(float[] values) Block changes to the underlying PdfArrayboolean
add
(int[] values) Block changes to the underlying PdfArrayboolean
Overrides theadd
-method inPdfArray
in order to prevent the adding of extra object to the array.void
Block changes to the underlying PdfArrayfloat
bottom()
Returns the lower left y-coordinate.float
bottom
(int margin) Returns the lower left y-coordinate, considering a given margin.private static float
convertToFloat
(PdfObject object) Returns the high level version of this PdfRectanglefloat
height()
Returns the height of the rectangle.float
left()
Returns the lower left x-coordinate.float
left
(int margin) Returns the lower left x-coordinate, considering a given margin.float
right()
Returns the upper right x-coordinate.float
right
(int margin) Returns the upper right x-coordinate, considering a given margin.rotate()
Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.float
top()
Returns the upper right y-coordinate.float
top
(int margin) Returns the upper right y-coordinate, considering a given margin.float
width()
Returns the width of the rectangle.Methods inherited from class com.lowagie.text.pdf.PdfArray
add, contains, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getElements, getPdfObject, isEmpty, listIterator, remove, remove, set, size, toPdf, toString
Methods inherited from class com.lowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Field Details
-
llx
private float llxlower left x -
lly
private float llylower left y -
urx
private float urxupper right x -
ury
private float uryupper right y
-
-
Constructor Details
-
PdfRectangle
public PdfRectangle(float llx, float lly, float urx, float ury, int rotation) Constructs aPdfRectangle
-object.- Parameters:
llx
- lower left xlly
- lower left yurx
- upper right xury
- upper right yrotation
- the rotation angle- Since:
- rugPdf0.10
-
PdfRectangle
public PdfRectangle(float llx, float lly, float urx, float ury) -
PdfRectangle
public PdfRectangle(float urx, float ury, int rotation) Constructs aPdfRectangle
-object starting from the origin (0, 0).- Parameters:
urx
- upper right xury
- upper right yrotation
- the rotation angle
-
PdfRectangle
public PdfRectangle(float urx, float ury) -
PdfRectangle
Constructs aPdfRectangle
-object with aRectangle
-object.- Parameters:
rectangle
- aRectangle
rotation
- the rotation angle
-
PdfRectangle
-
PdfRectangle
To be used when the array contains 4 float numbers as pdf coordinates like RECT / BBox- Parameters:
rectangle
- as a PdfArray
-
-
Method Details
-
convertToFloat
-
getRectangle
Returns the high level version of this PdfRectangle- Returns:
- this PdfRectangle translated to class Rectangle
-
add
Overrides theadd
-method inPdfArray
in order to prevent the adding of extra object to the array. -
add
public boolean add(float[] values) Block changes to the underlying PdfArray -
add
public boolean add(int[] values) Block changes to the underlying PdfArray -
addFirst
Block changes to the underlying PdfArray -
left
public float left()Returns the lower left x-coordinate.- Returns:
- the lower left x-coordinate
-
right
public float right()Returns the upper right x-coordinate.- Returns:
- the upper right x-coordinate
-
top
public float top()Returns the upper right y-coordinate.- Returns:
- the upper right y-coordinate
-
bottom
public float bottom()Returns the lower left y-coordinate.- Returns:
- the lower left y-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(int margin) Returns the upper right x-coordinate, considering a given margin.- Parameters:
margin
- a margin- Returns:
- the upper right x-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
-
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
-
width
public float width()Returns the width of the rectangle.- Returns:
- a width
-
height
public float height()Returns the height of the rectangle.- Returns:
- a height
-
rotate
Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.- Returns:
- a
PdfRectangle
-