org.apache.pdfbox.tools

Class PDFText2HTML

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.apache.pdfbox.tools.PDFText2HTML

public class PDFText2HTML
extends PDFTextStripper

Wrap stripped text in simple HTML, trying to form HTML paragraphs. Paragraphs broken by pages, columns, or figures are not mended.

Author:

John J Barton

Field Summary

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

charactersByArticle, document, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor and Description
PDFText2HTML() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	endArticle() Write out the article separator.
void	endDocument(PDDocument document) This method is available for subclasses of this class.
protected String	getTitle() This method will attempt to guess the title of the document using either the document properties or the first lines of text.
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	startArticle(boolean isLTR) Write out the article separator (div tag) with proper text direction information.
protected void	startDocument(PDDocument document) This method is available for subclasses of this class.
protected void	writeHeader() Deprecated. deprecated, use startDocument(PDDocument)
protected void	writeParagraphEnd() Writes the paragraph end "</p>" to the output.
protected void	writeString(String chars) Write a string to the output stream and escape some HTML characters.
protected void	writeString(String text, List<TextPosition> textPositions) Write a string to the output stream, maintain font state, and escape some HTML characters.

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

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, startPage, writeCharacters, writeLineSeparator, writePage, writePageEnd, writePageStart, writeParagraphSeparator, writeParagraphStart, 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

PDFText2HTML

public PDFText2HTML()
             throws IOException

Constructor.

Throws:

IOException - If there is an error during initialization.

Method Detail

writeHeader

protected void writeHeader()
                    throws IOException

Deprecated. deprecated, use startDocument(PDDocument)

Write the header to the output document. Now also writes the tag defining the character encoding.

Throws:

IOException - If there is a problem writing out the header to the document.

startDocument

protected void startDocument(PDDocument document)
                      throws IOException

Description copied from class: PDFTextStripper

This method is available for subclasses of this class. It will be called before processing of the document start.

Overrides:

startDocument in class PDFTextStripper

Parameters:

document - The PDF document that is being processed.

Throws:

IOException - If an IO error occurs.

endDocument

public void endDocument(PDDocument document)
                 throws IOException

This method is available for subclasses of this class. It will be called after processing of the document finishes.

Overrides:

endDocument in class PDFTextStripper

Parameters:

document - The PDF document that is being processed.

Throws:

IOException - If an IO error occurs.

getTitle

protected String getTitle()

This method will attempt to guess the title of the document using either the document properties or the first lines of text.

Returns:

returns the title.

startArticle

protected void startArticle(boolean isLTR)
                     throws IOException

Write out the article separator (div tag) with proper text direction information.

Overrides:

startArticle in class PDFTextStripper

Parameters:

isLTR - true if direction of text is left to right

Throws:

IOException - If there is an error writing to the stream.

endArticle

protected void endArticle()
                   throws IOException

Write out the article separator.

Overrides:

endArticle in class PDFTextStripper

Throws:

IOException - If there is an error writing to the stream.

writeString

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

Write a string to the output stream, maintain font state, and escape some HTML characters. The font state is only preserved per word.

Overrides:

writeString in class PDFTextStripper

Parameters:

text - The text to write to the stream.

textPositions - the corresponding text positions

Throws:

IOException - If there is an error writing to the stream.

writeString

protected void writeString(String chars)
                    throws IOException

Write a string to the output stream and escape some HTML characters.

Overrides:

writeString in class PDFTextStripper

Parameters:

chars - String to be written to the stream

Throws:

IOException - If there is an error writing to the stream.

writeParagraphEnd

protected void writeParagraphEnd()
                          throws IOException

Writes the paragraph end "</p>" to the output. Furthermore, it will also clear the font state. Write something (if defined) at the end of a paragraph.

Overrides:

writeParagraphEnd in class PDFTextStripper

Throws:

IOException - if something went wrong

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.

Overrides:

showGlyph in class 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