src/jalview/gui/ImageExporter.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import java.awt.Component;
  24 import java.awt.Graphics;
  25 import java.io.File;
  26 import java.util.concurrent.Callable;
  27 import java.util.concurrent.atomic.AtomicBoolean;
  28
  29 import jalview.bin.Cache;
  30 import jalview.bin.Jalview;
  31 import jalview.io.JalviewFileChooser;
  32 import jalview.io.JalviewFileView;
  33 import jalview.util.ImageMaker;
  34 import jalview.util.ImageMaker.TYPE;
  35 import jalview.util.MessageManager;
  36 import jalview.util.Platform;
  37
  38 /**
  39  * A class that marshals steps in exporting a view in image graphics format
  40  * <ul>
  41  * <li>prompts the user for the output file, if not already specified</li>
  42  * <li>prompts the user for Text or Lineart character rendering, if
  43  * necessary</li>
  44  * <li>instantiates an ImageMaker to create the appropriate Graphics output
  45  * context for the image format</li>
  46  * <li>invokes a callback to do the work of writing to the graphics</li>
  47  * </ul>
  48  *
  49  * @author gmcarstairs
  50  *
  51  */
  52 public class ImageExporter
  53 {
  54   // todo move interface to jalview.api? or replace with lambda?
  55   /**
  56    * An interface for the callback that can be run to write the image on to the
  57    * graphics object. The callback should throw any exceptions arising so they
  58    * can be reported by this class.
  59    */
  60   public interface ImageWriterI
  61   {
  62     void exportImage(Graphics g) throws Exception;
  63   }
  64
  65   private IProgressIndicator messageBoard;
  66
  67   private ImageWriterI imageWriter;
  68
  69   TYPE imageType;
  70
  71   private String title;
  72
  73   /**
  74    * Constructor given a callback handler to write graphics data, an (optional)
  75    * target for status messages, image type and (optional) title for output file
  76    *
  77    * @param writer
  78    * @param statusBar
  79    * @param type
  80    * @param fileTitle
  81    */
  82   public ImageExporter(ImageWriterI writer, IProgressIndicator statusBar,
  83           TYPE type, String fileTitle)
  84   {
  85     this.imageWriter = writer;
  86     this.messageBoard = statusBar;
  87     this.imageType = type;
  88     this.title = fileTitle;
  89   }
  90
  91   /**
  92    * Prompts the user for output file and Text/Lineart options as required,
  93    * configures a Graphics context for output, and makes a callback to the
  94    * client code to perform the image output
  95    *
  96    * @param file
  97    *          output file (if null, user is prompted to choose)
  98    * @param parent
  99    *          parent component for any dialogs shown
 100    * @param width
 101    * @param height
 102    * @param imageSource
 103    *          what the image is of e.g. Tree, Alignment
 104    */
 105   public void doExport(File file, Component parent, int width, int height,
 106           String imageSource)
 107   {
 108     doExport(file, parent, width, height, imageSource, null);
 109   }
 110
 111   public void doExport(File file, Component parent, int width, int height,
 112           String imageSource, String renderer)
 113   {
 114     final long messageId = System.currentTimeMillis();
 115     setStatus(
 116             MessageManager.formatMessage(
 117                     "status.exporting_alignment_as_x_file", imageType),
 118             messageId);
 119
 120     /*
 121      * prompt user for output file if not provided
 122      */
 123     if (file == null && !Jalview.isHeadlessMode())
 124     {
 125       JalviewFileChooser chooser = imageType.getFileChooser();
 126       chooser.setFileView(new JalviewFileView());
 127       MessageManager.formatMessage("label.create_image_of",
 128               imageType.getName(), imageSource);
 129       String title = "Create " + imageType.getName()
 130               + " image from alignment";
 131       chooser.setDialogTitle(title);
 132       chooser.setToolTipText(MessageManager.getString("action.save"));
 133       int value = chooser.showSaveDialog(parent);
 134       if (value != JalviewFileChooser.APPROVE_OPTION)
 135       {
 136         String msg = MessageManager.formatMessage(
 137                 "status.cancelled_image_export_operation", imageType.name);
 138         setStatus(msg, messageId);
 139         return;
 140       }
 141       Cache.setProperty("LAST_DIRECTORY",
 142               chooser.getSelectedFile().getParent());
 143       file = chooser.getSelectedFile();
 144     }
 145
 146     /*
 147      * Prompt for Text or Lineart (EPS/SVG) unless a preference is already set
 148      * for this as EPS_RENDERING / SVG_RENDERING
 149      * Always set to Text for JalviewJS as Lineart (glyph fonts) not available
 150      */
 151     String renderStyle = renderer == null
 152             ? Cache.getDefault(imageType.getName() + "_RENDERING",
 153                     LineartOptions.PROMPT_EACH_TIME)
 154             : renderer;
 155     if (Platform.isJS())
 156     {
 157       renderStyle = "Text";
 158     }
 159     AtomicBoolean textSelected = new AtomicBoolean(
 160             !"Lineart".equals(renderStyle));
 161     if ((imageType == TYPE.EPS || imageType == TYPE.SVG)
 162             && LineartOptions.PROMPT_EACH_TIME.equals(renderStyle)
 163             && !Jalview.isHeadlessMode())
 164     {
 165       final File chosenFile = file;
 166       Callable<Void> okAction = () -> {
 167         exportImage(chosenFile, !textSelected.get(), width, height,
 168                 messageId);
 169         return null;
 170       };
 171       LineartOptions epsOption = new LineartOptions(TYPE.EPS.getName(),
 172               textSelected);
 173       epsOption.setResponseAction(1, new Callable<Void>()
 174       {
 175         @Override
 176         public Void call()
 177         {
 178           setStatus(MessageManager.formatMessage(
 179                   "status.cancelled_image_export_operation",
 180                   imageType.getName()), messageId);
 181           return null;
 182         }
 183       });
 184       epsOption.setResponseAction(0, okAction);
 185       epsOption.showDialog();
 186       /* no code here - JalviewJS cannot execute it */
 187     }
 188     else
 189     {
 190       /*
 191        * character rendering not required, or preference already set
 192        * - just do the export
 193        */
 194       exportImage(file, !textSelected.get(), width, height, messageId);
 195     }
 196   }
 197
 198   /**
 199    * Constructs a suitable graphics context and passes it to the callback
 200    * handler for the image to be written. Shows status messages for export in
 201    * progress, complete, or failed as appropriate.
 202    *
 203    * @param chosenFile
 204    * @param asLineart
 205    * @param width
 206    * @param height
 207    * @param messageId
 208    */
 209   protected void exportImage(File chosenFile, boolean asLineart, int width,
 210           int height, long messageId)
 211   {
 212     String type = imageType.getName();
 213     try
 214     {
 215       // setStatus(
 216       // MessageManager.formatMessage(
 217       // "status.exporting_alignment_as_x_file", type),
 218       // messageId);
 219       ImageMaker im = new ImageMaker(imageType, width, height, chosenFile,
 220               title, asLineart);
 221       imageWriter.exportImage(im.getGraphics());
 222       im.writeImage();
 223       setStatus(
 224               MessageManager.formatMessage("status.export_complete", type),
 225               messageId);
 226     } catch (Exception e)
 227     {
 228       System.out.println(String.format("Error creating %s file: %s", type,
 229               e.toString()));
 230       setStatus(MessageManager.formatMessage("info.error_creating_file",
 231               type), messageId);
 232     }
 233   }
 234
 235   /**
 236    * Asks the callback to show a status message with given id
 237    *
 238    * @param msg
 239    * @param id
 240    */
 241   void setStatus(String msg, long id)
 242   {
 243     if (messageBoard != null && !Jalview.isHeadlessMode())
 244     {
 245       messageBoard.setProgressBar(msg, id);
 246     }
 247   }
 248
 249 }