com.qoppa.pdfProcess

Class PDFPage

java.lang.Object

com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

com.qoppa.pdfProcess.PDFPage

All Implemented Interfaces:

IPDFPage

public class PDFPage
extends com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

This class holds a page in a PDF document.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPRESSION_DEFLATE
static int	COMPRESSION_JBIG2
static int	COMPRESSION_JPEG

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Annotation annot) Adds a new annotation to this page.
void	addJPEGImage(File jpegFile, int x, int y, AffineTransform xform) Adds a JPEG image onto this page.
SignatureField	addSignatureField(String fieldName, Rectangle2D bounds) Adds a signature field to this page.
void	appendPageContent(PDFPage srcPage, double x, double y, double scaleX, double scaleY, Layer layer) Adds the content of another page to this page.
boolean	applyRedactionAnnotation(Redaction redactionAnnot) This method will apply or "burn in" the redaction annotation.
boolean	applyRedactionAnnotations() This method will apply or "burn in" all redaction annotations that are on this PDFPage.
boolean	containsInvisibleText() Checks whether the page contains text which is invisible.
Annotation	copyAnnotation(Annotation annot) Use this method to copy a single annotation onto this page, from this or other documents.
void	copyAnnotations(PDFPage srcPage) Use this method to copy annotations onto this page, from this or other documents.
void	copyAnnotations(PDFPage srcPage, Layer layer) Use this method to copy annotations onto this page, from this or other documents.
Graphics2D	createGraphics() Creates a Graphics2D object to draw into this page.
Graphics2D	createGraphics(Layer layer) Creates a graphics object that encapsulates a layer in a PDF document.
void	deleteAnnotations() Deprecated. Use deleteAnnotations(List) instead.
int	deleteAnnotations(List<? extends Annotation> annots) Deletes a list of annotations on the page.
void	drawImage(Image image, int dstX, int dstY, Color bgndColor, AffineTransform xform, ImageCompression imageSettings) Draws an image onto this page.
void	drawImage(Image image, int dstX, int dstY, int dstWidth, int dstHeight, Color bgndColor, AffineTransform xform, ImageCompression imageSettings) Draws an image onto this page.
void	drawImage(Image image, int dstX, int dstY, int dstWidth, int dstHeight, Color bgndColor, AffineTransform xform, ImageCompression params, Float alpha) Draws an image onto this page.
void	drawText(String str, Font font, Paint textPaint, double x, double y, AffineTransform xform) Draw text to this page using Java Font
void	fillShape(Shape shape, Paint shapePaint, double offsetX, double offsetY, AffineTransform xform) Fills a shape on this page.
Vector<TextPosition>	findText(String searchText, boolean caseSensitive, boolean wholeWords) This method searches for the given text in the page.
Vector<TextPosition>	findTextUsingRegex(String regex) This method searches for the given text in the page.
Vector<TextPositionWithContext>	findTextWithContext(String searchText, boolean caseSensitive, boolean wholeWords) This method searches for the given text in the page.
Vector<TextPositionWithContext>	findTextWithContextUsingRegEx(String regexString) This method searches for text in the page for matches with the given regular expression.
Object	flattenAnnotation(Annotation annot) Flatten an annotation into the content.
Object	flattenAnnotations(boolean paintNonPrintableAnnots) Flattens the annotations.
void	flattenWidget(Widget widget) Flatten a widget into the content layer of the page.
Vector<Annotation>	getAnnotations() Returns a list of PDF annotations in this page, including form fields widgets.
Rectangle2D	getArtBox() Return this page's Art Box.
Rectangle2D	getBleedBox() Return this page's Bleed Box.
Rectangle2D	getCropBox() Return this page's Crop Box.
double	getDisplayHeight() Gets the page's display height.
double	getDisplayWidth() Gets the page's display width.
double	getDisplayX() Returns the page's left margin.
double	getDisplayY() Returns the page's top margin.
PDFDocument	getDocument() Returns the document that this page belongs to.
BufferedImage	getImage() Returns a BufferedImage containing a rendering of the page at the default PDF resolution: 72 DPI.
BufferedImage	getImage(int dpi) Returns a BufferedImage containing a rendering of the page at the given resolution in DPI.
BufferedImage	getImage(int width, int height, boolean keepAspect) Returns a buffered image showing the contents of this page.
BufferedImage	getImageCS(int dpi, ColorSpace imageCS) Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI.
BufferedImage	getImageCS(int dpi, ColorSpace imageCS, boolean simOverprint) Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI.
Rectangle2D	getMediaBox() Returns this page's Media Box.
int	getPageIndex() Gets the page index of this page within the document.
String	getPageLabel() Returns the page label for this page.
int	getPageRotation() Returns the rotation of this page in degrees.
double	getPaperHeight() Returns the paper's height of this page in 72 DPI.
double	getPaperWidth() Returns the paper's width of this page in 72 DPI.
BufferedImage	getSubImage(Rectangle2D pageArea, int dpi) Returns an image for part of the page.
String	getTabbingOrder() Returns the tabbing order as defined in the page description, if present.
String	getText() Returns the text content of this page as a String.
TextContent	getTextContent() This method returns a TextContent object that represents the text content in a page.
TextSelection	getTextInArea(Rectangle2D selectArea) Selects the text in an area of the page.
TextSelection	getTextWithCursors(Point2D startCursor, Point2D endCursor) Returns the text contained between the start and end cursors, in "reading mode".
Rectangle2D	getTrimBox() Return this page's Trim Box.
void	insert_hOCR(String hocrText, boolean renderText) This methods inserts hOCR text into this page.
boolean	isEmpty() Check whether the page is empty.
void	paintPage(Graphics2D g2d) Paints this page to the given graphics object.
void	paintPage(Graphics2D g2d, boolean paintAnnotations) Paints this page to the given graphics object, with an option to paint the annotations on the page.
void	prependPageContent(PDFPage srcPage, double x, double y, double scaleX, double scaleY, Layer layer) Prepend the contents of another page to this page.
void	printPage(Graphics2D g2d, PageFormat pf, PrintSettings printSettings) Prints this page given a page format describing the printer's page and a PrintSettings object.
void	removeAnnotation(Annotation annot) Removes an annotation from this page.
void	resizePage(ResizePageOptions options) Sets this page's Media Box.
void	savePageAsGIF(OutputStream outStream, int dpi) Render the page as an image and save it to the output stream in GIF format.
void	savePageAsJPEG(OutputStream outStream, int dpi, float quality) Render the page as an image and save it to the output stream in JPEG format.
void	savePageAsJPEG2000(OutputStream outStream, int dpi, float quality) Render the page as an image and save it to the output stream in JPEG2000 format.
void	savePageAsPNG(OutputStream outStream, int dpi) Render the page as an image and save it to the output stream in PNG format.
void	savePageAsTIFF(OutputStream outStream, double resDPI, String tiffCompression) Save the rendering image of the page to the given OutputStream in TIFF format.
void	savePageAsTIFF(OutputStream outStream, TIFFOptions options) Render the page to an image and save it in TIFF format to the given OutputStream.
void	setArtBox(Rectangle2D rect) Sets this page's Art Box.
void	setBleedBox(Rectangle2D rect) Sets this page's Bleed Box.
void	setClip(Area newClip) Sets the clip area in the page's content stream when drawing to the page.
void	setCropBox(Rectangle2D rect) Sets the PDF page's 'CropBox'.
void	setPageRotation(int degrees) Changes this page's rotation.
void	setTrimBox(Rectangle2D rect) Sets this page's Trim Box.
void	strokeShape(Shape shape, Paint shapePaint, double offsetX, double offsetY, AffineTransform xform) Draws the outline of a shape on this page.
String	useGradientPaint(GradientPaint paint)
String	useGState(double strokeAlpha, double fillAlpha, String blendName)

