Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.common.PDRectangle

Field Summary

Modifier and Type	Field and Description
public static final PDRectangle	A0 An immutable rectangle the size of A0 Paper.
public static final PDRectangle	A1 An immutable rectangle the size of A1 Paper.
public static final PDRectangle	A2 An immutable rectangle the size of A2 Paper.
public static final PDRectangle	A3 An immutable rectangle the size of A3 Paper.
public static final PDRectangle	A4 An immutable rectangle the size of A4 Paper.
public static final PDRectangle	A5 An immutable rectangle the size of A5 Paper.
public static final PDRectangle	A6 An immutable rectangle the size of A6 Paper.
public static final PDRectangle	LEGAL An immutable rectangle the size of U.S.
public static final PDRectangle	LETTER An immutable rectangle the size of U.S.
private static final float	POINTS_PER_INCH user space units per inch
private static final float	POINTS_PER_MM user space units per millimeter
private final COSArray	rectArray
public static final PDRectangle	TABLOID An immutable rectangle the size of U.S.

Constructor Summary

Access	Constructor and Description
public	PDRectangle() Constructor.
public	PDRectangle(float The width of the rectangle. width, float The height of the rectangle. height) Constructor.
public	PDRectangle(float the x coordinate of the rectangle x, float the y coordinate of the rectangle y, float The width of the rectangle. width, float The height of the rectangle. height) Constructor.
public	PDRectangle(BoundingBox the bounding box to be used for the rectangle box) Constructor.
public	PDRectangle(COSArray An array of numbers as specified in the PDF Reference for a rectangle type. array) Constructor.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: True if the point is inside this rectangle. contains(float The x-coordinate to test. x, float The y-coordinate to test. y) Method to determine if the x/y point is inside this rectangle.
public PDRectangle	Returns: A new rectangle that has been translated back to the origin. 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.
public COSArray	Returns: The cos array. getCOSArray() This will get the underlying array for this rectangle.
public COSBase	Returns: The cos object that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public float	Returns: The height of this rectangle. getHeight() This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.
public float	Returns: The lower left x. getLowerLeftX() This will get the lower left x coordinate.
public float	Returns: The lower left y. getLowerLeftY() This will get the lower left y coordinate.
public float	Returns: The upper right x . getUpperRightX() This will get the upper right x coordinate.
public float	Returns: The upper right y. getUpperRightY() This will get the upper right y coordinate.
public float	Returns: The width of this rectangle. getWidth() This will get the width of this rectangle as calculated by upperRightX - lowerLeftX.
public void	setLowerLeftX(float The lower left x. value) This will set the lower left x coordinate.
public void	setLowerLeftY(float The lower left y. value) This will set the lower left y coordinate.
public void	setUpperRightX(float The upper right x . value) This will set the upper right x coordinate.
public void	setUpperRightY(float The upper right y. value) This will set the upper right y coordinate.
public GeneralPath	Returns: a general path equivalent to this rectangle toGeneralPath() Returns a general path equivalent to this rectangle.
public String	Returns: This object as a string. toString() Overrides java.lang.Object.toString. This will return a string representation of this rectangle.
public GeneralPath	Returns: the transformed rectangle transform(Matrix the matrix to be used for the transformation matrix) Returns a path which represents this rectangle having been transformed by the given matrix.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

A0	back to summary
public static final PDRectangle A0 An immutable rectangle the size of A0 Paper. Annotations @SuppressWarnings:java:S2390

A1	back to summary
public static final PDRectangle A1 An immutable rectangle the size of A1 Paper. Annotations @SuppressWarnings:java:S2390

A2	back to summary
public static final PDRectangle A2 An immutable rectangle the size of A2 Paper. Annotations @SuppressWarnings:java:S2390

A3	back to summary
public static final PDRectangle A3 An immutable rectangle the size of A3 Paper. Annotations @SuppressWarnings:java:S2390

A4	back to summary
public static final PDRectangle A4 An immutable rectangle the size of A4 Paper. Annotations @SuppressWarnings:java:S2390

