org.fit.cssbox.pdf

Class CSSBoxTree

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.fit.pdfdom.PDFBoxTree

org.fit.pdfdom.PDFDomTree

org.fit.cssbox.pdf.CSSBoxTree

public class CSSBoxTree
extends PDFDomTree

This class implements direct creation of a CSSBox tree from a PDF file. It creates a tree if boxes compatible with the original CSSBox BoxFactory result for HTML documents. The resulting tree contains the boxes together with their styles. Its further processing (layout and positioning) is the same as for the tree of boxes obtained from the HTML documents.

Author:

burgetr

Nested Class Summary

Nested classes/interfaces inherited from class org.fit.pdfdom.PDFDomTree

PDFDomTree.HtmlDivLine

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	baseurl Base URL used for eventual references in the input file
protected org.fit.cssbox.layout.BlockBox	body BODY box
protected org.fit.cssbox.layout.BrowserConfig	config Used CSSBox configuration
protected org.fit.cssbox.layout.VisualContext	ctx Root visual context
protected Dimension	dim Preferred dimensions of the result
protected Graphics2D	g Root graphics context
protected org.fit.cssbox.layout.BlockBox	html HTML box
protected int	next_order Internal counter for assigning the node IDs
protected org.fit.cssbox.layout.BlockBox	pagebox The box representing the page that is currently being created
protected cz.vutbr.web.css.TermNumeric.Unit	unit Length units used in the output
protected float	unknownFontScale Scale factor for unknown fonts - it is used to prevent overlaping the boxes when an inappropriate font is used
protected org.fit.cssbox.layout.Viewport	viewport The resulting viewport

Fields inherited from class org.fit.pdfdom.PDFDomTree

curpage, defaultStyle, doc, globalStyle, head, pagecnt, textcnt, title

Fields inherited from class org.fit.pdfdom.PDFBoxTree

cssFontFamily, cssFontStyle, cssFontWeight, cur_x, cur_y, curstyle, disableGraphics, disableImageData, disableImages, endPage, fontTable, graphicsPath, lastDia, lastText, path_start_x, path_start_y, path_x, path_y, pdFontType, pdpage, startPage, style, textLine, textMetrics, UNIT

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

document, charactersByArticle, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor and Description
CSSBoxTree(Graphics2D g, org.fit.cssbox.layout.VisualContext ctx, Dimension dim, URL baseurl) Creates a new instance bound to certain graphic context.

Method Summary

Modifier and Type	Method and Description
protected Element	createAnonymousElement(Document doc, String name, String display) Creates a new DOM element that represents an anonymous box in a document.
protected org.fit.cssbox.layout.BlockBox	createBlock(org.fit.cssbox.layout.BlockBox parent, Element n, boolean replaced) Creates a new block box from the given element with the given parent.
protected cz.vutbr.web.css.NodeData	createBlockStyle() Creates an empty block style definition.
protected cz.vutbr.web.css.NodeData	createBodyStyle() Creates a style definition used for the body element.
protected cz.vutbr.web.css.Declaration	createDeclaration(String property, cz.vutbr.web.css.Term<?> term) Creates a single property declaration.
protected void	createDocument() Creates a new empty HTML document tree.
protected cz.vutbr.web.css.NodeData	createLineStyle(float x1, float y1, float x2, float y2)
protected cz.vutbr.web.css.NodeData	createPageStyle() Creates a style definition used for pages.
protected cz.vutbr.web.css.NodeData	createRectangleStyle(float x, float y, float width, float height, boolean stroke, boolean fill) Creates the style definition used for a rectangle element based on the given properties of the rectangle
protected org.fit.cssbox.layout.TextBox	createTextBox(org.fit.cssbox.layout.BlockBox contblock, Text n) Creates a text box with the given parent and text node assigned.
protected cz.vutbr.web.css.NodeData	createTextStyle(BoxStyle style, float width) Creates the style declaration for a text box based on the given BoxStyle structure.
org.fit.cssbox.layout.BrowserConfig	getConfig()
int	getLastId() Obtains the first unused ID of the box.
org.fit.cssbox.layout.Viewport	getViewport() Obtains the resulting viewport that represents the root node of the resulting box tree.
void	processDocument(org.apache.pdfbox.pdmodel.PDDocument pdfdocument, int startPage, int endPage)
protected void	renderImage(float x, float y, float width, float height, ImageResource resource) Adds an image to the current page.
protected void	renderPath(List<PathSegment> path, boolean stroke, boolean fill) Adds a rectangle to the current page on the specified position.
protected void	renderText(String data, TextMetrics metrics) Creates a new text box in the current page.
void	setConfig(org.fit.cssbox.layout.BrowserConfig config)
protected void	showGlyph(org.apache.pdfbox.util.Matrix arg0, org.apache.pdfbox.pdmodel.font.PDFont arg1, int arg2, String arg3, org.apache.pdfbox.util.Vector arg4)
protected void	startNewPage() Adds a new page to the resulting document and makes it a current (active) page.