Methods inherited from class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

drawAnnotations, findTextUsingRegex, getAbstractPDFDocument, getAdditionalActions, getColorSpace, getIDocument, getImage, getImageModel, getImageWithoutText, getImageWithoutTextGray, getPageTransform, getPageTransformWithoutMirror, getPDFGraphicsOperators, getShapes, getStreamWithResources, getTextInArea, getTextModel, hasText, invalidateTextModel, pageHasNoText, paintHighlights, paintPage, paintPageContent, setAdditionalActions, updateActionsDictionary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPRESSION_DEFLATE

public static final int COMPRESSION_DEFLATE

See Also:

Constant Field Values

COMPRESSION_JBIG2

public static final int COMPRESSION_JBIG2

See Also:

Constant Field Values

COMPRESSION_JPEG

public static final int COMPRESSION_JPEG

See Also:

Constant Field Values

Method Detail

addAnnotation

public void addAnnotation(Annotation annot)
                   throws PDFException

Adds a new annotation to this page. This method should only be used with annotations that have been newly created using the AnnotationFactory. It should not be used with existing annotations from this documetn or from other documents. To do this, use the copyAnnotation method.

Overrides:

addAnnotation in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

annot - The annotation to add.

Throws:

PDFException

addJPEGImage

public void addJPEGImage(File jpegFile,
                         int x,
                         int y,
                         AffineTransform xform)
                  throws PDFException,
                         IOException

Adds a JPEG image onto this page.

Parameters:

jpegFile - The JPEG file.

x - The horizontal position of the image in 72 DPI.

y - The vertical position of the image in 72 DPI.

xform - A transform to apply to the image before drawing it to the page. This parameter can be left null for no transform.

Throws:

PDFException

IOException

addSignatureField

public SignatureField addSignatureField(String fieldName,
                                        Rectangle2D bounds)
                                 throws PDFException

Adds a signature field to this page. The signature field is added to the page but is NOT signed. To sign the document, the application must call PDFDocument.signDocument. To create an invisible signature field, the bound rectangle should be set to (0,0,0,0) for the bounds.

Parameters:

fieldName - The name of the new field.

bounds - The bounds of the field on the page. (0,0,0,0) indicates that the signature field will be invisible.

Throws:

PDFException

appendPageContent

public void appendPageContent(PDFPage srcPage,
                              double x,
                              double y,
                              double scaleX,
                              double scaleY,
                              Layer layer)
                       throws PDFException