A5	back to summary
public static final PDRectangle A5 An immutable rectangle the size of A5 Paper. Annotations @SuppressWarnings:java:S2390

A6	back to summary
public static final PDRectangle A6 An immutable rectangle the size of A6 Paper. Annotations @SuppressWarnings:java:S2390

LEGAL	back to summary
public static final PDRectangle LEGAL An immutable rectangle the size of U.S. Legal, 8.5" x 14". Annotations @SuppressWarnings:java:S2390

LETTER	back to summary
public static final PDRectangle LETTER An immutable rectangle the size of U.S. Letter, 8.5" x 11". Annotations @SuppressWarnings:java:S2390

POINTS_PER_INCH	back to summary
private static final float POINTS_PER_INCH user space units per inch

POINTS_PER_MM	back to summary
private static final float POINTS_PER_MM user space units per millimeter

rectArray	back to summary
private final COSArray rectArray

TABLOID	back to summary
public static final PDRectangle TABLOID An immutable rectangle the size of U.S. Tabloid, 11" x 17". Annotations @SuppressWarnings:java:S2390

Constructor Detail

PDRectangle	back to summary
public PDRectangle() Constructor. Initializes to 0,0,0,0

PDRectangle	back to summary
public PDRectangle(float width, float height) Constructor. Parameters width:float The width of the rectangle. height:float The height of the rectangle.

PDRectangle

back to summary

public PDRectangle(float width, float height)

Constructor.

Parameters

width:float: The width of the rectangle.
height:float: The height of the rectangle.

PDRectangle	back to summary
public PDRectangle(float x, float y, float width, float height) Constructor. Parameters x:float the x coordinate of the rectangle y:float the y coordinate of the rectangle width:float The width of the rectangle. height:float The height of the rectangle.

PDRectangle

back to summary

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

Constructor.

Parameters

x:float: the x coordinate of the rectangle
y:float: the y coordinate of the rectangle
width:float: The width of the rectangle.
height:float: The height of the rectangle.

PDRectangle	back to summary
public PDRectangle(BoundingBox box) Constructor. Parameters box:BoundingBox the bounding box to be used for the rectangle

PDRectangle

back to summary

public PDRectangle(BoundingBox box)

Constructor.

Parameters

box:BoundingBox: the bounding box to be used for the rectangle

PDRectangle	back to summary
public PDRectangle(COSArray array) Constructor. Parameters array:COSArray An array of numbers as specified in the PDF Reference for a rectangle type.

PDRectangle

back to summary

public PDRectangle(COSArray array)

Constructor.

Parameters

array:COSArray: An array of numbers as specified in the PDF Reference for a rectangle type.

Method Detail

contains	back to summary
public boolean contains(float x, float y) Method to determine if the x/y point is inside this rectangle. Parameters x:float The x-coordinate to test. y:float The y-coordinate to test. Returns:boolean True if the point is inside this rectangle.

contains

back to summary

public boolean contains(float x, float y)

Method to determine if the x/y point is inside this rectangle.

Parameters

x:float: The x-coordinate to test.
y:float: The y-coordinate to test.

Returns:boolean

True if the point is inside this rectangle.

createRetranslatedRectangle	back to summary
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 Returns:PDRectangle A new rectangle that has been translated back to the origin.

createRetranslatedRectangle

back to summary

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

Returns:PDRectangle: A new rectangle that has been translated back to the origin.

getCOSArray	back to summary
public COSArray getCOSArray() This will get the underlying array for this rectangle. Returns:COSArray The cos array.

getCOSArray

back to summary

public COSArray getCOSArray()

This will get the underlying array for this rectangle.

Returns:COSArray: The cos array.

getCOSObject	back to summary
public COSBase getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSBase The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSBase getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSBase

The cos object that matches this Java object.

Annotations

@Override

getHeight	back to summary
public float getHeight() This will get the height of this rectangle as calculated by upperRightY - lowerLeftY. Returns:float The height of this rectangle.

