file format enum wip changes
[jalview.git] / src / jalview / io / HtmlSvgOutput.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
11  *  
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.
16  * 
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.
20  */
21 package jalview.io;
22
23 import jalview.api.AlignExportSettingI;
24 import jalview.api.FeatureRenderer;
25 import jalview.datamodel.AlignmentExportData;
26 import jalview.datamodel.SequenceI;
27 import jalview.gui.AlignViewport;
28 import jalview.gui.AlignmentPanel;
29 import jalview.gui.HTMLOptions;
30 import jalview.gui.IProgressIndicator;
31 import jalview.gui.OOMWarning;
32 import jalview.math.AlignmentDimension;
33 import jalview.util.MessageManager;
34
35 import java.awt.Color;
36 import java.awt.FontMetrics;
37 import java.awt.Graphics;
38 import java.awt.print.Printable;
39 import java.awt.print.PrinterException;
40 import java.io.File;
41 import java.io.FileOutputStream;
42
43 import org.jfree.graphics2d.svg.SVGGraphics2D;
44 import org.jfree.graphics2d.svg.SVGHints;
45
46 public class HtmlSvgOutput
47 {
48   AlignViewport av;
49
50   FeatureRenderer fr;
51
52   AlignmentPanel ap;
53
54   private IProgressIndicator pIndicator;
55
56   private long pSessionId;
57
58   private boolean headless;
59
60
61   public HtmlSvgOutput(File file, AlignmentPanel ap)
62   {
63     this.av = ap.av;
64     this.ap = ap;
65     fr = ap.cloneFeatureRenderer();
66     generateHtmlSvgOutput(file);
67   }
68
69   public void generateHtmlSvgOutput(File file)
70   {
71     pIndicator = ap.alignFrame;
72     pSessionId = System.currentTimeMillis();
73     try
74     {
75       headless = (System.getProperty("java.awt.headless") != null && System
76               .getProperty("java.awt.headless").equals("true"));
77       if (file == null)
78       {
79         setProgressMessage(MessageManager.formatMessage(
80                 "status.waiting_for_user_to_select_output_file", "HTML"));
81         JalviewFileChooser chooser = getHTMLChooser();
82         chooser.setFileView(new jalview.io.JalviewFileView());
83         chooser.setDialogTitle(ap.alignFrame.getTitle());
84         chooser.setToolTipText(MessageManager.getString("action.save"));
85         int value = chooser.showSaveDialog(ap.alignFrame);
86
87         if (value == jalview.io.JalviewFileChooser.APPROVE_OPTION)
88         {
89           jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
90                   .getSelectedFile().getParent());
91           file = chooser.getSelectedFile();
92           ap.alignFrame.repaint();
93         }
94         else
95         {
96           setProgressMessage(MessageManager.formatMessage(
97                   "status.cancelled_image_export_operation", "HTML"));
98           return;
99         }
100       }
101     } catch (Exception e)
102     {
103       pIndicator.setProgressBar(MessageManager.formatMessage(
104               "info.error_creating_file", "HTML"), pSessionId);
105       e.printStackTrace();
106       return;
107     }
108     final File fileX = file;
109     new Thread()
110     {
111       @Override
112       public void run()
113       {
114         try
115         {
116           setProgressMessage(null);
117           setProgressMessage(MessageManager.formatMessage(
118                   "status.exporting_alignment_as_x_file", "HTML"));
119           AlignmentDimension aDimension = ap.getAlignmentDimension();
120           SVGGraphics2D g1 = new SVGGraphics2D(aDimension.getWidth(),
121                   aDimension.getHeight());
122           SVGGraphics2D g2 = new SVGGraphics2D(aDimension.getWidth(),
123                   aDimension.getHeight());
124
125           String renderStyle = jalview.bin.Cache.getDefault(
126                   "HTML_RENDERING", "Prompt each time");
127
128           // If we need to prompt, and if the GUI is visible then
129           // Prompt for rendering style
130           if (renderStyle.equalsIgnoreCase("Prompt each time")
131                   && !(System.getProperty("java.awt.headless") != null && System
132                           .getProperty("java.awt.headless").equals("true")))
133           {
134             HTMLOptions svgOption = new HTMLOptions();
135             renderStyle = svgOption.getValue();
136
137             if (renderStyle == null || svgOption.cancelled)
138             {
139               setProgressMessage(MessageManager.formatMessage(
140                       "status.cancelled_image_export_operation", "HTML"));
141               return;
142             }
143           }
144
145           if (renderStyle.equalsIgnoreCase("Lineart"))
146           {
147             g1.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
148                     SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
149             g2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
150                     SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
151           }
152           printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
153                   g1, g2);
154
155           String titleSvgData = g1.getSVGDocument();
156           String alignSvgData = g2.getSVGDocument();
157           String jsonData = null;
158           boolean isEmbbedBioJSON = Boolean.valueOf(jalview.bin.Cache
159                   .getDefault("EXPORT_EMBBED_BIOJSON", "true"));
160           if (isEmbbedBioJSON)
161           {
162             AlignExportSettingI exportSettings = new AlignExportSettingI()
163             {
164               @Override
165               public boolean isExportHiddenSequences()
166               {
167                 return true;
168               }
169
170               @Override
171               public boolean isExportHiddenColumns()
172               {
173                 return true;
174               }
175
176               @Override
177               public boolean isExportAnnotations()
178               {
179                 return true;
180               }
181
182               @Override
183               public boolean isExportFeatures()
184               {
185                 return true;
186               }
187
188               @Override
189               public boolean isExportGroups()
190               {
191                 return true;
192               }
193
194               @Override
195               public boolean isCancelled()
196               {
197                 return false;
198               }
199
200             };
201             AlignmentExportData exportData = jalview.gui.AlignFrame
202                     .getAlignmentForExport(FileFormat.Json, av,
203                             exportSettings);
204             jsonData = new FormatAdapter(ap, exportData.getSettings())
205                     .formatSequences(FileFormat.Json,
206                             exportData.getAlignment(),
207                             exportData.getOmitHidden(),
208                             exportData.getStartEndPostions(),
209                             av.getColumnSelection());
210           }
211           String htmlData = getHtml(titleSvgData, alignSvgData, jsonData);
212           FileOutputStream out = new FileOutputStream(fileX);
213           out.write(htmlData.getBytes());
214           out.flush();
215           out.close();
216           if (!(System.getProperty("java.awt.headless") != null && System
217                   .getProperty("java.awt.headless").equals("true")))
218           {
219             jalview.util.BrowserLauncher.openURL("file:///" + fileX);
220           }
221         } catch (OutOfMemoryError err)
222         {
223           System.out.println("########################\n"
224                   + "OUT OF MEMORY " + fileX + "\n"
225                   + "########################");
226           new OOMWarning("Creating Image for " + fileX, err);
227         } catch (Exception e)
228         {
229           e.printStackTrace();
230           pIndicator.setProgressBar(MessageManager.formatMessage(
231                   "info.error_creating_file", "HTML"), pSessionId);
232         }
233         setProgressMessage(MessageManager.formatMessage(
234                 "status.export_complete", "HTML"));
235       }
236     }.start();
237
238   }
239
240   private void setProgressMessage(String message)
241   {
242     if (pIndicator != null && !headless)
243     {
244       pIndicator.setProgressBar(message, pSessionId);
245     }
246     else
247     {
248       System.out.println(message);
249     }
250   }
251
252   static JalviewFileChooser getHTMLChooser()
253   {
254     return new jalview.io.JalviewFileChooser(
255             jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
256             new String[] { "html" },
257             new String[] { "Hypertext Markup Language" },
258             "Hypertext Markup Language");
259   }
260
261   public int printUnwrapped(int pwidth, int pheight, int pi, Graphics... pg)
262           throws PrinterException
263   {
264     int idWidth = ap.getVisibleIdWidth(false);
265     FontMetrics fm = ap.getFontMetrics(av.getFont());
266     int scaleHeight = av.getCharHeight() + fm.getDescent();
267
268     pg[0].setColor(Color.white);
269     pg[0].fillRect(0, 0, pwidth, pheight);
270     pg[0].setFont(av.getFont());
271
272     // //////////////////////////////////
273     // / How many sequences and residues can we fit on a printable page?
274     int totalRes = (pwidth - idWidth) / av.getCharWidth();
275     int totalSeq = (pheight - scaleHeight) / av.getCharHeight() - 1;
276     int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;
277
278     // ///////////////////////////
279     // / Only print these sequences and residues on this page
280     int startRes;
281
282     // ///////////////////////////
283     // / Only print these sequences and residues on this page
284     int endRes;
285
286     // ///////////////////////////
287     // / Only print these sequences and residues on this page
288     int startSeq;
289
290     // ///////////////////////////
291     // / Only print these sequences and residues on this page
292     int endSeq;
293     startRes = (pi % pagesWide) * totalRes;
294     endRes = (startRes + totalRes) - 1;
295
296     if (endRes > (av.getAlignment().getWidth() - 1))
297     {
298       endRes = av.getAlignment().getWidth() - 1;
299     }
300     startSeq = (pi / pagesWide) * totalSeq;
301     endSeq = startSeq + totalSeq;
302     if (endSeq > av.getAlignment().getHeight())
303     {
304       endSeq = av.getAlignment().getHeight();
305     }
306     int pagesHigh = ((av.getAlignment().getHeight() / totalSeq) + 1)
307             * pheight;
308     if (av.isShowAnnotation())
309     {
310       pagesHigh += ap.getAnnotationPanel().adjustPanelHeight() + 3;
311     }
312     pagesHigh /= pheight;
313     if (pi >= (pagesWide * pagesHigh))
314     {
315       return Printable.NO_SUCH_PAGE;
316     }
317
318     // draw Scale
319     pg[1].translate(0, 0);
320     ap.getScalePanel().drawScale(pg[1], startRes, endRes, pwidth - idWidth,
321             scaleHeight);
322     pg[1].translate(-idWidth, scaleHeight);
323
324     // //////////////
325     // Draw the ids
326     Color currentColor = null;
327     Color currentTextColor = null;
328     pg[0].translate(0, scaleHeight);
329     pg[0].setFont(ap.getIdPanel().getIdCanvas().getIdfont());
330     SequenceI seq;
331     for (int i = startSeq; i < endSeq; i++)
332     {
333       seq = av.getAlignment().getSequenceAt(i);
334       if ((av.getSelectionGroup() != null)
335               && av.getSelectionGroup().getSequences(null).contains(seq))
336       {
337         currentColor = Color.gray;
338         currentTextColor = Color.black;
339       }
340       else
341       {
342         currentColor = av.getSequenceColour(seq);
343         currentTextColor = Color.black;
344       }
345       pg[0].setColor(currentColor);
346       pg[0].fillRect(0, (i - startSeq) * av.getCharHeight(), idWidth,
347               av.getCharHeight());
348       pg[0].setColor(currentTextColor);
349       int xPos = 0;
350       if (av.isRightAlignIds())
351       {
352         fm = pg[0].getFontMetrics();
353         xPos = idWidth
354                 - fm.stringWidth(seq.getDisplayId(av.getShowJVSuffix()))
355                 - 4;
356       }
357       pg[0].drawString(seq.getDisplayId(av.getShowJVSuffix()), xPos,
358               (((i - startSeq) * av.getCharHeight()) + av.getCharHeight())
359                       - (av.getCharHeight() / 5));
360     }
361     pg[0].setFont(av.getFont());
362     pg[0].translate(idWidth, 0);
363
364     // draw main sequence panel
365     pg[1].translate(idWidth, 0);
366     ap.getSeqPanel().seqCanvas.drawPanel(pg[1], startRes, endRes, startSeq,
367             endSeq, 0);
368     if (av.isShowAnnotation() && (endSeq == av.getAlignment().getHeight()))
369     {
370       // draw annotation label - need to offset for current scroll position
371       int offset = -ap.getAlabels().getScrollOffset();
372       pg[0].translate(0, offset);
373       pg[0].translate(-idWidth - 3,
374               (endSeq - startSeq) * av.getCharHeight() + 3);
375       ap.getAlabels().drawComponent(pg[0], idWidth);
376       pg[0].translate(idWidth + 3, 0);
377       pg[0].translate(0, -offset);
378
379       // draw annotation - need to offset for current scroll position
380       pg[1].translate(0, offset);
381       pg[1].translate(-idWidth - 3,
382               (endSeq - startSeq) * av.getCharHeight() + 3);
383       pg[1].translate(idWidth + 3, 0);
384       ap.getAnnotationPanel().renderer.drawComponent(
385               ap.getAnnotationPanel(), av, pg[1], -1, startRes, endRes + 1);
386       pg[1].translate(0, -offset);
387     }
388
389     return Printable.PAGE_EXISTS;
390   }
391
392   private String getHtml(String titleSvg, String alignmentSvg,
393           String jsonData)
394   {
395     StringBuilder htmlSvg = new StringBuilder();
396     htmlSvg.append("<html>\n");
397     if (jsonData != null)
398     {
399       htmlSvg.append("<button onclick=\"javascipt:openJalviewUsingCurrentUrl();\">Launch in Jalview</button> &nbsp;");
400       htmlSvg.append("<input type=\"submit\" value=\"View raw BioJSON Data\" onclick=\"jQuery.facebox({ div:'#seqData' }); return false;\" />");
401       htmlSvg.append("<div style=\"display: none;\" name=\"seqData\" id=\"seqData\" >"
402               + jsonData + "</div>");
403       htmlSvg.append("<br/>&nbsp;");
404     }
405     htmlSvg.append("\n<style type=\"text/css\"> "
406             + "div.parent{ width:100%;<!-- overflow: auto; -->}\n"
407             + "div.titlex{ width:11%; float: left; }\n"
408             + "div.align{ width:89%; float: right; }\n"
409             + "div.main-container{ border: 2px solid blue; border: 2px solid blue; width: 99%;   min-height: 99%; }\n"
410             + ".sub-category-container {overflow-y: scroll; overflow-x: hidden; width: 100%; height: 100%;}\n"
411             + "object {pointer-events: none;}");
412     if (jsonData != null)
413     {
414       // facebox style sheet for displaying raw BioJSON data
415       htmlSvg.append("#facebox { position: absolute;  top: 0;   left: 0; z-index: 100; text-align: left; }\n"
416               + "#facebox .popup{ position:relative; border:3px solid rgba(0,0,0,0); -webkit-border-radius:5px;"
417               + "-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);"
418               + "box-shadow:0 0 18px rgba(0,0,0,0.4); }\n"
419               + "#facebox .content { display:table; width: 98%; padding: 10px; background: #fff; -webkit-border-radius:4px; -moz-border-radius:4px;"
420               + " border-radius:4px; }\n"
421               + "#facebox .content > p:first-child{ margin-top:0; }\n"
422               + "#facebox .content > p:last-child{ margin-bottom:0; }\n"
423               + "#facebox .close{ position:absolute; top:5px; right:5px; padding:2px; background:#fff; }\n"
424               + "#facebox .close img{ opacity:0.3; }\n"
425               + "#facebox .close:hover img{ opacity:1.0; }\n"
426               + "#facebox .loading { text-align: center; }\n"
427               + "#facebox .image { text-align: center;}\n"
428               + "#facebox img { border: 0;  margin: 0; }\n"
429               + "#facebox_overlay { position: fixed; top: 0px; left: 0px; height:100%; width:100%; }\n"
430               + ".facebox_hide { z-index:-100; }\n"
431               + ".facebox_overlayBG { background-color: #000;  z-index: 99;  }");
432     }
433
434     htmlSvg.append("</style>");
435     htmlSvg.append("<div class=\"main-container\" \n>");
436     htmlSvg.append("<div class=\"titlex\">\n");
437     htmlSvg.append("<div class=\"sub-category-container\"> \n");
438     htmlSvg.append(titleSvg);
439     htmlSvg.append("</div>");
440     htmlSvg.append("</div>\n\n<!-- ========================================================================================== -->\n\n");
441     htmlSvg.append("<div class=\"align\" >");
442     htmlSvg.append(
443             "<div class=\"sub-category-container\"> <div style=\"overflow-x: scroll;\">")
444             .append(alignmentSvg).append("</div></div>").append("</div>");
445     htmlSvg.append("</div>");
446
447     htmlSvg.append("<script language=\"JavaScript\" type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js\"></script>\n"
448             + "<script language=\"JavaScript\" type=\"text/javascript\"  src=\"http://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js\"></script>\n"
449             + "<script>\n"
450             + "var subCatContainer = $(\".sub-category-container\");\n"
451             + "subCatContainer.scroll(\nfunction() {\n"
452             + "subCatContainer.scrollTop($(this).scrollTop());\n});\n");
453
454     htmlSvg.append("</script>\n");
455
456     // javascript for launching file in Jalview
457
458     htmlSvg.append("<script language=\"JavaScript\">\n");
459     htmlSvg.append("function openJalviewUsingCurrentUrl(){\n");
460     htmlSvg.append("    var json = JSON.parse(document.getElementById(\"seqData\").innerHTML);\n");
461     htmlSvg.append("    var jalviewVersion = json['appSettings'].version;\n");
462     htmlSvg.append("    var url = json['appSettings'].webStartUrl;\n");
463     htmlSvg.append("    var myForm = document.createElement(\"form\");\n\n");
464     htmlSvg.append("    var heap = document.createElement(\"input\");\n");
465     htmlSvg.append("    heap.setAttribute(\"name\", \"jvm-max-heap\") ;\n");
466     htmlSvg.append("    heap.setAttribute(\"value\", \"2G\");\n\n");
467     htmlSvg.append("    var target = document.createElement(\"input\");\n");
468     htmlSvg.append("    target.setAttribute(\"name\", \"open\");\n");
469     htmlSvg.append("    target.setAttribute(\"value\", document.URL);\n\n");
470     htmlSvg.append("    var jvVersion = document.createElement(\"input\");\n");
471     htmlSvg.append("    jvVersion.setAttribute(\"name\", \"version\") ;\n");
472     htmlSvg.append("    jvVersion.setAttribute(\"value\", jalviewVersion);\n\n");
473     htmlSvg.append("    myForm.action = url;\n");
474     htmlSvg.append("    myForm.appendChild(heap);\n");
475     htmlSvg.append("    myForm.appendChild(target);\n");
476     htmlSvg.append("    myForm.appendChild(jvVersion);\n");
477     htmlSvg.append("    document.body.appendChild(myForm);\n");
478     htmlSvg.append("    myForm.submit() ;\n");
479     htmlSvg.append("    document.body.removeChild(myForm);\n");
480     htmlSvg.append("}\n");
481
482     // jquery facebox for displaying raw BioJSON data");
483     if (jsonData != null)
484     {
485       htmlSvg.append("/* Facebox (for jQuery)\n");
486       htmlSvg.append("* version: 1.3\n");
487       htmlSvg.append(" * @requires jQuery v1.2 or later\n");
488       htmlSvg.append(" * @homepage https://github.com/defunkt/facebox\n");
489       htmlSvg.append(" * Licensed under the MIT:\n");
490       htmlSvg.append(" *   http://www.opensource.org/licenses/mit-license.php\n");
491       htmlSvg.append(" * Copyright Forever Chris Wanstrath, Kyle Neath\n");
492       htmlSvg.append(" * Usage:\n");
493       htmlSvg.append(" *  jQuery(document).ready(function() {\n");
494       htmlSvg.append(" *    jQuery('a[rel*=facebox]').facebox()\n");
495       htmlSvg.append(" *  })\n");
496       htmlSvg.append(" *  <a href=\"#terms\" rel=\"facebox\">Terms</a>\n");
497       htmlSvg.append(" *    Loads the #terms div in the box\n");
498       htmlSvg.append(" *  <a href=\"terms.html\" rel=\"facebox\">Terms</a>\n");
499       htmlSvg.append(" *    Loads the terms.html page in the box\n");
500       htmlSvg.append(" *  <a href=\"terms.png\" rel=\"facebox\">Terms</a>\n");
501       htmlSvg.append(" *    Loads the terms.png image in the box\n");
502       htmlSvg.append(" *  You can also use it programmatically:\n");
503       htmlSvg.append(" *    jQuery.facebox('some html')\n");
504       htmlSvg.append(" *    jQuery.facebox('some html', 'my-groovy-style')\n");
505       htmlSvg.append(" *  The above will open a facebox with \"some html\" as the content.\n");
506       htmlSvg.append(" *    jQuery.facebox(function($) {\n");
507       htmlSvg.append(" *      $.get('blah.html', function(data) { $.facebox(data) })\n");
508       htmlSvg.append(" *    })\n");
509       htmlSvg.append(" *  The above will show a loading screen before the passed function is called,\n");
510       htmlSvg.append(" *  allowing for a better ajaxy experience.\n");
511       htmlSvg.append(" *  The facebox function can also display an ajax page, an image, or the contents of a div:\n");
512       htmlSvg.append(" *    jQuery.facebox({ ajax: 'remote.html' })\n");
513       htmlSvg.append(" *    jQuery.facebox({ ajax: 'remote.html' }, 'my-groovy-style')\n");
514       htmlSvg.append(" *    jQuery.facebox({ image: 'stairs.jpg' })\n");
515       htmlSvg.append(" *    jQuery.facebox({ image: 'stairs.jpg' }, 'my-groovy-style')\n");
516       htmlSvg.append(" *    jQuery.facebox({ div: '#box' })\n");
517       htmlSvg.append(" *    jQuery.facebox({ div: '#box' }, 'my-groovy-style')\n");
518       htmlSvg.append(" *    Want to close the facebox?  Trigger the 'close.facebox' document event:\n");
519       htmlSvg.append(" *    jQuery(document).trigger('close.facebox')\n");
520       htmlSvg.append(" *  Facebox also has a bunch of other hooks:\n");
521       htmlSvg.append(" *    loading.facebox\n");
522       htmlSvg.append(" *    beforeReveal.facebox\n");
523       htmlSvg.append(" *    reveal.facebox (aliased as 'afterReveal.facebox')\n");
524       htmlSvg.append(" *    init.facebox\n");
525       htmlSvg.append(" *    afterClose.facebox\n");
526       htmlSvg.append(" *  Simply bind a function to any of these hooks:\n");
527       htmlSvg.append(" *   $(document).bind('reveal.facebox', function() { ...stuff to do after the facebox and contents are revealed... })\n");
528       htmlSvg.append(" *\n");
529       htmlSvg.append(" */\n");
530       htmlSvg.append("(function($) {\n");
531       htmlSvg.append("  $.facebox = function(data, klass) {\n");
532       htmlSvg.append("    $.facebox.loading()\n");
533       htmlSvg.append("    if (data.ajax) fillFaceboxFromAjax(data.ajax, klass)\n");
534       htmlSvg.append("    else if (data.image) fillFaceboxFromImage(data.image, klass)\n");
535       htmlSvg.append("    else if (data.div) fillFaceboxFromHref(data.div, klass)\n");
536       htmlSvg.append("    else if ($.isFunction(data)) data.call($)\n");
537       htmlSvg.append("    else $.facebox.reveal(data, klass)\n");
538       htmlSvg.append("  }\n");
539
540       htmlSvg.append("  $.extend($.facebox, {\n");
541       htmlSvg.append("    settings: {\n");
542       htmlSvg.append("      opacity      : 0.2,\n");
543       htmlSvg.append("      overlay      : true,\n");
544       htmlSvg.append("      loadingImage : 'https://raw.githubusercontent.com/jalview/biojson/gh-pages/images/loading.gif',\n");
545       htmlSvg.append("      closeImage   : 'https://raw.githubusercontent.com/jalview/biojson/gh-pages/images/cancel.png',\n");
546       htmlSvg.append("      imageTypes   : [ 'png', 'jpg', 'jpeg', 'gif' ],\n");
547       htmlSvg.append("      faceboxHtml  : '<div  id=\"facebox\" style=\"display:none; width: 95%; height: 85%; overflow: auto;\"> ");
548       htmlSvg.append("      <div class=\"popup\"> ");
549       htmlSvg.append("        <div class=\"content\"> ");
550       htmlSvg.append("        </div> ");
551       htmlSvg.append("        <a href=\"#\" class=\"close\"></a> ");
552       htmlSvg.append("      </div> ");
553       htmlSvg.append("    </div>'\n");
554       htmlSvg.append("    },      \n");
555       htmlSvg.append("    loading: function() {\n");
556       htmlSvg.append("      init()\n");
557       htmlSvg.append("      if ($('#facebox .loading').length == 1) return true\n");
558       htmlSvg.append("      showOverlay()      \n");
559       htmlSvg.append("      $('#facebox .content').empty().\n");
560       htmlSvg.append("        append('<div class=\"loading\"><img src=\"'+$.facebox.settings.loadingImage+'\"/></div>')\n");
561       htmlSvg.append("      $('#facebox').show().css({\n");
562       htmlSvg.append("        top:    getPageScroll()[1] + (getPageHeight() / 10),\n");
563       htmlSvg.append("        left:    $(window).width() / 2 - ($('#facebox .popup').outerWidth() / 2)\n");
564       htmlSvg.append("      })      \n");
565       htmlSvg.append("      $(document).bind('keydown.facebox', function(e) {\n");
566       htmlSvg.append("       if (e.keyCode == 27) $.facebox.close()\n");
567       htmlSvg.append("        return true\n");
568       htmlSvg.append("      })\n");
569       htmlSvg.append("      $(document).trigger('loading.facebox')\n");
570       htmlSvg.append("    },\n");
571       htmlSvg.append("    reveal: function(data, klass) {\n");
572       htmlSvg.append("      $(document).trigger('beforeReveal.facebox')\n");
573       htmlSvg.append("      if (klass) $('#facebox .content').addClass(klass)\n");
574       htmlSvg.append("      $('#facebox .content').empty().append('<pre><code>'+JSON.stringify(JSON.parse(data),null,4)+'</pre></code>')\n");
575       htmlSvg.append("      $('#facebox .popup').children().fadeIn('normal')\n");
576       htmlSvg.append("      $('#facebox').css('left', $(window).width() / 2 - ($('#facebox .popup').outerWidth() / 2))\n");
577       htmlSvg.append("      $(document).trigger('reveal.facebox').trigger('afterReveal.facebox')\n");
578       htmlSvg.append("    },      \n");
579       htmlSvg.append("    close: function() {\n");
580       htmlSvg.append("      $(document).trigger('close.facebox')\n");
581       htmlSvg.append("      return false\n");
582       htmlSvg.append("    }\n");
583       htmlSvg.append("  })\n");
584       htmlSvg.append("  $.fn.facebox = function(settings) {\n");
585       htmlSvg.append("    if ($(this).length == 0) return    \n");
586       htmlSvg.append("    init(settings)      \n");
587       htmlSvg.append("    function clickHandler() {\n");
588       htmlSvg.append("      $.facebox.loading(true)      \n");
589       htmlSvg.append("      // support for rel=\"facebox.inline_popup\" syntax, to add a class\n");
590       htmlSvg.append("      // also supports deprecated \"facebox[.inline_popup]\" syntax\n");
591       htmlSvg.append("      var klass = this.rel.match(/facebox\\[?\\.(\\w+)\\]?/)\n");
592       htmlSvg.append("      if (klass) klass = klass[1]\n");
593       htmlSvg.append("      fillFaceboxFromHref(this.href, klass)\n");
594       htmlSvg.append("      return false\n");
595       htmlSvg.append("    }      \n");
596       htmlSvg.append("    return this.bind('click.facebox', clickHandler)\n");
597       htmlSvg.append("  }\n");
598       htmlSvg.append("  // called one time to setup facebox on this page\n");
599       htmlSvg.append("  function init(settings) {\n");
600       htmlSvg.append("    if ($.facebox.settings.inited) return true\n");
601       htmlSvg.append("    else $.facebox.settings.inited = true\n");
602       htmlSvg.append("    $(document).trigger('init.facebox')\n");
603       htmlSvg.append("    makeCompatible()\n");
604       htmlSvg.append("    var imageTypes = $.facebox.settings.imageTypes.join('|')\n");
605       htmlSvg.append("    $.facebox.settings.imageTypesRegexp = new RegExp('\\\\.(' + imageTypes + ')(\\\\?.*)?$', 'i')\n");
606
607       htmlSvg.append("    if (settings) $.extend($.facebox.settings, settings)\n");
608       htmlSvg.append("    $('body').append($.facebox.settings.faceboxHtml)\n");
609
610       htmlSvg.append("    var preload = [ new Image(), new Image() ]\n");
611       htmlSvg.append("    preload[0].src = $.facebox.settings.closeImage\n");
612       htmlSvg.append("    preload[1].src = $.facebox.settings.loadingImage\n");
613
614       htmlSvg.append("    $('#facebox').find('.b:first, .bl').each(function() {\n");
615       htmlSvg.append("      preload.push(new Image())\n");
616       htmlSvg.append("      preload.slice(-1).src = $(this).css('background-image').replace(/url\\((.+)\\)/, '$1')\n");
617       htmlSvg.append("    })\n");
618
619       htmlSvg.append("    $('#facebox .close')\n");
620       htmlSvg.append("      .click($.facebox.close)\n");
621       htmlSvg.append("      .append('<img src=\"'\n");
622       htmlSvg.append("              + $.facebox.settings.closeImage\n");
623       htmlSvg.append("              + '\" class=\"close_image\" title=\"close\">')\n");
624       htmlSvg.append("  }\n");
625
626       htmlSvg.append("  // getPageScroll() by quirksmode.com\n");
627       htmlSvg.append("  function getPageScroll() {\n");
628       htmlSvg.append("    var xScroll, yScroll;\n");
629       htmlSvg.append("    if (self.pageYOffset) {\n");
630       htmlSvg.append("      yScroll = self.pageYOffset;\n");
631       htmlSvg.append("      xScroll = self.pageXOffset;\n");
632       htmlSvg.append("    } else if (document.documentElement && document.documentElement.scrollTop) {     // Explorer 6 Strict\n");
633       htmlSvg.append("      yScroll = document.documentElement.scrollTop;\n");
634       htmlSvg.append("      xScroll = document.documentElement.scrollLeft;\n");
635       htmlSvg.append("    } else if (document.body) {// all other Explorers\n");
636       htmlSvg.append("      yScroll = document.body.scrollTop;\n");
637       htmlSvg.append("      xScroll = document.body.scrollLeft;\n");
638       htmlSvg.append("    }\n");
639       htmlSvg.append("    return new Array(xScroll,yScroll)\n");
640       htmlSvg.append("  }\n");
641
642       // Adapted from getPageSize() by quirksmode.com");
643       htmlSvg.append("  function getPageHeight() {\n");
644       htmlSvg.append("    var windowHeight\n");
645       htmlSvg.append("    if (self.innerHeight) {    // all except Explorer\n");
646       htmlSvg.append("      windowHeight = self.innerHeight;\n");
647       htmlSvg.append("    } else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode\n");
648       htmlSvg.append("      windowHeight = document.documentElement.clientHeight;\n");
649       htmlSvg.append("    } else if (document.body) { // other Explorers\n");
650       htmlSvg.append("      windowHeight = document.body.clientHeight;\n");
651       htmlSvg.append("    }\n");
652       htmlSvg.append("    return windowHeight\n");
653       htmlSvg.append("  }\n");
654
655       htmlSvg.append("  // Backwards compatibility\n");
656       htmlSvg.append("  function makeCompatible() {\n");
657       htmlSvg.append("    var $s = $.facebox.settings      \n");
658       htmlSvg.append("    $s.loadingImage = $s.loading_image || $s.loadingImage\n");
659       htmlSvg.append("    $s.closeImage = $s.close_image || $s.closeImage\n");
660       htmlSvg.append("    $s.imageTypes = $s.image_types || $s.imageTypes\n");
661       htmlSvg.append("    $s.faceboxHtml = $s.facebox_html || $s.faceboxHtml\n");
662       htmlSvg.append("  }\n");
663
664       htmlSvg.append("  // Figures out what you want to display and displays it\n");
665       htmlSvg.append("  // formats are:\n");
666       htmlSvg.append("  //     div: #id\n");
667       htmlSvg.append("  //   image: blah.extension\n");
668       htmlSvg.append("  //    ajax: anything else\n");
669       htmlSvg.append("  function fillFaceboxFromHref(href, klass) {\n");
670       htmlSvg.append("    // div\n");
671       htmlSvg.append("    if (href.match(/#/)) {\n");
672       htmlSvg.append("      var url    = window.location.href.split('#')[0]\n");
673       htmlSvg.append("      var target = href.replace(url,'')\n");
674       htmlSvg.append("      if (target == '#') return\n");
675       htmlSvg.append("      $.facebox.reveal($(target).html(), klass)\n");
676
677       htmlSvg.append("    // image\n");
678       htmlSvg.append("    } else if (href.match($.facebox.settings.imageTypesRegexp)) {\n");
679       htmlSvg.append("      fillFaceboxFromImage(href, klass)\n");
680       htmlSvg.append("    // ajax\n");
681       htmlSvg.append("    } else {\n");
682       htmlSvg.append("      fillFaceboxFromAjax(href, klass)\n");
683       htmlSvg.append("    }\n");
684       htmlSvg.append("  }\n");
685
686       htmlSvg.append("  function fillFaceboxFromImage(href, klass) {\n");
687       htmlSvg.append("    var image = new Image()\n");
688       htmlSvg.append("    image.onload = function() {\n");
689       htmlSvg.append("      $.facebox.reveal('<div class=\"image\"><img src=\"' + image.src + '\" /></div>', klass)\n");
690       htmlSvg.append("    }\n");
691       htmlSvg.append("    image.src = href\n");
692       htmlSvg.append("   }\n");
693
694       htmlSvg.append("  function fillFaceboxFromAjax(href, klass) {\n");
695       htmlSvg.append("    $.facebox.jqxhr = $.get(href, function(data) { $.facebox.reveal(data, klass) })\n");
696       htmlSvg.append("  }\n");
697
698       htmlSvg.append("  function skipOverlay() {\n");
699       htmlSvg.append("    return $.facebox.settings.overlay == false || $.facebox.settings.opacity === null\n");
700       htmlSvg.append("  }\n");
701
702       htmlSvg.append("  function showOverlay() {\n");
703       htmlSvg.append("    if (skipOverlay()) return\n");
704
705       htmlSvg.append("    if ($('#facebox_overlay').length == 0)\n");
706       htmlSvg.append("      $(\"body\").append('<div id=\"facebox_overlay\" class=\"facebox_hide\"></div>')\n");
707
708       htmlSvg.append("    $('#facebox_overlay').hide().addClass(\"facebox_overlayBG\")\n");
709       htmlSvg.append("      .css('opacity', $.facebox.settings.opacity)\n");
710       htmlSvg.append("      .click(function() { $(document).trigger('close.facebox') })\n");
711       htmlSvg.append("       .fadeIn(200)\n");
712       htmlSvg.append("    return false\n");
713       htmlSvg.append("  }\n");
714
715       htmlSvg.append("  function hideOverlay() {\n");
716       htmlSvg.append("    if (skipOverlay()) return      \n");
717       htmlSvg.append("    $('#facebox_overlay').fadeOut(200, function(){\n");
718       htmlSvg.append("      $(\"#facebox_overlay\").removeClass(\"facebox_overlayBG\")\n");
719       htmlSvg.append("      $(\"#facebox_overlay\").addClass(\"facebox_hide\")\n");
720       htmlSvg.append("      $(\"#facebox_overlay\").remove()\n");
721       htmlSvg.append("    })      \n");
722       htmlSvg.append("    return false\n");
723       htmlSvg.append("  }\n");
724
725       htmlSvg.append("  $(document).bind('close.facebox', function() {\n");
726       htmlSvg.append("    if ($.facebox.jqxhr) {\n");
727       htmlSvg.append("      $.facebox.jqxhr.abort()\n");
728       htmlSvg.append("      $.facebox.jqxhr = null\n");
729       htmlSvg.append("    }\n");
730       htmlSvg.append("    $(document).unbind('keydown.facebox')\n");
731       htmlSvg.append("    $('#facebox').fadeOut(function() {\n");
732       htmlSvg.append("      $('#facebox .content').removeClass().addClass('content')\n");
733       htmlSvg.append("      $('#facebox .loading').remove()\n");
734       htmlSvg.append("      $(document).trigger('afterClose.facebox')\n");
735       htmlSvg.append("    })\n");
736       htmlSvg.append("    hideOverlay()\n");
737       htmlSvg.append("  })\n");
738
739       htmlSvg.append("})(jQuery);\n");
740
741     }
742
743     htmlSvg.append("</script>\n");
744     htmlSvg.append("</html>");
745     return htmlSvg.toString();
746   }
747 }