com.openhtmltopdf.pdfboxout

Class PdfBoxFastOutputDevice

java.lang.Object

com.openhtmltopdf.render.AbstractOutputDevice

com.openhtmltopdf.pdfboxout.PdfBoxFastOutputDevice

All Implemented Interfaces:

OutputDevice, PdfBoxOutputDevice, Closeable, AutoCloseable

public class PdfBoxFastOutputDevice
extends AbstractOutputDevice
implements OutputDevice, PdfBoxOutputDevice

Constructor Summary

Constructors

Constructor and Description
PdfBoxFastOutputDevice(float dotsPerPoint, boolean testMode, boolean pdfUaConform, boolean pdfAConform)

Method Summary

Modifier and Type	Method and Description
void	addMetadata(String name, String value) Appends a name/content metadata pair to this output device.
void	close() Perform any internal cleanup needed
void	draw(Shape s)
void	drawBorderLine(Shape bounds, int side, int lineWidth, boolean solid)
void	drawImage(FSImage fsImage, int x, int y, boolean interpolate)
protected void	drawLine(int x1, int y1, int x2, int y2)
void	drawLinearGradient(FSLinearGradient backgroundLinearGradient, Shape bounds)
void	drawOval(int x, int y, int width, int height)
void	drawPdfAsImage(org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject _srcObject, Rectangle contentBounds, float intrinsicWidth, float intrinsicHeight)
void	drawRect(int x, int y, int width, int height)
void	drawSelection(RenderingContext c, InlineText inlineText)
void	drawString(String s, float x, float y, JustificationInfo info)
void	drawStringFast(String s, float x, float y, JustificationInfo info, PdfBoxFontResolver.FontDescription desc, float fontSize)
void	drawWithGraphics(float x, float y, float width, float height, OutputDeviceGraphicsDrawer renderer)
void	endStructure(Object token)
void	fill(Shape s)
void	fillOval(int x, int y, int width, int height)
void	fillRect(int x, int y, int width, int height)
List<PagePosition<Box>>	findPagePositionsByID(CssContext c, Pattern pattern)
void	finish(RenderingContext c, Box root)
void	finishPage()
PdfContentStreamAdapter	getCurrentPage()
float	getDeviceLength(float length) Given a value in dots units, converts to PDF points.
float	getDotsPerPoint()
List<com.openhtmltopdf.pdfboxout.PdfBoxUtil.Metadata>	getMetadata()
String	getMetadataByName(String name) Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name.
List<String>	getMetadataListByName(String name) Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList.
org.apache.pdfbox.pdmodel.PDPage	getPage()
int	getPageRefY(Box box)
Object	getRenderingHint(RenderingHints.Key key)
SharedContext	getSharedContext()
int	getStartPageNo()
Stroke	getStroke()
org.apache.pdfbox.pdmodel.PDDocument	getWriter()
void	initializePage(org.apache.pdfbox.pdmodel.PDPageContentStream currentPage, org.apache.pdfbox.pdmodel.PDPage page, float height) Start a page.
boolean	isFastRenderer()
boolean	isPDF()
boolean	isSupportsCMYKColors()
float	normalizeY(float y) Converts a top down unit to a bottom up PDF unit for the current page.
float	normalizeY(float y, float pageHeight) Converts a top down unit to a bottom up PDF unit for the specified page height.
void	paintBackground(RenderingContext c, Box box) We use paintBackground to do extra stuff such as processing links, forms and form controls.
void	paintReplacedElement(RenderingContext c, BlockBox box)
void	popClip()
void	popTransformLayer()
void	pushClip(Shape s)
void	pushTransformLayer(AffineTransform transform)
void	realizeImage(PdfBoxImage img)
void	setBidiReorderer(BidiReorderer reorderer)
void	setColor(FSColor color)
void	setFont(FSFont font)
void	setPaint(Paint paint)
void	setRenderingContext(RenderingContext result)
void	setRenderingHint(RenderingHints.Key key, Object value)
void	setRoot(Box root)
void	setSharedContext(SharedContext sharedContext)
void	setStartPageNo(int startPageNo)
void	setStroke(Stroke s)
void	setWriter(org.apache.pdfbox.pdmodel.PDDocument writer)
void	start(Document doc)
Object	startStructure(StructureType type, Box box)
void	translate(double tx, double ty)