Adds the content of another page to this page. This method takes the content stream and directly appends it to this page without doing any processing. If x and y are set to 0, the source page will be aligned with the destination so that the upper left corners coincide. An optional layer argument can be specified in which to put the source page content.

Parameters:

srcPage - The source page to take the content stream from.

x - The X position on the destination page at which the upper left corner of the source page will be placed.

y - The Y position on the destination page at which the upper left corner of the source page will be placed.

scaleX - Horizontal scale to apply to the source page before adding it to the destination page. The scale is 1 based, 1 = full scale.

scaleY - Vertical scale to apply to the source page before adding it to the destination page. The scale is 1 based, 1 = full scale.

layer - The layer to append the source page content stream, or null.

Throws:

PDFException

IllegalArgumentException - if layer is not null, layer must be from the target document

See Also:

prependPageContent(PDFPage, double, double, double, double, Layer)

copyAnnotation

public Annotation copyAnnotation(Annotation annot)
                          throws PDFException

Use this method to copy a single annotation onto this page, from this or other documents. The method will clone the annotation and then add it to this page. Because this method only copies a single annotation, the copied annotation will lose any associations to other annotations which it had in the previous document; if it was part of a group, it no longer will be.

Returns:

The new annotation.

Throws:

PDFException

copyAnnotations

public void copyAnnotations(PDFPage srcPage)
                     throws PDFException

Use this method to copy annotations onto this page, from this or other documents. The method will clone all annotations (except for widgets/fields) on the source page, and add them to this page. All annotation groupings will be preserved.

Parameters:

srcPage - The source page to copy annotations from

Throws:

PDFException

copyAnnotations

public void copyAnnotations(PDFPage srcPage,
                            Layer layer)
                     throws PDFException

Use this method to copy annotations onto this page, from this or other documents. The method will clone all annotations (except for widgets/fields) on the source page, and add them to this page. All annotation groupings will be preserved. If layer is not null, the layer must belong to this PDFPage's PDFDocument.

Parameters:

srcPage - The source page to copy annotations from

layer - The layer to add the annotations to, may be null

Throws:

PDFException

createGraphics

public Graphics2D createGraphics()
                          throws PDFException

Creates a Graphics2D object to draw into this page. Anything drawn to this graphics object will be drawn onto the PDF page and can then be saved into a PDF document or printed. New content will be drawn on top of the current page content.

The Graphics2D object will initially have its origin on the upper left corner of the page's crop box (the visible area of the page).

Returns:

Graphics2D Graphics object used to draw into this page.

Throws:

PDFException

createGraphics

public Graphics2D createGraphics(Layer layer)
                          throws PDFException

Creates a graphics object that encapsulates a layer in a PDF document. When drawing to this graphics object, all elements will be drawn into a new layer (optional content group) in the pdf document.

The Graphics2D object will initially have its origin on the upper left corner of the page's crop box (the visible area of the page).

Parameters:

layer - The layer to draw into. This object must be created through PDFDocument.addLayer()

Returns:

A Graphics2D object that can be drawn into.

Throws:

PDFException

deleteAnnotations

public void deleteAnnotations()
                       throws PDFException

Deprecated. Use deleteAnnotations(List) instead.

Delete all annotations from the page. This removes all the annotations in the PDF page. Even though technically, links, sounds, redactions, widgets (text fields, buttons, etc) and file attachments are annotations, this method does not delete them as they are not annotations in the logical sense.

Throws:

PDFException

drawImage

public void drawImage(Image image,
                      int dstX,
                      int dstY,
                      Color bgndColor,
                      AffineTransform xform,
                      ImageCompression imageSettings)
               throws PDFException

Draws an image onto this page. The image will be drawn at the specified dstX, dstY location and will not be scaled except for any transform passed into the method.

Parameters:

image - The image to draw.

dstX - The horizontal position of the image in 72 DPI.

dstY - The vertical position of the image in 72 DPI.

bgndColor - The background color if any. If this parameter is not null, the method will first fill a rectangle with this color where the image will be drawn, then draw the image on top.

xform - A transform to apply to the image before drawing it to the page. This parameter can be left null for no transform.

imageSettings - An ImageCompression object describing what compression to use when writing images to the PDF document. If null, the library will use default settings.

Throws:

PDFException

drawImage

public void drawImage(Image image,
                      int dstX,
                      int dstY,
                      int dstWidth,
                      int dstHeight,
                      Color bgndColor,
                      AffineTransform xform,
                      ImageCompression imageSettings)
               throws PDFException

Draws an image onto this page. The image will be scaled to dstWidth and dstHeight. If dstWidth or dstHeight are set to 0, the method will get the destination width and/or height from the image size.

Parameters:

image - The image to draw.

dstX - The horizontal position of the image in 72 DPI.

dstY - The vertical position of the image in 72 DPI.

dstWidth - The width on the page that the image will occupy. If this is <= 0, the method will use the image's width.

dstHeight - The height on the page that the image will occupy. If this is <= 0, the method will use the image's height.

bgndColor - The background color if any. If this parameter is not null, the method will first fill a rectangle with this color where the image will be drawn, then draw the image on top.

xform - A transform to apply to the image before drawing it to the page. This parameter can be left null for no transform.

imageSettings - An ImageCompression object describing what compression to use when writing images to the PDF document. If null, the library will use default settings.

Throws:

PDFException

drawImage

public void drawImage(Image image,
                      int dstX,
                      int dstY,
                      int dstWidth,
                      int dstHeight,
                      Color bgndColor,
                      AffineTransform xform,
                      ImageCompression params,
                      Float alpha)
               throws PDFException

Draws an image onto this page. The image will be scaled to dstWidth and dstHeight. If dstWidth or dstHeight are set to 0, the method will get the destination width and/or height from the image size.

Parameters:

image - The image to draw.

dstX - The horizontal position of the image in 72 DPI.

dstY - The vertical position of the image in 72 DPI.

dstWidth - The width on the page that the image will occupy. If this is <= 0, the method will use the image's width.

dstHeight - The height on the page that the image will occupy. If this is <= 0, the method will use the image's height.

bgndColor - The background color if any. If this parameter is not null, the method will first fill a rectangle with this color where the image will be drawn, then draw the image on top.

xform - A transform to apply to the image before drawing it to the page. This parameter can be left null for no transform.

params - An ImageCompression object describing what compression to use when writing images to the PDF document. If null, the library will use default settings.

alpha - The alpha component to display the image with transparency

Throws:

PDFException

drawText

public void drawText(String str,
                     Font font,
                     Paint textPaint,
                     double x,
                     double y,
                     AffineTransform xform)
              throws PDFException

Draw text to this page using Java Font

Parameters:

str - The string to draw on the page.

font - The font to use when drawing the text.

textPaint - The color to use when drawing the text.

x - The horizontal position of the text on the page, in 72 DPI.

y - The vertical position of the text on the page, in 72 DPI.

xform - A transform to apply to the text before drawing it to the page.

Throws:

PDFException

fillShape

public void fillShape(Shape shape,
                      Paint shapePaint,
                      double offsetX,
                      double offsetY,
                      AffineTransform xform)

Fills a shape on this page.

Parameters:

shape - The shape to fill.

shapePaint - The color to use when filling the shape.

offsetX - A horizontal offset to apply before drawing the shape, in 72 DPI.

offsetY - A vertical offset to apply before drawing the shape, in 72 DPI.

xform - A transform to apply to the shape before drawing it to the page.

findText

public Vector<TextPosition> findText(String searchText,
                                     boolean caseSensitive,
                                     boolean wholeWords)
                              throws PDFException

This method searches for the given text in the page. If there are instances of the text found, the method returns a Vector of TextPosition objects. These objects contain information about the text and its position. If there is no occurrences of the search text found on the page, the method returns a Vector of 0 length.

Specified by:

findText in interface IPDFPage

Overrides:

findText in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

searchText - The text to search for.

caseSensitive - Flag to determine if the search should be case sensitive.

wholeWords - Flag to indicate if only whole words should be found

Returns:

A list of TextPosition objects

Throws:

PDFException

getTextWithCursors

public TextSelection getTextWithCursors(Point2D startCursor,
                                        Point2D endCursor)
                                 throws PDFException

Returns the text contained between the start and end cursors, in "reading mode". Reading mode implies line wrapping, column detection and wrapping and more. The effect should be the same as if the user chose the text selection tool, pressed down at the startCursor location and dragged to the endCursor location.

Specified by:

getTextWithCursors in interface IPDFPage

Overrides:

getTextWithCursors in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

startCursor - the location where the cursor should start selection

endCursor - The location where the cursor ends selection

Returns:

A TextSelection object representing the text that was selected.

Throws:

PDFException

getTextInArea

public TextSelection getTextInArea(Rectangle2D selectArea)
                            throws PDFException

Selects the text in an area of the page. The coordinates on the page should be in 'display' coords, i.e. the origin of the coordinates is page.getCropBox.getX() and page.getCropBox().getY().

Specified by:

getTextInArea in interface IPDFPage

Overrides:

getTextInArea in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

A TextSelection object representing the selected text. null if no text is selected. The text selection coordinates will be returned in 'display' space as well, i.e. the origin of the coordinates is page.getCropBox.getX() and page.getCropBox().getY();

Throws:

PDFException

flattenAnnotation

public Object flattenAnnotation(Annotation annot)
                         throws PDFException

Flatten an annotation into the content. When an annotation is flattened, it becomes part of the content of the PDF and is not editable anymore.

Parameters:

annot - The annotation to flatten.

Returns:

This method returns an internal object.

Throws:

PDFException

flattenAnnotations

public Object flattenAnnotations(boolean paintNonPrintableAnnots)
                          throws PDFException

Flattens the annotations. This makes the annotations uneditable and merges the content of the annotations with the page. Even though technically, links, sounds, redactions, widgets (text fields, buttons, etc) and file attachments are annotations, this method does not delete them as they are not annotations in the logical sense. To delete these, the application needs to call the removeAnnotation() method with the annotation as an argument.

Overrides:

flattenAnnotations in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

paintNonPrintableAnnots - Flag to indicate whether non-printable annotations should be painted or not.

Returns:

This method returns an internal object.

Throws:

PDFException

deleteAnnotations

