JAL-1759 corrected syntax for 'atom picked' callback (toggles label
[jalview.git] / src / jalview / io / HtmlSvgOutput.java
1 package jalview.io;
2
3 import jalview.api.FeatureRenderer;
4 import jalview.datamodel.AlignmentExportData;
5 import jalview.datamodel.SequenceI;
6 import jalview.gui.AlignViewport;
7 import jalview.gui.AlignmentPanel;
8 import jalview.gui.HTMLOptions;
9 import jalview.math.AlignmentDimension;
10 import jalview.util.MessageManager;
11
12 import java.awt.Color;
13 import java.awt.FontMetrics;
14 import java.awt.Graphics;
15 import java.awt.print.Printable;
16 import java.awt.print.PrinterException;
17 import java.io.File;
18 import java.io.FileOutputStream;
19
20 import org.jfree.graphics2d.svg.SVGGraphics2D;
21 import org.jfree.graphics2d.svg.SVGHints;
22
23 public class HtmlSvgOutput
24 {
25   AlignViewport av;
26
27   FeatureRenderer fr;
28   AlignmentPanel ap;
29
30
31   public HtmlSvgOutput(File file, AlignmentPanel ap)
32   {
33     this.av = ap.av;
34     this.ap = ap;
35     fr = ap.cloneFeatureRenderer();
36     generateHtmlSvgOutput(file);
37   }
38
39   public void generateHtmlSvgOutput(File file)
40   {
41     try
42     {
43       if (file == null)
44       {
45
46       JalviewFileChooser chooser = getHTMLChooser();
47       chooser.setFileView(new jalview.io.JalviewFileView());
48       chooser.setDialogTitle(ap.alignFrame.getTitle());
49       chooser.setToolTipText(MessageManager.getString("action.save"));
50       int value = chooser.showSaveDialog(ap.alignFrame);
51
52       if (value == jalview.io.JalviewFileChooser.APPROVE_OPTION)
53       {
54         jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
55                 .getSelectedFile().getParent());
56         file = chooser.getSelectedFile();
57       }
58       }
59
60       AlignmentDimension aDimension = ap.getAlignmentDimension();
61       SVGGraphics2D g1 = new SVGGraphics2D(aDimension.getWidth(),
62               aDimension.getHeight());
63       SVGGraphics2D g2 = new SVGGraphics2D(aDimension.getWidth(),
64               aDimension.getHeight());
65
66       String renderStyle = jalview.bin.Cache.getDefault("HTML_RENDERING",
67               "Prompt each time");
68
69       // If we need to prompt, and if the GUI is visible then
70       // Prompt for rendering style
71       if (renderStyle.equalsIgnoreCase("Prompt each time")
72               && !(System.getProperty("java.awt.headless") != null && System
73                       .getProperty("java.awt.headless").equals("true")))
74       {
75         HTMLOptions svgOption = new HTMLOptions();
76         renderStyle = svgOption.getValue();
77
78         if (renderStyle == null || svgOption.cancelled)
79         {
80           return;
81         }
82       }
83
84       if (renderStyle.equalsIgnoreCase("lineart"))
85       {
86         g1.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
87                 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
88         g2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
89                 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
90       }
91       printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0, g1,
92               g2);
93
94       String titleSvgData = g1.getSVGDocument();
95       String alignSvgData = g2.getSVGDocument();
96       String jsonData = null;
97       boolean isEmbbedBioJSON = Boolean.valueOf(jalview.bin.Cache
98               .getDefault("EXPORT_EMBBED_BIOJSON", "true"));
99       if (isEmbbedBioJSON)
100       {
101         AlignmentExportData exportData = jalview.gui.AlignFrame
102                 .getAlignmentForExport(
103               JSONFile.FILE_DESC, av);
104       if (exportData.getSettings().isCancelled())
105       {
106         return;
107       }
108         jsonData = new FormatAdapter(ap, exportData.getSettings())
109               .formatSequences(JSONFile.FILE_DESC, exportData
110                       .getAlignment(), exportData.getOmitHidden(),
111                         exportData.getStartEndPostions(),
112                         av.getColumnSelection());
113       }
114       String htmlData = getHtml(titleSvgData, alignSvgData, jsonData);
115       FileOutputStream out = new FileOutputStream(file);
116       out.write(htmlData.getBytes());
117       out.flush();
118       out.close();
119       if (!(System.getProperty("java.awt.headless") != null && System
120               .getProperty("java.awt.headless").equals("true")))
121       {
122       jalview.util.BrowserLauncher.openURL("file:///" + file);
123       }
124     } catch (Exception e)
125     {
126       e.printStackTrace();
127     }
128   }
129   
130   static JalviewFileChooser getHTMLChooser()
131   {
132     return new jalview.io.JalviewFileChooser(
133             jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
134             { "html" }, new String[]
135             { "Hypertext Markup Language" }, "Hypertext Markup Language");
136   }
137
138   public int printUnwrapped(int pwidth, int pheight, int pi, Graphics... pg)
139           throws PrinterException
140   {
141     int idWidth = ap.getVisibleIdWidth(false);
142     FontMetrics fm = ap.getFontMetrics(av.getFont());
143     int scaleHeight = av.getCharHeight() + fm.getDescent();
144
145     pg[0].setColor(Color.white);
146     pg[0].fillRect(0, 0, pwidth, pheight);
147     pg[0].setFont(av.getFont());
148
149     // //////////////////////////////////
150     // / How many sequences and residues can we fit on a printable page?
151     int totalRes = (pwidth - idWidth) / av.getCharWidth();
152     int totalSeq = (pheight - scaleHeight) / av.getCharHeight() - 1;
153     int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;
154
155     // ///////////////////////////
156     // / Only print these sequences and residues on this page
157     int startRes;
158
159     // ///////////////////////////
160     // / Only print these sequences and residues on this page
161     int endRes;
162
163     // ///////////////////////////
164     // / Only print these sequences and residues on this page
165     int startSeq;
166
167     // ///////////////////////////
168     // / Only print these sequences and residues on this page
169     int endSeq;
170     startRes = (pi % pagesWide) * totalRes;
171     endRes = (startRes + totalRes) - 1;
172
173     if (endRes > (av.getAlignment().getWidth() - 1))
174     {
175       endRes = av.getAlignment().getWidth() - 1;
176     }
177     startSeq = (pi / pagesWide) * totalSeq;
178     endSeq = startSeq + totalSeq;
179     if (endSeq > av.getAlignment().getHeight())
180     {
181       endSeq = av.getAlignment().getHeight();
182     }
183     int pagesHigh = ((av.getAlignment().getHeight() / totalSeq) + 1)
184             * pheight;
185     if (av.isShowAnnotation())
186     {
187       pagesHigh += ap.getAnnotationPanel().adjustPanelHeight() + 3;
188     }
189     pagesHigh /= pheight;
190     if (pi >= (pagesWide * pagesHigh))
191     {
192       return Printable.NO_SUCH_PAGE;
193     }
194
195     // draw Scale
196     pg[1].translate(0, 0);
197     ap.getScalePanel().drawScale(pg[1], startRes, endRes, pwidth - idWidth,
198             scaleHeight);
199     pg[1].translate(-idWidth, scaleHeight);
200
201     // //////////////
202     // Draw the ids
203     Color currentColor = null;
204     Color currentTextColor = null;
205     pg[0].translate(0, scaleHeight);
206     pg[0].setFont(ap.getIdPanel().getIdCanvas().getIdfont());
207     SequenceI seq;
208     for (int i = startSeq; i < endSeq; i++)
209     {
210       seq = av.getAlignment().getSequenceAt(i);
211       if ((av.getSelectionGroup() != null)
212               && av.getSelectionGroup().getSequences(null).contains(seq))
213       {
214         currentColor = Color.gray;
215         currentTextColor = Color.black;
216       }
217       else
218       {
219         currentColor = av.getSequenceColour(seq);
220         currentTextColor = Color.black;
221       }
222       pg[0].setColor(currentColor);
223       pg[0].fillRect(0, (i - startSeq) * av.getCharHeight(), idWidth,
224               av.getCharHeight());
225       pg[0].setColor(currentTextColor);
226       int xPos = 0;
227       if (av.isRightAlignIds())
228       {
229         fm = pg[0].getFontMetrics();
230         xPos = idWidth
231                 - fm.stringWidth(seq.getDisplayId(av.getShowJVSuffix()))
232                 - 4;
233       }
234       pg[0].drawString(
235               seq.getDisplayId(av.getShowJVSuffix()),
236               xPos,
237               (((i - startSeq) * av.getCharHeight()) + av.getCharHeight())
238                       - (av.getCharHeight() / 5));
239     }
240     pg[0].setFont(av.getFont());
241     pg[0].translate(idWidth, 0);
242
243     // draw main sequence panel
244     pg[1].translate(idWidth, 0);
245     ap.getSeqPanel().seqCanvas.drawPanel(pg[1], startRes, endRes, startSeq,
246             endSeq, 0);
247     if (av.isShowAnnotation() && (endSeq == av.getAlignment().getHeight()))
248     {
249       // draw annotation label - need to offset for current scroll position
250       int offset = -ap.getAlabels().getScrollOffset();
251       pg[0].translate(0, offset);
252       pg[0].translate(-idWidth - 3,
253               (endSeq - startSeq) * av.getCharHeight() + 3);
254       ap.getAlabels().drawComponent(pg[0], idWidth);
255       pg[0].translate(idWidth + 3, 0);
256       pg[0].translate(0, -offset);
257
258       // draw annotation - need to offset for current scroll position
259       pg[1].translate(0, offset);
260       pg[1].translate(-idWidth - 3,
261               (endSeq - startSeq) * av.getCharHeight() + 3);
262       pg[1].translate(idWidth + 3, 0);
263       ap.getAnnotationPanel().renderer.drawComponent(
264               ap.getAnnotationPanel(), av, pg[1], -1, startRes, endRes + 1);
265       pg[1].translate(0, -offset);
266     }
267
268     return Printable.PAGE_EXISTS;
269   }
270   
271   private String getHtml(String titleSvg, String alignmentSvg,
272           String jsonData)
273   {
274     StringBuilder htmlSvg = new StringBuilder();
275     htmlSvg.append("<html>\n");
276     if (jsonData != null)
277     {
278       htmlSvg.append("<button onclick=\"javascipt:openJalviewUsingCurrentUrl();\">Launch in Jalview</button>");
279       htmlSvg.append("<input type=\"hidden\" name=\"seqData\" id=\"seqData\" value='"
280               + jsonData + "'>");
281     }
282     htmlSvg.append("\n<style type=\"text/css\"> "
283             + "div.parent{ width:100%;<!-- overflow: auto; -->}\n"
284             + "div.titlex{ width:11%; float: left; }\n"
285             + "div.align{ width:89%; float: right; }\n"
286             + ".sub-category-container {overflow-y: scroll; overflow-x: hidden; width: 100%; height: 100%;}\n"
287             + "object {pointer-events: none;}"
288             + "</style>");
289     htmlSvg.append("<div>");
290     htmlSvg.append(
291 "<div class=\"titlex\">");
292     htmlSvg.append(
293 "<div class=\"sub-category-container\"> ")
294             .append(titleSvg)
295             .append("</div>")
296             .append("</div>\n\n<!-- ========================================================================================== -->\n\n");
297     htmlSvg.append(
298 "<div class=\"align\" >");
299     htmlSvg.append(
300             "<div class=\"sub-category-container\"> <div style=\"overflow-x: scroll;\">")
301             .append(alignmentSvg)
302 .append("</div></div>")
303             .append("</div>");
304     htmlSvg.append("</div>");
305
306     htmlSvg.append("<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js\"></script>\n"
307             + "<script language=\"JavaScript\" type=\"text/javascript\"  src=\"//ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js\"></script>\n"
308             + "<script>\n"
309             + "var subCatContainer = $(\".sub-category-container\");\n"
310             + "subCatContainer.scroll(\nfunction() {\n"
311             + "subCatContainer.scrollTop($(this).scrollTop());\n});\n");
312
313     htmlSvg.append("</script>\n");
314
315     // javascript for launching file in Jalview
316
317     htmlSvg.append("<script language=\"JavaScript\">\n");
318     htmlSvg.append("function openJalviewUsingCurrentUrl(){\n");
319     htmlSvg.append("    var json = JSON.parse(document.getElementById(\"seqData\").value);\n");
320     htmlSvg.append("    var jalviewVersion = json['appSettings'].version;\n");
321     htmlSvg.append("    var url = json['appSettings'].webStartUrl;\n");
322     htmlSvg.append("    var myForm = document.createElement(\"form\");\n\n");
323     htmlSvg.append("    var heap = document.createElement(\"input\");\n");
324     htmlSvg.append("    heap.setAttribute(\"name\", \"jvm-max-heap\") ;\n");
325     htmlSvg.append("    heap.setAttribute(\"value\", \"2G\");\n\n");
326     htmlSvg.append("    var target = document.createElement(\"input\");\n");
327     htmlSvg.append("    target.setAttribute(\"name\", \"open\");\n");
328     htmlSvg.append("    target.setAttribute(\"value\", document.URL);\n\n");
329     htmlSvg.append("    var jvVersion = document.createElement(\"input\");\n");
330     htmlSvg.append("    jvVersion.setAttribute(\"name\", \"version\") ;\n");
331     htmlSvg.append("    jvVersion.setAttribute(\"value\", jalviewVersion);\n\n");
332     htmlSvg.append("    myForm.action = url;\n");
333     htmlSvg.append("    myForm.appendChild(heap);\n");
334     htmlSvg.append("    myForm.appendChild(target);\n");
335     htmlSvg.append("    myForm.appendChild(jvVersion);\n");
336     htmlSvg.append("    document.body.appendChild(myForm);\n");
337     htmlSvg.append("    myForm.submit() ;\n");
338     htmlSvg.append("    document.body.removeChild(myForm);\n");
339     htmlSvg.append("}\n");
340     htmlSvg.append("</script>\n");
341     htmlSvg.append("</hmtl>");
342     return htmlSvg.toString();
343   }
344 }