Methods inherited from class com.openhtmltopdf.render.AbstractOutputDevice

drawDebugOutline, drawText, drawTextDecoration, drawTextDecoration, getFontSpecification, paintBackground, paintBorder, paintBorder, paintCollapsedBorder, setFontSpecification

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openhtmltopdf.extend.OutputDevice

drawDebugOutline, drawText, drawTextDecoration, drawTextDecoration, paintBackground, paintBorder, paintBorder, paintCollapsedBorder

Constructor Detail

PdfBoxFastOutputDevice

public PdfBoxFastOutputDevice(float dotsPerPoint,
                              boolean testMode,
                              boolean pdfUaConform,
                              boolean pdfAConform)

Method Detail

setWriter

public void setWriter(org.apache.pdfbox.pdmodel.PDDocument writer)

Specified by:

setWriter in interface PdfBoxOutputDevice

getWriter

public org.apache.pdfbox.pdmodel.PDDocument getWriter()

Specified by:

getWriter in interface PdfBoxOutputDevice

initializePage

public void initializePage(org.apache.pdfbox.pdmodel.PDPageContentStream currentPage,
                           org.apache.pdfbox.pdmodel.PDPage page,
                           float height)

Start a page. A new PDF page starts a new content stream so all graphics state has to be set back to default.

Specified by:

initializePage in interface PdfBoxOutputDevice

finishPage

public void finishPage()

Specified by:

finishPage in interface PdfBoxOutputDevice

paintReplacedElement

public void paintReplacedElement(RenderingContext c,
                                 BlockBox box)

Specified by:

paintReplacedElement in interface OutputDevice

Specified by:

paintReplacedElement in interface PdfBoxOutputDevice

paintBackground

public void paintBackground(RenderingContext c,
                            Box box)

We use paintBackground to do extra stuff such as processing links, forms and form controls.

Specified by:

paintBackground in interface OutputDevice

Specified by:

paintBackground in interface PdfBoxOutputDevice

Overrides:

paintBackground in class AbstractOutputDevice

getDeviceLength

public float getDeviceLength(float length)

Given a value in dots units, converts to PDF points.

Specified by:

getDeviceLength in interface PdfBoxOutputDevice

drawBorderLine

public void drawBorderLine(Shape bounds,
                           int side,
                           int lineWidth,
                           boolean solid)

Specified by:

drawBorderLine in interface OutputDevice

Specified by:

drawBorderLine in interface PdfBoxOutputDevice

setColor

public void setColor(FSColor color)

Specified by:

setColor in interface OutputDevice

Specified by:

setColor in interface PdfBoxOutputDevice

draw

public void draw(Shape s)

Specified by:

draw in interface OutputDevice

Specified by:

draw in interface PdfBoxOutputDevice

drawLine

protected void drawLine(int x1,
                        int y1,
                        int x2,
                        int y2)

Specified by:

drawLine in class AbstractOutputDevice

drawRect

public void drawRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

drawRect in interface OutputDevice

Specified by:

drawRect in interface PdfBoxOutputDevice

drawOval

public void drawOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

drawOval in interface OutputDevice

Specified by:

drawOval in interface PdfBoxOutputDevice

fill

public void fill(Shape s)

Specified by:

fill in interface OutputDevice

Specified by:

fill in interface PdfBoxOutputDevice

fillRect

public void fillRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillRect in interface OutputDevice

Specified by:

fillRect in interface PdfBoxOutputDevice

fillOval

public void fillOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillOval in interface OutputDevice

Specified by:

