com.openhtmltopdf.pdfboxout

Class PdfBoxOutputDevice

java.lang.Object

com.openhtmltopdf.render.AbstractOutputDevice

com.openhtmltopdf.pdfboxout.PdfBoxOutputDevice

All Implemented Interfaces:

OutputDevice

public class PdfBoxOutputDevice
extends AbstractOutputDevice
implements OutputDevice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfBoxOutputDevice.FontRun

Constructor Summary

Constructors

Constructor and Description
PdfBoxOutputDevice(float dotsPerPoint, boolean testMode)

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	clip(Shape s)
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)
protected void	drawLine(int x1, int y1, int x2, int y2)
void	drawOval(int x, int y, int width, int height)
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	fill(Shape s)
void	fillOval(int x, int y, int width, int height)
void	fillRect(int x, int y, int width, int height)
List	findPagePositionsByID(CssContext c, Pattern pattern)
void	finish(RenderingContext c, Box root)
void	finishPage()
float	getAbsoluteTransformOriginX()
float	getAbsoluteTransformOriginY()
Shape	getClip()
PdfContentStreamAdapter	getCurrentPage()
float	getDeviceLength(float length) Given a value in dots units, converts to PDF points.
float	getDotsPerPoint()
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	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()
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	isPDF()
boolean	isSupportsCMYKColors()
boolean	isSupportsSelection()
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	popTransforms(List<AffineTransform> inverse)
List<AffineTransform>	pushTransforms(List<AffineTransform> transforms)
void	realizeImage(PdfBoxImage img)
void	setBidiReorderer(BidiReorderer reorderer)
void	setClip(Shape s)
void	setColor(FSColor color)
void	setFont(FSFont font)
void	setMetadata(String name, String value) Replaces all copies of the named metadata with a single value.
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)
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

PdfBoxOutputDevice

public PdfBoxOutputDevice(float dotsPerPoint,
                          boolean testMode)

Method Detail

setWriter

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

getWriter

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

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.

finishPage

public void finishPage()

paintReplacedElement

public void paintReplacedElement(RenderingContext c,
                                 BlockBox box)

Specified by:

paintReplacedElement in interface OutputDevice

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

Overrides:

paintBackground in class AbstractOutputDevice

getDeviceLength

public float getDeviceLength(float length)

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

drawBorderLine

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

Specified by:

drawBorderLine in interface OutputDevice

setColor

public void setColor(FSColor color)

Specified by:

setColor in interface OutputDevice

draw

public void draw(Shape s)

Specified by:

draw in interface OutputDevice

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

drawOval

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

Specified by:

drawOval in interface OutputDevice

fill

public void fill(Shape s)

Specified by:

fill in interface OutputDevice

fillRect

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

Specified by:

fillRect in interface OutputDevice

fillOval

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

Specified by:

fillOval in interface OutputDevice

translate

public void translate(double tx,
                      double ty)

Specified by:

translate in interface OutputDevice

getRenderingHint

public Object getRenderingHint(RenderingHints.Key key)

Specified by:

getRenderingHint in interface OutputDevice

setRenderingHint

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

Specified by:

setRenderingHint in interface OutputDevice

setFont

public void setFont(FSFont font)

Specified by:

setFont in interface OutputDevice

drawString

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

drawStringFast

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

getCurrentPage

public PdfContentStreamAdapter getCurrentPage()

getPage

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

setStroke

public void setStroke(Stroke s)

Specified by:

setStroke in interface OutputDevice

clip

public void clip(Shape s)

Specified by:

clip in interface OutputDevice

getClip

public Shape getClip()

Specified by:

getClip in interface OutputDevice

setClip

public void setClip(Shape s)

Specified by:

setClip in interface OutputDevice

getStroke

public Stroke getStroke()

Specified by:

getStroke in interface OutputDevice

realizeImage

public void realizeImage(PdfBoxImage img)

drawImage

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

Specified by:

drawImage in interface OutputDevice

getDotsPerPoint

public float getDotsPerPoint()

start

public void start(Document doc)

finish

public void finish(RenderingContext c,
                   Box root)

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.

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.

Parameters:

name - the metadata element name to locate.

Returns:

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

getMetadataListByName

public List 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.

Parameters:

name - the metadata element name to locate.

Returns:

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

setMetadata

public void setMetadata(String name,
                        String value)

Replaces all copies of the named metadata with a single value. A a new value of null will result in the removal of all copies of the named metadata. Use addMetadata to append additional values with the same name.

Parameters:

name - the metadata element name to locate.

getSharedContext

public SharedContext getSharedContext()

setSharedContext

public void setSharedContext(SharedContext sharedContext)

setRoot

public void setRoot(Box root)

getStartPageNo

public int getStartPageNo()

setStartPageNo

public void setStartPageNo(int startPageNo)

drawSelection

public void drawSelection(RenderingContext c,
                          InlineText inlineText)

Specified by:

drawSelection in interface OutputDevice

isSupportsSelection

public boolean isSupportsSelection()

Specified by:

isSupportsSelection in interface OutputDevice

isSupportsCMYKColors

public boolean isSupportsCMYKColors()

Specified by:

isSupportsCMYKColors in interface OutputDevice

drawWithGraphics

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

Specified by:

drawWithGraphics in interface OutputDevice

findPagePositionsByID

public List findPagePositionsByID(CssContext c,
                                  Pattern pattern)

setRenderingContext

public void setRenderingContext(RenderingContext result)

setBidiReorderer

public void setBidiReorderer(BidiReorderer reorderer)

popTransforms

public void popTransforms(List<AffineTransform> inverse)

Specified by:

popTransforms in interface OutputDevice

pushTransforms

public List<AffineTransform> pushTransforms(List<AffineTransform> transforms)

Specified by:

pushTransforms in interface OutputDevice

getAbsoluteTransformOriginX

public float getAbsoluteTransformOriginX()

Specified by:

getAbsoluteTransformOriginX in interface OutputDevice

getAbsoluteTransformOriginY

public float getAbsoluteTransformOriginY()

Specified by:

getAbsoluteTransformOriginY in interface OutputDevice

setPaint

public void setPaint(Paint paint)

Specified by:

setPaint in interface OutputDevice

isPDF

public boolean isPDF()

Specified by:

isPDF in interface OutputDevice

Overrides:

isPDF in class AbstractOutputDevice

close

public void close()

Perform any internal cleanup needed