net.sf.jasperreports.engine.export.ooxml.GenericElementXlsxHandler Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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.ooxml;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRGenericPrintElement;
import net.sf.jasperreports.engine.JRPrintImage;
import net.sf.jasperreports.engine.export.GenericElementHandler;
import net.sf.jasperreports.engine.export.JRExporterGridCell;
/**
* A generic print element XLSX export handler.
*
* @author Teodor Danciu ([email protected])
*/
public interface GenericElementXlsxHandler extends GenericElementHandler
{
/**
* Exports a generic element.
*
*
* Access to the exporter output and environment is provided via the
* {@link JRXlsxExporterContext} argument.
*
* @param exporterContext the exporter context
* @param element the generic element to export
*/
void exportElement(
JRXlsxExporterContext exporterContext,
JRGenericPrintElement element,
JRExporterGridCell gridCell,
int colIndex,
int rowIndex
) throws JRException;
/**
* Creates an equivalent image of the {@link JRGenericPrintElement} element to be exported instead.
*
* @param element the generic element to export
* @return JRPrintImage the equivalent image
*/
JRPrintImage getImage(JRXlsxExporterContext exporterContext, JRGenericPrintElement element) throws JRException;
}