fillOval in interface PdfBoxOutputDevice

translate

public void translate(double tx,
                      double ty)

Specified by:

translate in interface OutputDevice

Specified by:

translate in interface PdfBoxOutputDevice

getRenderingHint

public Object getRenderingHint(RenderingHints.Key key)

Specified by:

getRenderingHint in interface OutputDevice

Specified by:

getRenderingHint in interface PdfBoxOutputDevice

setRenderingHint

public void setRenderingHint(RenderingHints.Key key,
                             Object value)

Specified by:

setRenderingHint in interface OutputDevice

Specified by:

setRenderingHint in interface PdfBoxOutputDevice

setFont

public void setFont(FSFont font)

Specified by:

setFont in interface OutputDevice

Specified by:

setFont in interface PdfBoxOutputDevice

drawString

public void drawString(String s,
                       float x,
                       float y,
                       JustificationInfo info)

Specified by:

drawString in interface PdfBoxOutputDevice

drawStringFast

public void drawStringFast(String s,
                           float x,
                           float y,
                           JustificationInfo info,
                           PdfBoxFontResolver.FontDescription desc,
                           float fontSize)

Specified by:

drawStringFast in interface PdfBoxOutputDevice

getCurrentPage

public PdfContentStreamAdapter getCurrentPage()

Specified by:

getCurrentPage in interface PdfBoxOutputDevice

getPage

public org.apache.pdfbox.pdmodel.PDPage getPage()

Specified by:

getPage in interface PdfBoxOutputDevice

normalizeY

public float normalizeY(float y)

Converts a top down unit to a bottom up PDF unit for the current page.

normalizeY

public float normalizeY(float y,
                        float pageHeight)

Converts a top down unit to a bottom up PDF unit for the specified page height.

Specified by:

normalizeY in interface PdfBoxOutputDevice

setStroke

public void setStroke(Stroke s)

Specified by:

setStroke in interface OutputDevice

Specified by:

setStroke in interface PdfBoxOutputDevice

popClip

public void popClip()

Specified by:

popClip in interface OutputDevice

Specified by:

popClip in interface PdfBoxOutputDevice

pushClip

public void pushClip(Shape s)

Specified by:

pushClip in interface OutputDevice

Specified by:

pushClip in interface PdfBoxOutputDevice

getStroke

public Stroke getStroke()

Specified by:

getStroke in interface OutputDevice

Specified by:

getStroke in interface PdfBoxOutputDevice

realizeImage

public void realizeImage(PdfBoxImage img)

Specified by:

realizeImage in interface PdfBoxOutputDevice

drawLinearGradient

public void drawLinearGradient(FSLinearGradient backgroundLinearGradient,
                               Shape bounds)

Specified by:

drawLinearGradient in interface OutputDevice

drawImage

public void drawImage(FSImage fsImage,
                      int x,
                      int y,
                      boolean interpolate)

Specified by:

drawImage in interface OutputDevice

Specified by:

drawImage in interface PdfBoxOutputDevice

drawPdfAsImage

public void drawPdfAsImage(org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject _srcObject,
                           Rectangle contentBounds,
                           float intrinsicWidth,
                           float intrinsicHeight)

Specified by:

drawPdfAsImage in interface PdfBoxOutputDevice

getDotsPerPoint

public float getDotsPerPoint()

Specified by:

getDotsPerPoint in interface PdfBoxOutputDevice

start

public void start(Document doc)

Specified by:

start in interface PdfBoxOutputDevice

finish

public void finish(RenderingContext c,
                   Box root)

Specified by:

finish in interface PdfBoxOutputDevice

getPageRefY

public int getPageRefY(Box box)

Specified by:

getPageRefY in interface PdfBoxOutputDevice

addMetadata

public void addMetadata(String name,
                        String value)

Appends a name/content metadata pair to this output device. A name or content value of null will be ignored.

Specified by:

addMetadata in interface PdfBoxOutputDevice