public int deleteAnnotations(List<? extends Annotation> annots)
                      throws PDFException

Deletes a list of annotations on the page. To get a list of all annotations on the page, an application can call the getAnnotations() method. If not all annotations will be deleted, the application can pick and choose the annotations to delete from the full list.

Parameters:

annots - The list of annotations that should be deleted.

Returns:

The number of annotations deleted.

Throws:

PDFException - Thrown when there is any errors parsing PDF content.

flattenWidget

public void flattenWidget(Widget widget)
                   throws PDFException

Flatten a widget into the content layer of the page. After flattening the widget, the widget is removed from the list of widgets in the page.

Parameters:

widget - The widget to flatten

Throws:

PDFException

getDocument

public PDFDocument getDocument()

Returns the document that this page belongs to. A PDFPage can only belong to a single document at a time.

Returns:

The parent document.

getImage

public BufferedImage getImage()
                       throws PDFException

Returns a BufferedImage containing a rendering of the page at the default PDF resolution: 72 DPI.

Throws:

PDFException

getImageCS

public BufferedImage getImageCS(int dpi,
                                ColorSpace imageCS)
                         throws PDFException

Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. Note that this method will render content directly onto the image in the image's color space, not render in RGB and then convert. This method should can be used to preview output to devices that have a specific color spaces, such as printers.

Parameters:

dpi - Dots per inch at which to render the image.

imageCS - The color space to use when creating the image.

Returns:

A BufferedImage object of the page at the requested DPI.

Throws:

PDFException

getImageCS

public BufferedImage getImageCS(int dpi,
                                ColorSpace imageCS,
                                boolean simOverprint)
                         throws PDFException

Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. Note that this method will render content directly onto the image in the image's color space, not render in RGB and then convert. This method should can be used to preview output to devices that have a specific color spaces, such as printers.

Parameters:

dpi - Dots per inch at which to render the image.

imageCS - The color space to use when creating the image.

simOverprint - Flag indicating whether the renderer should simulate overprinting.

Returns:

A BufferedImage object of the page at the requested DPI.

Throws:

PDFException

getImage

public BufferedImage getImage(int dpi)
                       throws PDFException

Returns a BufferedImage containing a rendering of the page at the given resolution in DPI.

Parameters:

dpi - Dots per inch at which to render the image.

Returns:

A BufferedImage object of the page at the requested DPI.

Throws:

PDFException

getPageIndex

public int getPageIndex()

Gets the page index of this page within the document. Page index starts at 0.

Specified by:

getPageIndex in interface IPDFPage

Specified by:

getPageIndex in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

int This page's index

getPageLabel

public String getPageLabel()
                    throws PDFException

Returns the page label for this page. Labels can be defined in a document to use any string, including for instance roman numerals, or any other labels. This method returns the page label defined for this page, if there is a definition in the document. If there is no definition, this method returns the page number as a string. Page numbers start with 1.

Overrides:

getPageLabel in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

the page label

Throws:

PDFException

getPaperHeight

public double getPaperHeight()

Returns the paper's height of this page in 72 DPI. This values comes from the page's MediaBox.

Returns:

double Height of this page

getPaperWidth

public double getPaperWidth()

Returns the paper's width of this page in 72 DPI. This values comes from the page's MediaBox.

Returns:

double Width of this page

getSubImage

public BufferedImage getSubImage(Rectangle2D pageArea,
                                 int dpi)
                          throws PDFException

Returns an image for part of the page. The section of the page to get the image for is specified in a rectangle, the resolution of the image is given in the dpi argument.

Parameters:

pageArea - The area of the page to get an image for.

dpi - The desired resolution for the image.

Returns:

A BufferedImage object of the section of the page requested.

Throws:

PDFException

isEmpty

public boolean isEmpty()
                throws PDFException

Check whether the page is empty. An empty page is a page without any content on it.

Returns:

true if the page is empty, false otherwise.

Throws:

PDFException

prependPageContent

public void prependPageContent(PDFPage srcPage,
                               double x,
                               double y,
                               double scaleX,
                               double scaleY,
                               Layer layer)
                        throws PDFException

Prepend the contents of another page to this page. This method takes the content stream and adds it directly before the current page's content. This will have the effect of adding the content underneath the current content. If x and y are set to 0, the upper left corners of the two pages will coincide. An optional layer argument can be specified in which to put the source page content.

Parameters:

srcPage - The source page to take the content stream from.

x - The X position on the destination page at which the upper left corner of the source page will be placed

y - The Y position on the destination page at which the upper left corner of the source page will be placed

scaleX - Horizontal scale to apply to the source page before adding it to the destination page.

scaleY - Vertical scale to apply to the source page before adding it to the destination page.

layer - The layer to append the source page content stream, or null.

Throws:

PDFException

IllegalArgumentException - if layer is not null, layer must be from the target document

See Also:

appendPageContent(PDFPage, double, double, double, double, Layer)

removeAnnotation

public void removeAnnotation(Annotation annot)
                      throws PDFException

Removes an annotation from this page.

Parameters:

annot - A reference to the annotation that needs to be removed.

Throws:

PDFException

savePageAsGIF

public void savePageAsGIF(OutputStream outStream,
                          int dpi)
                   throws PDFException,
                          IOException