getHeight

back to summary

public float getHeight()

This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.

Returns:float: The height of this rectangle.

getLowerLeftX	back to summary
public float getLowerLeftX() This will get the lower left x coordinate. Returns:float The lower left x.

getLowerLeftX

back to summary

public float getLowerLeftX()

This will get the lower left x coordinate.

Returns:float: The lower left x.

getLowerLeftY	back to summary
public float getLowerLeftY() This will get the lower left y coordinate. Returns:float The lower left y.

getLowerLeftY

back to summary

public float getLowerLeftY()

This will get the lower left y coordinate.

Returns:float: The lower left y.

getUpperRightX	back to summary
public float getUpperRightX() This will get the upper right x coordinate. Returns:float The upper right x .

getUpperRightX

back to summary

public float getUpperRightX()

This will get the upper right x coordinate.

Returns:float: The upper right x .

getUpperRightY	back to summary
public float getUpperRightY() This will get the upper right y coordinate. Returns:float The upper right y.

getUpperRightY

back to summary

public float getUpperRightY()

This will get the upper right y coordinate.

Returns:float: The upper right y.

getWidth	back to summary
public float getWidth() This will get the width of this rectangle as calculated by upperRightX - lowerLeftX. Returns:float The width of this rectangle.

getWidth

back to summary

public float getWidth()

This will get the width of this rectangle as calculated by upperRightX - lowerLeftX.

Returns:float: The width of this rectangle.

setLowerLeftX	back to summary
public void setLowerLeftX(float value) This will set the lower left x coordinate. Parameters value:float The lower left x.

setLowerLeftX

back to summary

public void setLowerLeftX(float value)

This will set the lower left x coordinate.

Parameters

value:float: The lower left x.

setLowerLeftY	back to summary
public void setLowerLeftY(float value) This will set the lower left y coordinate. Parameters value:float The lower left y.

setLowerLeftY

back to summary

public void setLowerLeftY(float value)

This will set the lower left y coordinate.

Parameters

value:float: The lower left y.

setUpperRightX	back to summary
public void setUpperRightX(float value) This will set the upper right x coordinate. Parameters value:float The upper right x .

setUpperRightX

back to summary

public void setUpperRightX(float value)

This will set the upper right x coordinate.

Parameters

value:float: The upper right x .

setUpperRightY	back to summary
public void setUpperRightY(float value) This will set the upper right y coordinate. Parameters value:float The upper right y.

setUpperRightY

back to summary

public void setUpperRightY(float value)

This will set the upper right y coordinate.

Parameters

value:float: The upper right y.

toGeneralPath	back to summary
public GeneralPath toGeneralPath() Returns a general path equivalent to this rectangle. This method avoids the problems caused by Rectangle2D not working well with -ve rectangles. Returns:GeneralPath a general path equivalent to this rectangle

toGeneralPath

back to summary

public GeneralPath toGeneralPath()

Returns a general path equivalent to this rectangle. This method avoids the problems caused by Rectangle2D not working well with -ve rectangles.

Returns:GeneralPath: a general path equivalent to this rectangle

toString	back to summary
public String toString() Overrides java.lang.Object.toString. This will return a string representation of this rectangle. Returns:String This object as a string. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

This will return a string representation of this rectangle.

Returns:String

This object as a string.

Annotations

@Override

transform	back to summary
public GeneralPath transform(Matrix matrix) Returns a path which represents this rectangle having been transformed by the given matrix. Note that the resulting path need not be rectangular. Parameters matrix:Matrix the matrix to be used for the transformation Returns:GeneralPath the transformed rectangle

transform

back to summary

public GeneralPath transform(Matrix matrix)

Returns a path which represents this rectangle having been transformed by the given matrix. Note that the resulting path need not be rectangular.

Parameters

matrix:Matrix: the matrix to be used for the transformation

Returns:GeneralPath

the transformed rectangle

public Class PDRectangle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail