Package com.openhtmltopdf.svgsupport

Class BatikSVGDrawer

java.lang.Object

com.openhtmltopdf.svgsupport.BatikSVGDrawer

All Implemented Interfaces:

SVGDrawer, java.io.Closeable, java.lang.AutoCloseable

public class BatikSVGDrawer
extends java.lang.Object
implements SVGDrawer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatikSVGDrawer.SvgExternalResourceMode
static class	BatikSVGDrawer.SvgScriptMode

Nested classes/interfaces inherited from interface com.openhtmltopdf.extend.SVGDrawer

SVGDrawer.SVGImage

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.String>	allowedProtocols
private boolean	allowExternalResources
private boolean	allowScripts
PDFTranscoder.OpenHtmlFontResolver	fontResolver
private UserAgentCallback	userAgentCallback

Constructor Summary

Constructors

Constructor	Description
BatikSVGDrawer()	Creates a SVGDrawer that does NOT allow scripts to run or external resources such as file:// or http:// protocol urls to be requested.
BatikSVGDrawer(BatikSVGDrawer.SvgScriptMode scriptMode, BatikSVGDrawer.SvgExternalResourceMode externalResourceMode)	Creates a SVGDrawer that can allow arbitary scripts to run or allow arbitary external resources to be requested.
BatikSVGDrawer(BatikSVGDrawer.SvgScriptMode scriptMode, java.util.Set<java.lang.String> allowedProtocols)	Creates a SVGDrawer that can allow arbitary scripts to run and allow the loading of external resources with the specified protocols.

Method Summary

Modifier and Type	Method	Description
void	addFontFile(java.io.File fontFile, java.lang.String family, java.lang.Integer weight, BaseRendererBuilder.FontStyle style)
SVGDrawer.SVGImage	buildSVGImage(org.w3c.dom.Element svgElement, Box box, CssContext c, double cssWidth, double cssHeight, double dotsPerPixel)
void	close()
void	importFontFaceRules(java.util.List<FontFaceRule> fontFaces, SharedContext shared)
void	withUserAgent(UserAgentCallback userAgentCallback)

Methods inherited from class java.lang.Object

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

Field Detail

allowedProtocols

private final java.util.Set<java.lang.String> allowedProtocols

fontResolver

public PDFTranscoder.OpenHtmlFontResolver fontResolver

allowScripts

private final boolean allowScripts

allowExternalResources

private final boolean allowExternalResources

userAgentCallback

private UserAgentCallback userAgentCallback

Constructor Detail

BatikSVGDrawer

public BatikSVGDrawer(BatikSVGDrawer.SvgScriptMode scriptMode,
                      BatikSVGDrawer.SvgExternalResourceMode externalResourceMode)

Creates a SVGDrawer that can allow arbitary scripts to run or allow arbitary external resources to be requested. IMPORTANT: External resources include the file:// protocol and may give an attacker access to all files on the system. Scripts may call Javascript or Java code and take control of the system. Please be very sure you are ONLY using trusted SVGs before using this constructor!

BatikSVGDrawer

public BatikSVGDrawer(BatikSVGDrawer.SvgScriptMode scriptMode,
                      java.util.Set<java.lang.String> allowedProtocols)

Creates a SVGDrawer that can allow arbitary scripts to run and allow the loading of external resources with the specified protocols.

Parameters:

scriptMode -

allowedProtocols -

BatikSVGDrawer

public BatikSVGDrawer()

Creates a SVGDrawer that does NOT allow scripts to run or external resources such as file:// or http:// protocol urls to be requested. Recommended for most users.

Method Detail

importFontFaceRules

public void importFontFaceRules(java.util.List<FontFaceRule> fontFaces,
                                SharedContext shared)

Specified by:

importFontFaceRules in interface SVGDrawer

withUserAgent

public void withUserAgent(UserAgentCallback userAgentCallback)

Specified by:

withUserAgent in interface SVGDrawer

buildSVGImage

public SVGDrawer.SVGImage buildSVGImage(org.w3c.dom.Element svgElement,
                                        Box box,
                                        CssContext c,
                                        double cssWidth,
                                        double cssHeight,
                                        double dotsPerPixel)

Specified by:

buildSVGImage in interface SVGDrawer

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

addFontFile

public void addFontFile(java.io.File fontFile,
                        java.lang.String family,
                        java.lang.Integer weight,
                        BaseRendererBuilder.FontStyle style)
                 throws java.io.IOException,
                        java.awt.FontFormatException

Specified by:

addFontFile in interface SVGDrawer

Throws:

java.io.IOException

java.awt.FontFormatException