Package org.apache.pdfbox.pdmodel.common
Class PDRectangle
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDRectangle
- All Implemented Interfaces:
COSObjectable
This represents a rectangle in a PDF document.
- Version:
- $Revision: 1.12 $
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PDRectangle
(float width, float height) Constructor.PDRectangle
(BoundingBox box) Constructor.PDRectangle
(COSArray array) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
contains
(float x, float y) Method to determine if the x/y point is inside this rectangle.A convenience method to create a dimension object for AWT operations.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.This will get the underlying array for this rectangle.Convert this standard java object to a COS object.float
This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.float
This will get the lower left x coordinate.float
This will get the lower left y coordinate.float
This will get the upper right x coordinate.float
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.toString()
This will return a string representation of this rectangle.
-
Constructor Details
-
PDRectangle
public PDRectangle()Constructor. Initializes to 0,0,0,0 -
PDRectangle
public PDRectangle(float width, float height) Constructor.- Parameters:
width
- The width of the rectangle.height
- The height of the rectangle.
-
PDRectangle
Constructor.- Parameters:
box
- the bounding box to be used for the rectangle
-
PDRectangle
Constructor.- Parameters:
array
- An array of numbers as specified in the PDF Reference for a rectangle type.
-
-
Method Details
-
contains
public boolean contains(float x, float y) Method to determine if the x/y point is inside this rectangle.- Parameters:
x
- The x-coordinate to test.y
- The y-coordinate to test.- Returns:
- True if the point is inside this rectangle.
-
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- Returns:
- A new rectangle that has been translated back to the origin.
-
getCOSArray
This will get the underlying array for this rectangle.- Returns:
- The cos array.
-
getLowerLeftX
public float getLowerLeftX()This will get the lower left x coordinate.- Returns:
- The lower left x.
-
setLowerLeftX
public void setLowerLeftX(float value) This will set the lower left x coordinate.- Parameters:
value
- The lower left x.
-
getLowerLeftY
public float getLowerLeftY()This will get the lower left y coordinate.- Returns:
- The lower left y.
-
setLowerLeftY
public void setLowerLeftY(float value) This will set the lower left y coordinate.- Parameters:
value
- The lower left y.
-
getUpperRightX
public float getUpperRightX()This will get the upper right x coordinate.- Returns:
- The upper right x .
-
setUpperRightX
public void setUpperRightX(float value) This will set the upper right x coordinate.- Parameters:
value
- The upper right x .
-
getUpperRightY
public float getUpperRightY()This will get the upper right y coordinate.- Returns:
- The upper right y.
-
setUpperRightY
public void setUpperRightY(float value) This will set the upper right y coordinate.- Parameters:
value
- The upper right y.
-
getWidth
public float getWidth()This will get the width of this rectangle as calculated by upperRightX - lowerLeftX.- Returns:
- The width of this rectangle.
-
getHeight
public float getHeight()This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.- Returns:
- The height of this rectangle.
-
createDimension
A convenience method to create a dimension object for AWT operations.- Returns:
- A dimension that matches the width and height of this rectangle.
-
move
public void move(float horizontalAmount, float verticalAmount) This will move the rectangle the given relative amount.- Parameters:
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.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
toString
This will return a string representation of this rectangle.
-