com.openhtmltopdf.render

Class FSSVGImage

java.lang.Object

com.openhtmltopdf.render.FSSVGImage

All Implemented Interfaces:

FSImage

public class FSSVGImage
extends Object
implements FSImage

An image that is drawn by the SVG drawer rather than decoded into a bitmap, so that SVGs used as CSS images (background-image, list-style-image, ...) stay vector art in the output.

Unlike a replaced svg element there is no box to size against here: the image starts out at the size the SVG asks for and is resized by the layout, for example by background-size. Because of that the size is mutable, and each user gets its own instance via copy() while the expensive parts - the parsed element and the already built images - stay shared.

Output devices recognize this class in drawImage and hand it back to the SVG drawer instead of treating it as a bitmap.

Method Summary

Modifier and Type	Method and Description
FSSVGImage	copy() Returns an independently sizable view of this image.
static FSSVGImage	create(Element svgElement, SVGDrawer drawer, double dotsPerPixel, String uri) Creates an image for the given SVG root element.
void	drawSVG(OutputDevice outputDevice, double x, double y) Draws the SVG at its current size, with the top left corner at the given position in dots.
int	getHeight()
Element	getSVGElement() The root svg element, for callers that would rather draw the SVG themselves than go through this image.
String	getUri() The URI this image was loaded from, for logging.
int	getWidth()
boolean	isAwaitingSize() Whether this image has no size of its own and is still waiting for CSS to give it one.
void	scale(int width, int height)
void	sizeToDefaultObjectSize(int availableWidth, int availableHeight) Sizes an SVG that has no size of its own to the area it is being painted into, which is what CSS calls the default object size.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static FSSVGImage create(Element svgElement,
                                SVGDrawer drawer,
                                double dotsPerPixel,
                                String uri)

Creates an image for the given SVG root element.

Returns:

the image, or null if the drawer can not build standalone SVG images or the SVG turned out to have no usable size.

copy

public FSSVGImage copy()

Returns an independently sizable view of this image. The parsed SVG and any images already built from it are shared with the original, so copying is cheap and drawing the same SVG in more than one place does not rebuild it.

sizeToDefaultObjectSize

public void sizeToDefaultObjectSize(int availableWidth,
                                    int availableHeight)

Sizes an SVG that has no size of its own to the area it is being painted into, which is what CSS calls the default object size. A ratio from the SVG's viewBox is respected, so the image is made as large as it can be inside the area without changing its shape. Does nothing once the size is settled, or for an SVG that has a size already.

This is how a browser sizes a background image whose SVG is written in percentages or carries no width and height at all: the image fills the background positioning area unless background-size says otherwise.

isAwaitingSize

public boolean isAwaitingSize()

Whether this image has no size of its own and is still waiting for CSS to give it one.

getWidth

public int getWidth()

Specified by:

getWidth in interface FSImage

getHeight

public int getHeight()

Specified by:

getHeight in interface FSImage

scale

public void scale(int width,
                  int height)

Specified by:

scale in interface FSImage

drawSVG

public void drawSVG(OutputDevice outputDevice,
                    double x,
                    double y)

Draws the SVG at its current size, with the top left corner at the given position in dots.

getUri

public String getUri()

The URI this image was loaded from, for logging.

getSVGElement

public Element getSVGElement()

The root svg element, for callers that would rather draw the SVG themselves than go through this image.