Parameters:

name - the name of the metadata element to add.

getMetadataByName

public String getMetadataByName(String name)

Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name. The search is case insensitive.

Specified by:

getMetadataByName in interface PdfBoxOutputDevice

Parameters:

name - the metadata element name to locate.

Returns:

the content value of the first found metadata element; otherwise null.

getMetadataListByName

public List<String> getMetadataListByName(String name)

Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList. The search is case insensitive.

Specified by:

getMetadataListByName in interface PdfBoxOutputDevice

Parameters:

name - the metadata element name to locate.

Returns:

an ArrayList with matching content values; otherwise an empty list.

getMetadata

public List<com.openhtmltopdf.pdfboxout.PdfBoxUtil.Metadata> getMetadata()

Specified by:

getMetadata in interface PdfBoxOutputDevice

Returns:

All metadata entries

getSharedContext

public SharedContext getSharedContext()

Specified by:

getSharedContext in interface PdfBoxOutputDevice

setSharedContext

public void setSharedContext(SharedContext sharedContext)

Specified by:

setSharedContext in interface PdfBoxOutputDevice

setRoot

public void setRoot(Box root)

Specified by:

setRoot in interface PdfBoxOutputDevice

getStartPageNo

public int getStartPageNo()

Specified by:

getStartPageNo in interface PdfBoxOutputDevice

setStartPageNo

public void setStartPageNo(int startPageNo)

Specified by:

setStartPageNo in interface PdfBoxOutputDevice

drawSelection

public void drawSelection(RenderingContext c,
                          InlineText inlineText)

Specified by:

drawSelection in interface OutputDevice

Specified by:

drawSelection in interface PdfBoxOutputDevice

isSupportsCMYKColors

public boolean isSupportsCMYKColors()

Specified by:

isSupportsCMYKColors in interface OutputDevice

Specified by:

isSupportsCMYKColors in interface PdfBoxOutputDevice

drawWithGraphics

public void drawWithGraphics(float x,
                             float y,
                             float width,
                             float height,
                             OutputDeviceGraphicsDrawer renderer)

Specified by:

drawWithGraphics in interface OutputDevice

Specified by:

drawWithGraphics in interface PdfBoxOutputDevice

findPagePositionsByID

public List<PagePosition<Box>> findPagePositionsByID(CssContext c,
                                                     Pattern pattern)

Specified by:

findPagePositionsByID in interface PdfBoxOutputDevice

setRenderingContext

public void setRenderingContext(RenderingContext result)

Specified by:

setRenderingContext in interface PdfBoxOutputDevice

setBidiReorderer

public void setBidiReorderer(BidiReorderer reorderer)

Specified by:

setBidiReorderer in interface PdfBoxOutputDevice

setPaint

public void setPaint(Paint paint)

Specified by:

setPaint in interface OutputDevice

Specified by:

setPaint in interface PdfBoxOutputDevice

isPDF

public boolean isPDF()

Specified by:

isPDF in interface OutputDevice

Specified by:

isPDF in interface PdfBoxOutputDevice

Overrides:

isPDF in class AbstractOutputDevice

close

public void close()

Perform any internal cleanup needed

Specified by:

close in interface PdfBoxOutputDevice

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

pushTransformLayer

public void pushTransformLayer(AffineTransform transform)

Specified by:

pushTransformLayer in interface OutputDevice

Specified by:

pushTransformLayer in interface PdfBoxOutputDevice

popTransformLayer

public void popTransformLayer()

Specified by:

popTransformLayer in interface OutputDevice

Specified by:

popTransformLayer in interface PdfBoxOutputDevice

isFastRenderer

public boolean isFastRenderer()

Specified by:

isFastRenderer in interface PdfBoxOutputDevice

startStructure

public Object startStructure(StructureType type,
                             Box box)

Specified by:

startStructure in interface OutputDevice

endStructure

public void endStructure(Object token)

Specified by:

endStructure in interface OutputDevice