net.sf.mzmine.chartbasics.graphicsexport.ChartExportUtil.java Source code

Java tutorial

Introduction

Here is the source code for net.sf.mzmine.chartbasics.graphicsexport.ChartExportUtil.java

Source

/*
 * Copyright 2006-2015 The MZmine 2 Development Team
 * 
 * This file is part of MZmine 2.
 * 
 * MZmine 2 is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * 
 * MZmine 2 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
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with MZmine 2; if not,
 * write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 * USA
 */

package net.sf.mzmine.chartbasics.graphicsexport;

import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.geom.AffineTransform;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import javax.swing.JMenuItem;
import org.apache.batik.anim.dom.SVGDOMImplementation;
import org.apache.batik.svggen.SVGGraphics2D;
import org.apache.batik.svggen.SVGGraphics2DIOException;
import org.freehep.graphics2d.VectorGraphics;
import org.freehep.graphicsio.emf.EMFGraphics2D;
import org.jfree.chart.ChartPanel;
import org.jfree.chart.ChartUtils;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.encoders.EncoderUtil;
import org.jfree.chart.encoders.ImageFormat;
import org.jfree.chart.title.PaintScaleLegend;
import org.jfree.chart.util.Args;
import org.w3c.dom.DOMImplementation;
import com.itextpdf.awt.DefaultFontMapper;
import com.itextpdf.text.Document;
import com.itextpdf.text.Rectangle;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfTemplate;
import com.itextpdf.text.pdf.PdfWriter;
import net.sf.epsgraphics.ColorMode;
import net.sf.epsgraphics.EpsGraphics;
import net.sf.mzmine.chartbasics.ChartLogics;
import net.sf.mzmine.chartbasics.graphicsexport.GraphicsExportParameters.FixedSize;
import net.sf.mzmine.util.files.FileAndPathUtil;

/**
 * Graphics export of JFreeCharts to different vector and pixel graphics formats.
 * 
 * @author Robin Schmid (robinschmid@uni-muenster.de)
 */
public class ChartExportUtil {
    // ######################################################################################
    // VECTORS: PDF uses ITextpdf lib

    /**
     * Add export dialog to popup menu of a chartpanel
     * 
     * @param plotChartPanel
     */
    public static void addExportDialogToMenu(final ChartPanel cp) {
        JMenuItem exportGraphics = new JMenuItem("Export graphics...");
        exportGraphics.addActionListener(e -> GraphicsExportDialog.openDialog(cp.getChart()));
        // add to menu
        cp.getPopupMenu().add(exportGraphics);
    }

    /**
     * takes Only Width in account
     * 
     * @param chart
     * @param sett
     * @throws Exception
     */
    public static void writeChartToImage(ChartPanel chart, GraphicsExportParameters sett) throws Exception {
        boolean repaint = false;
        FixedSize fixed = sett.getFixedSize();

        double oldW = sett.getWidthPixel();
        double oldH = sett.getHeightPixel();

        // Size only by width?
        if (sett.isUseOnlyWidth()) {
            // fixed size for chart or plot
            if (fixed.equals(FixedSize.Chart)) {
                sett.setHeightPixel(ChartLogics.calcHeightToWidth(chart, oldW, false));
            } else {
                // fixed plot width
                sett.setPixelSize(ChartLogics.calcSizeForPlotWidth(chart, oldW));
            }
        } else if (fixed.equals(FixedSize.Plot)) {
            // fixed plot size - width and height are given
            sett.setPixelSize(ChartLogics.calcSizeForPlotSize(chart, oldW, oldH));
        }

        Dimension size = sett.getPixelSize();
        // resize
        chart.setPreferredSize(size);
        chart.setMaximumSize(size);
        chart.setMinimumSize(size);
        // repaint
        if (repaint) {
            chart.revalidate();
            chart.repaint();
        }
        writeChartToImage(chart.getChart(), sett);
        // reset size
        sett.setPixelSize(oldW, oldH);
    }

