net.sf.jasperreports.renderers.AbstractSvgDataToGraphics2DRenderer Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.renderers;
import java.awt.Graphics2D;
import java.awt.geom.AffineTransform;
import java.awt.geom.Dimension2D;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.lang.ref.SoftReference;
import java.util.List;
import org.apache.batik.anim.dom.SAXSVGDocumentFactory;
import org.apache.batik.bridge.BridgeContext;
import org.apache.batik.bridge.FontFamilyResolver;
import org.apache.batik.bridge.GVTBuilder;
import org.apache.batik.bridge.UserAgent;
import org.apache.batik.bridge.ViewBox;
import org.apache.batik.dom.svg.SVGDocumentFactory;
import org.apache.batik.ext.awt.image.GraphicsUtil;
import org.apache.batik.gvt.GraphicsNode;
import org.w3c.dom.Node;
import org.w3c.dom.svg.SVGDocument;
import org.w3c.dom.svg.SVGPreserveAspectRatio;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPrintImageAreaHyperlink;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.util.SimpleDimension2D;
/**
* SVG renderer implementation based on Batik.
*
* @author Lucian Chirita ([email protected])
*/
public abstract class AbstractSvgDataToGraphics2DRenderer extends AbstractRenderToImageAwareRenderer implements DataRenderable, Graphics2DRenderable, DimensionRenderable, AreaHyperlinksRenderable
{
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
private List areaHyperlinks;
private transient SoftReference rootNodeRef;
private transient Dimension2D documentSize;
/**
* Creates a SVG renderer.
*
* @param areaHyperlinks a list of {@link JRPrintImageAreaHyperlink area hyperlinks}
*/
protected AbstractSvgDataToGraphics2DRenderer(List areaHyperlinks)
{
this.areaHyperlinks = areaHyperlinks;
}
@Override
public Graphics2D createGraphics(BufferedImage bi)
{
Graphics2D graphics = GraphicsUtil.createGraphics(bi);
return graphics;
}
@Override
public void render(JasperReportsContext jasperReportsContext, Graphics2D grx, Rectangle2D rectangle) throws JRException
{
GraphicsNode rootNode = getRootNode(jasperReportsContext);
AffineTransform transform =
ViewBox.getPreserveAspectRatioTransform(
new float[]{0, 0, (float) documentSize.getWidth(), (float) documentSize.getHeight()},
SVGPreserveAspectRatio.SVG_PRESERVEASPECTRATIO_NONE,
true,
(float) rectangle.getWidth(),
(float) rectangle.getHeight()
);
Graphics2D graphics = (Graphics2D) grx.create();
try
{
graphics.translate(rectangle.getX(), rectangle.getY());
graphics.transform(transform);
// CompositeGraphicsNode not thread safe
synchronized (rootNode)
{
rootNode.paint(graphics);
}
}
finally
{
graphics.dispose();
}
}
@Override
public Dimension2D getDimension(JasperReportsContext jasperReportsContext)
{
try
{
getRootNode(jasperReportsContext);
return documentSize;
}
catch (JRException e)
{
throw new JRRuntimeException(e);
}
}
protected synchronized GraphicsNode getRootNode(JasperReportsContext jasperReportsContext) throws JRException
{
if (rootNodeRef == null || rootNodeRef.get() == null)
{
FontFamilyResolver fontFamilyResolver = BatikFontFamilyResolver.getInstance(jasperReportsContext);
UserAgent userAgentForDoc =
new BatikUserAgent(
fontFamilyResolver,
BatikUserAgent.PIXEL_TO_MM_72_DPI
);
SVGDocumentFactory documentFactory =
new SAXSVGDocumentFactory(userAgentForDoc.getXMLParserClassName(), true);
documentFactory.setValidating(userAgentForDoc.isXMLParserValidating());
SVGDocument document = getSvgDocument(jasperReportsContext, documentFactory);
Node svgNode = document.getElementsByTagName("svg").item(0);
Node svgWidthNode = svgNode.getAttributes().getNamedItem("width");
Node svgHeightNode = svgNode.getAttributes().getNamedItem("height");
String strSvgWidth = svgWidthNode == null ? null : svgWidthNode.getNodeValue().trim();
String strSvgHeight = svgHeightNode == null ? null : svgHeightNode.getNodeValue().trim();
float pixel2mm = BatikUserAgent.PIXEL_TO_MM_72_DPI;
if (
(strSvgWidth != null && strSvgWidth.endsWith("mm"))
|| (strSvgHeight != null && strSvgHeight.endsWith("mm"))
)
{
pixel2mm = BatikUserAgent.PIXEL_TO_MM_96_DPI;
}
UserAgent userAgentForCtx =
new BatikUserAgent(
fontFamilyResolver,
pixel2mm
);
BridgeContext ctx = new BridgeContext(userAgentForCtx);
ctx.setDynamic(true);
GVTBuilder builder = new GVTBuilder();
GraphicsNode rootNode = builder.build(ctx, document);
rootNodeRef = new SoftReference<>(rootNode);
//copying the document size object because it has a reference to SVGSVGElementBridge,
//which prevents rootNodeRef from being cleared by the garbage collector
Dimension2D svgSize = ctx.getDocumentSize();
documentSize = new SimpleDimension2D(svgSize.getWidth(), svgSize.getHeight());
}
return rootNodeRef.get();
}
/**
*
*/
protected abstract SVGDocument getSvgDocument(
JasperReportsContext jasperReportsContext,
SVGDocumentFactory documentFactory
) throws JRException;
@Override
public List getImageAreaHyperlinks(Rectangle2D renderingArea) throws JRException
{
return areaHyperlinks;
}
@Override
public boolean hasImageAreaHyperlinks()
{
return areaHyperlinks != null && !areaHyperlinks.isEmpty();
}
}