| Package | Description |
|---|---|
| org.apache.pdfbox.contentstream |
This package contains provides classes for working with content streams.
|
| org.apache.pdfbox.pdmodel |
The PDModel package represents a high level API for creating and manipulating PDF documents.
|
| org.apache.pdfbox.pdmodel.common |
High level PD classes that are used throughout several packages are placed in the PDModel common package.
|
| org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf |
The tagged PDF package provides a mechanism for incorporating "tags" (standard
structure types and attributes) into a PDF file.
|
| org.apache.pdfbox.pdmodel.fdf |
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
|
| org.apache.pdfbox.pdmodel.font |
Classes to deal with font functionality in a PDF Document.
|
| org.apache.pdfbox.pdmodel.graphics.form |
This package deals with Form XObjects that are stored in a PDF document.
|
| org.apache.pdfbox.pdmodel.graphics.pattern |
This package deals with patterns which are used instead of colors.
|
| org.apache.pdfbox.pdmodel.graphics.shading |
This package deals with shadings which are used for filling instead of a color.
|
| org.apache.pdfbox.pdmodel.graphics.state |
This package deals with graphics states within the PDF document.
|
| org.apache.pdfbox.pdmodel.interactive.annotation |
The annotation package contains classes that work with PDF annotation elements.
|
| org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible |
This is the visual signature part that help creating the visual representation for the digital signature.
|
| org.apache.pdfbox.pdmodel.interactive.measurement |
The measurement package contains classes that work with elements specifying measure properties.
|
| org.apache.pdfbox.pdmodel.interactive.pagenavigation |
A package to allow provide access to PDF page navigation functionality.
|
| org.apache.pdfbox.rendering |
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDContentStream.getBBox()
Returns the bounding box of the contents.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDPage.getArtBox()
A rectangle, expressed in default user space units, defining the extent of the page's
meaningful content (including potential white space) as intended by the page's creator The
default is the CropBox.
|
PDRectangle |
PDPage.getBBox() |
PDRectangle |
PDPage.getBleedBox()
A rectangle, expressed in default user space units, defining the region to which the contents
of the page should be clipped when output in a production environment.
|
PDRectangle |
PDPage.getCropBox()
A rectangle, expressed in default user space units, defining the visible region of default
user space.
|
PDRectangle |
PDPage.getMediaBox()
A rectangle, expressed in default user space units, defining the boundaries of the physical
medium on which the page is intended to be displayed or printed.
|
PDRectangle |
PDPage.getTrimBox()
A rectangle, expressed in default user space units, defining the intended dimensions of the
finished page after trimming.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDPage.setArtBox(PDRectangle artBox)
This will set the ArtBox for this page.
|
void |
PDPage.setBleedBox(PDRectangle bleedBox)
This will set the BleedBox for this page.
|
void |
PDPage.setCropBox(PDRectangle cropBox)
This will set the CropBox for this page.
|
void |
PDPage.setMediaBox(PDRectangle mediaBox)
This will set the mediaBox for this page.
|
void |
PDPage.setTrimBox(PDRectangle trimBox)
This will set the TrimBox for this page.
|
| Constructor and Description |
|---|
PDPage(PDRectangle mediaBox)
Creates a new instance of PDPage for embedding.
|
| Modifier and Type | Field and Description |
|---|---|
static PDRectangle |
PDRectangle.A0
A rectangle the size of A0 Paper.
|
static PDRectangle |
PDRectangle.A1
A rectangle the size of A1 Paper.
|
static PDRectangle |
PDRectangle.A2
A rectangle the size of A2 Paper.
|
static PDRectangle |
PDRectangle.A3
A rectangle the size of A3 Paper.
|
static PDRectangle |
PDRectangle.A4
A rectangle the size of A4 Paper.
|
static PDRectangle |
PDRectangle.A5
A rectangle the size of A5 Paper.
|
static PDRectangle |
PDRectangle.A6
A rectangle the size of A6 Paper.
|
static PDRectangle |
PDRectangle.LEGAL
A rectangle the size of U.S.
|
static PDRectangle |
PDRectangle.LETTER
A rectangle the size of U.S.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
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.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDLayoutAttributeObject.getBBox()
Gets the bounding box.
|
PDRectangle |
PDArtifactMarkedContent.getBBox()
Gets the artifact's bounding box (BBox).
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDLayoutAttributeObject.setBBox(PDRectangle bbox)
Sets the bounding box.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
FDFAnnotationSquare.getFringe()
This will get the fringe.
|
PDRectangle |
FDFAnnotationFreeText.getFringe()
This will get the fringe.
|
PDRectangle |
FDFAnnotationCircle.getFringe()
This will get the fringe.
|
PDRectangle |
FDFAnnotationCaret.getFringe()
This will retrieve the fringe.
|
PDRectangle |
FDFAnnotation.getRectangle()
The rectangle associated with this annotation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FDFAnnotationSquare.setFringe(PDRectangle fringe)
This will set the fringe rectangle.
|
void |
FDFAnnotationFreeText.setFringe(PDRectangle fringe)
This will set the fringe rectangle.
|
void |
FDFAnnotationCircle.setFringe(PDRectangle fringe)
This will set the fringe rectangle.
|
void |
FDFAnnotationCaret.setFringe(PDRectangle fringe)
This will set the fringe rectangle.
|
void |
FDFAnnotation.setRectangle(PDRectangle rectangle)
Set the rectangle associated with this annotation.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDType3CharProc.getBBox() |
PDRectangle |
PDType3Font.getFontBBox()
This will get the fonts bounding box from its dictionary.
|
PDRectangle |
PDFontDescriptor.getFontBoundingBox()
This will get the fonts bounding box.
|
PDRectangle |
PDType3CharProc.getGlyphBBox()
Calculate the bounding box of this glyph.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDFontDescriptor.setFontBoundingBox(PDRectangle rect)
Set the fonts bounding box.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDFormXObject.getBBox()
An array of four numbers in the form coordinate system (see below),
giving the coordinates of the left, bottom, right, and top edges, respectively,
of the form XObject's bounding box.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDFormXObject.setBBox(PDRectangle bbox)
This will set the BBox (bounding box) for this form.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDTilingPattern.getBBox()
An array of four numbers in the form coordinate system (see
below), giving the coordinates of the left, bottom, right, and top edges,
respectively, of the pattern's bounding box.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDTilingPattern.setBBox(PDRectangle bbox)
This will set the BBox (bounding box) for this Pattern.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDShading.getBBox()
An array of four numbers in the form coordinate system (see below),
giving the coordinates of the left, bottom, right, and top edges,
respectively, of the shading's bounding box.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDShading.setBBox(PDRectangle newBBox)
This will set the BBox (bounding box) for this Shading.
|
| Constructor and Description |
|---|
PDGraphicsState(PDRectangle page)
Constructor with a given page size to initialize the clipping path.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDAnnotation.getRectangle()
The annotation rectangle, defining the location of the annotation on the page in default user space units.
|
PDRectangle |
PDAnnotationSquareCircle.getRectDifference()
This will get the rectangle difference rectangle.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDAnnotation.setRectangle(PDRectangle rectangle)
This will set the rectangle for this annotation.
|
void |
PDAnnotationSquareCircle.setRectDifference(PDRectangle rd)
This will set the rectangle difference rectangle.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDFTemplateStructure.getFormatterRectangle()
Gets formatter rectangle
|
PDRectangle |
PDFTemplateStructure.getSignatureRectangle()
Gets SignatureRectangle
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDVisibleSigBuilder.createHolderForm(PDResources holderFormResources,
PDStream holderFormStream,
PDRectangle formrect) |
void |
PDFTemplateBuilder.createHolderForm(PDResources holderFormResources,
PDStream holderFormStream,
PDRectangle formrect)
Creates Form
|
void |
PDVisibleSigBuilder.createImageForm(PDResources imageFormResources,
PDResources innerFormResource,
PDStream imageFormStream,
PDRectangle formrect,
AffineTransform at,
PDImageXObject img) |
void |
PDFTemplateBuilder.createImageForm(PDResources imageFormResources,
PDResources innerFormResource,
PDStream imageFormStream,
PDRectangle formrect,
AffineTransform affineTransform,
PDImageXObject img)
Creates Image form
|
void |
PDVisibleSigBuilder.createInnerForm(PDResources innerFormResources,
PDStream innerFormStream,
PDRectangle formrect) |
void |
PDFTemplateBuilder.createInnerForm(PDResources innerFormResources,
PDStream innerFormStream,
PDRectangle formrect) |
void |
PDFTemplateStructure.setFormatterRectangle(PDRectangle formatterRectangle)
Sets formatter rectangle
|
void |
PDFTemplateStructure.setSignatureRectangle(PDRectangle signatureRectangle)
Sets SignatureRectangle
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDViewportDictionary.getBBox()
This will retrieve the rectangle specifying the location of the viewport.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDViewportDictionary.setBBox(PDRectangle rectangle)
This will set the rectangle specifying the location of the viewport.
|
| Modifier and Type | Method and Description |
|---|---|
PDRectangle |
PDThreadBead.getRectangle()
The rectangle on the page that this bead is part of.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDThreadBead.setRectangle(PDRectangle rect)
Set the rectangle on the page that this bead covers.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PageDrawer.drawPage(Graphics g,
PDRectangle pageSize)
Draws the page to the requested context.
|
Copyright © 2002–2017 The Apache Software Foundation. All rights reserved.