Package org.apache.pdfbox.examples.util

Class DrawPrintTextLocations

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.LegacyPDFStreamEngine

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.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	filename
private AffineTransform	flipAT
private Graphics2D	g2d
private AffineTransform	rotateAT
(package private) static final int	SCALE
private AffineTransform	transAT

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

charactersByArticle, document, LINE_SEPARATOR, output

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private Shape	calculateGlyphBounds(Matrix textRenderingMatrix, PDFont font, int code)
static void	main(String[] args)	This will print the documents data.
protected void	showGlyph(Matrix textRenderingMatrix, PDFont font, int code, Vector displacement)	Called when a glyph is to be processed.
private void	stripPage(int page)
private static void	usage()	This will print the usage for this document.
protected void	writeString(String string, List<TextPosition> textPositions)	Override the default functionality of PDFTextStripper.

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

beginMarkedContentSequence, endArticle, endDocument, endMarkedContentSequence, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCharactersByArticle, getCurrentPageNo, getDropThreshold, getEndBookmark, getEndPage, getIgnoreContentStreamSpaceGlyphs, 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, setIgnoreContentStreamSpaceGlyphs, 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.text.LegacyPDFStreamEngine

computeFontHeight

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

addOperator, applyTextAdjustment, beginText, decreaseLevel, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getLevel, getResources, getTextLineMatrix, getTextMatrix, increaseLevel, isShouldProcessColorOperators, markedContentPoint, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, 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

Field Details

flipAT

private AffineTransform flipAT

rotateAT

private AffineTransform rotateAT

transAT

private AffineTransform transAT

filename

private final String filename

SCALE

static final int SCALE

See Also:

• Constant Field Values

g2d

private Graphics2D g2d

Constructor Details

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 Details

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,
 Vector displacement)
                  throws IOException

Description copied from class: LegacyPDFStreamEngine

Called when a glyph is to be processed. The heuristic calculations here were originally written by Ben Litchfield for PDFStreamEngine.

Overrides:

showGlyph in class LegacyPDFStreamEngine

Parameters:

textRenderingMatrix - the current text rendering matrix, T_rm

font - the current font

code - internal PDF character code for the glyph

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

Throws:

IOException - if the glyph cannot be processed

calculateGlyphBounds

private Shape calculateGlyphBounds(Matrix textRenderingMatrix,
 PDFont font,
 int code)
                            throws IOException

Throws:

IOException

stripPage

private void stripPage(int page)
                throws IOException

Throws:

IOException

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.

usage

private static void usage()

This will print the usage for this document.