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 jalview.api.AlignExportSettingI;
24 import jalview.datamodel.AlignmentExportData;
25 import jalview.exceptions.NoFileSelectedException;
26 import jalview.gui.AlignmentPanel;
27 import jalview.gui.IProgressIndicator;
28 import jalview.util.MessageManager;
30 import java.io.BufferedReader;
32 import java.io.IOException;
33 import java.io.InputStreamReader;
35 import java.util.Objects;
38 public abstract class HTMLOutput
40 protected AlignmentPanel ap;
42 protected long pSessionId;
44 protected IProgressIndicator pIndicator;
46 protected File generatedFile;
48 public HTMLOutput(AlignmentPanel ap)
53 this.pIndicator = ap.alignFrame;
58 public String getBioJSONData()
64 AlignExportSettingI exportSettings = new AlignExportSettingI()
67 public boolean isExportHiddenSequences()
73 public boolean isExportHiddenColumns()
79 public boolean isExportAnnotations()
85 public boolean isExportFeatures()
91 public boolean isExportGroups()
97 public boolean isCancelled()
103 AlignmentExportData exportData = jalview.gui.AlignFrame
104 .getAlignmentForExport(JSONFile.FILE_DESC,
105 ap.getAlignViewport(), exportSettings);
106 String bioJSON = new FormatAdapter(ap, exportData.getSettings())
107 .formatSequences(JSONFile.FILE_DESC, exportData.getAlignment(),
108 exportData.getOmitHidden(), exportData
109 .getStartEndPostions(), ap.getAlignViewport()
110 .getColumnSelection());
115 * Read a template file content as string
118 * - the file to be read
119 * @return File content as String
120 * @throws IOException
122 public static String readFileAsString(File file) throws IOException
124 InputStreamReader isReader = null;
125 BufferedReader buffReader = null;
126 StringBuilder sb = new StringBuilder();
127 Objects.requireNonNull(file, "File must not be null!");
128 @SuppressWarnings("deprecation")
129 URL url = file.toURL();
134 isReader = new InputStreamReader(url.openStream());
135 buffReader = new BufferedReader(isReader);
137 String lineSeparator = System.getProperty("line.separator");
138 while ((line = buffReader.readLine()) != null)
140 sb.append(line).append(lineSeparator);
143 } catch (Exception ex)
145 ex.printStackTrace();
148 if (isReader != null)
153 if (buffReader != null)
159 return sb.toString();
162 public static String getImageMapHTML()
167 + "<script language=\"JavaScript\">\n"
168 + "var ns4 = document.layers;\n"
169 + "var ns6 = document.getElementById && !document.all;\n"
170 + "var ie4 = document.all;\n"
173 + "var toolTipSTYLE=\"\";\n"
174 + "function initToolTips()\n"
176 + " if(ns4||ns6||ie4)\n"
178 + " if(ns4) toolTipSTYLE = document.toolTipLayer;\n"
179 + " else if(ns6) toolTipSTYLE = document.getElementById(\"toolTipLayer\").style;\n"
180 + " else if(ie4) toolTipSTYLE = document.all.toolTipLayer.style;\n"
181 + " if(ns4) document.captureEvents(Event.MOUSEMOVE);\n"
184 + " toolTipSTYLE.visibility = \"visible\";\n"
185 + " toolTipSTYLE.display = \"none\";\n"
187 + " document.onmousemove = moveToMouseLoc;\n"
190 + "function toolTip(msg, fg, bg)\n"
192 + " if(toolTip.arguments.length < 1) // hide\n"
194 + " if(ns4) toolTipSTYLE.visibility = \"hidden\";\n"
195 + " else toolTipSTYLE.display = \"none\";\n"
199 + " if(!fg) fg = \"#555555\";\n"
200 + " if(!bg) bg = \"#FFFFFF\";\n"
202 + " '<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" bgcolor=\"' + fg + '\"><td>' +\n"
203 + " '<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" bgcolor=\"' + bg + \n"
204 + " '\"><td align=\"center\"><font face=\"sans-serif\" color=\"' + fg +\n"
205 + " '\" size=\"-2\"> ' + msg +\n"
206 + " ' </font></td></table></td></table>';\n"
209 + " toolTipSTYLE.document.write(content);\n"
210 + " toolTipSTYLE.document.close();\n"
211 + " toolTipSTYLE.visibility = \"visible\";\n"
215 + " document.getElementById(\"toolTipLayer\").innerHTML = content;\n"
216 + " toolTipSTYLE.display='block'\n"
220 + " document.all(\"toolTipLayer\").innerHTML=content;\n"
221 + " toolTipSTYLE.display='block'\n"
225 + "function moveToMouseLoc(e)\n"
234 + " x = event.x + document.body.scrollLeft;\n"
235 + " y = event.y + document.body.scrollTop;\n"
237 + " toolTipSTYLE.left = x + offsetX;\n"
238 + " toolTipSTYLE.top = y + offsetY;\n"
244 + "<div id=\"toolTipLayer\" style=\"position:absolute; visibility: hidden\"></div>\n"
245 + "<script language=\"JavaScript\"><!--\n"
246 + "initToolTips(); //--></script>\n");
250 public String getOutputFile() throws NoFileSelectedException
252 String selectedFile = null;
253 if (pIndicator != null && !isHeadless())
255 pIndicator.setProgressBar(MessageManager.formatMessage(
256 "status.waiting_for_user_to_select_output_file", "HTML"),
260 JalviewFileChooser jvFileChooser = new JalviewFileChooser(
261 jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
262 new String[] { "html" }, new String[] { "HTML files" },
264 jvFileChooser.setFileView(new JalviewFileView());
266 jvFileChooser.setDialogTitle(MessageManager
267 .getString("label.save_as_biojs_html"));
268 jvFileChooser.setToolTipText(MessageManager.getString("action.save"));
270 int fileChooserOpt = jvFileChooser.showSaveDialog(null);
271 if (fileChooserOpt == JalviewFileChooser.APPROVE_OPTION)
273 jalview.bin.Cache.setProperty("LAST_DIRECTORY", jvFileChooser
274 .getSelectedFile().getParent());
275 selectedFile = jvFileChooser.getSelectedFile().getPath();
279 pIndicator.setProgressBar(MessageManager.formatMessage(
280 "status.cancelled_image_export_operation", "BioJS"),
282 throw new NoFileSelectedException("No file was selected.");
287 protected void setProgressMessage(String message)
289 if (pIndicator != null && !isHeadless())
291 pIndicator.setProgressBar(message, pSessionId);
295 System.out.println(message);
300 * Answers true if HTML export is invoke in headless mode or false otherwise
304 protected boolean isHeadless()
306 return System.getProperty("java.awt.headless") != null
307 && System.getProperty("java.awt.headless").equals("true");
311 * This method provides implementation of consistent behaviour which should
312 * occur before a HTML file export. It MUST be called at the start of the
313 * exportHTML() method implementation.
315 protected void exportStarted()
317 pSessionId = System.currentTimeMillis();
321 * This method provides implementation of consistent behaviour which should
322 * occur after a HTML file export. It MUST be called at the end of the
323 * exportHTML() method implementation.
325 protected void exportCompleted()
327 if (isLaunchInBrowserAfterExport() && !isHeadless())
331 jalview.util.BrowserLauncher
332 .openURL("file:///" + getExportedFile());
333 } catch (IOException e)
341 * if this answers true then BioJSON data will be embedded to the exported
342 * HTML file otherwise it won't be embedded.
346 public abstract boolean isEmbedData();
349 * if this answers true then the generated HTML file is opened for viewing in
350 * a browser after its generation otherwise it won't be opened in a browser
354 public abstract boolean isLaunchInBrowserAfterExport();
357 * handle to the generated HTML file
361 public abstract File getExportedFile();
364 * This is the main method to handle the HTML generation.
367 * the file path of the generated HTML
369 public abstract void exportHTML(String outputFile);