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