    /**
     * This method is used to save all image formats. it uses the specific methods for each file
     * format
     * 
     * @param chart
     * @param sett
     */
    private static void writeChartToImage(JFreeChart chart, GraphicsExportParameters sett) throws Exception {
        // Background color
        Paint saved = chart.getBackgroundPaint();
        chart.setBackgroundPaint(sett.getColorWithAlpha());
        chart.setBackgroundImageAlpha((float) sett.getTransparency());
        if (chart.getLegend() != null)
            chart.getLegend().setBackgroundPaint(sett.getColorWithAlpha());
        // legends and stuff
        for (int i = 0; i < chart.getSubtitleCount(); i++)
            if (PaintScaleLegend.class.isAssignableFrom(chart.getSubtitle(i).getClass()))
                ((PaintScaleLegend) chart.getSubtitle(i)).setBackgroundPaint(sett.getColorWithAlpha());

        // apply bg
        chart.getPlot().setBackgroundPaint(sett.getColorWithAlpha());

        // create folder
        File f = sett.getFullpath();
        if (!f.exists()) {
            if (f.getParentFile() != null)
                f.getParentFile().mkdirs();
            // f.createNewFile();
        }

        Dimension size = sett.getPixelSize();
        // Format
        switch (sett.getFormat()) {
        case "PDF":
            writeChartToPDF(chart, size.width, size.height, f);
            break;
        case "PNG":
            writeChartToPNG(chart, size.width, size.height, f, (int) sett.getDPI());
            break;
        case "JPG":
            writeChartToJPEG(chart, size.width, size.height, f, (int) sett.getDPI());
            break;
        case "EPS":
            writeChartToEPS(chart, size.width, size.height, f);
            break;
        case "SVG":
            writeChartToSVG(chart, size.width, size.height, f);
            break;
        case "EMF":
            writeChartToEMF(chart, size.width, size.height, f);
            break;
        }
        //
        chart.setBackgroundPaint(saved);
        chart.setBackgroundImageAlpha(255);
        if (chart.getLegend() != null)
            chart.getLegend().setBackgroundPaint(saved);
        // legends and stuff
        for (int i = 0; i < chart.getSubtitleCount(); i++)
            if (PaintScaleLegend.class.isAssignableFrom(chart.getSubtitle(i).getClass()))
                ((PaintScaleLegend) chart.getSubtitle(i)).setBackgroundPaint(saved);

        // apply bg
        chart.getPlot().setBackgroundPaint(saved);
    }

    /**
     * This method saves a chart as a PDF with given dimensions
     * 
     * @param chart
     * @param width
     * @param height
     * @param fileName is a full path
     */
    public static void writeChartToPDF(JFreeChart chart, int width, int height, File fileName) throws Exception {
        PdfWriter writer = null;

        Document document = new Document(new Rectangle(width, height));

        try {
            writer = PdfWriter.getInstance(document, new FileOutputStream(fileName));
            document.open();
            PdfContentByte contentByte = writer.getDirectContent();
            PdfTemplate template = contentByte.createTemplate(width, height);
            Graphics2D graphics2d = template.createGraphics(width, height, new DefaultFontMapper());
            Rectangle2D rectangle2d = new Rectangle2D.Double(0, 0, width, height);

            chart.draw(graphics2d, rectangle2d);

            graphics2d.dispose();
            contentByte.addTemplate(template, 0, 0);

        } catch (Exception e) {
            e.printStackTrace();
            throw e;
        } finally {
            document.close();
        }
    }

    public static void writeChartToPDF(JFreeChart chart, int width, int height, File path, String fileName)
            throws Exception {
        writeChartToPDF(chart, width, height, FileAndPathUtil.getRealFilePath(path, fileName, ".pdf"));
    }

    // ######################################################################################
    // PIXELS: JPG PNG
    public static void writeChartToPNG(JFreeChart chart, int width, int height, File fileName) throws IOException {
        ChartUtils.saveChartAsPNG(fileName, chart, width, height);
    }

    public static void writeChartToPNG(JFreeChart chart, int width, int height, File fileName, int resolution)
            throws IOException {
        if (resolution == 72)
            writeChartToPNG(chart, width, height, fileName);
        else {
            OutputStream out = new BufferedOutputStream(new FileOutputStream(fileName));
            try {
                BufferedImage image = paintScaledChartToBufferedImage(chart, out, width, height, resolution,
                        BufferedImage.TYPE_INT_ARGB);
                out.write(ChartUtils.encodeAsPNG(image));
            } finally {
                out.close();
            }
        }
    }

    public static void writeChartToJPEG(JFreeChart chart, int width, int height, File fileName) throws IOException {
        ChartUtils.saveChartAsJPEG(fileName, chart, width, height);
    }

