src/jalview/gui/AlignmentPanel.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.gui;
  22
  23 import java.awt.BorderLayout;
  24 import java.awt.Color;
  25 import java.awt.Container;
  26 import java.awt.Dimension;
  27 import java.awt.Font;
  28 import java.awt.FontMetrics;
  29 import java.awt.Graphics;
  30 import java.awt.Graphics2D;
  31 import java.awt.event.AdjustmentEvent;
  32 import java.awt.event.AdjustmentListener;
  33 import java.awt.event.ComponentAdapter;
  34 import java.awt.event.ComponentEvent;
  35 import java.awt.print.PageFormat;
  36 import java.awt.print.Printable;
  37 import java.awt.print.PrinterException;
  38 import java.beans.PropertyChangeEvent;
  39 import java.beans.PropertyChangeListener;
  40 import java.io.File;
  41 import java.io.FileWriter;
  42 import java.io.PrintWriter;
  43 import java.util.List;
  44
  45 import javax.swing.SwingUtilities;
  46
  47 import jalview.analysis.AnnotationSorter;
  48 import jalview.api.AlignViewportI;
  49 import jalview.api.AlignmentViewPanel;
  50 import jalview.bin.Cache;
  51 import jalview.bin.Console;
  52 import jalview.bin.Jalview;
  53 import jalview.datamodel.AlignmentAnnotation;
  54 import jalview.datamodel.AlignmentI;
  55 import jalview.datamodel.HiddenColumns;
  56 import jalview.datamodel.SearchResultsI;
  57 import jalview.datamodel.SequenceFeature;
  58 import jalview.datamodel.SequenceGroup;
  59 import jalview.datamodel.SequenceI;
  60 import jalview.gui.ImageExporter.ImageWriterI;
  61 import jalview.io.HTMLOutput;
  62 import jalview.io.exceptions.ImageOutputException;
  63 import jalview.jbgui.GAlignmentPanel;
  64 import jalview.math.AlignmentDimension;
  65 import jalview.schemes.ResidueProperties;
  66 import jalview.structure.StructureSelectionManager;
  67 import jalview.util.Comparison;
  68 import jalview.util.ImageMaker;
  69 import jalview.util.MessageManager;
  70 import jalview.util.imagemaker.BitmapImageSizing;
  71 import jalview.viewmodel.ViewportListenerI;
  72 import jalview.viewmodel.ViewportRanges;
  73
  74 /**
  75  * DOCUMENT ME!
  76  *
  77  * @author $author$
  78  * @version $Revision: 1.161 $
  79  */
  80 @SuppressWarnings("serial")
  81 public class AlignmentPanel extends GAlignmentPanel implements
  82         AdjustmentListener, Printable, AlignmentViewPanel, ViewportListenerI
  83 {
  84   /*
  85    * spare space in pixels between sequence id and alignment panel
  86    */
  87   private static final int ID_WIDTH_PADDING = 4;
  88
  89   public AlignViewport av;
  90
  91   OverviewPanel overviewPanel;
  92
  93   private SeqPanel seqPanel;
  94
  95   private IdPanel idPanel;
  96
  97   IdwidthAdjuster idwidthAdjuster;
  98
  99   public AlignFrame alignFrame;
 100
 101   private ScalePanel scalePanel;
 102
 103   private AnnotationPanel annotationPanel;
 104
 105   private AnnotationLabels alabels;
 106
 107   private int hextent = 0;
 108
 109   private int vextent = 0;
 110
 111   /*
 112    * Flag set while scrolling to follow complementary cDNA/protein scroll. When
 113    * false, suppresses invoking the same method recursively.
 114    */
 115   private boolean scrollComplementaryPanel = true;
 116
 117   private PropertyChangeListener propertyChangeListener;
 118
 119   private CalculationChooser calculationDialog;
 120
 121   /**
 122    * Creates a new AlignmentPanel object.
 123    *
 124    * @param af
 125    * @param av
 126    */
 127   public AlignmentPanel(AlignFrame af, final AlignViewport av)
 128   {
 129     // setBackground(Color.white); // BH 2019
 130     alignFrame = af;
 131     this.av = av;
 132     setSeqPanel(new SeqPanel(av, this));
 133     setIdPanel(new IdPanel(av, this));
 134
 135     setScalePanel(new ScalePanel(av, this));
 136
 137     idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
 138     idwidthAdjuster = new IdwidthAdjuster(this);
 139     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
 140
 141     setAnnotationPanel(new AnnotationPanel(this));
 142     setAlabels(new AnnotationLabels(this));
 143
 144     annotationScroller.setViewportView(getAnnotationPanel());
 145     annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
 146
 147     scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
 148     seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
 149
 150     setScrollValues(0, 0);
 151
 152     hscroll.addAdjustmentListener(this);
 153     vscroll.addAdjustmentListener(this);
 154
 155     addComponentListener(new ComponentAdapter()
 156     {
 157       @Override
 158       public void componentResized(ComponentEvent evt)
 159       {
 160         // reset the viewport ranges when the alignment panel is resized
 161         // in particular, this initialises the end residue value when Jalview
 162         // is initialised
 163         ViewportRanges ranges = av.getRanges();
 164         if (av.getWrapAlignment())
 165         {
 166           int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
 167                   getSeqPanel().seqCanvas.getWidth());
 168           ranges.setViewportWidth(widthInRes);
 169         }
 170         else
 171         {
 172           int widthInRes = getSeqPanel().seqCanvas.getWidth()
 173                   / av.getCharWidth();
 174           int heightInSeq = getSeqPanel().seqCanvas.getHeight()
 175                   / av.getCharHeight();
 176
 177           ranges.setViewportWidth(widthInRes);
 178           ranges.setViewportHeight(heightInSeq);
 179         }
 180       }
 181
 182     });
 183
 184     final AlignmentPanel ap = this;
 185     propertyChangeListener = new PropertyChangeListener()
 186     {
 187       @Override
 188       public void propertyChange(PropertyChangeEvent evt)
 189       {
 190         if (evt.getPropertyName().equals("alignment"))
 191         {
 192           PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
 193           alignmentChanged();
 194         }
 195       }
 196     };
 197     av.addPropertyChangeListener(propertyChangeListener);
 198
 199     av.getRanges().addPropertyChangeListener(this);
 200     fontChanged();
 201     adjustAnnotationHeight();
 202     updateLayout();
 203   }
 204
 205   @Override
 206   public AlignViewportI getAlignViewport()
 207   {
 208     return av;
 209   }
 210
 211   public void alignmentChanged()
 212   {
 213     av.alignmentChanged(this);
 214
 215     if (getCalculationDialog() != null)
 216     {
 217       getCalculationDialog().validateCalcTypes();
 218     }
 219
 220     alignFrame.updateEditMenuBar();
 221
 222     // no idea if we need to update structure
 223     paintAlignment(true, true);
 224
 225   }
 226
 227   /**
 228    * DOCUMENT ME!
 229    */
 230   public void fontChanged()
 231   {
 232     // set idCanvas bufferedImage to null
 233     // to prevent drawing old image
 234     FontMetrics fm = getFontMetrics(av.getFont());
 235
 236     // update the flag controlling whether the grid is too small to render the
 237     // font
 238     av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
 239
 240     scalePanelHolder.setPreferredSize(
 241             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 242     idSpaceFillerPanel1.setPreferredSize(
 243             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 244     idwidthAdjuster.invalidate();
 245     scalePanelHolder.invalidate();
 246     // BH 2018 getIdPanel().getIdCanvas().gg = null;
 247     getSeqPanel().seqCanvas.img = null;
 248     getAnnotationPanel().adjustPanelHeight();
 249
 250     Dimension d = calculateIdWidth();
 251     getIdPanel().getIdCanvas().setPreferredSize(d);
 252     hscrollFillerPanel.setPreferredSize(d);
 253
 254     repaint();
 255   }
 256
 257   /**
 258    * Calculates the width of the alignment labels based on the displayed names
 259    * and any bounds on label width set in preferences. The calculated width is
 260    * also set as a property of the viewport.
 261    *
 262    * @return Dimension giving the maximum width of the alignment label panel
 263    *         that should be used.
 264    */
 265   public Dimension calculateIdWidth()
 266   {
 267     int oldWidth = av.getIdWidth();
 268
 269     // calculate sensible default width when no preference is available
 270     Dimension r = null;
 271     if (av.getIdWidth() < 0)
 272     {
 273       r = calculateDefaultAlignmentIdWidth();
 274       av.setIdWidth(r.width);
 275     }
 276     else
 277     {
 278       r = new Dimension();
 279       r.width = av.getIdWidth();
 280       r.height = 0;
 281     }
 282
 283     /*
 284      * fudge: if desired width has changed, update layout
 285      * (see also paintComponent - updates layout on a repaint)
 286      */
 287     if (r.width != oldWidth)
 288     {
 289       idPanelHolder.setPreferredSize(r);
 290       validate();
 291     }
 292     return r;
 293   }
 294
 295   public Dimension calculateDefaultAlignmentIdWidth()
 296   {
 297     int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
 298     int idWidth = Math.min(afwidth - 200, 2 * afwidth / 3);
 299     int maxwidth = Math.max(IdwidthAdjuster.MIN_ID_WIDTH, idWidth);
 300     return calculateIdWidth(-1, false, false);
 301   }
 302
 303   /**
 304    * Calculate the width of the alignment labels based on the displayed names
 305    * and any bounds on label width set in preferences.
 306    *
 307    * @param maxwidth
 308    *          -1 or maximum width allowed for IdWidth
 309    * @return Dimension giving the maximum width of the alignment label panel
 310    *         that should be used.
 311    */
 312   protected Dimension calculateIdWidth(int maxwidth)
 313   {
 314     return calculateIdWidth(maxwidth, true, false);
 315   }
 316
 317   public Dimension calculateIdWidth(int maxwidth,
 318           boolean includeAnnotations, boolean visibleOnly)
 319   {
 320     Container c = new Container();
 321
 322     FontMetrics fm = c.getFontMetrics(
 323             new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
 324
 325     AlignmentI al = av.getAlignment();
 326     int i = 0;
 327     int idWidth = 0;
 328
 329     while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
 330     {
 331       SequenceI s = al.getSequenceAt(i);
 332       String id = s.getDisplayId(av.getShowJVSuffix());
 333       int stringWidth = fm.stringWidth(id);
 334       idWidth = Math.max(idWidth, stringWidth);
 335       i++;
 336     }
 337
 338     // Also check annotation label widths
 339     if (includeAnnotations && al.getAlignmentAnnotation() != null)
 340     {
 341       if (Jalview.isHeadlessMode())
 342       {
 343         AnnotationLabels aal = this.getAlabels();
 344         int stringWidth = aal.drawLabels(null, false, idWidth, false, fm);
 345         idWidth = Math.max(idWidth, stringWidth);
 346       }
 347       else
 348       {
 349         fm = c.getFontMetrics(getAlabels().getFont());
 350
 351         for (i = 0; i < al.getAlignmentAnnotation().length; i++)
 352         {
 353           AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
 354           if (visibleOnly && !aa.visible)
 355           {
 356             continue;
 357           }
 358           String label = aa.label;
 359           int stringWidth = fm.stringWidth(label);
 360           idWidth = Math.max(idWidth, stringWidth);
 361         }
 362       }
 363     }
 364
 365     int w = maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth);
 366     w += ID_WIDTH_PADDING;
 367
 368     return new Dimension(w, 12);
 369   }
 370
 371   /**
 372    * Highlight the given results on the alignment
 373    *
 374    */
 375   public void highlightSearchResults(SearchResultsI results)
 376   {
 377     boolean scrolled = scrollToPosition(results, 0, false);
 378
 379     boolean fastPaint = !(scrolled && av.getWrapAlignment());
 380
 381     getSeqPanel().seqCanvas.highlightSearchResults(results, fastPaint);
 382   }
 383
 384   /**
 385    * Scroll the view to show the position of the highlighted region in results
 386    * (if any)
 387    *
 388    * @param searchResults
 389    * @return
 390    */
 391   public boolean scrollToPosition(SearchResultsI searchResults)
 392   {
 393     return scrollToPosition(searchResults, 0, false);
 394   }
 395
 396   /**
 397    * Scrolls the view (if necessary) to show the position of the first
 398    * highlighted region in results (if any). Answers true if the view was
 399    * scrolled, or false if no matched region was found, or it is already
 400    * visible.
 401    *
 402    * @param results
 403    * @param verticalOffset
 404    *          if greater than zero, allows scrolling to a position below the
 405    *          first displayed sequence
 406    * @param centre
 407    *          if true, try to centre the search results horizontally in the view
 408    * @return
 409    */
 410   protected boolean scrollToPosition(SearchResultsI results,
 411           int verticalOffset, boolean centre)
 412   {
 413     int startv, endv, starts, ends;
 414     ViewportRanges ranges = av.getRanges();
 415
 416     if (results == null || results.isEmpty() || av == null
 417             || av.getAlignment() == null)
 418     {
 419       return false;
 420     }
 421     int seqIndex = av.getAlignment().findIndex(results);
 422     if (seqIndex == -1)
 423     {
 424       return false;
 425     }
 426     SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
 427
 428     int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
 429     if (r == null)
 430     {
 431       return false;
 432     }
 433     int start = r[0];
 434     int end = r[1];
 435
 436     /*
 437      * To centre results, scroll to positions half the visible width
 438      * left/right of the start/end positions
 439      */
 440     if (centre)
 441     {
 442       int offset = (ranges.getEndRes() - ranges.getStartRes() + 1) / 2 - 1;
 443       start = Math.max(start - offset, 0);
 444       end = end + offset - 1;
 445     }
 446     if (start < 0)
 447     {
 448       return false;
 449     }
 450     if (end == seq.getEnd())
 451     {
 452       return false;
 453     }
 454
 455     if (av.hasHiddenColumns())
 456     {
 457       HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 458       start = hidden.absoluteToVisibleColumn(start);
 459       end = hidden.absoluteToVisibleColumn(end);
 460       if (start == end)
 461       {
 462         if (!hidden.isVisible(r[0]))
 463         {
 464           // don't scroll - position isn't visible
 465           return false;
 466         }
 467       }
 468     }
 469
 470     /*
 471      * allow for offset of target sequence (actually scroll to one above it)
 472      */
 473     seqIndex = Math.max(0, seqIndex - verticalOffset);
 474     boolean scrollNeeded = true;
 475
 476     if (!av.getWrapAlignment())
 477     {
 478       if ((startv = ranges.getStartRes()) >= start)
 479       {
 480         /*
 481          * Scroll left to make start of search results visible
 482          */
 483         setScrollValues(start, seqIndex);
 484       }
 485       else if ((endv = ranges.getEndRes()) <= end)
 486       {
 487         /*
 488          * Scroll right to make end of search results visible
 489          */
 490         setScrollValues(startv + end - endv, seqIndex);
 491       }
 492       else if ((starts = ranges.getStartSeq()) > seqIndex)
 493       {
 494         /*
 495          * Scroll up to make start of search results visible
 496          */
 497         setScrollValues(ranges.getStartRes(), seqIndex);
 498       }
 499       else if ((ends = ranges.getEndSeq()) <= seqIndex)
 500       {
 501         /*
 502          * Scroll down to make end of search results visible
 503          */
 504         setScrollValues(ranges.getStartRes(), starts + seqIndex - ends + 1);
 505       }
 506       /*
 507        * Else results are already visible - no need to scroll
 508        */
 509       scrollNeeded = false;
 510     }
 511     else
 512     {
 513       scrollNeeded = ranges.scrollToWrappedVisible(start);
 514     }
 515
 516     paintAlignment(false, false);
 517
 518     return scrollNeeded;
 519   }
 520
 521   /**
 522    * DOCUMENT ME!
 523    *
 524    * @return DOCUMENT ME!
 525    */
 526   public OverviewPanel getOverviewPanel()
 527   {
 528     return overviewPanel;
 529   }
 530
 531   /**
 532    * DOCUMENT ME!
 533    *
 534    * @param op
 535    *          DOCUMENT ME!
 536    */
 537   public void setOverviewPanel(OverviewPanel op)
 538   {
 539     overviewPanel = op;
 540   }
 541
 542   /**
 543    *
 544    * @param b
 545    *          Hide or show annotation panel
 546    *
 547    */
 548   public void setAnnotationVisible(boolean b)
 549   {
 550     if (!av.getWrapAlignment())
 551     {
 552       annotationSpaceFillerHolder.setVisible(b);
 553       annotationScroller.setVisible(b);
 554     }
 555     repaint();
 556   }
 557
 558   /**
 559    * automatically adjust annotation panel height for new annotation whilst
 560    * ensuring the alignment is still visible.
 561    */
 562   @Override
 563   public void adjustAnnotationHeight()
 564   {
 565     // TODO: display vertical annotation scrollbar if necessary
 566     // this is called after loading new annotation onto alignment
 567     if (alignFrame.getHeight() == 0)
 568     {
 569       jalview.bin.Console.outPrintln("NEEDS FIXING");
 570     }
 571     validateAnnotationDimensions(true);
 572     addNotify();
 573     // TODO: many places call this method and also paintAlignment with various
 574     // different settings. this means multiple redraws are triggered...
 575     paintAlignment(true, av.needToUpdateStructureViews());
 576   }
 577
 578   /**
 579    * calculate the annotation dimensions and refresh slider values accordingly.
 580    * need to do repaints/notifys afterwards.
 581    */
 582   protected void validateAnnotationDimensions(boolean adjustPanelHeight)
 583   {
 584     // BH 2018.04.18 comment: addNotify() is not appropriate here. We
 585     // are not changing ancestors, and keyboard action listeners do
 586     // not need to be reset. addNotify() is a very expensive operation,
 587     // requiring a full re-layout of all parents and children.
 588     // Note in JComponent:
 589     // This method is called by the toolkit internally and should
 590     // not be called directly by programs.
 591     // I note that addNotify() is called in several areas of Jalview.
 592
 593     AnnotationPanel ap = getAnnotationPanel();
 594     int annotationHeight = ap.adjustPanelHeight();
 595     annotationHeight = ap.adjustForAlignFrame(adjustPanelHeight,
 596             annotationHeight);
 597
 598     hscroll.addNotify();
 599     Dimension e = idPanel.getSize();
 600     int idWidth = e.width;
 601     boolean manuallyAdjusted = this.getIdPanel().getIdCanvas()
 602             .manuallyAdjusted();
 603     annotationScroller.setPreferredSize(new Dimension(
 604             manuallyAdjusted ? idWidth : annotationScroller.getWidth(),
 605             annotationHeight));
 606
 607     alabels.setPreferredSize(new Dimension(idWidth, annotationHeight));
 608
 609     annotationSpaceFillerHolder.setPreferredSize(new Dimension(
 610             manuallyAdjusted ? idWidth
 611                     : annotationSpaceFillerHolder.getWidth(),
 612             annotationHeight));
 613     annotationScroller.validate();
 614     annotationScroller.addNotify();
 615     ap.validate();
 616   }
 617
 618   /**
 619    * update alignment layout for viewport settings
 620    *
 621    * @param wrap
 622    *          DOCUMENT ME!
 623    */
 624   public void updateLayout()
 625   {
 626     fontChanged();
 627     setAnnotationVisible(av.isShowAnnotation());
 628     boolean wrap = av.getWrapAlignment();
 629     ViewportRanges ranges = av.getRanges();
 630     ranges.setStartSeq(0);
 631     // scalePanelHolder.setVisible(!wrap);
 632     hscroll.setVisible(!wrap);
 633     // Allow idPanel width adjustment in wrap mode
 634     idwidthAdjuster.setVisible(true);
 635
 636     if (wrap)
 637     {
 638       annotationScroller.setVisible(false);
 639       annotationSpaceFillerHolder.setVisible(false);
 640     }
 641     else if (av.isShowAnnotation())
 642     {
 643       annotationScroller.setVisible(true);
 644       annotationSpaceFillerHolder.setVisible(true);
 645       validateAnnotationDimensions(false);
 646     }
 647
 648     int canvasWidth = getSeqPanel().seqCanvas.getWidth();
 649     if (canvasWidth > 0)
 650     { // may not yet be laid out
 651       if (wrap)
 652       {
 653         int widthInRes = getSeqPanel().seqCanvas
 654                 .getWrappedCanvasWidth(canvasWidth);
 655         ranges.setViewportWidth(widthInRes);
 656       }
 657       else
 658       {
 659         int widthInRes = (canvasWidth / av.getCharWidth());
 660         int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
 661                 / av.getCharHeight());
 662
 663         ranges.setViewportWidth(widthInRes);
 664         ranges.setViewportHeight(heightInSeq);
 665       }
 666     }
 667
 668     // idSpaceFillerPanel1.setVisible(!wrap);
 669
 670     repaint();
 671   }
 672
 673   /**
 674    * Adjust row/column scrollers to show a visible position in the alignment.
 675    *
 676    * @param x
 677    *          visible column to scroll to
 678    * @param y
 679    *          visible row to scroll to
 680    *
 681    */
 682   public void setScrollValues(int xpos, int ypos)
 683   {
 684     int x = xpos;
 685     int y = ypos;
 686
 687     if (av == null || av.getAlignment() == null)
 688     {
 689       return;
 690     }
 691
 692     if (av.getWrapAlignment())
 693     {
 694       setScrollingForWrappedPanel(x);
 695     }
 696     else
 697     {
 698       int width = av.getAlignment().getVisibleWidth();
 699       int height = av.getAlignment().getHeight();
 700
 701       hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 702       vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 703
 704       if (hextent > width)
 705       {
 706         hextent = width;
 707       }
 708
 709       if (vextent > height)
 710       {
 711         vextent = height;
 712       }
 713
 714       if ((hextent + x) > width)
 715       {
 716         x = width - hextent;
 717       }
 718
 719       if ((vextent + y) > height)
 720       {
 721         y = height - vextent;
 722       }
 723
 724       if (y < 0)
 725       {
 726         y = 0;
 727       }
 728
 729       if (x < 0)
 730       {
 731         x = 0;
 732       }
 733
 734       // update the scroll values
 735       hscroll.setValues(x, hextent, 0, width);
 736       vscroll.setValues(y, vextent, 0, height);
 737     }
 738   }
 739
 740   /**
 741    * Respond to adjustment event when horizontal or vertical scrollbar is
 742    * changed
 743    *
 744    * @param evt
 745    *          adjustment event encoding whether hscroll or vscroll changed
 746    */
 747   @Override
 748   public void adjustmentValueChanged(AdjustmentEvent evt)
 749   {
 750     if (av.getWrapAlignment())
 751     {
 752       adjustScrollingWrapped(evt);
 753       return;
 754     }
 755
 756     ViewportRanges ranges = av.getRanges();
 757
 758     if (evt.getSource() == hscroll)
 759     {
 760       int oldX = ranges.getStartRes();
 761       int oldwidth = ranges.getViewportWidth();
 762       int x = hscroll.getValue();
 763       int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 764
 765       // if we're scrolling to the position we're already at, stop
 766       // this prevents infinite recursion of events when the scroll/viewport
 767       // ranges values are the same
 768       if ((x == oldX) && (width == oldwidth))
 769       {
 770         return;
 771       }
 772       ranges.setViewportStartAndWidth(x, width);
 773     }
 774     else if (evt.getSource() == vscroll)
 775     {
 776       int oldY = ranges.getStartSeq();
 777       int oldheight = ranges.getViewportHeight();
 778       int y = vscroll.getValue();
 779       int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 780
 781       // if we're scrolling to the position we're already at, stop
 782       // this prevents infinite recursion of events when the scroll/viewport
 783       // ranges values are the same
 784       if ((y == oldY) && (height == oldheight))
 785       {
 786         return;
 787       }
 788       ranges.setViewportStartAndHeight(y, height);
 789     }
 790     repaint();
 791   }
 792
 793   /**
 794    * Responds to a scroll change by setting the start position of the viewport.
 795    * Does
 796    *
 797    * @param evt
 798    */
 799   protected void adjustScrollingWrapped(AdjustmentEvent evt)
 800   {
 801     if (evt.getSource() == hscroll)
 802     {
 803       return; // no horizontal scroll when wrapped
 804     }
 805     final ViewportRanges ranges = av.getRanges();
 806
 807     if (evt.getSource() == vscroll)
 808     {
 809       int newY = vscroll.getValue();
 810
 811       /*
 812        * if we're scrolling to the position we're already at, stop
 813        * this prevents infinite recursion of events when the scroll/viewport
 814        * ranges values are the same
 815        */
 816       int oldX = ranges.getStartRes();
 817       int oldY = ranges.getWrappedScrollPosition(oldX);
 818       if (oldY == newY)
 819       {
 820         return;
 821       }
 822       if (newY > -1)
 823       {
 824         /*
 825          * limit page up/down to one width's worth of positions
 826          */
 827         int rowSize = ranges.getViewportWidth();
 828         int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
 829         ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
 830       }
 831     }
 832     else
 833     {
 834       // This is only called if file loaded is a jar file that
 835       // was wrapped when saved and user has wrap alignment true
 836       // as preference setting
 837       SwingUtilities.invokeLater(new Runnable()
 838       {
 839         @Override
 840         public void run()
 841         {
 842           // When updating scrolling to use ViewportChange events, this code
 843           // could not be validated and it is not clear if it is now being
 844           // called. Log warning here in case it is called and unforeseen
 845           // problems occur
 846           Console.warn(
 847                   "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
 848
 849           // scroll to start of panel
 850           ranges.setStartRes(0);
 851           ranges.setStartSeq(0);
 852         }
 853       });
 854     }
 855     repaint();
 856   }
 857
 858   /* (non-Javadoc)
 859    * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
 860    */
 861   @Override
 862   public void paintAlignment(boolean updateOverview,
 863           boolean updateStructures)
 864   {
 865     final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
 866             av.isShowAutocalculatedAbove());
 867     sorter.sort(getAlignment().getAlignmentAnnotation(),
 868             av.getSortAnnotationsBy());
 869     repaint();
 870
 871     if (updateStructures)
 872     {
 873       av.getStructureSelectionManager().sequenceColoursChanged(this);
 874     }
 875     if (updateOverview)
 876     {
 877
 878       if (overviewPanel != null)
 879       {
 880         overviewPanel.updateOverviewImage();
 881       }
 882     }
 883   }
 884
 885   @Override
 886   public void paintComponent(Graphics g)
 887   {
 888     invalidate(); // needed so that the id width adjuster works correctly
 889     Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
 890     int idWidth = d.width;
 891
 892     // check wrapped alignment as at least 1 residue width
 893     if (av.getWrapAlignment())
 894     {
 895       SeqCanvas sc = this.getSeqPanel().seqCanvas;
 896       if (sc != null && sc.getWidth() < sc.getMinimumWrappedCanvasWidth())
 897       {
 898         // need to make some adjustments
 899         idWidth -= (sc.getMinimumWrappedCanvasWidth() - sc.getWidth());
 900         av.setIdWidth(idWidth);
 901         av.getAlignPanel().getIdPanel().getIdCanvas()
 902                 .setManuallyAdjusted(true);
 903
 904         validateAnnotationDimensions(false);
 905       }
 906     }
 907
 908     idPanelHolder.setPreferredSize(new Dimension(idWidth, d.height));
 909     hscrollFillerPanel.setPreferredSize(new Dimension(idWidth, 12));
 910
 911     validate(); // needed so that the id width adjuster works correctly
 912
 913     /*
 914      * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
 915      * though I still think this call should be elsewhere.
 916      */
 917     ViewportRanges ranges = av.getRanges();
 918     setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
 919     super.paintComponent(g);
 920   }
 921
 922   /**
 923    * Set vertical scroll bar position, and number of increments, for wrapped
 924    * panel
 925    *
 926    * @param topLeftColumn
 927    *          the column position at top left (0..)
 928    */
 929   private void setScrollingForWrappedPanel(int topLeftColumn)
 930   {
 931     ViewportRanges ranges = av.getRanges();
 932     int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
 933     int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
 934
 935     /*
 936      * a scrollbar's value can be set to at most (maximum-extent)
 937      * so we add extent (1) to the maxScroll value
 938      */
 939     vscroll.setUnitIncrement(1);
 940     vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
 941   }
 942
 943   /**
 944    * DOCUMENT ME!
 945    *
 946    * @param pg
 947    *          DOCUMENT ME!
 948    * @param pf
 949    *          DOCUMENT ME!
 950    * @param pi
 951    *          DOCUMENT ME!
 952    *
 953    * @return DOCUMENT ME!
 954    *
 955    * @throws PrinterException
 956    *           DOCUMENT ME!
 957    */
 958   @Override
 959   public int print(Graphics pg, PageFormat pf, int pi)
 960           throws PrinterException
 961   {
 962     pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 963
 964     int pwidth = (int) pf.getImageableWidth();
 965     int pheight = (int) pf.getImageableHeight();
 966
 967     if (av.getWrapAlignment())
 968     {
 969       return printWrappedAlignment(pwidth, pheight, pi, pg);
 970     }
 971     else
 972     {
 973       return printUnwrapped(pwidth, pheight, pi, pg, pg);
 974     }
 975   }
 976
 977   /**
 978    * Draws the alignment image, including sequence ids, sequences, and
 979    * annotation labels and annotations if shown, on either one or two Graphics
 980    * contexts.
 981    *
 982    * @param pageWidth
 983    *          in pixels
 984    * @param pageHeight
 985    *          in pixels
 986    * @param pageIndex
 987    *          (0, 1, ...)
 988    * @param idGraphics
 989    *          the graphics context for sequence ids and annotation labels
 990    * @param alignmentGraphics
 991    *          the graphics context for sequences and annotations (may or may not
 992    *          be the same context as idGraphics)
 993    * @return
 994    * @throws PrinterException
 995    */
 996   public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
 997           Graphics idGraphics, Graphics alignmentGraphics)
 998           throws PrinterException
 999   {
1000     final int idWidth = getVisibleIdWidth(false);
1001
1002     /*
1003      * Get the horizontal offset to where we draw the sequences.
1004      * This is idWidth if using a single Graphics context, else zero.
1005      */
1006     final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
1007             : idWidth;
1008
1009     FontMetrics fm = getFontMetrics(av.getFont());
1010     final int charHeight = av.getCharHeight();
1011     final int scaleHeight = charHeight + fm.getDescent();
1012
1013     idGraphics.setColor(Color.white);
1014     idGraphics.fillRect(0, 0, pageWidth, pageHeight);
1015     idGraphics.setFont(av.getFont());
1016
1017     /*
1018      * How many sequences and residues can we fit on a printable page?
1019      */
1020     final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
1021
1022     final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1023
1024     final int alignmentWidth = av.getAlignment().getVisibleWidth();
1025     int pagesWide = (alignmentWidth / totalRes) + 1;
1026
1027     final int startRes = (pageIndex % pagesWide) * totalRes;
1028     final int endRes = Math.min(startRes + totalRes - 1,
1029             alignmentWidth - 1);
1030
1031     final int startSeq = (pageIndex / pagesWide) * totalSeq;
1032     final int alignmentHeight = av.getAlignment().getHeight();
1033     final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
1034
1035     int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
1036
1037     if (av.isShowAnnotation())
1038     {
1039       pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1040     }
1041
1042     pagesHigh /= pageHeight;
1043
1044     if (pageIndex >= (pagesWide * pagesHigh))
1045     {
1046       return Printable.NO_SUCH_PAGE;
1047     }
1048     final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
1049
1050     /*
1051      * draw the Scale at horizontal offset, then reset to top left (0, 0)
1052      */
1053     alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1054     getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1055             pageWidth - idWidth, scaleHeight);
1056     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1057
1058     /*
1059      * Draw the sequence ids, offset for scale height,
1060      * then reset to top left (0, 0)
1061      */
1062     idGraphics.translate(0, scaleHeight);
1063     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1064     List<SequenceI> selection = av.getSelectionGroup() == null ? null
1065             : av.getSelectionGroup().getSequences(null);
1066     idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
1067             selection);
1068
1069     idGraphics.setFont(av.getFont());
1070     idGraphics.translate(0, -scaleHeight);
1071
1072     /*
1073      * draw the sequences, offset for scale height, and id width (if using a
1074      * single graphics context), then reset to (0, scale height)
1075      */
1076     alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1077     getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics,
1078             startRes, endRes, startSeq, endSeq - 1);
1079     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1080
1081     if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1082     {
1083       /*
1084        * draw annotation labels; drawComponent() translates by
1085        * getScrollOffset(), so compensate for that first;
1086        * then reset to (0, scale height)
1087        */
1088       int offset = getAlabels().getScrollOffset();
1089       idGraphics.translate(0, -offset);
1090       idGraphics.translate(0, alignmentDrawnHeight);
1091       getAlabels().drawComponent(idGraphics, idWidth);
1092       idGraphics.translate(0, -alignmentDrawnHeight);
1093
1094       /*
1095        * draw the annotations starting at
1096        * (idOffset, alignmentHeight) from (0, scaleHeight)
1097        */
1098       alignmentGraphics.translate(alignmentGraphicsOffset,
1099               alignmentDrawnHeight);
1100       updateLayout();
1101       getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1102               alignmentGraphics, -1, startRes, endRes + 1);
1103     }
1104
1105     return Printable.PAGE_EXISTS;
1106   }
1107
1108   /**
1109    * Prints one page of an alignment in wrapped mode. Returns
1110    * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
1111    * no page could be drawn (page number out of range).
1112    *
1113    * @param pageWidth
1114    * @param pageHeight
1115    * @param pageNumber
1116    *          (0, 1, ...)
1117    * @param g
1118    *
1119    * @return
1120    *
1121    * @throws PrinterException
1122    */
1123   public int printWrappedAlignment(int pageWidth, int pageHeight,
1124           int pageNumber, Graphics g) throws PrinterException
1125   {
1126     getSeqPanel().seqCanvas.calculateWrappedGeometry(getWidth(),
1127             getHeight());
1128     int annotationHeight = 0;
1129     if (av.isShowAnnotation())
1130     {
1131       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1132     }
1133
1134     int hgap = av.getCharHeight();
1135     if (av.getScaleAboveWrapped())
1136     {
1137       hgap += av.getCharHeight();
1138     }
1139
1140     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1141             + annotationHeight;
1142
1143     int idWidth = getVisibleIdWidth(false);
1144
1145     int maxwidth = av.getAlignment().getVisibleWidth();
1146
1147     int resWidth = getSeqPanel().seqCanvas
1148             .getWrappedCanvasWidth(pageWidth - idWidth);
1149     av.getRanges().setViewportStartAndWidth(0, resWidth);
1150
1151     int totalHeight = cHeight * (maxwidth / resWidth + 1);
1152
1153     g.setColor(Color.white);
1154     g.fillRect(0, 0, pageWidth, pageHeight);
1155     g.setFont(av.getFont());
1156     g.setColor(Color.black);
1157
1158     /*
1159      * method: print the whole wrapped alignment, but with a clip region that
1160      * is restricted to the requested page; this supports selective print of
1161      * single pages or ranges, (at the cost of repeated processing in the
1162      * 'normal' case, when all pages are printed)
1163      */
1164     g.translate(0, -pageNumber * pageHeight);
1165
1166     g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
1167
1168     /*
1169      * draw sequence ids and annotation labels (if shown)
1170      */
1171     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1172     idCanvas.drawIdsWrapped((Graphics2D) g, av, 0, totalHeight);
1173
1174     g.translate(idWidth, 0);
1175
1176     getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g,
1177             pageWidth - idWidth, totalHeight, 0);
1178
1179     if ((pageNumber * pageHeight) < totalHeight)
1180     {
1181       return Printable.PAGE_EXISTS;
1182     }
1183     else
1184     {
1185       return Printable.NO_SUCH_PAGE;
1186     }
1187   }
1188
1189   /**
1190    * get current sequence ID panel width, or nominal value if panel were to be
1191    * displayed using default settings
1192    *
1193    * @return
1194    */
1195   public int getVisibleIdWidth()
1196   {
1197     return getVisibleIdWidth(true);
1198   }
1199
1200   /**
1201    * get current sequence ID panel width, or nominal value if panel were to be
1202    * displayed using default settings
1203    *
1204    * @param onscreen
1205    *          indicate if the Id width for onscreen or offscreen display should
1206    *          be returned
1207    * @return
1208    */
1209   protected int getVisibleIdWidth(boolean onscreen)
1210   {
1211     // see if rendering offscreen - check preferences and calc width accordingly
1212     if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1213     {
1214       return calculateIdWidth(-1).width;
1215     }
1216     Integer idwidth = onscreen ? null
1217             : Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH");
1218     if (idwidth != null)
1219     {
1220       return idwidth.intValue() + ID_WIDTH_PADDING;
1221     }
1222
1223     int w = getIdPanel().getWidth();
1224     w = this.calculateIdWidth(-1, true, true).width;
1225     return (w > 0 ? w : calculateIdWidth().width);
1226   }
1227
1228   void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer)
1229           throws ImageOutputException
1230   {
1231     makeAlignmentImage(type, file, renderer,
1232             BitmapImageSizing.nullBitmapImageSizing());
1233   }
1234
1235   /**
1236    * Builds an image of the alignment of the specified type (EPS/PNG/SVG) and
1237    * writes it to the specified file
1238    *
1239    * @param type
1240    * @param file
1241    * @param textrenderer
1242    * @param bitmapscale
1243    */
1244   void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer,
1245           BitmapImageSizing userBis) throws ImageOutputException
1246   {
1247     final int borderBottomOffset = 5;
1248
1249     AlignmentDimension aDimension = getAlignmentDimension();
1250
1251     // todo use a lambda function in place of callback here?
1252     ImageWriterI writer = new ImageWriterI()
1253     {
1254       @Override
1255       public void exportImage(Graphics graphics) throws Exception
1256       {
1257         if (av.getWrapAlignment())
1258         {
1259           printWrappedAlignment(aDimension.getWidth(),
1260                   aDimension.getHeight() + borderBottomOffset, 0, graphics);
1261         }
1262         else
1263         {
1264           printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1265                   graphics, graphics);
1266         }
1267       }
1268     };
1269
1270     String fileTitle = alignFrame.getTitle();
1271     ImageExporter exporter = new ImageExporter(writer, alignFrame, type,
1272             fileTitle);
1273     int imageWidth = aDimension.getWidth();
1274     int imageHeight = aDimension.getHeight() + borderBottomOffset;
1275     String of = MessageManager.getString("label.alignment");
1276     exporter.doExport(file, this, imageWidth, imageHeight, of, renderer,
1277             userBis);
1278   }
1279
1280   /**
1281    * Calculates and returns a suitable width and height (in pixels) for an
1282    * exported image
1283    *
1284    * @return
1285    */
1286   public AlignmentDimension getAlignmentDimension()
1287   {
1288     int maxwidth = av.getAlignment().getVisibleWidth();
1289
1290     int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1291             + getScalePanel().getHeight();
1292     int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1293
1294     if (av.getWrapAlignment())
1295     {
1296       height = getWrappedHeight();
1297       if (Jalview.isHeadlessMode())
1298       {
1299         // need to obtain default alignment width and then add in any
1300         // additional allowance for id margin
1301         // this duplicates the calculation in getWrappedHeight but adjusts for
1302         // offscreen idWith
1303         width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1304                 - alignFrame.getInsets().left - alignFrame.getInsets().right
1305                 - getVisibleIdWidth() + getVisibleIdWidth(false);
1306       }
1307       else
1308       {
1309         width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1310       }
1311
1312     }
1313     else if (av.isShowAnnotation())
1314     {
1315       height += getAnnotationPanel().adjustPanelHeight() + 3;
1316     }
1317     return new AlignmentDimension(width, height);
1318
1319   }
1320
1321   public void makePNGImageMap(File imgMapFile, String imageName)
1322           throws ImageOutputException
1323   {
1324     // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1325     // ////////////////////////////////////////////
1326     int idWidth = getVisibleIdWidth(false);
1327     FontMetrics fm = getFontMetrics(av.getFont());
1328     int scaleHeight = av.getCharHeight() + fm.getDescent();
1329
1330     // Gen image map
1331     // ////////////////////////////////
1332     if (imgMapFile != null)
1333     {
1334       try
1335       {
1336         int sSize = av.getAlignment().getHeight();
1337         int alwidth = av.getAlignment().getWidth();
1338         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1339         out.println(HTMLOutput.getImageMapHTML());
1340         out.println("<img src=\"" + imageName
1341                 + "\" border=\"0\" usemap=\"#Map\" >"
1342                 + "<map name=\"Map\">");
1343
1344         for (int s = 0; s < sSize; s++)
1345         {
1346           int sy = s * av.getCharHeight() + scaleHeight;
1347
1348           SequenceI seq = av.getAlignment().getSequenceAt(s);
1349           SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1350           for (int column = 0; column < alwidth; column++)
1351           {
1352             StringBuilder text = new StringBuilder(512);
1353             String triplet = null;
1354             if (av.getAlignment().isNucleotide())
1355             {
1356               triplet = ResidueProperties.nucleotideName
1357                       .get(seq.getCharAt(column) + "");
1358             }
1359             else
1360             {
1361               triplet = ResidueProperties.aa2Triplet
1362                       .get(seq.getCharAt(column) + "");
1363             }
1364
1365             if (triplet == null)
1366             {
1367               continue;
1368             }
1369
1370             int seqPos = seq.findPosition(column);
1371             int gSize = groups.length;
1372             for (int g = 0; g < gSize; g++)
1373             {
1374               if (text.length() < 1)
1375               {
1376                 text.append("<area shape=\"rect\" coords=\"")
1377                         .append((idWidth + column * av.getCharWidth()))
1378                         .append(",").append(sy).append(",")
1379                         .append((idWidth
1380                                 + (column + 1) * av.getCharWidth()))
1381                         .append(",").append((av.getCharHeight() + sy))
1382                         .append("\"").append(" onMouseOver=\"toolTip('")
1383                         .append(seqPos).append(" ").append(triplet);
1384               }
1385
1386               if (groups[g].getStartRes() < column
1387                       && groups[g].getEndRes() > column)
1388               {
1389                 text.append("<br><em>").append(groups[g].getName())
1390                         .append("</em>");
1391               }
1392             }
1393
1394             if (text.length() < 1)
1395             {
1396               text.append("<area shape=\"rect\" coords=\"")
1397                       .append((idWidth + column * av.getCharWidth()))
1398                       .append(",").append(sy).append(",")
1399                       .append((idWidth + (column + 1) * av.getCharWidth()))
1400                       .append(",").append((av.getCharHeight() + sy))
1401                       .append("\"").append(" onMouseOver=\"toolTip('")
1402                       .append(seqPos).append(" ").append(triplet);
1403             }
1404             if (!Comparison.isGap(seq.getCharAt(column)))
1405             {
1406               List<SequenceFeature> features = seq.findFeatures(column,
1407                       column);
1408               for (SequenceFeature sf : features)
1409               {
1410                 if (sf.isContactFeature())
1411                 {
1412                   text.append("<br>").append(sf.getType()).append(" ")
1413                           .append(sf.getBegin()).append(":")
1414                           .append(sf.getEnd());
1415                 }
1416                 else
1417                 {
1418                   text.append("<br>");
1419                   text.append(sf.getType());
1420                   String description = sf.getDescription();
1421                   if (description != null
1422                           && !sf.getType().equals(description))
1423                   {
1424                     description = description.replace("\"", "&quot;");
1425                     text.append(" ").append(description);
1426                   }
1427                 }
1428                 String status = sf.getStatus();
1429                 if (status != null && !"".equals(status))
1430                 {
1431                   text.append(" (").append(status).append(")");
1432                 }
1433               }
1434               if (text.length() > 1)
1435               {
1436                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");
1437                 out.println(text.toString());
1438               }
1439             }
1440           }
1441         }
1442         out.println("</map></body></html>");
1443         out.close();
1444
1445       } catch (Exception ex)
1446       {
1447         throw new ImageOutputException(
1448                 "couldn't write ImageMap due to unexpected error", ex);
1449       }
1450     } // /////////END OF IMAGE MAP
1451
1452   }
1453
1454   /**
1455    * Answers the height of the entire alignment in pixels, assuming it is in
1456    * wrapped mode
1457    *
1458    * @return
1459    */
1460   int getWrappedHeight()
1461   {
1462     int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1463
1464     if (Jalview.isHeadlessMode())
1465     {
1466       seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1467               - vscroll.getPreferredSize().width
1468               - alignFrame.getInsets().left - alignFrame.getInsets().right;
1469     }
1470
1471     int chunkWidth = getSeqPanel().seqCanvas
1472             .getWrappedCanvasWidth(seqPanelWidth);
1473
1474     int hgap = av.getCharHeight();
1475     if (av.getScaleAboveWrapped())
1476     {
1477       hgap += av.getCharHeight();
1478     }
1479
1480     int annotationHeight = 0;
1481     if (av.isShowAnnotation())
1482     {
1483       hgap += SeqCanvas.SEQS_ANNOTATION_GAP;
1484       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1485     }
1486
1487     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1488             + annotationHeight;
1489
1490     int maxwidth = av.getAlignment().getWidth();
1491     if (av.hasHiddenColumns())
1492     {
1493       maxwidth = av.getAlignment().getHiddenColumns()
1494               .absoluteToVisibleColumn(maxwidth) - 1;
1495     }
1496
1497     int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1498
1499     return height;
1500   }
1501
1502   /**
1503    * close the panel - deregisters all listeners and nulls any references to
1504    * alignment data.
1505    */
1506   public void closePanel()
1507   {
1508     PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1509     PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1510     PaintRefresher.RemoveComponent(this);
1511
1512     closeChildFrames();
1513
1514     /*
1515      * try to ensure references are nulled
1516      */
1517     if (annotationPanel != null)
1518     {
1519       annotationPanel.dispose();
1520       annotationPanel = null;
1521     }
1522
1523     if (av != null)
1524     {
1525       av.removePropertyChangeListener(propertyChangeListener);
1526       propertyChangeListener = null;
1527       StructureSelectionManager ssm = av.getStructureSelectionManager();
1528       ssm.removeStructureViewerListener(getSeqPanel(), null);
1529       ssm.removeSelectionListener(getSeqPanel());
1530       ssm.removeCommandListener(av);
1531       ssm.removeStructureViewerListener(getSeqPanel(), null);
1532       ssm.removeSelectionListener(getSeqPanel());
1533       av.dispose();
1534       av = null;
1535     }
1536     else
1537     {
1538       if (Console.isDebugEnabled())
1539       {
1540         Console.warn("Closing alignment panel which is already closed.");
1541       }
1542     }
1543   }
1544
1545   /**
1546    * Close any open dialogs that would be orphaned when this one is closed
1547    */
1548   protected void closeChildFrames()
1549   {
1550     if (overviewPanel != null)
1551     {
1552       overviewPanel.dispose();
1553       overviewPanel = null;
1554     }
1555     if (calculationDialog != null)
1556     {
1557       calculationDialog.closeFrame();
1558       calculationDialog = null;
1559     }
1560   }
1561
1562   /**
1563    * hides or shows dynamic annotation rows based on groups and av state flags
1564    */
1565   public void updateAnnotation()
1566   {
1567     updateAnnotation(false, false);
1568   }
1569
1570   public void updateAnnotation(boolean applyGlobalSettings)
1571   {
1572     updateAnnotation(applyGlobalSettings, false);
1573   }
1574
1575   public void updateAnnotation(boolean applyGlobalSettings,
1576           boolean preserveNewGroupSettings)
1577   {
1578     av.updateGroupAnnotationSettings(applyGlobalSettings,
1579             preserveNewGroupSettings);
1580     adjustAnnotationHeight();
1581   }
1582
1583   @Override
1584   public AlignmentI getAlignment()
1585   {
1586     return av == null ? null : av.getAlignment();
1587   }
1588
1589   @Override
1590   public String getViewName()
1591   {
1592     return av.getViewName();
1593   }
1594
1595   /**
1596    * Make/Unmake this alignment panel the current input focus
1597    *
1598    * @param b
1599    */
1600   public void setSelected(boolean b)
1601   {
1602     try
1603     {
1604       if (alignFrame.getSplitViewContainer() != null)
1605       {
1606         /*
1607          * bring enclosing SplitFrame to front first if there is one
1608          */
1609         ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1610       }
1611       alignFrame.setSelected(b);
1612     } catch (Exception ex)
1613     {
1614     }
1615     if (b)
1616     {
1617       setAlignFrameView();
1618     }
1619   }
1620
1621   public void setAlignFrameView()
1622   {
1623     alignFrame.setDisplayedView(this);
1624   }
1625
1626   @Override
1627   public StructureSelectionManager getStructureSelectionManager()
1628   {
1629     return av.getStructureSelectionManager();
1630   }
1631
1632   @Override
1633   public void raiseOOMWarning(String string, OutOfMemoryError error)
1634   {
1635     new OOMWarning(string, error, this);
1636   }
1637
1638   @Override
1639   public jalview.api.FeatureRenderer cloneFeatureRenderer()
1640   {
1641
1642     return new FeatureRenderer(this);
1643   }
1644
1645   @Override
1646   public jalview.api.FeatureRenderer getFeatureRenderer()
1647   {
1648     return seqPanel.seqCanvas.getFeatureRenderer();
1649   }
1650
1651   public void updateFeatureRenderer(
1652           jalview.renderer.seqfeatures.FeatureRenderer fr)
1653   {
1654     fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1655   }
1656
1657   public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1658   {
1659     if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1660     {
1661       getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1662     }
1663   }
1664
1665   public ScalePanel getScalePanel()
1666   {
1667     return scalePanel;
1668   }
1669
1670   public void setScalePanel(ScalePanel scalePanel)
1671   {
1672     this.scalePanel = scalePanel;
1673   }
1674
1675   public SeqPanel getSeqPanel()
1676   {
1677     return seqPanel;
1678   }
1679
1680   public void setSeqPanel(SeqPanel seqPanel)
1681   {
1682     this.seqPanel = seqPanel;
1683   }
1684
1685   public AnnotationPanel getAnnotationPanel()
1686   {
1687     return annotationPanel;
1688   }
1689
1690   public void setAnnotationPanel(AnnotationPanel annotationPanel)
1691   {
1692     this.annotationPanel = annotationPanel;
1693   }
1694
1695   public AnnotationLabels getAlabels()
1696   {
1697     return alabels;
1698   }
1699
1700   public void setAlabels(AnnotationLabels alabels)
1701   {
1702     this.alabels = alabels;
1703   }
1704
1705   public IdPanel getIdPanel()
1706   {
1707     return idPanel;
1708   }
1709
1710   public void setIdPanel(IdPanel idPanel)
1711   {
1712     this.idPanel = idPanel;
1713   }
1714
1715   /**
1716    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1717    * The aim is to keep the two alignments 'lined up' on their centre columns.
1718    *
1719    * @param sr
1720    *          holds mapped region(s) of this alignment that we are scrolling
1721    *          'to'; may be modified for sequence offset by this method
1722    * @param verticalOffset
1723    *          the number of visible sequences to show above the mapped region
1724    */
1725   protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1726   {
1727     scrollToPosition(sr, verticalOffset, true);
1728   }
1729
1730   /**
1731    * Set a flag to say do not scroll any (cDNA/protein) complement.
1732    *
1733    * @param b
1734    */
1735   protected void setToScrollComplementPanel(boolean b)
1736   {
1737     this.scrollComplementaryPanel = b;
1738   }
1739
1740   /**
1741    * Get whether to scroll complement panel
1742    *
1743    * @return true if cDNA/protein complement panels should be scrolled
1744    */
1745   protected boolean isSetToScrollComplementPanel()
1746   {
1747     return this.scrollComplementaryPanel;
1748   }
1749
1750   /**
1751    * Redraw sensibly.
1752    *
1753    * @adjustHeight if true, try to recalculate panel height for visible
1754    *               annotations
1755    */
1756   protected void refresh(boolean adjustHeight)
1757   {
1758     validateAnnotationDimensions(adjustHeight);
1759     addNotify();
1760     if (adjustHeight)
1761     {
1762       // sort, repaint, update overview
1763       paintAlignment(true, false);
1764     }
1765     else
1766     {
1767       // lightweight repaint
1768       repaint();
1769     }
1770   }
1771
1772   @Override
1773   /**
1774    * Property change event fired when a change is made to the viewport ranges
1775    * object associated with this alignment panel's viewport
1776    */
1777   public void propertyChange(PropertyChangeEvent evt)
1778   {
1779     // update this panel's scroll values based on the new viewport ranges values
1780     ViewportRanges ranges = av.getRanges();
1781     int x = ranges.getStartRes();
1782     int y = ranges.getStartSeq();
1783     setScrollValues(x, y);
1784
1785     // now update any complementary alignment (its viewport ranges object
1786     // is different so does not get automatically updated)
1787     if (isSetToScrollComplementPanel())
1788     {
1789       setToScrollComplementPanel(false);
1790       av.scrollComplementaryAlignment();
1791       setToScrollComplementPanel(true);
1792     }
1793   }
1794
1795   /**
1796    * Set the reference to the PCA/Tree chooser dialog for this panel. This
1797    * reference should be nulled when the dialog is closed.
1798    *
1799    * @param calculationChooser
1800    */
1801   public void setCalculationDialog(CalculationChooser calculationChooser)
1802   {
1803     calculationDialog = calculationChooser;
1804   }
1805
1806   /**
1807    * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1808    * if none is open)
1809    */
1810   public CalculationChooser getCalculationDialog()
1811   {
1812     return calculationDialog;
1813   }
1814
1815   /**
1816    * Constructs and sets the title for the Overview window (if there is one),
1817    * including the align frame's title, and view name (if applicable). Returns
1818    * the title, or null if this panel has no Overview window open.
1819    *
1820    * @param alignFrame
1821    * @return
1822    */
1823   public String setOverviewTitle(AlignFrame alignFrame)
1824   {
1825     if (this.overviewPanel == null)
1826     {
1827       return null;
1828     }
1829     String overviewTitle = MessageManager
1830             .formatMessage("label.overview_params", new Object[]
1831             { alignFrame.getTitle() });
1832     String viewName = getViewName();
1833     if (viewName != null)
1834     {
1835       overviewTitle += (" " + viewName);
1836     }
1837     overviewPanel.setTitle(overviewTitle);
1838     return overviewTitle;
1839   }
1840
1841   /**
1842    * If this alignment panel has an Overview panel open, closes it
1843    */
1844   public void closeOverviewPanel()
1845   {
1846     if (overviewPanel != null)
1847     {
1848       overviewPanel.close();
1849       overviewPanel = null;
1850     }
1851   }
1852
1853 }