Package org.apache.pdfbox.examples.util

Class PrintTextColors

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.LegacyPDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.apache.pdfbox.examples.util.PrintTextColors

public class PrintTextColors
extends PDFTextStripper

This is an example on how to get the colors of text. Note that this will not tell the background, and will only work properly if the text is not overwritten later, and only if the text rendering modes are 0, 1 or 2. In the PDF 32000 specification, please read 9.3.6 "Text Rendering Mode" to know more. Mode 0 (FILL) is the default. Mode 1 (STROKE) will make glyphs look "hollow". Mode 2 (FILL_STROKE) will make glyphs look "fat".

Field Summary

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

charactersByArticle, document, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor	Description
PrintTextColors()	Instantiate a new PDFTextStripper object.

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	This will print the documents data.
protected void	processTextPosition(TextPosition text)	This will process a TextPosition object and add the text to the list of characters on a page.
private static void	usage()	This will print the usage for this document.

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, 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, writeString, writeText, writeWordSeparator

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

computeFontHeight, showGlyph

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

Constructor Details

PrintTextColors

public PrintTextColors()
                throws IOException

Instantiate a new PDFTextStripper object.

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.

processTextPosition

protected void processTextPosition(TextPosition text)

Description copied from class: PDFTextStripper

This will process a TextPosition object and add the text to the list of characters on a page. It takes care of overlapping text.

Overrides:

processTextPosition in class PDFTextStripper

Parameters:

text - The text to process.

usage

private static void usage()

This will print the usage for this document.