net.sf.jasperreports.engine.JRImage 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 .
*/
package net.sf.jasperreports.engine;
import net.sf.jasperreports.engine.type.OnErrorTypeEnum;
/**
* An abstract representation of a graphic element representing an image. Images can be aligned and scaled. They can
* also contain hyperlinks or be anchors for other hyperlinks.
*
* @author Teodor Danciu ([email protected])
* @version $Id: JRImage.java 5878 2013-01-07 20:23:13Z teodord $
*/
public interface JRImage extends JRGraphicElement, JREvaluation, JRAnchor, JRHyperlink, JRAlignment, JRCommonImage
{
/**
* Indicates if the engine is loading the current image from cache.
* Implementations of this method rely on default values that depend on the type of the image expression
* if a value was not explicitly set of this flag.
* @return true if the image should be loaded from cache, false otherwise
* @deprecated Replaced by {@link #getUsingCache()}.
*/
public boolean isUsingCache();
/**
* @deprecated Replaced by {@link #getUsingCache()}.
*/
public Boolean isOwnUsingCache();
/**
* Indicates if the engine is loading the current image from cache.
* Implementations of this method return the actual value for the internal flag that was explicitly
* set on this image element.
* @return Boolean.TRUE if the image should be loaded from cache, Boolean.FALSE otherwise
* or null in case the flag was never explicitly set on this image element
*/
public Boolean getUsingCache();
/**
* Specifies if the engine should be loading the current image from cache. If set to true, the reporting engine
* will try to recognize previously loaded images using their specified source. For example, it will recognize
* an image if the image source is a file name that it has already loaded, or if it is the same URL.
*
* For image elements that have expressions returning java.lang.String objects as the image source,
* representing file names, URLs or classpath resources, the default value for this flag is true.
*/
public void setUsingCache(boolean isUsingCache);
/**
* Specifies if the engine should be loading the current image from cache. If set to Boolean.TRUE, the reporting engine
* will try to recognize previously loaded images using their specified source. For example, it will recognize
* an image if the image source is a file name that it has already loaded, or if it is the same URL.
*
* If set to null, the engine will rely on some default value which depends on the type of the image expression.
* The cache is turned on by default only for images that have java.lang.String objects in their expressions.
*/
public void setUsingCache(Boolean isUsingCache);
/**
* Indicates if the images will be loaded lazily or not.
*/
public boolean isLazy();
/**
* Gives control over when the images are retrieved from their specified location. If set to true, the image is
* loaded from the specified location only when the document is viewed or exported to other formats. Otherwise
* it is loaded during the report filling process and stored in the resulting document.
* @param isLazy specifies whether
*/
public void setLazy(boolean isLazy);
/**
* Indicates how the engine will treat a missing image.
* @return a value representing one of the missing image handling constants in {@link OnErrorTypeEnum}
*/
public OnErrorTypeEnum getOnErrorTypeValue();
/**
* Specifies how the engine should treat a missing image.
* @param onErrorTypeEnum a value representing one of the missing image handling constants in {@link OnErrorTypeEnum}
*/
public void setOnErrorType(OnErrorTypeEnum onErrorTypeEnum);
/**
*
*/
public JRExpression getExpression();
}