ptolemy.vergil.basic.export.itextpdf.ExportPDFAction.java Source code

Java tutorial

Introduction

Here is the source code for ptolemy.vergil.basic.export.itextpdf.ExportPDFAction.java

Source

/* Implement the Export PDF menu choice using iText.
    
 Copyright (c) 2010-2014 The Regents of the University of California.
 All rights reserved.
 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.
    
 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
    
 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.
    
 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY 2
 */

package ptolemy.vergil.basic.export.itextpdf;

import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.awt.print.PageFormat;
import java.awt.print.Paper;
import java.awt.print.Printable;
import java.io.File;
import java.io.FileOutputStream;
import java.util.LinkedList;

import javax.swing.AbstractAction;
import javax.swing.JFileChooser;

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 diva.gui.GUIUtilities;
import ptolemy.gui.ExtensionFilenameFilter;
import ptolemy.gui.JFileChooserBugFix;
import ptolemy.gui.PtFileChooser;
import ptolemy.gui.PtGUIUtilities;
import ptolemy.gui.Top;
import ptolemy.util.MessageHandler;
import ptolemy.vergil.basic.BasicGraphFrame;

///////////////////////////////////////////////////////////////////
//// ExportPDFAction

/**
 An Action to Export PDF using iText PDF.
    
 <p>This implementation uses <a href="http://itextpdf.com/#in_browser">iText PDF</a>,
 which is under the
 <a href="http://itextpdf.com/terms-of-use/index.php">Affero General Public License (AGPL)</a>.
 Thus, use of this package is optional.  To add the "Export PDF" menu
 choice to the GraphEditor, add the following to the configuration
 <pre>
  &lt;property name="_exportPDFClassName"
        class="ptolemy.data.expr.StringParameter"
        value="ptolemy.vergil.basic.export.itextpdf.ExportPDFAction"/&gt;
 </pre>
 {@link ptolemy.vergil.basic.BasicGraphFrame} checks for this parameter
 and adds the "Export PDF" menu choice if the class named by that parameter exists.
    
 <p>The <code>$PTII/ptolemy/configs/defaultFullConfiguration.xml</code> file
 already has this parameter.  The ptiny configuration does <b>not</b> have
 this parameter so that we have a smaller download and have a non-GPL executable.
    
    
 @author  Edward A. Lee, Christopher Brooks
 @version $Id: ExportPDFAction.java 72972 2015-08-05 23:34:57Z cxh $
 @since Ptolemy II 10.0
 @Pt.ProposedRating Red (cxh)
 @Pt.AcceptedRating Red (cxh)
 */
@SuppressWarnings("serial")
public class ExportPDFAction extends AbstractAction {
    /** Create a new action to export PDF.
     *  @param frame The Frame which to which this action is added.
     */
    public ExportPDFAction(Top frame) {
        super("Export PDF");
        _frame = frame;
        putValue("tooltip", "Export PDF to a file.");
        putValue(GUIUtilities.MNEMONIC_KEY, Integer.valueOf(KeyEvent.VK_X));
    }

    ///////////////////////////////////////////////////////////////////
    ////                         ppublic methods                   ////

    /** Export PDF. */
    @Override
    public void actionPerformed(ActionEvent e) {
        if (!(_frame instanceof Printable)) {
            MessageHandler.error("Export PDF not supported.");
        }
        _exportPDF();
    }

    ///////////////////////////////////////////////////////////////////
    ////                         protected methods                 ////

