• Home
• net.sourceforge.dynamicreports
• dynamicreports-core
• 5.0.0
• source code
• JasperTocReport.java

×

Project download

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.dynamicreports.jasper.base.tableofcontents.JasperTocReport Maven / Gradle / Ivy

/**
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2016 Ricardo Mariaca
 * http://www.dynamicreports.org
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports 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.
 *
 * DynamicReports 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 DynamicReports. If not, see .
 */

package net.sf.dynamicreports.jasper.base.tableofcontents;

import static net.sf.dynamicreports.report.builder.DynamicReports.*;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

import net.sf.dynamicreports.jasper.base.JasperCustomValues;
import net.sf.dynamicreports.jasper.base.JasperReportDesign;
import net.sf.dynamicreports.jasper.builder.JasperReportBuilder;
import net.sf.dynamicreports.jasper.exception.JasperDesignException;
import net.sf.dynamicreports.jasper.transformation.ConstantTransform;
import net.sf.dynamicreports.report.base.DRPage;
import net.sf.dynamicreports.report.builder.MarginBuilder;
import net.sf.dynamicreports.report.constant.TableOfContentsPosition;
import net.sf.dynamicreports.report.defaults.Defaults;
import net.sf.dynamicreports.report.definition.DRITableOfContentsCustomizer;
import net.sf.dynamicreports.report.exception.DRException;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRParameter;
import net.sf.jasperreports.engine.JRPrintElement;
import net.sf.jasperreports.engine.JRPrintFrame;
import net.sf.jasperreports.engine.JRPrintPage;
import net.sf.jasperreports.engine.JRPrintText;
import net.sf.jasperreports.engine.JRStyle;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

import org.apache.commons.lang3.StringUtils;

/**
 * @author Ricardo Mariaca ([email protected])
 */
public class JasperTocReport {

	public static void createTocReport(JasperReportDesign jasperReportDesign, JasperPrint jasperPrint, Map parameters) throws DRException, JRException {
		JasperCustomValues customValues = jasperReportDesign.getCustomValues();
		Map headings = customValues.getTocHeadings();
		if (headings != null && !headings.isEmpty()) {
			JasperReportBuilder tocReport = report();

			List headingList = new ArrayList();
			int pageNumber = 1;
			for (JRPrintPage page : jasperPrint.getPages()) {
				for (JRPrintElement element : page.getElements()) {
					addTocHeading(headings, headingList, element, pageNumber);
				}
				pageNumber++;
			}

			int levels = 0;
			for (JasperTocHeading heading : headingList) {
				if (heading.getLevel() > levels) {
					levels = heading.getLevel();
				}
			}
			levels++;

			DRPage tocPage = tocReport.getReport().getPage();
			tocPage.setWidth(jasperReportDesign.getDesign().getPageWidth());
			tocPage.setHeight(jasperReportDesign.getDesign().getPageHeight());
			tocPage.setOrientation(ConstantTransform.pageOrientation(jasperReportDesign.getDesign().getOrientationValue()));
			MarginBuilder tocMargin = margin();
			tocMargin.setTop(jasperReportDesign.getDesign().getTopMargin());
			tocMargin.setLeft(jasperReportDesign.getDesign().getLeftMargin());
			tocMargin.setBottom(jasperReportDesign.getDesign().getBottomMargin());
			tocMargin.setRight(jasperReportDesign.getDesign().getRightMargin());
			tocReport.setLocale((Locale) parameters.get(JRParameter.REPORT_LOCALE));
			tocReport.setResourceBundle((ResourceBundle) parameters.get(JRParameter.REPORT_RESOURCE_BUNDLE));
			tocReport.setPageMargin(tocMargin);
			tocReport.setDataSource(new JRBeanCollectionDataSource(headingList));

			DRITableOfContentsCustomizer tableOfContents = jasperReportDesign.getTableOfContentsCustomizer();
			tableOfContents.setReport(tocReport);
			tableOfContents.setHeadingList(headingList);
			tableOfContents.setHeadings(headings.size());
			tableOfContents.setLevels(levels);
			tableOfContents.customize();

			TableOfContentsPosition tableOfContentsPosition = tableOfContents.getPosition();
			if (tableOfContentsPosition == null) {
				tableOfContentsPosition = Defaults.getDefaults().getTableOfContentsPosition();
			}
			JasperPrint tocJasperPrint = tocReport.toJasperPrint();
			for (int i = 0; i < tocJasperPrint.getPages().size(); i++) {
				JRPrintPage page = tocJasperPrint.getPages().get(i);
				switch (tableOfContentsPosition) {
				case TOP:
					jasperPrint.addPage(i, page);
					break;
				case BOTTOM:
					jasperPrint.addPage(page);
					break;
				default:
					throw new JasperDesignException("Table of contents position " + tableOfContentsPosition.name() + " not supported");
				}
			}
			for (JRStyle style : tocJasperPrint.getStyles()) {
				jasperPrint.addStyle(style);
			}
		}
	}

	private static void addTocHeading(Map headings, List headingList, JRPrintElement element, int pageNumber) {
		if (element instanceof JRPrintText && StringUtils.contains(element.getKey(), ".tocReference")) {
			String id = ((JRPrintText) element).getAnchorName();
			JasperTocHeading heading = headings.get(id);
			heading.setPageIndex(pageNumber);
			headingList.add(heading);
		}
		if (element instanceof JRPrintFrame) {
			for (JRPrintElement element2 : ((JRPrintFrame) element).getElements()) {
				addTocHeading(headings, headingList, element2, pageNumber);
			}
		}
	}

}