Methods inherited from class org.fit.pdfdom.PDFDomTree

createDOM, createFontFaces, createGlobalStyle, createImageElement, createLineElement, createPageElement, createPathImage, createRectangleElement, createTextElement, createTextElement, endDocument, getDocument, startDocument, updateFontTable, writeText

Methods inherited from class org.fit.pdfdom.PDFBoxTree

colorString, colorString, colorString, createCurrentPageTransformation, finishBox, floatValue, getCurrentMediaBox, getDisableGraphics, getDisableImageData, getDisableImages, getEndPage, getLength, getStartPage, getTextDirectionality, getTextDirectionality, getTitle, intValue, isReversed, processImageOperation, processOperator, processPage, processTextPosition, setDisableGraphics, setDisableImageData, setDisableImages, setEndPage, setStartPage, stringValue, toRectangle, transformLength, transformPosition, updateStyle

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

endArticle, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCurrentPageNo, getDropThreshold, getEndBookmark, getCharactersByArticle, getIndentThreshold, getLineSeparator, getListItemPatterns, getOutput, getPageEnd, getPageStart, getParagraphEnd, getParagraphStart, getSeparateByBeads, getSortByPosition, getSpacingTolerance, getStartBookmark, getSuppressDuplicateOverlappingText, getText, getWordSeparator, matchPattern, processPages, setAddMoreFormatting, setArticleEnd, setArticleStart, setAverageCharTolerance, setDropThreshold, setEndBookmark, setIndentThreshold, setLineSeparator, setListItemPatterns, setPageEnd, setPageStart, setParagraphEnd, setParagraphStart, setShouldSeparateByBeads, setSortByPosition, setSpacingTolerance, setStartBookmark, setSuppressDuplicateOverlappingText, setWordSeparator, startArticle, startArticle, startPage, writeCharacters, writeLineSeparator, writePage, writePageEnd, writePageStart, writeParagraphEnd, writeParagraphSeparator, writeParagraphStart, writeString, writeString, 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, 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

Field Detail

unknownFontScale

protected float unknownFontScale

Scale factor for unknown fonts - it is used to prevent overlaping the boxes when an inappropriate font is used

unit

protected cz.vutbr.web.css.TermNumeric.Unit unit

Length units used in the output

g

protected Graphics2D g

Root graphics context

ctx

protected org.fit.cssbox.layout.VisualContext ctx

Root visual context

dim

protected Dimension dim

Preferred dimensions of the result

baseurl

protected URL baseurl

Base URL used for eventual references in the input file

viewport

protected org.fit.cssbox.layout.Viewport viewport

The resulting viewport

html

protected org.fit.cssbox.layout.BlockBox html

HTML box

body

protected org.fit.cssbox.layout.BlockBox body

BODY box

pagebox

protected org.fit.cssbox.layout.BlockBox pagebox

The box representing the page that is currently being created

config

protected org.fit.cssbox.layout.BrowserConfig config

Used CSSBox configuration

next_order

protected int next_order

Internal counter for assigning the node IDs

Constructor Detail

CSSBoxTree

public CSSBoxTree(Graphics2D g,
                  org.fit.cssbox.layout.VisualContext ctx,
                  Dimension dim,
                  URL baseurl)
           throws IOException,
                  ParserConfigurationException

Creates a new instance bound to certain graphic context.

Parameters:

g - The graphic context used for displaying the rendered result. It is used for obtaining the font metrics.

ctx - The initial CSSBox visual context used for the viewport.

dim - The initial dimensions of the viewport. The resulting dimensions may be updated according to the page contents.

baseurl - Base url used for loading referenced objects.

Throws:

IOException

ParserConfigurationException

Method Detail

getConfig

public org.fit.cssbox.layout.BrowserConfig getConfig()

setConfig

public void setConfig(org.fit.cssbox.layout.BrowserConfig config)

getViewport

public org.fit.cssbox.layout.Viewport getViewport()

Obtains the resulting viewport that represents the root node of the resulting box tree.

Returns:

the viewport

getLastId

public int getLastId()

Obtains the first unused ID of the box. This can be used for obtaining the box count.

Returns:

the first unused box ID

processDocument

public void processDocument(org.apache.pdfbox.pdmodel.PDDocument pdfdocument,
                            int startPage,
                            int endPage)
                     throws IOException

