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.
net.sf.jasperreports.engine.JRImageRenderer Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2013 Jaspersoft Corporation. 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 [email protected] )
* @version $Id: JRImageRenderer.java 5878 2013-01-07 20:23:13Z teodord $
*/
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 #getInstance(String, OnErrorTypeEnum, boolean)}.
*/
public static JRRenderable getInstance(
String imageLocation,
OnErrorTypeEnum onErrorType,
boolean isLazy,
ClassLoader classLoader,
URLStreamHandlerFactory urlHandlerFactory,
FileResolver fileResolver
) throws JRException
{
if (imageLocation == null)
{
return null;
}
if (isLazy)
{
return new JRImageRenderer(imageLocation);
}
try
{
byte[] data = JRLoader.loadBytesFromLocation(imageLocation, classLoader, urlHandlerFactory, fileResolver);
return new JRImageRenderer(data);
}
catch (JRException e)
{
return getOnErrorRenderer(onErrorType, e);
}
}
/**
* @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;
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);
}
}
}
