org.pdfbox.pdmodel.common
Class PDRectangle
java.lang.Object
org.pdfbox.pdmodel.common.PDRectangle
- COSObjectable
public class PDRectangle
extends java.lang.Object
This represents a rectangle in a PDF document.
boolean | contains(float x, float y) - Method to determine if the x/y point is inside this rectangle.
|
Dimension | createDimension() - A convenience method to create a dimension object for AWT operations.
|
PDRectangle | createRetranslatedRectangle() - This will create a translated rectangle based off of this rectangle, such
that the new rectangle retains the same dimensions(height/width), but the
lower left x,y values are zero.
|
COSArray | getCOSArray() - This will get the underlying array for this rectangle.
|
COSBase | getCOSObject() - Convert this standard java object to a COS object.
|
float | getHeight() - This will get the height of this rectangle as calculated by
upperRightY - lowerLeftY.
|
float | getLowerLeftX() - This will get the lower left x coordinate.
|
float | getLowerLeftY() - This will get the lower left y coordinate.
|
float | getUpperRightX() - This will get the upper right x coordinate.
|
float | getUpperRightY() - This will get the upper right y coordinate.
|
float | getWidth() - This will get the width of this rectangle as calculated by
upperRightX - lowerLeftX.
|
void | move(float horizontalAmount, float verticalAmount) - This will move the rectangle the given relative amount.
|
void | setLowerLeftX(float value) - This will set the lower left x coordinate.
|
void | setLowerLeftY(float value) - This will set the lower left y coordinate.
|
void | setUpperRightX(float value) - This will set the upper right x coordinate.
|
void | setUpperRightY(float value) - This will set the upper right y coordinate.
|
String | toString() - This will return a string representation of this rectangle.
|
PDRectangle
public PDRectangle()
Constructor.
Initializes to 0,0,0,0
PDRectangle
public PDRectangle(BoundingBox box)
Constructor.
box
- The non PD bouding box.
PDRectangle
public PDRectangle(float width,
float height)
Constructor.
width
- The width of the rectangle.height
- The height of the rectangle.
PDRectangle
public PDRectangle(COSArray array)
Constructor.
array
- An array of numbers as specified in the PDF Reference for a rectangle type.
contains
public boolean contains(float x,
float y)
Method to determine if the x/y point is inside this rectangle.
x
- The x-coordinate to test.y
- The y-coordinate to test.
- True if the point is inside this rectangle.
createDimension
public Dimension createDimension()
A convenience method to create a dimension object for AWT operations.
- A dimension that matches the width and height of this rectangle.
createRetranslatedRectangle
public PDRectangle createRetranslatedRectangle()
This will create a translated rectangle based off of this rectangle, such
that the new rectangle retains the same dimensions(height/width), but the
lower left x,y values are zero.
100, 100, 400, 400 (llx, lly, urx, ury )
will be translated to 0,0,300,300
- A new rectangle that has been translated back to the origin.
getCOSArray
public COSArray getCOSArray()
This will get the underlying array for this rectangle.
getCOSObject
public COSBase getCOSObject()
Convert this standard java object to a COS object.
- getCOSObject in interface COSObjectable
- The cos object that matches this Java object.
getHeight
public float getHeight()
This will get the height of this rectangle as calculated by
upperRightY - lowerLeftY.
- The height of this rectangle.
getLowerLeftX
public float getLowerLeftX()
This will get the lower left x coordinate.
getLowerLeftY
public float getLowerLeftY()
This will get the lower left y coordinate.
getUpperRightX
public float getUpperRightX()
This will get the upper right x coordinate.
getUpperRightY
public float getUpperRightY()
This will get the upper right y coordinate.
getWidth
public float getWidth()
This will get the width of this rectangle as calculated by
upperRightX - lowerLeftX.
- The width of this rectangle.
move
public void move(float horizontalAmount,
float verticalAmount)
This will move the rectangle the given relative amount.
horizontalAmount
- positive values will move rectangle to the right, negative's to the left.verticalAmount
- positive values will move the rectangle up, negative's down.
setLowerLeftX
public void setLowerLeftX(float value)
This will set the lower left x coordinate.
value
- The lower left x.
setLowerLeftY
public void setLowerLeftY(float value)
This will set the lower left y coordinate.
value
- The lower left y.
setUpperRightX
public void setUpperRightX(float value)
This will set the upper right x coordinate.
value
- The upper right x .
setUpperRightY
public void setUpperRightY(float value)
This will set the upper right y coordinate.
value
- The upper right y.
toString
public String toString()
This will return a string representation of this rectangle.