package jalview.gui; import jalview.bin.Cache; import jalview.bin.Jalview; import jalview.io.JalviewFileChooser; import jalview.io.JalviewFileView; import jalview.util.ImageMaker; import jalview.util.ImageMaker.TYPE; import jalview.util.MessageManager; import jalview.util.Platform; import java.awt.Component; import java.awt.Graphics; import java.io.File; import java.util.concurrent.atomic.AtomicBoolean; /** * A class that marshals steps in exporting a view in image graphics format * * * @author gmcarstairs * */ public class ImageExporter { // todo move interface to jalview.api? or replace with lambda? /** * An interface for the callback that can be run to write the image on to the * graphics object. The callback should throw any exceptions arising so they * can be reported by this class. */ public interface ImageWriterI { void exportImage(Graphics g) throws Exception; } private IProgressIndicator messageBoard; private ImageWriterI imageWriter; TYPE imageType; private String title; /** * Constructor given a callback handler to write graphics data, an (optional) * target for status messages, image type and (optional) title for output file * * @param writer * @param statusBar * @param type * @param fileTitle */ public ImageExporter(ImageWriterI writer, IProgressIndicator statusBar, TYPE type, String fileTitle) { this.imageWriter = writer; this.messageBoard = statusBar; this.imageType = type; this.title = fileTitle; } /** * Prompts the user for output file and Text/Lineart options as required, * configures a Graphics context for output, and makes a callback to the * client code to perform the image output * * @param file * output file (if null, user is prompted to choose) * @param parent * parent component for any dialogs shown * @param width * @param height * @param imageSource * what the image is of e.g. Tree, Alignment */ public void doExport(File file, Component parent, int width, int height, String imageSource) { final long messageId = System.currentTimeMillis(); setStatus( MessageManager.formatMessage( "status.exporting_alignment_as_x_file", imageType), messageId); /* * prompt user for output file if not provided */ if (file == null && !Jalview.isHeadlessMode()) { JalviewFileChooser chooser = imageType.getFileChooser(); chooser.setFileView(new JalviewFileView()); MessageManager.formatMessage("label.create_image_of", imageType.getName(), imageSource); String title = "Create " + imageType.getName() + " image from alignment"; chooser.setDialogTitle(title); chooser.setToolTipText(MessageManager.getString("action.save")); int value = chooser.showSaveDialog(parent); if (value != JalviewFileChooser.APPROVE_OPTION) { String msg = MessageManager.formatMessage( "status.cancelled_image_export_operation", imageType.name); setStatus(msg, messageId); return; } Cache.setProperty("LAST_DIRECTORY", chooser.getSelectedFile().getParent()); file = chooser.getSelectedFile(); } /* * Prompt for Text or Lineart (EPS/SVG) unless a preference is already set * for this as EPS_RENDERING / SVG_RENDERING * Always set to Text for JalviewJS as Lineart (glyph fonts) not available */ String renderStyle = Cache.getDefault( imageType.getName() + "_RENDERING", LineartOptions.PROMPT_EACH_TIME); if (Platform.isJS()) { renderStyle = "Text"; } AtomicBoolean textSelected = new AtomicBoolean( !"Lineart".equals(renderStyle)); if ((imageType == TYPE.EPS || imageType == TYPE.SVG) && LineartOptions.PROMPT_EACH_TIME.equals(renderStyle) && !Jalview.isHeadlessMode()) { final File chosenFile = file; Runnable okAction = new Runnable() { @Override public void run() { exportImage(chosenFile, !textSelected.get(), width, height, messageId); } }; LineartOptions epsOption = new LineartOptions(TYPE.EPS.getName(), textSelected); epsOption.setResponseAction(1, new Runnable() { @Override public void run() { setStatus(MessageManager.formatMessage( "status.cancelled_image_export_operation", imageType.getName()), messageId); } }); epsOption.setResponseAction(0, okAction); epsOption.showDialog(); /* no code here - JalviewJS cannot execute it */ } else { /* * character rendering not required, or preference already set * - just do the export */ exportImage(file, !textSelected.get(), width, height, messageId); } } /** * Constructs a suitable graphics context and passes it to the callback * handler for the image to be written. Shows status messages for export in * progress, complete, or failed as appropriate. * * @param chosenFile * @param asLineart * @param width * @param height * @param messageId */ protected void exportImage(File chosenFile, boolean asLineart, int width, int height, long messageId) { String type = imageType.getName(); try { // setStatus( // MessageManager.formatMessage( // "status.exporting_alignment_as_x_file", type), // messageId); ImageMaker im = new ImageMaker(imageType, width, height, chosenFile, title, asLineart); imageWriter.exportImage(im.getGraphics()); im.writeImage(); setStatus( MessageManager.formatMessage("status.export_complete", type), messageId); } catch (Exception e) { System.out .println(String.format("Error creating %s file: %s", type, e.toString())); setStatus(MessageManager.formatMessage("info.error_creating_file", type), messageId); } } /** * Asks the callback to show a status message with given id * * @param msg * @param id */ void setStatus(String msg, long id) { if (messageBoard != null && !Jalview.isHeadlessMode()) { messageBoard.setProgressBar(msg, id); } } }