com.openhtmltopdf.extend

Interface SVGDrawer

All Superinterfaces:

AutoCloseable, Closeable

public interface SVGDrawer
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SVGDrawer.SVGImage

Method Summary

Modifier and Type	Method and Description
void	addFontFile(File fontFile, String family, Integer weight, BaseRendererBuilder.FontStyle style)
default void	addFontStream(FSSupplier<InputStream> supplier, String family, Integer weight, BaseRendererBuilder.FontStyle style) Adds a font that is supplied as a stream rather than as a file, so that fonts registered with useFont(FSSupplier<InputStream>, ...) can be used by SVG (or MathML) content too.
default SVGDrawer.SVGImage	buildStandaloneSVGImage(Element svgElement, String uri, double targetWidth, double targetHeight, double dotsPerPixel) Builds an SVG image that is not tied to a replaced element, so that SVGs can be used as CSS images, for example as a background-image or a list-style-image.
SVGDrawer.SVGImage	buildSVGImage(Element svgElement, Box box, CssContext cssContext, double cssWidth, double cssHeight, double dotsPerPixel)
void	importFontFaceRules(List<FontFaceRule> fontFaces, SharedContext shared)
default void	withUserAgent(UserAgentCallback userAgentCallback)

Methods inherited from interface java.io.Closeable

close

Method Detail

importFontFaceRules

void importFontFaceRules(List<FontFaceRule> fontFaces,
                         SharedContext shared)

buildSVGImage

SVGDrawer.SVGImage buildSVGImage(Element svgElement,
                                 Box box,
                                 CssContext cssContext,
                                 double cssWidth,
                                 double cssHeight,
                                 double dotsPerPixel)

buildStandaloneSVGImage

default SVGDrawer.SVGImage buildStandaloneSVGImage(Element svgElement,
                                                   String uri,
                                                   double targetWidth,
                                                   double targetHeight,
                                                   double dotsPerPixel)

Builds an SVG image that is not tied to a replaced element, so that SVGs can be used as CSS images, for example as a background-image or a list-style-image. In that position there is no box to size the image against, so the image is sized by the SVG itself or by the caller.

The default implementation draws nothing, so that implementations written against an earlier version of this interface keep compiling and working. It logs a warning so that a silently undrawn image is at least visible.

Parameters:

svgElement - the root svg element

uri - where the SVG was loaded from, for logging

targetWidth - the width to draw at, in dots, or -1 to use the intrinsic width

targetHeight - the height to draw at, in dots, or -1 to use the intrinsic height

dotsPerPixel - dots per CSS pixel

Returns:

the image, or null if this drawer only supports SVGs inside a replaced element.

withUserAgent

default void withUserAgent(UserAgentCallback userAgentCallback)

addFontFile

void addFontFile(File fontFile,
                 String family,
                 Integer weight,
                 BaseRendererBuilder.FontStyle style)
          throws IOException,
                 FontFormatException

Throws:

IOException

FontFormatException

addFontStream

default void addFontStream(FSSupplier<InputStream> supplier,
                           String family,
                           Integer weight,
                           BaseRendererBuilder.FontStyle style)
                    throws IOException,
                           FontFormatException

Adds a font that is supplied as a stream rather than as a file, so that fonts registered with useFont(FSSupplier<InputStream>, ...) can be used by SVG (or MathML) content too.

The default implementation ignores the font, so that implementations written against an earlier version of this interface keep compiling and working. It logs a warning so that a silently ignored font is at least visible.

Throws:

IOException

FontFormatException