Openhtmltopdf 1.0.10 · com.openhtmltopdf.pdfboxout.PdfBoxOutputDevice

Method Summary

Modifier and Type	Method and Description
public void	addMetadata(String the name of the metadata element to add. name, String value) Appends a name/content metadata pair to this output device.
public void	clip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.clip.
public void	close() Perform any internal cleanup needed
public void	draw(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.draw.
public void	drawBorderLine(Shape bounds, int side, int lineWidth, boolean solid) Redeclares com.openhtmltopdf.extend.OutputDevice.drawBorderLine.
public void	drawImage(FSImage fsImage, int x, int y, boolean interpolate) Redeclares com.openhtmltopdf.extend.OutputDevice.drawImage.
public void	drawOval(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.drawOval.
public void	drawPdfAsImage(PDFormXObject _src, Rectangle contentBounds, float intrinsicWidth, float intrinsicHeight)
public void	drawRect(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.drawRect.
public void	drawSelection(RenderingContext c, InlineText inlineText) Redeclares com.openhtmltopdf.extend.OutputDevice.drawSelection.
public void	drawString(String s, float x, float y, JustificationInfo info)
public void	drawStringFast(String s, float x, float y, JustificationInfo info, PdfBoxFontResolver.FontDescription desc, float fontSize)
public void	drawWithGraphics(float x, float y, float width, float height, OutputDeviceGraphicsDrawer renderer) Redeclares com.openhtmltopdf.extend.OutputDevice.drawWithGraphics. Draw something using a Graphics2D at the given rectangle.
public void	fill(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.fill.
public void	fillOval(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.fillOval.
public void	fillRect(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.fillRect.
public List<PagePosition<Box>>	findPagePositionsByID(CssContext c, Pattern pattern)
public void	finish(RenderingContext c, Box root)
public void	finishPage()
public float	getAbsoluteTransformOriginX() Redeclares com.openhtmltopdf.extend.OutputDevice.getAbsoluteTransformOriginX.
public float	getAbsoluteTransformOriginY() Redeclares com.openhtmltopdf.extend.OutputDevice.getAbsoluteTransformOriginY.
public Shape	getClip() Redeclares com.openhtmltopdf.extend.OutputDevice.getClip.
public PdfContentStreamAdapter	getCurrentPage()
public float	getDeviceLength(float length) Given a value in dots units, converts to PDF points.
public float	getDotsPerPoint()
public List<PdfBoxSlowOutputDevice.Metadata>	getMetadata()
public String	Returns: the content value of the first found metadata element; otherwise null. getMetadataByName(String the metadata element name to locate. name) Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name.
public List<String>	Returns: an ArrayList with matching content values; otherwise an empty list. getMetadataListByName(String the metadata element name to locate. name) Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList.
public PDPage	getPage()
public int	getPageRefY(Box box)
public Object	getRenderingHint(RenderingHints.Key key) Redeclares com.openhtmltopdf.extend.OutputDevice.getRenderingHint.
public SharedContext	getSharedContext()
public int	getStartPageNo()
public Stroke	getStroke() Redeclares com.openhtmltopdf.extend.OutputDevice.getStroke.
public PDDocument	getWriter()
public void	initializePage(PDPageContentStream currentPage, PDPage page, float height) Start a page.
public boolean	isFastRenderer() Redeclares com.openhtmltopdf.extend.OutputDevice.isFastRenderer. The new (2018) fast renderer is in use.
public boolean	isPDF() Redeclares com.openhtmltopdf.extend.OutputDevice.isPDF.
public boolean	isSupportsCMYKColors() Redeclares com.openhtmltopdf.extend.OutputDevice.isSupportsCMYKColors.
public boolean	isSupportsSelection() Redeclares com.openhtmltopdf.extend.OutputDevice.isSupportsSelection.
public float	normalizeY(float y, float pageHeight) Converts a top down unit to a bottom up PDF unit for the specified page height.
public void	paintBackground(RenderingContext c, Box box) Redeclares com.openhtmltopdf.extend.OutputDevice.paintBackground. We use paintBackground to do extra stuff such as processing links, forms and form controls.
public void	paintReplacedElement(RenderingContext c, BlockBox box) Redeclares com.openhtmltopdf.extend.OutputDevice.paintReplacedElement.
public void	popClip() Redeclares com.openhtmltopdf.extend.OutputDevice.popClip. Reverts the last clip on the stack.
public void	popTransformLayer() Redeclares com.openhtmltopdf.extend.OutputDevice.popTransformLayer. Reverts the transform on the stack.
public void	popTransforms(List<AffineTransform> inverse) Redeclares com.openhtmltopdf.extend.OutputDevice.popTransforms.
public void	pushClip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.pushClip. Applies a clip on the output device.
public void	pushTransformLayer(AffineTransform transform) Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransformLayer. Applies a transform on the output device.
public List<AffineTransform>	pushTransforms(List<AffineTransform> transforms) Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransforms. Apply the given transform on top of the current one in the PDF graphics stream.
public void	realizeImage(PdfBoxImage img)
public void	setBidiReorderer(BidiReorderer reorderer)
public void	setClip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.setClip.
public void	setColor(FSColor color) Redeclares com.openhtmltopdf.extend.OutputDevice.setColor.
public void	setFont(FSFont font) Redeclares com.openhtmltopdf.extend.OutputDevice.setFont.
public void	setMetadata(String the metadata element name to locate. name, String value) Replaces all copies of the named metadata with a single value.
public void	setPaint(Paint paint) Redeclares com.openhtmltopdf.extend.OutputDevice.setPaint.
public void	setRenderingContext(RenderingContext result)
public void	setRenderingHint(RenderingHints.Key key, Object value) Redeclares com.openhtmltopdf.extend.OutputDevice.setRenderingHint.
public void	setRoot(Box root)
public void	setSharedContext(SharedContext sharedContext)
public void	setStartPageNo(int startPageNo)
public void	setStroke(Stroke s) Redeclares com.openhtmltopdf.extend.OutputDevice.setStroke.
public void	setWriter(PDDocument writer)
public void	start(Document doc)
public void	translate(double tx, double ty) Redeclares com.openhtmltopdf.extend.OutputDevice.translate.

Inherited from com.openhtmltopdf.extend.OutputDevice:: drawDebugOutline drawLinearGradient drawText drawTextDecoration drawTextDecoration endStructure paintBackground paintBorder paintBorder paintCollapsedBorder startStructure

Method Detail

addMetadata

back to summary

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:String: the name of the metadata element to add.

clip	back to summary
public void clip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.clip.

close	back to summary
public void close() Perform any internal cleanup needed

draw	back to summary
public void draw(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.draw.

drawBorderLine	back to summary
public void drawBorderLine(Shape bounds, int side, int lineWidth, boolean solid) Redeclares com.openhtmltopdf.extend.OutputDevice.drawBorderLine.

drawImage	back to summary
public void drawImage(FSImage fsImage, int x, int y, boolean interpolate) Redeclares com.openhtmltopdf.extend.OutputDevice.drawImage.

drawOval	back to summary
public void drawOval(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.drawOval.

drawPdfAsImage	back to summary
public void drawPdfAsImage(PDFormXObject _src, Rectangle contentBounds, float intrinsicWidth, float intrinsicHeight)

drawRect	back to summary
public void drawRect(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.drawRect.

drawSelection	back to summary
public void drawSelection(RenderingContext c, InlineText inlineText) Redeclares com.openhtmltopdf.extend.OutputDevice.drawSelection.

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

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

drawWithGraphics	back to summary
public void drawWithGraphics(float x, float y, float width, float height, OutputDeviceGraphicsDrawer renderer) Redeclares com.openhtmltopdf.extend.OutputDevice.drawWithGraphics. Doc from com.openhtmltopdf.extend.OutputDevice.drawWithGraphics. Draw something using a Graphics2D at the given rectangle.

drawWithGraphics

back to summary

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

Redeclares com.openhtmltopdf.extend.OutputDevice.drawWithGraphics.

Doc from com.openhtmltopdf.extend.OutputDevice.drawWithGraphics.

Draw something using a Graphics2D at the given rectangle.

fill	back to summary
public void fill(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.fill.

fillOval	back to summary
public void fillOval(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.fillOval.

fillRect	back to summary
public void fillRect(int x, int y, int width, int height) Redeclares com.openhtmltopdf.extend.OutputDevice.fillRect.

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

finish	back to summary
public void finish(RenderingContext c, Box root)

finishPage	back to summary
public void finishPage()

getAbsoluteTransformOriginX	back to summary
public float getAbsoluteTransformOriginX() Redeclares com.openhtmltopdf.extend.OutputDevice.getAbsoluteTransformOriginX.

getAbsoluteTransformOriginY	back to summary
public float getAbsoluteTransformOriginY() Redeclares com.openhtmltopdf.extend.OutputDevice.getAbsoluteTransformOriginY.

getClip	back to summary
public Shape getClip() Redeclares com.openhtmltopdf.extend.OutputDevice.getClip.

getCurrentPage	back to summary
public PdfContentStreamAdapter getCurrentPage()

getDeviceLength	back to summary
public float getDeviceLength(float length) Given a value in dots units, converts to PDF points.

getDotsPerPoint	back to summary
public float getDotsPerPoint()

getMetadata	back to summary
public List<PdfBoxSlowOutputDevice.Metadata> getMetadata()

getMetadataByName

back to summary

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:String: the metadata element name to locate.

Returns:String

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

getMetadataListByName

back to summary

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.

Parameters

name:String: the metadata element name to locate.

Returns:List<String>

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

getPage	back to summary
public PDPage getPage()

getPageRefY	back to summary
public int getPageRefY(Box box)

getRenderingHint	back to summary
public Object getRenderingHint(RenderingHints.Key key) Redeclares com.openhtmltopdf.extend.OutputDevice.getRenderingHint.

getSharedContext	back to summary
public SharedContext getSharedContext()

getStartPageNo	back to summary
public int getStartPageNo()

getStroke	back to summary
public Stroke getStroke() Redeclares com.openhtmltopdf.extend.OutputDevice.getStroke.

getWriter	back to summary
public PDDocument getWriter()

initializePage	back to summary
public void initializePage(PDPageContentStream currentPage, 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.

isFastRenderer	back to summary
public boolean isFastRenderer() Redeclares com.openhtmltopdf.extend.OutputDevice.isFastRenderer. Doc from com.openhtmltopdf.extend.OutputDevice.isFastRenderer. The new (2018) fast renderer is in use.

isFastRenderer

back to summary

public boolean isFastRenderer()

Redeclares com.openhtmltopdf.extend.OutputDevice.isFastRenderer.

Doc from com.openhtmltopdf.extend.OutputDevice.isFastRenderer.

The new (2018) fast renderer is in use.

isPDF	back to summary
public boolean isPDF() Redeclares com.openhtmltopdf.extend.OutputDevice.isPDF.

isSupportsCMYKColors	back to summary
public boolean isSupportsCMYKColors() Redeclares com.openhtmltopdf.extend.OutputDevice.isSupportsCMYKColors.

isSupportsSelection	back to summary
public boolean isSupportsSelection() Redeclares com.openhtmltopdf.extend.OutputDevice.isSupportsSelection.

normalizeY	back to summary
public float normalizeY(float y, float pageHeight) Converts a top down unit to a bottom up PDF unit for the specified page height.

paintBackground	back to summary
public void paintBackground(RenderingContext c, Box box) Redeclares com.openhtmltopdf.extend.OutputDevice.paintBackground. We use paintBackground to do extra stuff such as processing links, forms and form controls.

paintBackground

back to summary

public void paintBackground(RenderingContext c, Box box)

Redeclares com.openhtmltopdf.extend.OutputDevice.paintBackground.

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

paintReplacedElement	back to summary
public void paintReplacedElement(RenderingContext c, BlockBox box) Redeclares com.openhtmltopdf.extend.OutputDevice.paintReplacedElement.

popClip back to summary

popClip	back to summary
public void popClip() Redeclares com.openhtmltopdf.extend.OutputDevice.popClip. Doc from com.openhtmltopdf.extend.OutputDevice.popClip. 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 `pushTransformLayer(AffineTransform)`, `popTransformLayer()`, `pushClip(Shape)` and `popClip()` MUST be nested correctly.

public void popClip()

Redeclares com.openhtmltopdf.extend.OutputDevice.popClip.

Doc from com.openhtmltopdf.extend.OutputDevice.popClip.

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 pushTransformLayer(AffineTransform), popTransformLayer(), pushClip(Shape) and popClip() MUST be nested correctly.

popTransformLayer back to summary

popTransformLayer	back to summary
public void popTransformLayer() Redeclares com.openhtmltopdf.extend.OutputDevice.popTransformLayer. Doc from com.openhtmltopdf.extend.OutputDevice.popTransformLayer. Reverts the transform on the stack. Note The current implementation shares a stack between transforms and clips, so calls to `pushTransformLayer(AffineTransform)`, `popTransformLayer()`, `pushClip(Shape)` and `popClip()` MUST be nested correctly.

public void popTransformLayer()

Redeclares com.openhtmltopdf.extend.OutputDevice.popTransformLayer.

Doc from com.openhtmltopdf.extend.OutputDevice.popTransformLayer.

Reverts the transform on the stack.

Note

popTransforms	back to summary
public void popTransforms(List<AffineTransform> inverse) Redeclares com.openhtmltopdf.extend.OutputDevice.popTransforms.

pushClip back to summary

pushClip	back to summary
public void pushClip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.pushClip. Doc from com.openhtmltopdf.extend.OutputDevice.pushClip. 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 `pushTransformLayer(AffineTransform)`, `popTransformLayer()`, `pushClip(Shape)` and `popClip()` MUST be nested correctly.

public void pushClip(Shape s)

Redeclares com.openhtmltopdf.extend.OutputDevice.pushClip.

Doc from com.openhtmltopdf.extend.OutputDevice.pushClip.

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

pushTransformLayer back to summary

pushTransformLayer	back to summary
public void pushTransformLayer(AffineTransform transform) Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransformLayer. Doc from com.openhtmltopdf.extend.OutputDevice.pushTransformLayer. 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 `pushTransformLayer(AffineTransform)`, `popTransformLayer()`, `pushClip(Shape)` and `popClip()` MUST be nested correctly.

public void pushTransformLayer(AffineTransform transform)

Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransformLayer.

Doc from com.openhtmltopdf.extend.OutputDevice.pushTransformLayer.

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

Note

pushTransforms	back to summary
public List<AffineTransform> pushTransforms(List<AffineTransform> transforms) Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransforms. Doc from com.openhtmltopdf.extend.OutputDevice.pushTransforms. 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. Returns:List<AffineTransform> the list of inverse transforms to undo the effect of this transform

pushTransforms

back to summary

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

Redeclares com.openhtmltopdf.extend.OutputDevice.pushTransforms.

Doc from com.openhtmltopdf.extend.OutputDevice.pushTransforms.

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.

Returns:List<AffineTransform>: the list of inverse transforms to undo the effect of this transform

realizeImage	back to summary
public void realizeImage(PdfBoxImage img)

setBidiReorderer	back to summary
public void setBidiReorderer(BidiReorderer reorderer)

setClip	back to summary
public void setClip(Shape s) Redeclares com.openhtmltopdf.extend.OutputDevice.setClip.

setColor	back to summary
public void setColor(FSColor color) Redeclares com.openhtmltopdf.extend.OutputDevice.setColor.

setFont	back to summary
public void setFont(FSFont font) Redeclares com.openhtmltopdf.extend.OutputDevice.setFont.

setMetadata back to summary

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:String: the metadata element name to locate.

setPaint	back to summary
public void setPaint(Paint paint) Redeclares com.openhtmltopdf.extend.OutputDevice.setPaint.

setRenderingContext	back to summary
public void setRenderingContext(RenderingContext result)

setRenderingHint	back to summary
public void setRenderingHint(RenderingHints.Key key, Object value) Redeclares com.openhtmltopdf.extend.OutputDevice.setRenderingHint.

setRoot	back to summary
public void setRoot(Box root)

setSharedContext	back to summary
public void setSharedContext(SharedContext sharedContext)

setStartPageNo	back to summary
public void setStartPageNo(int startPageNo)

setStroke	back to summary
public void setStroke(Stroke s) Redeclares com.openhtmltopdf.extend.OutputDevice.setStroke.

setWriter	back to summary
public void setWriter(PDDocument writer)

start	back to summary
public void start(Document doc)

translate	back to summary
public void translate(double tx, double ty) Redeclares com.openhtmltopdf.extend.OutputDevice.translate.

public Interface PdfBoxOutputDevice

Method Summary

Method Detail