    public static void writeChartToJPEG(JFreeChart chart, int width, int height, File fileName, int resolution)
            throws IOException {
        // Background color
        Paint saved = chart.getBackgroundPaint();
        if (((Color) saved).getAlpha() == 0) {
            chart.setBackgroundPaint(Color.WHITE);
            chart.setBackgroundImageAlpha(255);
            if (chart.getLegend() != null)
                chart.getLegend().setBackgroundPaint(Color.WHITE);
            // legends and stuff
            for (int i = 0; i < chart.getSubtitleCount(); i++)
                if (PaintScaleLegend.class.isAssignableFrom(chart.getSubtitle(i).getClass()))
                    ((PaintScaleLegend) chart.getSubtitle(i)).setBackgroundPaint(Color.WHITE);

            // apply bg
            chart.getPlot().setBackgroundPaint(Color.WHITE);
        }
        //
        if (resolution == 72)
            writeChartToJPEG(chart, width, height, fileName);
        else {
            OutputStream out = new BufferedOutputStream(new FileOutputStream(fileName));
            try {
                BufferedImage image = paintScaledChartToBufferedImage(chart, out, width, height, resolution,
                        BufferedImage.TYPE_INT_RGB);
                EncoderUtil.writeBufferedImage(image, ImageFormat.JPEG, out, 1.f);
            } finally {
                out.close();
            }
        }
    }

    /**
     * Paints a chart with scaling options
     * 
     * @param chart
     * @param out
     * @param width
     * @param height
     * @param resolution
     * @return BufferedImage of a given chart with scaling to resolution
     * @throws IOException
     */
    private static BufferedImage paintScaledChartToBufferedImage(JFreeChart chart, OutputStream out, int width,
            int height, int resolution, int bufferedIType) throws IOException {
        Args.nullNotPermitted(out, "out");
        Args.nullNotPermitted(chart, "chart");

        double scaleX = resolution / 72.0;
        double scaleY = resolution / 72.0;

        double desiredWidth = width * scaleX;
        double desiredHeight = height * scaleY;
        double defaultWidth = width;
        double defaultHeight = height;
        boolean scale = false;

        // get desired width and height from somewhere then...
        if ((scaleX != 1) || (scaleY != 1)) {
            scale = true;
        }

        BufferedImage image = new BufferedImage((int) desiredWidth, (int) desiredHeight, bufferedIType);
        Graphics2D g2 = image.createGraphics();

        if (scale) {
            AffineTransform saved = g2.getTransform();
            g2.transform(AffineTransform.getScaleInstance(scaleX, scaleY));
            chart.draw(g2, new Rectangle2D.Double(0, 0, defaultWidth, defaultHeight), null, null);
            g2.setTransform(saved);
            g2.dispose();
        } else {
            chart.draw(g2, new Rectangle2D.Double(0, 0, defaultWidth, defaultHeight), null, null);
        }
        return image;
    }

    // ######################################################################################
    // VECTORS: EPS uses EpsGraphics2D
    // SVG uses BATIK lib
    public static void writeChartToSVG(JFreeChart chart, int width, int height, File name) throws Exception {
        // Get a DOMImplementation
        DOMImplementation domImpl = SVGDOMImplementation.getDOMImplementation();
        org.w3c.dom.Document document = domImpl.createDocument(null, "svg", null);
        SVGGraphics2D svgGenerator = new SVGGraphics2D(document);
        svgGenerator.setSVGCanvasSize(new Dimension(width, height));
        chart.draw(svgGenerator, new Rectangle2D.Double(0, 0, width, height));

        boolean useCSS = true; // we want to use CSS style attribute

        Writer out = null;
        try {
            out = new OutputStreamWriter(new FileOutputStream(name), "UTF-8");
            svgGenerator.stream(out, useCSS);
        } catch (UnsupportedEncodingException | FileNotFoundException e) {
            e.printStackTrace();
            throw e;
        } catch (SVGGraphics2DIOException e) {
            e.printStackTrace();
            throw e;
        } finally {
            try {
                out.close();
            } catch (Exception e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
                throw e;
            }
        }
    }

    public static void writeChartToEPS(JFreeChart chart, int width, int height, File name) throws IOException {
        EpsGraphics g;
        try {
            g = new EpsGraphics("EpsTools Drawable Export", new FileOutputStream(name), 0, 0, width, height,
                    ColorMode.COLOR_RGB);
            Rectangle2D rectangle2d = new Rectangle2D.Double(0, 0, width, height);
            chart.draw((Graphics2D) g, rectangle2d);
            g.close();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            throw e;
        }
    }

    public static void writeChartToEMF(JFreeChart chart, int width, int height, File name) throws IOException {
        try {
            VectorGraphics g = new EMFGraphics2D(name, new Dimension(width, height));
            g.startExport();
            Rectangle2D rectangle2d = new Rectangle2D.Double(0, 0, width, height);
            chart.draw((Graphics2D) g, rectangle2d);
            g.endExport();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            throw e;
        }
    }

}