Render the page as an image and save it to the output stream in GIF format.

Parameters:

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.

Throws:

PDFException

IOException

savePageAsJPEG

public void savePageAsJPEG(OutputStream outStream,
                           int dpi,
                           float quality)
                    throws IOException,
                           PDFException

Render the page as an image and save it to the output stream in JPEG format. The range for this value is 0.0 to 1.0 with lower values producing higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality. Depending on the quality of the content in the page, using a higher value may not necessarily produce a larger image. For example, if a quality of 0.5 produces lossless compression, then anything higher than 0.5 will produce the same results. However using a compression of 0.4 will produce a smaller, lower quality file.

Parameters:

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.

quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.

Throws:

IOException

PDFException

savePageAsJPEG2000

public void savePageAsJPEG2000(OutputStream outStream,
                               int dpi,
                               float quality)
                        throws IOException,
                               PDFException

Render the page as an image and save it to the output stream in JPEG2000 format. The quality setting is used to calculate the data rate (bits per pixel). The range for this value is 0.0 to 1.0 with lower values producing higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality. If a value higher than the lossless compression rate is provided, then making a small change in the value will not make a difference. For example, if a quality of 0.5 produces lossless compression, then anything higher than 0.5 will produce the same results. However using a compression of 0.4 will produce a smaller, lower quality file.

Parameters:

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.

quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.

Throws:

IOException

PDFException

savePageAsPNG

public void savePageAsPNG(OutputStream outStream,
                          int dpi)
                   throws PDFException,
                          IOException

Render the page as an image and save it to the output stream in PNG format.

Parameters:

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.

Throws:

PDFException

IOException

savePageAsTIFF

public void savePageAsTIFF(OutputStream outStream,
                           double resDPI,
                           String tiffCompression)
                    throws IOException,
                           PDFException

Save the rendering image of the page to the given OutputStream in TIFF format. The image will be converted to black and white and fax compression will be used. resDPI is the resolution in DPI used to render the page, 72 is the recommended value for the resolution.
This method requires Java Advanced Imaging (JAI) classes in the class path (jai_codec.jar). See our documentation regarding Distribution and JAR Files for more info.

Parameters:

outStream - The stream to save the image to.

resDPI - Dots per inch at which to render the image.

tiffCompression - The type of TIFF compression to use. This value needs to be one of these predefined values:

TIFFOptions.TIFF_DEFLATE - Deflate lossless compression (Zip-in-TIFF)
TIFFOptions.TIFF_CCITT_RLE - CCITT Modified Huffman RLE
TIFFOptions.TIFF_CCITT_T4 - CCITT Group 3 fax encoding
TIFFOptions.TIFF_CCITT_T6 - CCITT Group 4 fax encoding
TIFFOptions.TIFF_JPEG - JPEG-in-TIFF compression.
TIFFOptions.TIFF_LZW - LZW Compression
TIFFOptions.TIFF_PACKBITS - Byte-oriented run-length encoding "PackBits" compression.
TIFFOptions.TIFF_ZLIB - ZLib Compression.
TIFFOptions.TIFF_NO_COMPRESSION - No compression.

Throws:

IOException

PDFException

savePageAsTIFF

public void savePageAsTIFF(OutputStream outStream,
                           TIFFOptions options)
                    throws IOException,
                           PDFException

Render the page to an image and save it in TIFF format to the given OutputStream. If fax compression is used, the image will be converted automatically to black and white.
This method requires Java Advanced Imaging (JAI) classes in the class path (jai_codec.jar). See our documentation regarding Distribution and JAR Files for more info.

Parameters:

outStream - The stream to save the image to.

options - Options when saving the image, such as the output DPI, the TIFF compression method and more.

Throws:

IOException

PDFException

setArtBox

public void setArtBox(Rectangle2D rect)

Sets this page's Art Box. The art box defines the extent of the page's meaningful content (including potential whitespace). This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.

Parameters:

rect - The new art box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

setBleedBox

public void setBleedBox(Rectangle2D rect)

Sets this page's Bleed Box. A page should be clipped to this coordinates when output to a production environment. This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.

Parameters:

rect - The new bleed box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

setClip

public void setClip(Area newClip)
             throws PDFException

Sets the clip area in the page's content stream when drawing to the page.

Parameters:

newClip - The new clip area.

Throws:

PDFException

setCropBox

public void setCropBox(Rectangle2D rect)
                throws PDFException

Sets the PDF page's 'CropBox'. The CropBox is a rectangle that is used to crop content before displaying or printing the page. This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.

Parameters:

rect - The new crop box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

Throws:

PDFException

resizePage

public void resizePage(ResizePageOptions options)
                throws PDFException

Sets this page's Media Box. The Media Box is a rectangle defining the boundaries of the physical medium on which the page is intended to be displayed or printed.

Parameters:

options - The resize page options.

Throws:

PDFException

setPageRotation

public void setPageRotation(int degrees)
                     throws PDFException

Changes this page's rotation.

Parameters:

degrees - The new page rotation, in degrees

Throws:

PDFException

setTrimBox

public void setTrimBox(Rectangle2D rect)

