net.sf.jasperreports.charts.ChartTheme Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation

Free Java Reporting Library

There is a newer version: 6.21.3

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2022 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.charts;

import net.sf.jasperreports.engine.JRException;

import org.jfree.chart.JFreeChart;

/**
 * Chart themes give more control over chart output, including 
 * the creation of the JFreeChart object itself. Also, chart themes 
 * affect a whole range of chart types across multiple reports and are not necessarily tied to 
 * a specific chart element within a report. They can even apply globally to all charts within 
 * a given JasperReports deployment, applying a new look and feel to all charts created.
 * 

 * A chart theme can be set globally using a configuration property within the 
 * jasperreports.properties file as follows: 
 * 


 * net.sf.jasperreports.chart.theme=<theme_name> 
 * 


 * The global chart theme can be overridden at report level using the following report 
 * property in the report template: 
 * 


 * <property name="net.sf.jasperreports.chart.theme" value="<theme_name>"/> 
 * 


 * If needed, at chart element level, the chart theme is specified using the theme attribute. 
 * 
 * @author Teodor Danciu ([email protected]) 
 */
public interface ChartTheme
{

	/**
	 * @return an org.jfree.chart.JFreeChart object representing the chart 
	 */
	public JFreeChart createChart(ChartContext chartContext) throws JRException;

}