adams.core.io.PDFBox.java Source code

Introduction

Here is the source code for adams.core.io.PDFBox.java

Source

/*
 *   This program 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 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * PDFBox.java
 * Copyright (C) 2015-2016 University of Waikato, Hamilton, NZ
 */

package adams.core.io;

import adams.core.logging.Logger;
import adams.core.logging.LoggingHelper;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.printing.PDFPageable;

import java.awt.print.PrinterJob;
import java.io.File;
import java.util.logging.Level;

/**
 * Helper class for PDFBox library.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision$
 */
public class PDFBox {

    /** the logger in use. */
    private static Logger LOGGER = LoggingHelper.getLogger(PDFBox.class);

    /**
     * Loads the PDF file.
     *
     * @param filename   the filename of the PDF
     * @return      the PDF document, null if failed to load
     */
    public static PDDocument load(String filename) {
        return load(new PlaceholderFile(filename));
    }

    /**
     * Loads the PDF file.
     *
     * @param file   the PDF file
     * @return      the PDF document, null if failed to load
     */
    public static PDDocument load(File file) {
        try {
            return PDDocument.load(file.getAbsoluteFile());
        } catch (Exception e) {
            LOGGER.log(Level.SEVERE, "Failed to load PDF: " + file, e);
            return null;
        }
    }

    /**
     * Closes the document again.
     *
     * @param document   the document to close, can be null
     */
    public static void close(PDDocument document) {
        if (document != null) {
            try {
                document.close();
            } catch (Exception e) {
                // ignored
            }
        }
    }

    /**
     * Saves the PDF document under the specified filename.
     *
     * @param doc      the document to save
     * @param file   the file to save the document to
     * @return      true if successfully saved
     */
    public static boolean save(PDDocument doc, String file) {
        return save(doc, new PlaceholderFile(file));
    }

    /**
     * Saves the PDF document under the specified filename.
     *
     * @param doc      the document to save
     * @param file   the file to save the document to
     * @return      true if successfully saved
     */
    public static boolean save(PDDocument doc, File file) {
        boolean result;

        try {
            doc.save(file.getAbsoluteFile());
            result = true;
        } catch (Exception e) {
            LOGGER.log(Level.SEVERE, "Failed to save PDF document to file '" + file + "':", e);
            result = false;
        }

        return result;
    }

    /**
     * Prints the PDF document.
     *
     * @param filename   the filename of the PDF to print
     * @return      true if successfully printed
     */
    public static boolean print(String filename) {
        return print(new PlaceholderFile(filename));
    }

    /**
     * Prints the PDF document.
     *
     * @param file   the PDF file print
     * @return      true if successfully printed
     */
    public static boolean print(File file) {
        boolean result;
        PDDocument document;

        result = false;
        document = load(file);
        if (document != null) {
            result = print(document);
            close(document);
        }

        return result;
    }

    /**
     * Prints the PDF document.
     *
     * @param document   the PDF document to print
     * @return      true if successfully printed
     */
    public static boolean print(PDDocument document) {
        try {
            PrinterJob job = PrinterJob.getPrinterJob();
            job.setPageable(new PDFPageable(document));
            job.print();
            return true;
        } catch (Exception e) {
            LOGGER.log(Level.SEVERE, "Failed to print PDF document!", e);
            return false;
        }
    }

    /**
     * Prints the PDF document, bringing up a dialog.
     *
     * @param file   the PDF file print
     * @return      true if successfully printed
     */
    public static boolean printWithDialog(File file) {
        boolean result;
        PDDocument document;

        result = false;
        document = load(file);
        if (document != null) {
            result = printWithDialog(document);
            close(document);
        }

        return result;
    }

    /**
     * Prints the PDF document, bringing up a dialog.
     *
     * @param document   the PDF document to print
     * @return      true if successfully printed
     */
    public static boolean printWithDialog(PDDocument document) {
        try {
            PrinterJob job = PrinterJob.getPrinterJob();
            job.setPageable(new PDFPageable(document));
            if (job.printDialog()) {
                job.print();
                return true;
            } else {
                return false;
            }
        } catch (Exception e) {
            LOGGER.log(Level.SEVERE, "Failed to print PDF document!", e);
            return false;
        }
    }
}