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.awt.Graphics;
24 import java.awt.print.PrinterException;
26 import java.io.FileOutputStream;
27 import java.io.IOException;
28 import java.util.Locale;
29 import java.util.concurrent.atomic.AtomicBoolean;
31 import org.jfree.graphics2d.svg.SVGGraphics2D;
32 import org.jfree.graphics2d.svg.SVGHints;
34 import jalview.bin.Cache;
35 import jalview.gui.AlignmentPanel;
36 import jalview.gui.LineartOptions;
37 import jalview.gui.OOMWarning;
38 import jalview.math.AlignmentDimension;
39 import jalview.util.MessageManager;
41 public class HtmlSvgOutput extends HTMLOutput
43 public HtmlSvgOutput(AlignmentPanel ap)
48 public int printUnwrapped(int pwidth, int pheight, int pi,
49 Graphics idGraphics, Graphics alignmentGraphics)
50 throws PrinterException
52 return ap.printUnwrapped(pwidth, pheight, pi, idGraphics,
56 public int printWrapped(int pwidth, int pheight, int pi, Graphics... pg)
57 throws PrinterException
59 return ap.printWrappedAlignment(pwidth, pheight, pi, pg[0]);
62 String getHtml(String titleSvg, String alignmentSvg, String jsonData,
65 StringBuilder htmlSvg = new StringBuilder();
66 htmlSvg.append("<html>\n");
70 "<button onclick=\"javascipt:openJalviewUsingCurrentUrl();\">Launch in Jalview</button> ");
72 "<input type=\"submit\" value=\"View raw BioJSON Data\" onclick=\"jQuery.facebox({ div:'#seqData' }); return false;\" />");
74 "<div style=\"display: none;\" name=\"seqData\" id=\"seqData\" >"
75 + jsonData + "</div>");
76 htmlSvg.append("<br/> ");
78 htmlSvg.append("\n<style type=\"text/css\"> "
79 + "div.parent{ width:100%;<!-- overflow: auto; -->}\n"
80 + "div.titlex{ width:11%; float: left; }\n"
81 + "div.align{ width:89%; float: right; }\n"
82 + "div.main-container{ border: 2px solid blue; border: 2px solid blue; width: 99%; min-height: 99%; }\n"
83 + ".sub-category-container {overflow-y: scroll; overflow-x: hidden; width: 100%; height: 100%;}\n"
84 + "object {pointer-events: none;}");
87 // facebox style sheet for displaying raw BioJSON data
89 "#facebox { position: absolute; top: 0; left: 0; z-index: 100; text-align: left; }\n"
90 + "#facebox .popup{ position:relative; border:3px solid rgba(0,0,0,0); -webkit-border-radius:5px;"
91 + "-moz-border-radius:5px; border-radius:5px; -webkit-box-shadow:0 0 18px rgba(0,0,0,0.4); -moz-box-shadow:0 0 18px rgba(0,0,0,0.4);"
92 + "box-shadow:0 0 18px rgba(0,0,0,0.4); }\n"
93 + "#facebox .content { display:table; width: 98%; padding: 10px; background: #fff; -webkit-border-radius:4px; -moz-border-radius:4px;"
94 + " border-radius:4px; }\n"
95 + "#facebox .content > p:first-child{ margin-top:0; }\n"
96 + "#facebox .content > p:last-child{ margin-bottom:0; }\n"
97 + "#facebox .close{ position:absolute; top:5px; right:5px; padding:2px; background:#fff; }\n"
98 + "#facebox .close img{ opacity:0.3; }\n"
99 + "#facebox .close:hover img{ opacity:1.0; }\n"
100 + "#facebox .loading { text-align: center; }\n"
101 + "#facebox .image { text-align: center;}\n"
102 + "#facebox img { border: 0; margin: 0; }\n"
103 + "#facebox_overlay { position: fixed; top: 0px; left: 0px; height:100%; width:100%; }\n"
104 + ".facebox_hide { z-index:-100; }\n"
105 + ".facebox_overlayBG { background-color: #000; z-index: 99; }");
107 htmlSvg.append("</style>");
110 htmlSvg.append("<div class=\"main-container\" \n>");
111 htmlSvg.append("<div class=\"titlex\">\n");
112 htmlSvg.append("<div class=\"sub-category-container\"> \n");
113 htmlSvg.append(titleSvg);
114 htmlSvg.append("</div>");
116 "</div>\n\n<!-- ========================================================================================== -->\n\n");
117 htmlSvg.append("<div class=\"align\" >");
119 "<div class=\"sub-category-container\"> <div style=\"overflow-x: scroll;\">")
120 .append(alignmentSvg).append("</div></div>").append("</div>");
121 htmlSvg.append("</div>");
124 "<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js\"></script>\n"
125 + "<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js\"></script>\n"
127 + "var subCatContainer = $(\".sub-category-container\");\n"
128 + "subCatContainer.scroll(\nfunction() {\n"
129 + "subCatContainer.scrollTop($(this).scrollTop());\n});\n");
131 htmlSvg.append("</script>\n");
135 htmlSvg.append("<div>\n").append(alignmentSvg).append("</div>");
137 "<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js\"></script>\n"
138 + "<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js\"></script>\n");
141 // javascript for launching file in Jalview
142 htmlSvg.append("<script language=\"JavaScript\">\n");
143 htmlSvg.append("function openJalviewUsingCurrentUrl(){\n");
145 " var json = JSON.parse(document.getElementById(\"seqData\").innerHTML);\n");
147 " var jalviewVersion = json['appSettings'].version;\n");
148 htmlSvg.append(" var url = json['appSettings'].webStartUrl;\n");
150 " var myForm = document.createElement(\"form\");\n\n");
151 htmlSvg.append(" var heap = document.createElement(\"input\");\n");
152 htmlSvg.append(" heap.setAttribute(\"name\", \"jvm-max-heap\") ;\n");
153 htmlSvg.append(" heap.setAttribute(\"value\", \"2G\");\n\n");
154 htmlSvg.append(" var target = document.createElement(\"input\");\n");
155 htmlSvg.append(" target.setAttribute(\"name\", \"open\");\n");
156 htmlSvg.append(" target.setAttribute(\"value\", document.URL);\n\n");
158 " var jvVersion = document.createElement(\"input\");\n");
159 htmlSvg.append(" jvVersion.setAttribute(\"name\", \"version\") ;\n");
161 " jvVersion.setAttribute(\"value\", jalviewVersion);\n\n");
162 htmlSvg.append(" myForm.action = url;\n");
163 htmlSvg.append(" myForm.appendChild(heap);\n");
164 htmlSvg.append(" myForm.appendChild(target);\n");
165 htmlSvg.append(" myForm.appendChild(jvVersion);\n");
166 htmlSvg.append(" document.body.appendChild(myForm);\n");
167 htmlSvg.append(" myForm.submit() ;\n");
168 htmlSvg.append(" document.body.removeChild(myForm);\n");
169 htmlSvg.append("}\n");
171 if (jsonData != null)
173 // JQuery FaceBox for displaying raw BioJSON data");
174 File faceBoxJsFile = new File("examples/javascript/facebox-1.3.js");
177 htmlSvg.append(HTMLOutput.readFileAsString(faceBoxJsFile));
178 } catch (IOException e)
184 htmlSvg.append("</script>\n");
185 htmlSvg.append("</html>");
186 return htmlSvg.toString();
190 public boolean isEmbedData()
193 .valueOf(Cache.getDefault("EXPORT_EMBBED_BIOJSON", "true"));
197 public boolean isLaunchInBrowserAfterExport()
209 public void run(String renderer)
213 String renderStyle = renderer == null
214 ? Cache.getDefault("HTML_RENDERING",
215 LineartOptions.PROMPT_EACH_TIME)
217 AtomicBoolean textOption = new AtomicBoolean(
218 !"lineart".equals(renderStyle.toLowerCase(Locale.ROOT)));
221 * configure the action to run on OK in the dialog
223 Runnable okAction = () -> {
224 doOutput(textOption.get());
228 * Prompt for character rendering style if preference is not set
230 if (renderStyle.equalsIgnoreCase(LineartOptions.PROMPT_EACH_TIME)
233 LineartOptions svgOption = new LineartOptions("HTML", textOption);
234 svgOption.setResponseAction(1, () -> {
235 setProgressMessage(MessageManager.formatMessage(
236 "status.cancelled_image_export_operation",
239 svgOption.setResponseAction(0, okAction);
240 svgOption.showDialog();
241 /* no code here - JalviewJS cannot execute it */
246 * else (if preference set) just do the export action
248 doOutput(textOption.get());
250 } catch (OutOfMemoryError err)
252 System.out.println("########################\n" + "OUT OF MEMORY "
253 + generatedFile + "\n" + "########################");
254 new OOMWarning("Creating Image for " + generatedFile, err);
255 } catch (Exception e)
258 setProgressMessage(MessageManager
259 .formatMessage("info.error_creating_file", getDescription()));
264 * Builds and writes the image to the file specified by field
265 * <code>generatedFile</code>
267 * @param textCharacters
268 * true for Text character rendering, false for Lineart
270 protected void doOutput(boolean textCharacters)
274 AlignmentDimension aDimension = ap.getAlignmentDimension();
275 SVGGraphics2D idPanelGraphics = new SVGGraphics2D(
276 aDimension.getWidth(), aDimension.getHeight());
277 SVGGraphics2D alignPanelGraphics = new SVGGraphics2D(
278 aDimension.getWidth(), aDimension.getHeight());
279 if (!textCharacters) // Lineart selected
281 idPanelGraphics.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
282 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
283 alignPanelGraphics.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
284 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
286 if (ap.av.getWrapAlignment())
288 printWrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
293 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
294 idPanelGraphics, alignPanelGraphics);
297 String idPanelSvgData = idPanelGraphics.getSVGDocument();
298 String alignPanelSvgData = alignPanelGraphics.getSVGDocument();
299 String jsonData = getBioJSONData();
300 String htmlData = getHtml(idPanelSvgData, alignPanelSvgData, jsonData,
301 ap.av.getWrapAlignment());
302 FileOutputStream out = new FileOutputStream(generatedFile);
303 out.write(htmlData.getBytes());
306 setProgressMessage(MessageManager
307 .formatMessage("status.export_complete", getDescription()));
309 } catch (Exception e)
312 setProgressMessage(MessageManager
313 .formatMessage("info.error_creating_file", getDescription()));