    /** Export PDF to a file.
     *  This uses the iText library at http://itextpdf.com/.
     *
     *  <p>If {@link ptolemy.gui.PtGUIUtilities#useFileDialog()} returns true
     *  then a java.awt.FileDialog is used, otherwise a javax.swing.JFileChooser
     *  is used.</p>
     */
    private void _exportPDF() {
        Dimension size = _frame.getContentSize();
        Rectangle pageSize = null;
        try {
            pageSize = new Rectangle(size.width, size.height);
        } catch (Throwable ex) {
            // This exception will occur if the iText library is not installed.
            MessageHandler.error("iText library is not installed. See http://itextpdf.com/."
                    + "  You must have iText.jar in your classpath.  Sometimes, "
                    + "iText.jar may be found in $PTII/vendors/itext/iText.jar.", ex);
            return;
        }
        Document document = new Document(pageSize);
        JFileChooserBugFix jFileChooserBugFix = new JFileChooserBugFix();
        Color background = null;
        PtFileChooser ptFileChooser = null;
        try {
            background = jFileChooserBugFix.saveBackground();

            ptFileChooser = new PtFileChooser(_frame, "Specify a pdf file to be written.",
                    JFileChooser.SAVE_DIALOG);

            LinkedList extensions = new LinkedList();
            extensions.add("pdf");
            ptFileChooser.addChoosableFileFilter(new ExtensionFilenameFilter(extensions));

            BasicGraphFrame basicGraphFrame = null;
            if (_frame instanceof BasicGraphFrame) {
                basicGraphFrame = (BasicGraphFrame) _frame;
                ptFileChooser.setCurrentDirectory(basicGraphFrame.getLastDirectory());
                ptFileChooser.setSelectedFile(new File(basicGraphFrame.getModel().getName() + ".pdf"));
            }
            int returnVal = ptFileChooser.showDialog(_frame, "Export PDF");

            if (returnVal == JFileChooser.APPROVE_OPTION) {
                if (basicGraphFrame != null) {
                    basicGraphFrame.setLastDirectory(ptFileChooser.getCurrentDirectory());
                }
                File pdfFile = ptFileChooser.getSelectedFile().getCanonicalFile();

                if (pdfFile.getName().indexOf(".") == -1) {
                    // If the user has not given the file an extension, add it
                    pdfFile = new File(pdfFile.getAbsolutePath() + ".pdf");
                }

                // The Mac OS X FileDialog will ask if we want to save before this point.
                if (pdfFile.exists() && !PtGUIUtilities.useFileDialog()) {
                    if (!MessageHandler.yesNoQuestion("Overwrite " + pdfFile.getName() + "?")) {
                        return;
                    }
                }

                PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(pdfFile));
                // To ensure Latex compatibility, use earlier PDF version.
                writer.setPdfVersion(PdfWriter.VERSION_1_3);
                document.open();
                PdfContentByte contentByte = writer.getDirectContent();

                PdfTemplate template = contentByte.createTemplate(size.width, size.height);
                Graphics2D graphics = template.createGraphics(size.width, size.height);
                template.setWidth(size.width);
                template.setHeight(size.height);

                Paper paper = new Paper();
                paper.setSize(size.width, size.height);
                paper.setImageableArea(0.0, 0.0, size.width, size.height);
                PageFormat format = new PageFormat();
                format.setPaper(paper);
                ((Printable) _frame).print(graphics, format, 0);
                graphics.dispose();
                contentByte.addTemplate(template, 0, 0);

                // Open the PDF file.
                // FIXME: _read is protected in BasicGraphFrame
                //_read(pdfFile.toURI().toURL());
                // Open the image pdfFile.
                if (basicGraphFrame == null) {
                    MessageHandler.message("PDF file exported to " + pdfFile.getName());
                    /* Remove the following. The extra click is annoying...
                    } else {
                    if (MessageHandler.yesNoQuestion("Open \""
                            + pdfFile.getCanonicalPath() + "\" in a browser?")) {
                        Configuration configuration = basicGraphFrame
                                .getConfiguration();
                        try {
                            URL imageURL = new URL(pdfFile.toURI().toURL()
                                    .toString()
                                    + "#in_browser");
                            configuration.openModel(imageURL, imageURL,
                                    imageURL.toExternalForm(),
                                    BrowserEffigy.staticFactory);
                        } catch (Throwable throwable) {
                            MessageHandler.error(
                                    "Failed to open \"" + pdfFile.getName()
                                            + "\".", throwable);
                        }
                    }
                     */
                }
            }
        } catch (Exception e) {
            MessageHandler.error("Export to PDF failed", e);
        } finally {
            try {
                document.close();
            } finally {
                jFileChooserBugFix.restoreBackground(background);
            }
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                    private variables

    /** The top-level window of the contents to be exported. */
    Top _frame;
}