Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software 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.engine;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Transparency;
import java.awt.geom.Dimension2D;
import java.awt.geom.Rectangle2D;
import java.awt.image.ColorModel;
import java.awt.image.RenderedImage;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.lang.ref.SoftReference;
import java.net.URL;
import net.sf.jasperreports.engine.type.ImageTypeEnum;
import net.sf.jasperreports.engine.type.OnErrorTypeEnum;
import net.sf.jasperreports.engine.type.RenderableTypeEnum;
import net.sf.jasperreports.engine.util.JRImageLoader;
import net.sf.jasperreports.engine.util.JRLoader;
import net.sf.jasperreports.engine.util.JRTypeSniffer;
import net.sf.jasperreports.repo.RepositoryUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Provides functionality for image rendering.
*
* The content of an image element can come either directly from an image file like a JPG,
* GIF, PNG, or can be a Scalable Vector Graphics (SVG) file that is rendered using some
* business logic or a special graphics API like a charting or a barcode library. Either way,
* JasperReports treats images in a very transparent way because it relies on a special
* interface called {@link net.sf.jasperreports.engine.Renderable} to offer a common
* way to render images.
*
* The {@link net.sf.jasperreports.engine.Renderable} interface has a method called
* {@link #render(JasperReportsContext, Graphics2D, Rectangle2D)},
* which gets called by the engine each time it needs to draw the image
* on a given device or graphic context. This approach provides the best quality for the
* SVG images when they must be drawn on unknown devices or zoomed into without
* losing sharpness.
*
* Other methods specified in this interface can be used to obtain the native size of the
* actual image that the renderer wraps or the binary data for an image that must be stored
* in a separate file during export.
*
* The library comes with a default implementation for the
* {@link net.sf.jasperreports.engine.Renderable} interface that
* wraps images that come from files or binary image data in JPG, GIF, or PNG format.
* This is the {@link net.sf.jasperreports.engine.JRImageRenderer} class, which is actually a container
* for the binary image data, used to load a java.awt.Image object from it.
* Then it draws the loaded image on the supplied java.awt.Graphics2D context when the engine
* requires it.
*
* Image renderers are serializable because inside the generated document for each image is
* a renderer object kept as reference, which is serialized along with the whole
* JasperPrint object.
*
* When a {@link net.sf.jasperreports.engine.JRImageRenderer} instance is serialized,
* so is the binary image data it contains.
*
* However, if the image element must be lazy loaded (see the isLazy image attribute), then the
* engine will not load the binary image data at report-filling time. Rather, it stores inside
* the renderer only the java.lang.String location of the image. The actual image data
* is loaded only when needed for rendering at report-export or view time.
*
* To simplify the implementation of SVG image renderers, JasperReports ships with an
* abstract rendered {@link net.sf.jasperreports.engine.JRAbstractSvgRenderer}. This
* implementation contains the code to produce binary image data from the SVG graphic in
* JPG format. This is needed when the image must be stored in separate files on disk or
* delivered in binary format to a consumer (like a web browser).
*
* @see net.sf.jasperreports.engine.JRAbstractSvgRenderer
* @author Teodor Danciu ([email protected])
*/
public class JRImageRenderer extends JRAbstractRenderer
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
private static final Log log = LogFactory.getLog(JRImageRenderer.class);
/**
*
*/
private byte[] imageData;
private String imageLocation;
private ImageTypeEnum imageTypeValue = ImageTypeEnum.UNKNOWN;
/**
*
*/
private transient SoftReference awtImageRef;
/**
*
*/
protected JRImageRenderer(byte[] imageData)
{
this.imageData = imageData;
if(imageData != null)
{
imageTypeValue = JRTypeSniffer.getImageTypeValue(imageData);
}
}
/**
*
*/
protected JRImageRenderer(String imageLocation)
{
this.imageLocation = imageLocation;
}
/**
*
*/
public static JRImageRenderer getInstance(byte[] imageData)
{
return new JRImageRenderer(imageData);
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(String)}.
*/
public static JRRenderable getInstance(String imageLocation) throws JRException
{
return RenderableUtil.getInstance(DefaultJasperReportsContext.getInstance()).getRenderable(imageLocation);
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(String, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(String imageLocation, OnErrorTypeEnum onErrorType) throws JRException
{
return RenderableUtil.getInstance(DefaultJasperReportsContext.getInstance()).getRenderable(imageLocation, onErrorType);
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(String, OnErrorTypeEnum, boolean)}.
*/
public static JRRenderable getInstance(String imageLocation, OnErrorTypeEnum onErrorType, boolean isLazy) throws JRException
{
return RenderableUtil.getInstance(DefaultJasperReportsContext.getInstance()).getRenderable(imageLocation, onErrorType, isLazy);
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(Image, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(Image img, OnErrorTypeEnum onErrorType) throws JRException
{
ImageTypeEnum type = ImageTypeEnum.JPEG;
if (img instanceof RenderedImage)
{
ColorModel colorModel = ((RenderedImage) img).getColorModel();
//if the image has transparency, encode as PNG
if (colorModel.hasAlpha()
&& colorModel.getTransparency() != Transparency.OPAQUE)
{
type = ImageTypeEnum.PNG;
}
}
return getInstance(img, type.getValue(), onErrorType);
}
/**
* Creates and returns an instance of the JRImageRenderer class after encoding the image object using an image
* encoder that supports the supplied image type.
*
* @param image the java.awt.Image object to wrap into a JRImageRenderer instance
* @param imageType the type of the image as specified by one of the constants defined in the JRRenderable interface
* @param onErrorType one of the error type constants defined in the {@link OnErrorTypeEnum}.
* @return the image renderer instance
* @deprecated Replaced by {@link RenderableUtil#getRenderable(Image, ImageTypeEnum, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(Image image, byte imageType, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
return new JRImageRenderer(JRImageLoader.loadImageDataFromAWTImage(image, imageType));
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(InputStream, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(InputStream is, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
return new JRImageRenderer(JRLoader.loadBytes(is));
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(URL, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(URL url, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
return new JRImageRenderer(JRLoader.loadBytes(url));
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @deprecated Replaced by {@link RenderableUtil#getRenderable(File, OnErrorTypeEnum)}.
*/
public static JRRenderable getInstance(File file, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
return new JRImageRenderer(JRLoader.loadBytes(file));
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @deprecated Replaced by {@link RenderableUtil#getOnErrorRendererForDimension(Renderable, OnErrorTypeEnum)}.
*/
public static JRRenderable getOnErrorRendererForDimension(JRRenderable renderer, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
renderer.getDimension();
return renderer;
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @deprecated Replaced by {@link RenderableUtil#getOnErrorRendererForImageData(Renderable, OnErrorTypeEnum)}.
*/
public static JRRenderable getOnErrorRendererForImageData(JRRenderable renderer, OnErrorTypeEnum onErrorType) throws JRException
{
try
{
renderer.getImageData();
return renderer;
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
*
*/
public static JRImageRenderer getOnErrorRendererForImage(JasperReportsContext jasperReportsContext, JRImageRenderer renderer, OnErrorTypeEnum onErrorType) throws JRException
{
JRImageRenderer result;
try
{
renderer.getImage(jasperReportsContext);
result = renderer;
}
catch (JRException e) //FIXME this duplicates RenderableUtil.handleImageError
{
result = getOnErrorRenderer(onErrorType, e);
if (log.isDebugEnabled())
{
log.debug("handled image error with type " + onErrorType, e);
}
}
catch (JRRuntimeException e)
{
result = getOnErrorRenderer(onErrorType, e);
if (log.isDebugEnabled())
{
log.debug("handled image error with type " + onErrorType, e);
}
}
return result;
}
/**
* @deprecated Replaced by {@link #getOnErrorRendererForImage(JasperReportsContext, JRImageRenderer, OnErrorTypeEnum)}.
*/
public static JRImageRenderer getOnErrorRendererForImage(JRImageRenderer renderer, OnErrorTypeEnum onErrorType) throws JRException
{
return getOnErrorRendererForImage(DefaultJasperReportsContext.getInstance(), renderer, onErrorType);
}
/**
*
*/
public static JRImageRenderer getOnErrorRenderer(OnErrorTypeEnum onErrorType, JRException e) throws JRException
{
JRImageRenderer renderer = null;
switch (onErrorType)
{
case ICON :
{
renderer = new JRImageRenderer(JRImageLoader.NO_IMAGE_RESOURCE);
//FIXME cache these renderers
break;
}
case BLANK :
{
break;
}
case ERROR :
default :
{
throw e;
}
}
return renderer;
}
public static JRImageRenderer getOnErrorRenderer(OnErrorTypeEnum onErrorType, JRRuntimeException e) throws JRRuntimeException
{
JRImageRenderer renderer = null;
switch (onErrorType)
{
case ICON :
{
renderer = new JRImageRenderer(JRImageLoader.NO_IMAGE_RESOURCE);
//FIXME cache these renderers
break;
}
case BLANK :
{
break;
}
case ERROR :
default :
{
throw e;
}
}
return renderer;
}
/**
*
*/
public Image getImage(JasperReportsContext jasperReportsContext) throws JRException
{
if (awtImageRef == null || awtImageRef.get() == null)
{
Image awtImage = JRImageLoader.getInstance(jasperReportsContext).loadAwtImageFromBytes(getImageData(jasperReportsContext));
awtImageRef = new SoftReference(awtImage);
}
return awtImageRef.get();
}
/**
* @deprecated Replaced by {@link #getImage(JasperReportsContext)}.
*/
public Image getImage() throws JRException
{
return getImage(DefaultJasperReportsContext.getInstance());
}
/**
*
*/
public String getImageLocation()
{
return imageLocation;
}
/**
* @deprecated Replaced by {@link #getTypeValue()}.
*/
public byte getType()
{
return getTypeValue().getValue();
}
/**
* @deprecated Replaced by {@link #getImageTypeValue()}.
*/
public byte getImageType()
{
return getImageTypeValue().getValue();
}
/**
*
*/
public RenderableTypeEnum getTypeValue()
{
return RenderableTypeEnum.IMAGE;
}
/**
*
*/
public ImageTypeEnum getImageTypeValue()
{
return imageTypeValue;
}
/**
* @deprecated Replaced by {@link #getDimension(JasperReportsContext)}.
*/
public Dimension2D getDimension() throws JRException
{
return getDimension(DefaultJasperReportsContext.getInstance());
}
/**
*
*/
public Dimension2D getDimension(JasperReportsContext jasperReportsContext) throws JRException
{
Image img = getImage(jasperReportsContext);
return new Dimension(img.getWidth(null), img.getHeight(null));
}
@Override
public byte[] getImageData(JasperReportsContext jasperReportsContext)
throws JRException
{
if (imageData == null)
{
imageData = RepositoryUtil.getInstance(jasperReportsContext).getBytesFromLocation(imageLocation);
if(imageData != null)
{
imageTypeValue = JRTypeSniffer.getImageTypeValue(imageData);
}
}
return imageData;
}
/**
* @deprecated Replaced by {@link #getImageData(JasperReportsContext)}.
*/
public byte[] getImageData() throws JRException
{
return getImageData(DefaultJasperReportsContext.getInstance());
}
/**
* @deprecated Replaced by {@link #render(JasperReportsContext, Graphics2D, Rectangle2D)}.
*/
public void render(Graphics2D grx, Rectangle2D rectangle) throws JRException
{
render(DefaultJasperReportsContext.getInstance(), grx, rectangle);
}
/**
*
*/
public void render(JasperReportsContext jasperReportsContext, Graphics2D grx, Rectangle2D rectangle) throws JRException
{
Image img = getImage(jasperReportsContext);
grx.drawImage(
img,
(int)rectangle.getX(),
(int)rectangle.getY(),
(int)rectangle.getWidth(),
(int)rectangle.getHeight(),
null
);
}
/*
* These fields are only for serialization backward compatibility.
*/
private int PSEUDO_SERIAL_VERSION_UID = JRConstants.PSEUDO_SERIAL_VERSION_UID; //NOPMD
/**
* @deprecated
*/
private byte imageType;
@SuppressWarnings("deprecation")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_4_6_0)
{
imageTypeValue = ImageTypeEnum.getByValue(imageType);
}
}
}