Sets this page's Trim Box. The trim box defines a finished page's intended dimension after trimming. This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.

Parameters:

rect - The new trim box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

strokeShape

public void strokeShape(Shape shape,
                        Paint shapePaint,
                        double offsetX,
                        double offsetY,
                        AffineTransform xform)

Draws the outline of a shape on this page.

Parameters:

shape - The shape whose outline will be drawn.

shapePaint - The color to use when drawing the outline of the shape.

offsetX - A horizontal offset to apply before drawing the shape, in 72 DPI.

offsetY - A vertical offset to apply before drawing the shape, in 72 DPI.

xform - A transform to apply to the shape before drawing it to the page.

useGradientPaint

public String useGradientPaint(GradientPaint paint)
                        throws PDFException

Throws:

PDFException

useGState

public String useGState(double strokeAlpha,
                        double fillAlpha,
                        String blendName)
                 throws PDFException

Throws:

PDFException

insert_hOCR

public void insert_hOCR(String hocrText,
                        boolean renderText)
                 throws PDFException

This methods inserts hOCR text into this page. hOCR is an open standard that defines a data format representation of OCR results. The hOCR standard is supported by a number of OCR engines, including Tesseract, CuneiForm and OCRopus. This method will take hOCR content and insert the text content into the page.

This function is an optional component for Qoppa Software's PDF libraries, it requires separate licensing. If the method is called without being licensed, OCR will be performed and all text results inserted into the page, but the method will add a watermark to the page.

Parameters:

hocrText - The hOCR text content.

renderText - Flag indicating whether the text should be shown on the page. If the flag is false, the text is added in "No Render" mode. Text that uses this mode is present in the page and it is selectable, but it is not visible.

Throws:

PDFException

applyRedactionAnnotations

public boolean applyRedactionAnnotations()
                                  throws PDFException

This method will apply or "burn in" all redaction annotations that are on this PDFPage. The page content that is contained within the redaction annotation's bounds will be redacted.

Returns:

true if this PDFPage contains ANY redaction annotations that were burned in. If there are no redaction annotations, this method returns false. otherwise false.

Throws:

PDFException

applyRedactionAnnotation

public boolean applyRedactionAnnotation(Redaction redactionAnnot)
                                 throws PDFException

This method will apply or "burn in" the redaction annotation. The redaction annotation must already be on this PDFPage. The page content that is contained within the redaction annotation's bounds will be redacted.

Returns:

true if this PDFPage contains the redaction annotation that was passed in and the content was redacted, false otherwise.

Throws:

PDFException

getMediaBox

public Rectangle2D getMediaBox()

Returns this page's Media Box. The media box is equivalent to the physical paper the page was designed for.

Specified by:

getMediaBox in interface IPDFPage

Overrides:

getMediaBox in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's media box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

getCropBox

public Rectangle2D getCropBox()

Return this page's Crop Box. The crop box in a page determines what area of the page will be displayed or printed.

Specified by:

getCropBox in interface IPDFPage

Overrides:

getCropBox in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's crop box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

getBleedBox

public Rectangle2D getBleedBox()

Return this page's Bleed Box. A page should be clipped to this coordinates when output to a production environment. jPDFViewer does not use the Bleed Box, it uses the Crop Box to clip a page before displaying. The method is provided for information to the host application.

Specified by:

getBleedBox in interface IPDFPage

Overrides:

getBleedBox in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's bleed box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

getTrimBox

public Rectangle2D getTrimBox()

Return this page's Trim Box. The trim box defines a finished page's intended dimension after trimming. jPDFViewer does not use the Trim Box, the method is provided here for information to the host application.

Specified by:

getTrimBox in interface IPDFPage

Overrides:

getTrimBox in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's crop box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

getArtBox

public Rectangle2D getArtBox()

Return this page's Art Box. The art box defines the extent of the page's meaningful content (including potential whitespace). jPDFViewer does not use the Art Box, the method is provided here for information to the host application.

Specified by:

getArtBox in interface IPDFPage

Overrides:

getArtBox in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's art box. The dimensions are given in PostScript points. 1 inch = 72 points, 1cm = 28.3465 points, 1mm = 2.8346 points

paintPage

public void paintPage(Graphics2D g2d)

Paints this page to the given graphics object.

Specified by:

paintPage in interface IPDFPage

Overrides:

paintPage in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

g2d - Graphics objects to paint the page to.

paintPage

public void paintPage(Graphics2D g2d,
                      boolean paintAnnotations)

Paints this page to the given graphics object, with an option to paint the annotations on the page.

Specified by:

paintPage in interface IPDFPage

Overrides:

paintPage in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

g2d - Graphics objects to paint the page to.

paintAnnotations - Flag indicating whether annotations should be painted

printPage

public void printPage(Graphics2D g2d,
                      PageFormat pf,
                      PrintSettings printSettings)
               throws PDFException

Prints this page given a page format describing the printer's page and a PrintSettings object.

Specified by:

printPage in interface IPDFPage

Overrides:

printPage in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

g2d - Printer graphics object.

pf - PageFormat object to use when printing.

printSettings - Printing preferences.

Throws:

PDFException

getDisplayHeight

