Package com.openhtmltopdf.pdfboxout

Interface PdfBoxOutputDevice

All Superinterfaces:

OutputDevice

All Known Implementing Classes:

PdfBoxFastOutputDevice, PdfBoxSlowOutputDevice

public interface PdfBoxOutputDevice
extends OutputDevice

Method Summary

Modifier and Type	Method	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, boolean interpolate)
void	drawOval(int x, int y, int width, int height)
void	drawPdfAsImage(org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject _src, 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)	Draw something using a Graphics2D at the given rectangle.
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()
float	getAbsoluteTransformOriginX()
float	getAbsoluteTransformOriginY()
Shape	getClip()
PdfContentStreamAdapter	getCurrentPage()
float	getDeviceLength(float length)	Given a value in dots units, converts to PDF points.
float	getDotsPerPoint()
List<PdfBoxSlowOutputDevice.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()	The new (2018) fast renderer is in use.
boolean	isPDF()
boolean	isSupportsCMYKColors()
boolean	isSupportsSelection()
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()	Reverts the last clip on the stack.
void	popTransformLayer()	Reverts the transform on the stack.
void	popTransforms(List<AffineTransform> inverse)
void	pushClip(Shape s)	Applies a clip on the output device.
void	pushTransformLayer(AffineTransform transform)	Applies a transform on the output device.
List<AffineTransform>	pushTransforms(List<AffineTransform> transforms)	Apply the given transform on top of the current one in the PDF graphics stream.
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 interface com.openhtmltopdf.extend.OutputDevice

drawDebugOutline, drawLinearGradient, drawText, drawTextDecoration, drawTextDecoration, endStructure, paintBackground, paintBorder, paintBorder, paintCollapsedBorder, startStructure

Method Details

setWriter

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

getWriter

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

initializePage

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

void finishPage()

paintReplacedElement

void paintReplacedElement(RenderingContext c,
 BlockBox box)

Specified by:

paintReplacedElement in interface OutputDevice

paintBackground

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

getDeviceLength

float getDeviceLength(float length)

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

drawBorderLine

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

Specified by:

drawBorderLine in interface OutputDevice

setColor

void setColor(FSColor color)

Specified by:

setColor in interface OutputDevice

draw

void draw(Shape s)

Specified by:

draw in interface OutputDevice

drawRect

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

Specified by:

drawRect in interface OutputDevice

drawOval

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

Specified by:

drawOval in interface OutputDevice

fill

void fill(Shape s)

Specified by:

fill in interface OutputDevice

fillRect

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

Specified by:

fillRect in interface OutputDevice

fillOval

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

Specified by:

fillOval in interface OutputDevice

translate

void translate(double tx,
 double ty)

Specified by:

translate in interface OutputDevice

getRenderingHint

Object getRenderingHint(RenderingHints.Key key)

Specified by:

getRenderingHint in interface OutputDevice

setRenderingHint

void setRenderingHint(RenderingHints.Key key,
 Object value)

Specified by:

setRenderingHint in interface OutputDevice

setFont

void setFont(FSFont font)

Specified by:

setFont in interface OutputDevice

drawString

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

drawStringFast

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

getCurrentPage

PdfContentStreamAdapter getCurrentPage()

getPage

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

normalizeY

float normalizeY(float y,
 float pageHeight)

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

setStroke

void setStroke(Stroke s)

Specified by:

setStroke in interface OutputDevice

clip

void clip(Shape s)

Specified by:

clip in interface OutputDevice

getClip

Shape getClip()

Specified by:

getClip in interface OutputDevice

popClip

void popClip()

Description copied from interface: OutputDevice

Reverts the last clip on the stack. The fast renderer MUST use pushClip and popClip in preference to clip and setClip.

NOTE: The current implementation shares a stack between transforms and clips, so calls to OutputDevice.pushTransformLayer(AffineTransform), OutputDevice.popTransformLayer(), OutputDevice.pushClip(Shape) and OutputDevice.popClip() MUST be nested correctly.

Specified by:

popClip in interface OutputDevice

pushClip

void pushClip(Shape s)

Description copied from interface: OutputDevice

Applies a clip on the output device. This is a cumulative operation. The fast renderer MUST use pushClip and popClip in preference to clip and setClip.