Throws:

IOException

createDocument

protected void createDocument()
                       throws ParserConfigurationException

Description copied from class: PDFDomTree

Creates a new empty HTML document tree.

Overrides:

createDocument in class PDFDomTree

Throws:

ParserConfigurationException

startNewPage

protected void startNewPage()

Description copied from class: PDFBoxTree

Adds a new page to the resulting document and makes it a current (active) page.

Overrides:

startNewPage in class PDFDomTree

renderText

protected void renderText(String data,
                          TextMetrics metrics)

Description copied from class: PDFBoxTree

Creates a new text box in the current page. The style and position of the text are contained in the PDFBoxTree.curstyle property.

Overrides:

renderText in class PDFDomTree

Parameters:

data - The text contents.

renderPath

protected void renderPath(List<PathSegment> path,
                          boolean stroke,
                          boolean fill)

Description copied from class: PDFBoxTree

Adds a rectangle to the current page on the specified position.

Overrides:

renderPath in class PDFDomTree

stroke - should there be a stroke around?

fill - should the rectangle be filled?

renderImage

protected void renderImage(float x,
                           float y,
                           float width,
                           float height,
                           ImageResource resource)
                    throws IOException

Description copied from class: PDFBoxTree

Adds an image to the current page.

Overrides:

renderImage in class PDFDomTree

Parameters:

x - the X coordinate of the image

y - the Y coordinate of the image

width - the width coordinate of the image

height - the height coordinate of the image

resource - the image data depending on the specified type

Throws:

IOException

createAnonymousElement

protected Element createAnonymousElement(Document doc,
                                         String name,
                                         String display)

Creates a new DOM element that represents an anonymous box in a document.

Parameters:

doc - the document

name - the anonymous element name (generally arbitrary)

display - the display style value for the block

Returns:

the new element

createBlock

protected org.fit.cssbox.layout.BlockBox createBlock(org.fit.cssbox.layout.BlockBox parent,
                                                     Element n,
                                                     boolean replaced)

Creates a new block box from the given element with the given parent. No style is assigned to the resulting box.

Parameters:

parent - The parent box in the tree of boxes.

n - The element that this box belongs to.

replaced - When set to true, a replaced block box will be created. Otherwise, a normal non-replaced block will be created.

Returns:

The new block box.

createTextBox

protected org.fit.cssbox.layout.TextBox createTextBox(org.fit.cssbox.layout.BlockBox contblock,
                                                      Text n)

Creates a text box with the given parent and text node assigned.

Parameters:

contblock - The parent node (and the containing block in the same time)

n - The corresponding text node in the DOM tree.

Returns:

The new text box.

createTextStyle

protected cz.vutbr.web.css.NodeData createTextStyle(BoxStyle style,
                                                    float width)

Creates the style declaration for a text box based on the given BoxStyle structure.

Parameters:

style - The source box style.

Returns:

The element style definition.

createBlockStyle

protected cz.vutbr.web.css.NodeData createBlockStyle()

Creates an empty block style definition.

Returns:

createBodyStyle

protected cz.vutbr.web.css.NodeData createBodyStyle()

Creates a style definition used for the body element.

Returns:

The body style definition.

createPageStyle

protected cz.vutbr.web.css.NodeData createPageStyle()

Creates a style definition used for pages.

Returns:

The page style definition.

createRectangleStyle

protected cz.vutbr.web.css.NodeData createRectangleStyle(float x,
                                                         float y,
                                                         float width,
                                                         float height,
                                                         boolean stroke,
                                                         boolean fill)

Creates the style definition used for a rectangle element based on the given properties of the rectangle

Parameters:

x - The X coordinate of the rectangle.

y - The Y coordinate of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

stroke - Should there be a stroke around?

fill - Should the rectangle be filled?

Returns:

The resulting element style definition.

createLineStyle

protected cz.vutbr.web.css.NodeData createLineStyle(float x1,
                                                    float y1,
                                                    float x2,
                                                    float y2)

createDeclaration

protected cz.vutbr.web.css.Declaration createDeclaration(String property,
                                                         cz.vutbr.web.css.Term<?> term)

Creates a single property declaration.

Parameters:

property - Property name.

term - Property value.

Returns:

The resulting declaration.

showGlyph

protected void showGlyph(org.apache.pdfbox.util.Matrix arg0,
                         org.apache.pdfbox.pdmodel.font.PDFont arg1,
                         int arg2,
                         String arg3,
                         org.apache.pdfbox.util.Vector arg4)
                  throws IOException

Overrides:

showGlyph in class org.apache.pdfbox.contentstream.PDFStreamEngine

Throws:

IOException