3 import jalview.bin.Cache;
4 import jalview.bin.Jalview;
5 import jalview.io.JalviewFileChooser;
6 import jalview.io.JalviewFileView;
7 import jalview.util.ImageMaker;
8 import jalview.util.ImageMaker.TYPE;
9 import jalview.util.MessageManager;
10 import jalview.util.dialogrunner.RunResponse;
12 import java.awt.Component;
13 import java.awt.Graphics;
15 import java.util.concurrent.atomic.AtomicBoolean;
17 import javax.swing.JOptionPane;
20 * A class that marshals steps in exporting a view in image graphics format
22 * <li>prompts the user for the output file, if not already specified</li>
23 * <li>prompts the user for Text or Lineart character rendering, if
25 * <li>instantiates an ImageMaker to create the appropriate Graphics output
26 * context for the image format</li>
27 * <li>invokes a callback to do the work of writing to the graphics</li>
33 public class ImageExporter
35 // todo move interface to jalview.api? or replace with lambda?
37 * An interface for the callback that can be run to write the image on to the
38 * graphics object. The callback should throw any exceptions arising so they
39 * can be reported by this class.
41 public interface ImageWriterI
43 void exportImage(Graphics g)
47 private IProgressIndicator messageBoard;
49 private ImageWriterI imageWriter;
56 * Constructor given a callback handler to write graphics data, an (optional)
57 * target for status messages, image type and (optional) title for output file
64 public ImageExporter(ImageWriterI writer, IProgressIndicator statusBar,
65 TYPE type, String fileTitle)
67 this.imageWriter = writer;
68 this.messageBoard = statusBar;
69 this.imageType = type;
70 this.title = fileTitle;
74 * Prompts the user for output file and Text/Lineart options as required,
75 * configures a Graphics context for output, and makes a callback to the
76 * client code to perform the image output
79 * output file (if null, user is prompted to choose)
81 * parent component for any dialogs shown
85 * what the image is of e.g. Tree, Alignment
87 public void doExport(File file, Component parent, int width, int height,
90 final long messageId = System.currentTimeMillis();
93 * prompt user for output file if not provided
95 if (file == null && !Jalview.isHeadlessMode())
97 JalviewFileChooser chooser = imageType.getFileChooser();
98 chooser.setFileView(new JalviewFileView());
99 MessageManager.formatMessage("label.create_image_of",
100 imageType.getName(), imageSource);
101 String title = "Create " + imageType.getName()
102 + " image from alignment";
103 chooser.setDialogTitle(title);
104 chooser.setToolTipText(MessageManager.getString("action.save"));
105 int value = chooser.showSaveDialog(parent);
106 if (value != JalviewFileChooser.APPROVE_OPTION)
108 String msg = MessageManager.formatMessage(
109 "status.cancelled_image_export_operation", imageType.name);
110 setStatus(msg, messageId);
113 Cache.setProperty("LAST_DIRECTORY",
114 chooser.getSelectedFile().getParent());
115 file = chooser.getSelectedFile();
119 * Prompt for Text or Lineart (EPS/SVG) unless a preference is already set
120 * for this as EPS_RENDERING / SVG_RENDERING
122 String renderStyle = Cache.getDefault(
123 imageType.getName() + "_RENDERING",
124 LineartOptions.PROMPT_EACH_TIME);
125 AtomicBoolean textSelected = new AtomicBoolean(
126 !"Lineart".equals(renderStyle));
127 if ((imageType == TYPE.EPS || imageType == TYPE.SVG)
128 && LineartOptions.PROMPT_EACH_TIME.equals(renderStyle)
129 && !Jalview.isHeadlessMode())
131 final File chosenFile = file;
132 RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
137 exportImage(chosenFile, !textSelected.get(), width, height,
141 LineartOptions epsOption = new LineartOptions(TYPE.EPS.getName(),
143 epsOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
148 setStatus(MessageManager.formatMessage(
149 "status.cancelled_image_export_operation",
150 imageType.getName()), messageId);
153 epsOption.setResponseAction(okAction);
154 epsOption.showDialog();
155 /* no code here - JalviewJS cannot execute it */
160 * character rendering not required, or preference already set
161 * - just do the export
163 exportImage(file, !textSelected.get(), width, height, messageId);
168 * Constructs a suitable graphics context and passes it to the callback
169 * handler for the image to be written. Shows status messages for export in
170 * progress, complete, or failed as appropriate.
178 protected void exportImage(File chosenFile, boolean asLineart, int width,
179 int height, long messageId)
181 String type = imageType.getName();
185 MessageManager.formatMessage(
186 "status.exporting_alignment_as_x_file", type),
188 ImageMaker im = new ImageMaker(imageType, width, height, chosenFile,
190 imageWriter.exportImage(im.getGraphics());
193 MessageManager.formatMessage("status.export_complete", type),
195 } catch (Exception e)
198 .println(String.format("Error creating %s file: %s", type,
200 setStatus(MessageManager.formatMessage("info.error_creating_file",
206 * Asks the callback to show a status message with given id
211 void setStatus(String msg, long id)
213 if (messageBoard != null && !Jalview.isHeadlessMode())
215 messageBoard.setProgressBar(msg, id);