NOTE: The current implementation shares a stack between transforms and clips, so calls to OutputDevice.pushTransformLayer(AffineTransform), OutputDevice.popTransformLayer(), OutputDevice.pushClip(Shape) and OutputDevice.popClip() MUST be nested correctly.

Specified by:

pushClip in interface OutputDevice

setClip

void setClip(Shape s)

Specified by:

setClip in interface OutputDevice

getStroke

Stroke getStroke()

Specified by:

getStroke in interface OutputDevice

realizeImage

void realizeImage(PdfBoxImage img)

drawImage

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

Specified by:

drawImage in interface OutputDevice

getDotsPerPoint

float getDotsPerPoint()

start

void start(Document doc)

finish

void finish(RenderingContext c,
 Box root)

addMetadata

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

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

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.

Parameters:

name - the metadata element name to locate.

Returns:

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

setMetadata

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

SharedContext getSharedContext()

setSharedContext

void setSharedContext(SharedContext sharedContext)

setRoot

void setRoot(Box root)

getStartPageNo

int getStartPageNo()

setStartPageNo

void setStartPageNo(int startPageNo)

drawSelection

void drawSelection(RenderingContext c,
 InlineText inlineText)

Specified by:

drawSelection in interface OutputDevice

isSupportsSelection

boolean isSupportsSelection()

Specified by:

isSupportsSelection in interface OutputDevice

isSupportsCMYKColors

boolean isSupportsCMYKColors()

Specified by:

isSupportsCMYKColors in interface OutputDevice

drawWithGraphics

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

Description copied from interface: OutputDevice

Draw something using a Graphics2D at the given rectangle.

Specified by:

drawWithGraphics in interface OutputDevice

findPagePositionsByID

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

setRenderingContext

void setRenderingContext(RenderingContext result)

setBidiReorderer

void setBidiReorderer(BidiReorderer reorderer)

popTransforms

void popTransforms(List<AffineTransform> inverse)

Specified by:

popTransforms in interface OutputDevice

pushTransforms

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

Description copied from interface: OutputDevice

Apply the given transform on top of the current one in the PDF graphics stream. This is a cumulative operation. You should popTransform after the box and children are painted.

Specified by:

pushTransforms in interface OutputDevice

Returns:

the list of inverse transforms to undo the effect of this transform

getAbsoluteTransformOriginX

float getAbsoluteTransformOriginX()

Specified by:

getAbsoluteTransformOriginX in interface OutputDevice

getAbsoluteTransformOriginY

float getAbsoluteTransformOriginY()

Specified by:

getAbsoluteTransformOriginY in interface OutputDevice

setPaint

void setPaint(Paint paint)

Specified by:

setPaint in interface OutputDevice

isPDF

boolean isPDF()

Specified by:

isPDF in interface OutputDevice

close

void close()

Perform any internal cleanup needed

pushTransformLayer

void pushTransformLayer(AffineTransform transform)

Description copied from interface: OutputDevice

Applies a transform on the output device. This is a cumulativew operation.

NOTE: The current implementation shares a stack between transforms and clips, so calls to OutputDevice.pushTransformLayer(AffineTransform), OutputDevice.popTransformLayer(), OutputDevice.pushClip(Shape) and OutputDevice.popClip() MUST be nested correctly.

Specified by:

pushTransformLayer in interface OutputDevice

popTransformLayer

void popTransformLayer()

Description copied from interface: OutputDevice

Reverts the transform on the stack.

NOTE: The current implementation shares a stack between transforms and clips, so calls to OutputDevice.pushTransformLayer(AffineTransform), OutputDevice.popTransformLayer(), OutputDevice.pushClip(Shape) and OutputDevice.popClip() MUST be nested correctly.

Specified by:

popTransformLayer in interface OutputDevice

isFastRenderer

boolean isFastRenderer()

Description copied from interface: OutputDevice

The new (2018) fast renderer is in use.

Specified by:

isFastRenderer in interface OutputDevice

getPageRefY

int getPageRefY(Box box)

getMetadata

List<PdfBoxSlowOutputDevice.Metadata> getMetadata()

drawPdfAsImage

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