org.apache.pdfbox.examples.util

Class DrawPrintTextLocations

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.apache.pdfbox.examples.util.DrawPrintTextLocations

public class DrawPrintTextLocations
extends PDFTextStripper

This is an example on how to get some x/y coordinates of text and to show them in a rendered image.

Author:

Ben Litchfield, Tilman Hausherr

Field Summary

Fields inherited from class org.apache.pdfbox.text.PDFTextStripper

charactersByArticle, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor and Description
DrawPrintTextLocations(PDDocument document, String filename) Instantiate a new PDFTextStripper object.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) This will print the documents data.
protected void	showGlyph(Matrix textRenderingMatrix, PDFont font, int code, String unicode, Vector displacement) This method was originally written by Ben Litchfield for PDFStreamEngine.
protected void	writeString(String string, List<TextPosition> textPositions) Override the default functionality of PDFTextStripper.

Methods inherited from class org.apache.pdfbox.text.PDFTextStripper

endArticle, endDocument, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCharactersByArticle, getCurrentPageNo, getDropThreshold, getEndBookmark, getEndPage, getIndentThreshold, getLineSeparator, getListItemPatterns, getOutput, getPageEnd, getPageStart, getParagraphEnd, getParagraphStart, getSeparateByBeads, getSortByPosition, getSpacingTolerance, getStartBookmark, getStartPage, getSuppressDuplicateOverlappingText, getText, getWordSeparator, matchPattern, processPage, processPages, processTextPosition, setAddMoreFormatting, setArticleEnd, setArticleStart, setAverageCharTolerance, setDropThreshold, setEndBookmark, setEndPage, setIndentThreshold, setLineSeparator, setListItemPatterns, setPageEnd, setPageStart, setParagraphEnd, setParagraphStart, setShouldSeparateByBeads, setSortByPosition, setSpacingTolerance, setStartBookmark, setStartPage, setSuppressDuplicateOverlappingText, setWordSeparator, startArticle, startArticle, startDocument, startPage, writeCharacters, writeLineSeparator, writePage, writePageEnd, writePageStart, writeParagraphEnd, writeParagraphSeparator, writeParagraphStart, writeString, writeText, writeWordSeparator

Methods inherited from class org.apache.pdfbox.contentstream.PDFStreamEngine

addOperator, applyTextAdjustment, beginText, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getResources, getTextLineMatrix, getTextMatrix, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, registerOperatorProcessor, restoreGraphicsStack, restoreGraphicsState, saveGraphicsStack, saveGraphicsState, setLineDashPattern, setTextLineMatrix, setTextMatrix, showAnnotation, showFontGlyph, showForm, showText, showTextString, showTextStrings, showTransparencyGroup, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

DrawPrintTextLocations

public DrawPrintTextLocations(PDDocument document,
                              String filename)
                       throws IOException

Instantiate a new PDFTextStripper object.

Parameters:

document -

filename -

Throws:

IOException - If there is an error loading the properties.

Method Detail

main

public static void main(String[] args)
                 throws IOException

This will print the documents data.

Parameters:

args - The command line arguments.

Throws:

IOException - If there is an error parsing the document.

showGlyph

protected void showGlyph(Matrix textRenderingMatrix,
                         PDFont font,
                         int code,
                         String unicode,
                         Vector displacement)
                  throws IOException

This method was originally written by Ben Litchfield for PDFStreamEngine.

Parameters:

textRenderingMatrix - the current text rendering matrix, T_rm

font - the current font

code - internal PDF character code for the glyph

unicode - the Unicode text for this glyph, or null if the PDF does provide it

displacement - the displacement (i.e. advance) of the glyph in text space

Throws:

IOException - if the glyph cannot be processed

writeString

protected void writeString(String string,
                           List<TextPosition> textPositions)
                    throws IOException

Override the default functionality of PDFTextStripper.

Overrides:

writeString in class PDFTextStripper

Parameters:

string - The text to write to the stream.

textPositions - The TextPositions belonging to the text.

Throws:

IOException - If there is an error when writing the text.