2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import java.io.BufferedReader;
25 import java.io.IOException;
26 import java.io.InputStreamReader;
28 import java.util.Objects;
30 import jalview.api.AlignExportSettingsI;
31 import jalview.bin.Cache;
32 import jalview.bin.Jalview;
33 import jalview.datamodel.AlignExportSettingsAdapter;
34 import jalview.datamodel.AlignmentExportData;
35 import jalview.gui.AlignmentPanel;
36 import jalview.gui.IProgressIndicator;
37 import jalview.io.exceptions.ImageOutputException;
38 import jalview.util.HttpUtils;
39 import jalview.util.MessageManager;
41 public abstract class HTMLOutput implements Runnable
43 protected AlignmentPanel ap;
46 * key for progress or status messages
48 protected long pSessionId;
51 * (optional) place to write progress messages to
53 protected IProgressIndicator pIndicator;
55 protected File generatedFile;
57 String _bioJson = null;
59 private String description;
62 * Constructor given an alignment panel (which should not be null)
67 public HTMLOutput(AlignmentPanel ap, String desc)
70 this.pIndicator = ap.alignFrame;
71 this.description = desc;
72 this.pSessionId = System.currentTimeMillis();
76 * Gets the BioJSON data as a string, with lazy evaluation (first time called
77 * only). If the output format is configured not to embed BioJSON, returns
82 public String getBioJSONData()
90 AlignExportSettingsI options = new AlignExportSettingsAdapter(true);
91 AlignmentExportData exportData = ap.getAlignViewport()
92 .getAlignExportData(options);
93 _bioJson = new FormatAdapter(ap, options).formatSequences(
94 FileFormat.Json, exportData.getAlignment(),
95 exportData.getOmitHidden(), exportData.getStartEndPostions(),
96 ap.getAlignViewport().getAlignment().getHiddenColumns());
103 * Read a template file content as string
106 * - the file to be read
107 * @return File content as String
108 * @throws IOException
110 public static String readFileAsString(File file) throws IOException
112 InputStreamReader isReader = null;
113 BufferedReader buffReader = null;
114 StringBuilder sb = new StringBuilder();
115 Objects.requireNonNull(file, "File must not be null!");
116 @SuppressWarnings("deprecation")
117 URL url = file.toURL();
122 isReader = new InputStreamReader(HttpUtils.openStream(url));
123 buffReader = new BufferedReader(isReader);
125 String lineSeparator = System.getProperty("line.separator");
126 while ((line = buffReader.readLine()) != null)
128 sb.append(line).append(lineSeparator);
131 } catch (Exception ex)
133 ex.printStackTrace();
136 if (isReader != null)
141 if (buffReader != null)
147 return sb.toString();
150 public static String getImageMapHTML()
152 return new String("<html>\n" + "<head>\n"
153 + "<script language=\"JavaScript\">\n"
154 + "var ns4 = document.layers;\n"
155 + "var ns6 = document.getElementById && !document.all;\n"
156 + "var ie4 = document.all;\n" + "offsetX = 0;\n"
157 + "offsetY = 20;\n" + "var toolTipSTYLE=\"\";\n"
158 + "function initToolTips()\n" + "{\n" + " if(ns4||ns6||ie4)\n"
160 + " if(ns4) toolTipSTYLE = document.toolTipLayer;\n"
161 + " else if(ns6) toolTipSTYLE = document.getElementById(\"toolTipLayer\").style;\n"
162 + " else if(ie4) toolTipSTYLE = document.all.toolTipLayer.style;\n"
163 + " if(ns4) document.captureEvents(Event.MOUSEMOVE);\n"
165 + " toolTipSTYLE.visibility = \"visible\";\n"
166 + " toolTipSTYLE.display = \"none\";\n" + " }\n"
167 + " document.onmousemove = moveToMouseLoc;\n" + " }\n"
168 + "}\n" + "function toolTip(msg, fg, bg)\n" + "{\n"
169 + " if(toolTip.arguments.length < 1) // hide\n" + " {\n"
170 + " if(ns4) toolTipSTYLE.visibility = \"hidden\";\n"
171 + " else toolTipSTYLE.display = \"none\";\n" + " }\n"
172 + " else // show\n" + " {\n"
173 + " if(!fg) fg = \"#555555\";\n"
174 + " if(!bg) bg = \"#FFFFFF\";\n" + " var content =\n"
175 + " '<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" bgcolor=\"' + fg + '\"><td>' +\n"
176 + " '<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" bgcolor=\"' + bg + \n"
177 + " '\"><td align=\"center\"><font face=\"sans-serif\" color=\"' + fg +\n"
178 + " '\" size=\"-2\"> ' + msg +\n"
179 + " ' </font></td></table></td></table>';\n"
180 + " if(ns4)\n" + " {\n"
181 + " toolTipSTYLE.document.write(content);\n"
182 + " toolTipSTYLE.document.close();\n"
183 + " toolTipSTYLE.visibility = \"visible\";\n" + " }\n"
184 + " if(ns6)\n" + " {\n"
185 + " document.getElementById(\"toolTipLayer\").innerHTML = content;\n"
186 + " toolTipSTYLE.display='block'\n" + " }\n"
187 + " if(ie4)\n" + " {\n"
188 + " document.all(\"toolTipLayer\").innerHTML=content;\n"
189 + " toolTipSTYLE.display='block'\n" + " }\n" + " }\n"
190 + "}\n" + "function moveToMouseLoc(e)\n" + "{\n"
191 + " if(ns4||ns6)\n" + " {\n" + " x = e.pageX;\n"
192 + " y = e.pageY;\n" + " }\n" + " else\n" + " {\n"
193 + " x = event.x + document.body.scrollLeft;\n"
194 + " y = event.y + document.body.scrollTop;\n" + " }\n"
195 + " toolTipSTYLE.left = x + offsetX;\n"
196 + " toolTipSTYLE.top = y + offsetY;\n" + " return true;\n"
197 + "}\n" + "</script>\n" + "</head>\n" + "<body>\n"
198 + "<div id=\"toolTipLayer\" style=\"position:absolute; visibility: hidden\"></div>\n"
199 + "<script language=\"JavaScript\"><!--\n"
200 + "initToolTips(); //--></script>\n");
205 * Prompts the user to choose an output file and returns the file path, or
210 public String getOutputFile()
212 String selectedFile = null;
214 // TODO: JAL-3048 generate html rendered view (requires SvgGraphics and/or
215 // Jalview HTML rendering system- probably not required for Jalview-JS)
216 JalviewFileChooser jvFileChooser = new JalviewFileChooser("html",
218 jvFileChooser.setFileView(new JalviewFileView());
221 .setDialogTitle(MessageManager.getString("label.save_as_html"));
222 jvFileChooser.setToolTipText(MessageManager.getString("action.save"));
224 int fileChooserOpt = jvFileChooser.showSaveDialog(null);
225 if (fileChooserOpt == JalviewFileChooser.APPROVE_OPTION)
227 Cache.setProperty("LAST_DIRECTORY",
228 jvFileChooser.getSelectedFile().getParent());
229 selectedFile = jvFileChooser.getSelectedFile().getPath();
235 protected void setProgressMessage(String message)
237 if (pIndicator != null && !isHeadless())
239 pIndicator.setProgressBar(message, pSessionId);
243 jalview.bin.Console.outPrintln(message);
248 * Answers true if HTML export is invoke in headless mode or false otherwise
252 protected boolean isHeadless()
254 return System.getProperty("java.awt.headless") != null
255 && System.getProperty("java.awt.headless").equals("true");
259 * This method provides implementation of consistent behaviour which should
260 * occur after a HTML file export. It MUST be called at the end of the
261 * exportHTML() method implementation.
263 protected void exportCompleted()
265 if (isLaunchInBrowserAfterExport() && !isHeadless())
271 jalview.util.BrowserLauncher.openURL("file:///" + getExportedFile());
273 } catch (IOException e)
282 * if this answers true then BioJSON data will be embedded to the exported
283 * HTML file otherwise it won't be embedded.
287 public abstract boolean isEmbedData();
290 * if this answers true then the generated HTML file is opened for viewing in
291 * a browser after its generation otherwise it won't be opened in a browser
295 public abstract boolean isLaunchInBrowserAfterExport();
298 * handle to the generated HTML file
302 public File getExportedFile()
304 return generatedFile;
307 public void exportHTML(String outputFile) throws ImageOutputException
309 exportHTML(outputFile, null);
312 public void exportHTML(String outputFile, String renderer)
313 throws ImageOutputException
315 setProgressMessage(MessageManager.formatMessage(
316 "status.exporting_alignment_as_x_file", getDescription()));
319 if (outputFile == null)
322 * prompt for output file
324 outputFile = getOutputFile();
325 if (outputFile == null)
327 setProgressMessage(MessageManager.formatMessage(
328 "status.cancelled_image_export_operation",
333 generatedFile = new File(outputFile);
334 } catch (Exception e)
336 setProgressMessage(MessageManager
337 .formatMessage("info.error_creating_file", getDescription()));
341 if (Jalview.isHeadlessMode())
347 new Thread(this).start();
353 * Answers a short description of the image format suitable for display in
358 protected final String getDescription()
363 // used to pass an option such as render to run
364 public abstract void run(String string) throws ImageOutputException;