net.sf.jasperreports.engine.export.JRExporterContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 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.export;
import java.util.Map;
import net.sf.jasperreports.engine.JRAbstractExporter;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.export.Exporter;
import net.sf.jasperreports.repo.RepositoryUtil;
/**
* A context that represents information about an export process.
*
* @author Lucian Chirita ([email protected])
*/
public interface JRExporterContext
{
/**
* @deprecated Replaced by {@link #getExporterRef()}.
*/
net.sf.jasperreports.engine.JRExporter getExporter();
/**
* Returns the current exporter.
*
* @return current exporter
*/
Exporter getExporterRef();
/**
*
*/
public JasperReportsContext getJasperReportsContext();
default public RepositoryUtil getRepository()
{
return RepositoryUtil.getInstance(getJasperReportsContext());
}
/**
* Returns the report which is currently exported.
*
* @return currently exported report
*/
JasperPrint getExportedReport();
/**
* @deprecated Replaced by {@link JRAbstractExporter#getExporterPropertiesPrefix()}.
*/
String getExportPropertiesPrefix();
/**
* Returns the map of export parameters.
*
*
* The map uses {@link net.sf.jasperreports.engine.JRExporterParameter} instances as keys.
*
* @return the map of export parameters
* @deprecated To be removed.
*/
Map getExportParameters();
/**
* Returns the current X-axis offset at which elements should be exported.
*
* @return the current X-axis offset
*/
int getOffsetX();
/**
* Returns the current Y-axis offset at which elements should be exported.
*
* @return the current Y-axis offset
*/
int getOffsetY();
/**
*
*/
public Object getValue(String key);
/**
*
*/
public void setValue(String key, Object value);
/**
*
*/
public Map getValues();
}