public double getDisplayHeight()

Gets the page's display height. This is equivalent to getCropBox().getHeight();

Specified by:

getDisplayHeight in interface IPDFPage

Overrides:

getDisplayHeight in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's display height.

getDisplayWidth

public double getDisplayWidth()

Gets the page's display width. This is equivalent to getCropBox().getWidth();

Specified by:

getDisplayWidth in interface IPDFPage

Overrides:

getDisplayWidth in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's display width.

getDisplayX

public double getDisplayX()

Returns the page's left margin. This value correspond to the different between the page's CropBox X coordinate and the MediaBox X coordinate. When the page is, this will be the origin of the displayed page.

Specified by:

getDisplayX in interface IPDFPage

Overrides:

getDisplayX in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's display X coordinate.

getDisplayY

public double getDisplayY()

Returns the page's top margin. This value correspond to the different between the page's CropBox Y coordinate and the MediaBox Y coordinate. When the page is, this will be the origin of the displayed page.

Specified by:

getDisplayY in interface IPDFPage

Overrides:

getDisplayY in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The page's display Y coordinate.

getPageRotation

public int getPageRotation()

Returns the rotation of this page in degrees.

Specified by:

getPageRotation in interface IPDFPage

Overrides:

getPageRotation in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

int Page rotation in degrees.

getAnnotations

public Vector<Annotation> getAnnotations()
                                  throws PDFException

Returns a list of PDF annotations in this page, including form fields widgets. This vector is a clone of the actual annotations vector so removing or adding annotations to this vector will not affect the page annotations. However annotations contained in the vector can be edited.

Specified by:

getAnnotations in interface IPDFPage

Overrides:

getAnnotations in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

List of annotations.

Throws:

PDFException

getImage

public BufferedImage getImage(int width,
                              int height,
                              boolean keepAspect)
                       throws PDFException

Returns a buffered image showing the contents of this page. The image is resized to the given width and height. If keepAspect is true, the resized image keeps its aspect ratio.

Specified by:

getImage in interface IPDFPage

Overrides:

getImage in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

width - Width of the desired image.

height - Height of the desired image.

keepAspect - Flag to indicate whether the resized image should keep its aspect ratio.

Returns:

BufferedImage with the contents of the page.

Throws:

PDFException

findTextWithContext

public Vector<TextPositionWithContext> findTextWithContext(String searchText,
                                                           boolean caseSensitive,
                                                           boolean wholeWords)
                                                    throws PDFException

This method searches for the given text in the page. If there are instances of the text found, the method returns a Vector of TextPositionWithContext objects. These objects contain information about the text, its position and the surrounding text.

Specified by:

findTextWithContext in interface IPDFPage

Overrides:

findTextWithContext in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

searchText - The text to search for.

caseSensitive - Flag to determine if the search should be case sensitive.

wholeWords - Flag to indicate if only whole words should be found

Returns:

A list of TextPositionWithContext objects

Throws:

PDFException

getTabbingOrder

public String getTabbingOrder()

Returns the tabbing order as defined in the page description, if present. The tabbing order is used by viewers to determine the tabbing between form fields. The possible values are R for row order, C for column order and S for structure order.

Specified by:

getTabbingOrder in interface IPDFPage

Overrides:

getTabbingOrder in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

A string that holds the entry for the tabbing order from the page description.

getText

public String getText()
               throws PDFException

Returns the text content of this page as a String.

Specified by:

getText in interface IPDFPage

Overrides:

getText in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Returns:

The text content of this page.

Throws:

PDFException

containsInvisibleText

public boolean containsInvisibleText()
                              throws PDFException

Checks whether the page contains text which is invisible.

Returns:

true if page contains text which is invisible, false otherwise.

Throws:

PDFException

findTextWithContextUsingRegEx

public Vector<TextPositionWithContext> findTextWithContextUsingRegEx(String regexString)
                                                              throws PDFException

This method searches for text in the page for matches with the given regular expression. If there are matches found, the method returns a Vector of TextPositionWithContext objects. These objects contain information about the text, its position and the surrounding text.

Specified by:

findTextWithContextUsingRegEx in interface IPDFPage

Overrides:

findTextWithContextUsingRegEx in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

regexString - The regular expression to match against.

Returns:

A list of TextPositionWithContext objects

Throws:

PDFException

findTextUsingRegex

public Vector<TextPosition> findTextUsingRegex(String regex)
                                        throws PDFException

This method searches for the given text in the page. If there are instances of the text found, the method returns a Vector of TextPosition objects. These objects contain information about the text and its position. If there is no occurrences of the search text found on the page, the method returns a Vector of 0 length.

Specified by:

findTextUsingRegex in interface IPDFPage

Overrides:

findTextUsingRegex in class com.qoppa.pdfViewer.hiObjects.AbstractPDFPage

Parameters:

regex - The regular expression to search for.

Returns:

A list of TextPosition objects

Throws:

PDFException

getTextContent

public TextContent getTextContent()
                           throws PDFException

This method returns a TextContent object that represents the text content in a page. The TextContent object provides method to get the text and its attributes, and to modify attributes as well.

Returns:

A TextContent object representing the text in the page.

Throws:

PDFException