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