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       System.out.println("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     annotationScroller.setPreferredSize(
 600             new Dimension(annotationScroller.getWidth(), annotationHeight));
 601
 602     Dimension e = idPanel.getSize();
 603     alabels.setSize(new Dimension(e.width, annotationHeight));
 604
 605     annotationSpaceFillerHolder.setPreferredSize(new Dimension(
 606             annotationSpaceFillerHolder.getWidth(), annotationHeight));
 607     annotationScroller.validate();
 608     annotationScroller.addNotify();
 609     ap.validate();
 610   }
 611
 612   /**
 613    * update alignment layout for viewport settings
 614    *
 615    * @param wrap
 616    *          DOCUMENT ME!
 617    */
 618   public void updateLayout()
 619   {
 620     fontChanged();
 621     setAnnotationVisible(av.isShowAnnotation());
 622     boolean wrap = av.getWrapAlignment();
 623     ViewportRanges ranges = av.getRanges();
 624     ranges.setStartSeq(0);
 625     scalePanelHolder.setVisible(!wrap);
 626     hscroll.setVisible(!wrap);
 627     // Allow idPanel width adjustment in wrap mode
 628     idwidthAdjuster.setVisible(true);
 629
 630     if (wrap)
 631     {
 632       annotationScroller.setVisible(false);
 633       annotationSpaceFillerHolder.setVisible(false);
 634     }
 635     else if (av.isShowAnnotation())
 636     {
 637       annotationScroller.setVisible(true);
 638       annotationSpaceFillerHolder.setVisible(true);
 639       validateAnnotationDimensions(false);
 640     }
 641
 642     int canvasWidth = getSeqPanel().seqCanvas.getWidth();
 643     if (canvasWidth > 0)
 644     { // may not yet be laid out
 645       if (wrap)
 646       {
 647         int widthInRes = getSeqPanel().seqCanvas
 648                 .getWrappedCanvasWidth(canvasWidth);
 649         ranges.setViewportWidth(widthInRes);
 650       }
 651       else
 652       {
 653         int widthInRes = (canvasWidth / av.getCharWidth());
 654         int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
 655                 / av.getCharHeight());
 656
 657         ranges.setViewportWidth(widthInRes);
 658         ranges.setViewportHeight(heightInSeq);
 659       }
 660     }
 661
 662     // idSpaceFillerPanel1.setVisible(!wrap);
 663
 664     repaint();
 665   }
 666
 667   /**
 668    * Adjust row/column scrollers to show a visible position in the alignment.
 669    *
 670    * @param x
 671    *          visible column to scroll to
 672    * @param y
 673    *          visible row to scroll to
 674    *
 675    */
 676   public void setScrollValues(int xpos, int ypos)
 677   {
 678     int x = xpos;
 679     int y = ypos;
 680
 681     if (av == null || av.getAlignment() == null)
 682     {
 683       return;
 684     }
 685
 686     if (av.getWrapAlignment())
 687     {
 688       setScrollingForWrappedPanel(x);
 689     }
 690     else
 691     {
 692       int width = av.getAlignment().getVisibleWidth();
 693       int height = av.getAlignment().getHeight();
 694
 695       hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 696       vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 697
 698       if (hextent > width)
 699       {
 700         hextent = width;
 701       }
 702
 703       if (vextent > height)
 704       {
 705         vextent = height;
 706       }
 707
 708       if ((hextent + x) > width)
 709       {
 710         x = width - hextent;
 711       }
 712
 713       if ((vextent + y) > height)
 714       {
 715         y = height - vextent;
 716       }
 717
 718       if (y < 0)
 719       {
 720         y = 0;
 721       }
 722
 723       if (x < 0)
 724       {
 725         x = 0;
 726       }
 727
 728       // update the scroll values
 729       hscroll.setValues(x, hextent, 0, width);
 730       vscroll.setValues(y, vextent, 0, height);
 731     }
 732   }
 733
 734   /**
 735    * Respond to adjustment event when horizontal or vertical scrollbar is
 736    * changed
 737    *
 738    * @param evt
 739    *          adjustment event encoding whether hscroll or vscroll changed
 740    */
 741   @Override
 742   public void adjustmentValueChanged(AdjustmentEvent evt)
 743   {
 744     if (av.getWrapAlignment())
 745     {
 746       adjustScrollingWrapped(evt);
 747       return;
 748     }
 749
 750     ViewportRanges ranges = av.getRanges();
 751
 752     if (evt.getSource() == hscroll)
 753     {
 754       int oldX = ranges.getStartRes();
 755       int oldwidth = ranges.getViewportWidth();
 756       int x = hscroll.getValue();
 757       int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 758
 759       // if we're scrolling to the position we're already at, stop
 760       // this prevents infinite recursion of events when the scroll/viewport
 761       // ranges values are the same
 762       if ((x == oldX) && (width == oldwidth))
 763       {
 764         return;
 765       }
 766       ranges.setViewportStartAndWidth(x, width);
 767     }
 768     else if (evt.getSource() == vscroll)
 769     {
 770       int oldY = ranges.getStartSeq();
 771       int oldheight = ranges.getViewportHeight();
 772       int y = vscroll.getValue();
 773       int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 774
 775       // if we're scrolling to the position we're already at, stop
 776       // this prevents infinite recursion of events when the scroll/viewport
 777       // ranges values are the same
 778       if ((y == oldY) && (height == oldheight))
 779       {
 780         return;
 781       }
 782       ranges.setViewportStartAndHeight(y, height);
 783     }
 784     repaint();
 785   }
 786
 787   /**
 788    * Responds to a scroll change by setting the start position of the viewport.
 789    * Does
 790    *
 791    * @param evt
 792    */
 793   protected void adjustScrollingWrapped(AdjustmentEvent evt)
 794   {
 795     if (evt.getSource() == hscroll)
 796     {
 797       return; // no horizontal scroll when wrapped
 798     }
 799     final ViewportRanges ranges = av.getRanges();
 800
 801     if (evt.getSource() == vscroll)
 802     {
 803       int newY = vscroll.getValue();
 804
 805       /*
 806        * if we're scrolling to the position we're already at, stop
 807        * this prevents infinite recursion of events when the scroll/viewport
 808        * ranges values are the same
 809        */
 810       int oldX = ranges.getStartRes();
 811       int oldY = ranges.getWrappedScrollPosition(oldX);
 812       if (oldY == newY)
 813       {
 814         return;
 815       }
 816       if (newY > -1)
 817       {
 818         /*
 819          * limit page up/down to one width's worth of positions
 820          */
 821         int rowSize = ranges.getViewportWidth();
 822         int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
 823         ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
 824       }
 825     }
 826     else
 827     {
 828       // This is only called if file loaded is a jar file that
 829       // was wrapped when saved and user has wrap alignment true
 830       // as preference setting
 831       SwingUtilities.invokeLater(new Runnable()
 832       {
 833         @Override
 834         public void run()
 835         {
 836           // When updating scrolling to use ViewportChange events, this code
 837           // could not be validated and it is not clear if it is now being
 838           // called. Log warning here in case it is called and unforeseen
 839           // problems occur
 840           Console.warn(
 841                   "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
 842
 843           // scroll to start of panel
 844           ranges.setStartRes(0);
 845           ranges.setStartSeq(0);
 846         }
 847       });
 848     }
 849     repaint();
 850   }
 851
 852   /* (non-Javadoc)
 853    * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
 854    */
 855   @Override
 856   public void paintAlignment(boolean updateOverview,
 857           boolean updateStructures)
 858   {
 859     final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
 860             av.isShowAutocalculatedAbove());
 861     sorter.sort(getAlignment().getAlignmentAnnotation(),
 862             av.getSortAnnotationsBy());
 863     repaint();
 864
 865     if (updateStructures)
 866     {
 867       av.getStructureSelectionManager().sequenceColoursChanged(this);
 868     }
 869     if (updateOverview)
 870     {
 871
 872       if (overviewPanel != null)
 873       {
 874         overviewPanel.updateOverviewImage();
 875       }
 876     }
 877   }
 878
 879   @Override
 880   public void paintComponent(Graphics g)
 881   {
 882     invalidate(); // needed so that the id width adjuster works correctly
 883
 884     Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
 885     idPanelHolder.setPreferredSize(d);
 886     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
 887
 888     validate(); // needed so that the id width adjuster works correctly
 889
 890     /*
 891      * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
 892      * though I still think this call should be elsewhere.
 893      */
 894     ViewportRanges ranges = av.getRanges();
 895     setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
 896     super.paintComponent(g);
 897   }
 898
 899   /**
 900    * Set vertical scroll bar position, and number of increments, for wrapped
 901    * panel
 902    *
 903    * @param topLeftColumn
 904    *          the column position at top left (0..)
 905    */
 906   private void setScrollingForWrappedPanel(int topLeftColumn)
 907   {
 908     ViewportRanges ranges = av.getRanges();
 909     int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
 910     int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
 911
 912     /*
 913      * a scrollbar's value can be set to at most (maximum-extent)
 914      * so we add extent (1) to the maxScroll value
 915      */
 916     vscroll.setUnitIncrement(1);
 917     vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
 918   }
 919
 920   /**
 921    * DOCUMENT ME!
 922    *
 923    * @param pg
 924    *          DOCUMENT ME!
 925    * @param pf
 926    *          DOCUMENT ME!
 927    * @param pi
 928    *          DOCUMENT ME!
 929    *
 930    * @return DOCUMENT ME!
 931    *
 932    * @throws PrinterException
 933    *           DOCUMENT ME!
 934    */
 935   @Override
 936   public int print(Graphics pg, PageFormat pf, int pi)
 937           throws PrinterException
 938   {
 939     pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 940
 941     int pwidth = (int) pf.getImageableWidth();
 942     int pheight = (int) pf.getImageableHeight();
 943
 944     if (av.getWrapAlignment())
 945     {
 946       return printWrappedAlignment(pwidth, pheight, pi, pg);
 947     }
 948     else
 949     {
 950       return printUnwrapped(pwidth, pheight, pi, pg, pg);
 951     }
 952   }
 953
 954   /**
 955    * Draws the alignment image, including sequence ids, sequences, and
 956    * annotation labels and annotations if shown, on either one or two Graphics
 957    * contexts.
 958    *
 959    * @param pageWidth
 960    *          in pixels
 961    * @param pageHeight
 962    *          in pixels
 963    * @param pageIndex
 964    *          (0, 1, ...)
 965    * @param idGraphics
 966    *          the graphics context for sequence ids and annotation labels
 967    * @param alignmentGraphics
 968    *          the graphics context for sequences and annotations (may or may not
 969    *          be the same context as idGraphics)
 970    * @return
 971    * @throws PrinterException
 972    */
 973   public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
 974           Graphics idGraphics, Graphics alignmentGraphics)
 975           throws PrinterException
 976   {
 977     final int idWidth = getVisibleIdWidth(false);
 978
 979     /*
 980      * Get the horizontal offset to where we draw the sequences.
 981      * This is idWidth if using a single Graphics context, else zero.
 982      */
 983     final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
 984             : idWidth;
 985
 986     FontMetrics fm = getFontMetrics(av.getFont());
 987     final int charHeight = av.getCharHeight();
 988     final int scaleHeight = charHeight + fm.getDescent();
 989
 990     idGraphics.setColor(Color.white);
 991     idGraphics.fillRect(0, 0, pageWidth, pageHeight);
 992     idGraphics.setFont(av.getFont());
 993
 994     /*
 995      * How many sequences and residues can we fit on a printable page?
 996      */
 997     final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
 998
 999     final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1000
1001     final int alignmentWidth = av.getAlignment().getVisibleWidth();
1002     int pagesWide = (alignmentWidth / totalRes) + 1;
1003
1004     final int startRes = (pageIndex % pagesWide) * totalRes;
1005     final int endRes = Math.min(startRes + totalRes - 1,
1006             alignmentWidth - 1);
1007
1008     final int startSeq = (pageIndex / pagesWide) * totalSeq;
1009     final int alignmentHeight = av.getAlignment().getHeight();
1010     final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
1011
1012     int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
1013
1014     if (av.isShowAnnotation())
1015     {
1016       pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1017     }
1018
1019     pagesHigh /= pageHeight;
1020
1021     if (pageIndex >= (pagesWide * pagesHigh))
1022     {
1023       return Printable.NO_SUCH_PAGE;
1024     }
1025     final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
1026
1027     /*
1028      * draw the Scale at horizontal offset, then reset to top left (0, 0)
1029      */
1030     alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1031     getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1032             pageWidth - idWidth, scaleHeight);
1033     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1034
1035     /*
1036      * Draw the sequence ids, offset for scale height,
1037      * then reset to top left (0, 0)
1038      */
1039     idGraphics.translate(0, scaleHeight);
1040     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1041     List<SequenceI> selection = av.getSelectionGroup() == null ? null
1042             : av.getSelectionGroup().getSequences(null);
1043     idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
1044             selection);
1045
1046     idGraphics.setFont(av.getFont());
1047     idGraphics.translate(0, -scaleHeight);
1048
1049     /*
1050      * draw the sequences, offset for scale height, and id width (if using a
1051      * single graphics context), then reset to (0, scale height)
1052      */
1053     alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1054     getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics,
1055             startRes, endRes, startSeq, endSeq - 1);
1056     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1057
1058     if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1059     {
1060       /*
1061        * draw annotation labels; drawComponent() translates by
1062        * getScrollOffset(), so compensate for that first;
1063        * then reset to (0, scale height)
1064        */
1065       int offset = getAlabels().getScrollOffset();
1066       idGraphics.translate(0, -offset);
1067       idGraphics.translate(0, alignmentDrawnHeight);
1068       getAlabels().drawComponent(idGraphics, idWidth);
1069       idGraphics.translate(0, -alignmentDrawnHeight);
1070
1071       /*
1072        * draw the annotations starting at
1073        * (idOffset, alignmentHeight) from (0, scaleHeight)
1074        */
1075       alignmentGraphics.translate(alignmentGraphicsOffset,
1076               alignmentDrawnHeight);
1077       updateLayout();
1078       getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1079               alignmentGraphics, -1, startRes, endRes + 1);
1080     }
1081
1082     return Printable.PAGE_EXISTS;
1083   }
1084
1085   /**
1086    * Prints one page of an alignment in wrapped mode. Returns
1087    * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
1088    * no page could be drawn (page number out of range).
1089    *
1090    * @param pageWidth
1091    * @param pageHeight
1092    * @param pageNumber
1093    *          (0, 1, ...)
1094    * @param g
1095    *
1096    * @return
1097    *
1098    * @throws PrinterException
1099    */
1100   public int printWrappedAlignment(int pageWidth, int pageHeight,
1101           int pageNumber, Graphics g) throws PrinterException
1102   {
1103     getSeqPanel().seqCanvas.calculateWrappedGeometry(getWidth(),
1104             getHeight());
1105     int annotationHeight = 0;
1106     if (av.isShowAnnotation())
1107     {
1108       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1109     }
1110
1111     int hgap = av.getCharHeight();
1112     if (av.getScaleAboveWrapped())
1113     {
1114       hgap += av.getCharHeight();
1115     }
1116
1117     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1118             + annotationHeight;
1119
1120     int idWidth = getVisibleIdWidth(false);
1121
1122     int maxwidth = av.getAlignment().getVisibleWidth();
1123
1124     int resWidth = getSeqPanel().seqCanvas
1125             .getWrappedCanvasWidth(pageWidth - idWidth);
1126     av.getRanges().setViewportStartAndWidth(0, resWidth);
1127
1128     int totalHeight = cHeight * (maxwidth / resWidth + 1);
1129
1130     g.setColor(Color.white);
1131     g.fillRect(0, 0, pageWidth, pageHeight);
1132     g.setFont(av.getFont());
1133     g.setColor(Color.black);
1134
1135     /*
1136      * method: print the whole wrapped alignment, but with a clip region that
1137      * is restricted to the requested page; this supports selective print of
1138      * single pages or ranges, (at the cost of repeated processing in the
1139      * 'normal' case, when all pages are printed)
1140      */
1141     g.translate(0, -pageNumber * pageHeight);
1142
1143     g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
1144
1145     /*
1146      * draw sequence ids and annotation labels (if shown)
1147      */
1148     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1149     idCanvas.drawIdsWrapped((Graphics2D) g, av, 0, totalHeight);
1150
1151     g.translate(idWidth, 0);
1152
1153     getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g,
1154             pageWidth - idWidth, totalHeight, 0);
1155
1156     if ((pageNumber * pageHeight) < totalHeight)
1157     {
1158       return Printable.PAGE_EXISTS;
1159     }
1160     else
1161     {
1162       return Printable.NO_SUCH_PAGE;
1163     }
1164   }
1165
1166   /**
1167    * get current sequence ID panel width, or nominal value if panel were to be
1168    * displayed using default settings
1169    *
1170    * @return
1171    */
1172   public int getVisibleIdWidth()
1173   {
1174     return getVisibleIdWidth(true);
1175   }
1176
1177   /**
1178    * get current sequence ID panel width, or nominal value if panel were to be
1179    * displayed using default settings
1180    *
1181    * @param onscreen
1182    *          indicate if the Id width for onscreen or offscreen display should
1183    *          be returned
1184    * @return
1185    */
1186   protected int getVisibleIdWidth(boolean onscreen)
1187   {
1188     // see if rendering offscreen - check preferences and calc width accordingly
1189     if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1190     {
1191       return calculateIdWidth(-1).width;
1192     }
1193     Integer idwidth = onscreen ? null
1194             : Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH");
1195     if (idwidth != null)
1196     {
1197       return idwidth.intValue() + ID_WIDTH_PADDING;
1198     }
1199
1200     int w = getIdPanel().getWidth();
1201     w = this.calculateIdWidth(-1, true, true).width;
1202     return (w > 0 ? w : calculateIdWidth().width);
1203   }
1204
1205   void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer)
1206           throws ImageOutputException
1207   {
1208     makeAlignmentImage(type, file, renderer,
1209             BitmapImageSizing.nullBitmapImageSizing());
1210   }
1211
1212   /**
1213    * Builds an image of the alignment of the specified type (EPS/PNG/SVG) and
1214    * writes it to the specified file
1215    *
1216    * @param type
1217    * @param file
1218    * @param textrenderer
1219    * @param bitmapscale
1220    */
1221   void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer,
1222           BitmapImageSizing userBis) throws ImageOutputException
1223   {
1224     final int borderBottomOffset = 5;
1225
1226     AlignmentDimension aDimension = getAlignmentDimension();
1227
1228     // todo use a lambda function in place of callback here?
1229     ImageWriterI writer = new ImageWriterI()
1230     {
1231       @Override
1232       public void exportImage(Graphics graphics) throws Exception
1233       {
1234         if (av.getWrapAlignment())
1235         {
1236           printWrappedAlignment(aDimension.getWidth(),
1237                   aDimension.getHeight() + borderBottomOffset, 0, graphics);
1238         }
1239         else
1240         {
1241           printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1242                   graphics, graphics);
1243         }
1244       }
1245     };
1246
1247     String fileTitle = alignFrame.getTitle();
1248     ImageExporter exporter = new ImageExporter(writer, alignFrame, type,
1249             fileTitle);
1250     int imageWidth = aDimension.getWidth();
1251     int imageHeight = aDimension.getHeight() + borderBottomOffset;
1252     String of = MessageManager.getString("label.alignment");
1253     exporter.doExport(file, this, imageWidth, imageHeight, of, renderer,
1254             userBis);
1255   }
1256
1257   /**
1258    * Calculates and returns a suitable width and height (in pixels) for an
1259    * exported image
1260    *
1261    * @return
1262    */
1263   public AlignmentDimension getAlignmentDimension()
1264   {
1265     int maxwidth = av.getAlignment().getVisibleWidth();
1266
1267     int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1268             + getScalePanel().getHeight();
1269     int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1270
1271     if (av.getWrapAlignment())
1272     {
1273       height = getWrappedHeight();
1274       if (Jalview.isHeadlessMode())
1275       {
1276         // need to obtain default alignment width and then add in any
1277         // additional allowance for id margin
1278         // this duplicates the calculation in getWrappedHeight but adjusts for
1279         // offscreen idWith
1280         width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1281                 - alignFrame.getInsets().left - alignFrame.getInsets().right
1282                 - getVisibleIdWidth() + getVisibleIdWidth(false);
1283       }
1284       else
1285       {
1286         width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1287       }
1288
1289     }
1290     else if (av.isShowAnnotation())
1291     {
1292       height += getAnnotationPanel().adjustPanelHeight() + 3;
1293     }
1294     return new AlignmentDimension(width, height);
1295
1296   }
1297
1298   public void makePNGImageMap(File imgMapFile, String imageName)
1299           throws ImageOutputException
1300   {
1301     // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1302     // ////////////////////////////////////////////
1303     int idWidth = getVisibleIdWidth(false);
1304     FontMetrics fm = getFontMetrics(av.getFont());
1305     int scaleHeight = av.getCharHeight() + fm.getDescent();
1306
1307     // Gen image map
1308     // ////////////////////////////////
1309     if (imgMapFile != null)
1310     {
1311       try
1312       {
1313         int sSize = av.getAlignment().getHeight();
1314         int alwidth = av.getAlignment().getWidth();
1315         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1316         out.println(HTMLOutput.getImageMapHTML());
1317         out.println("<img src=\"" + imageName
1318                 + "\" border=\"0\" usemap=\"#Map\" >"
1319                 + "<map name=\"Map\">");
1320
1321         for (int s = 0; s < sSize; s++)
1322         {
1323           int sy = s * av.getCharHeight() + scaleHeight;
1324
1325           SequenceI seq = av.getAlignment().getSequenceAt(s);
1326           SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1327           for (int column = 0; column < alwidth; column++)
1328           {
1329             StringBuilder text = new StringBuilder(512);
1330             String triplet = null;
1331             if (av.getAlignment().isNucleotide())
1332             {
1333               triplet = ResidueProperties.nucleotideName
1334                       .get(seq.getCharAt(column) + "");
1335             }
1336             else
1337             {
1338               triplet = ResidueProperties.aa2Triplet
1339                       .get(seq.getCharAt(column) + "");
1340             }
1341
1342             if (triplet == null)
1343             {
1344               continue;
1345             }
1346
1347             int seqPos = seq.findPosition(column);
1348             int gSize = groups.length;
1349             for (int g = 0; g < gSize; g++)
1350             {
1351               if (text.length() < 1)
1352               {
1353                 text.append("<area shape=\"rect\" coords=\"")
1354                         .append((idWidth + column * av.getCharWidth()))
1355                         .append(",").append(sy).append(",")
1356                         .append((idWidth
1357                                 + (column + 1) * av.getCharWidth()))
1358                         .append(",").append((av.getCharHeight() + sy))
1359                         .append("\"").append(" onMouseOver=\"toolTip('")
1360                         .append(seqPos).append(" ").append(triplet);
1361               }
1362
1363               if (groups[g].getStartRes() < column
1364                       && groups[g].getEndRes() > column)
1365               {
1366                 text.append("<br><em>").append(groups[g].getName())
1367                         .append("</em>");
1368               }
1369             }
1370
1371             if (text.length() < 1)
1372             {
1373               text.append("<area shape=\"rect\" coords=\"")
1374                       .append((idWidth + column * av.getCharWidth()))
1375                       .append(",").append(sy).append(",")
1376                       .append((idWidth + (column + 1) * av.getCharWidth()))
1377                       .append(",").append((av.getCharHeight() + sy))
1378                       .append("\"").append(" onMouseOver=\"toolTip('")
1379                       .append(seqPos).append(" ").append(triplet);
1380             }
1381             if (!Comparison.isGap(seq.getCharAt(column)))
1382             {
1383               List<SequenceFeature> features = seq.findFeatures(column,
1384                       column);
1385               for (SequenceFeature sf : features)
1386               {
1387                 if (sf.isContactFeature())
1388                 {
1389                   text.append("<br>").append(sf.getType()).append(" ")
1390                           .append(sf.getBegin()).append(":")
1391                           .append(sf.getEnd());
1392                 }
1393                 else
1394                 {
1395                   text.append("<br>");
1396                   text.append(sf.getType());
1397                   String description = sf.getDescription();
1398                   if (description != null
1399                           && !sf.getType().equals(description))
1400                   {
1401                     description = description.replace("\"", "&quot;");
1402                     text.append(" ").append(description);
1403                   }
1404                 }
1405                 String status = sf.getStatus();
1406                 if (status != null && !"".equals(status))
1407                 {
1408                   text.append(" (").append(status).append(")");
1409                 }
1410               }
1411               if (text.length() > 1)
1412               {
1413                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");
1414                 out.println(text.toString());
1415               }
1416             }
1417           }
1418         }
1419         out.println("</map></body></html>");
1420         out.close();
1421
1422       } catch (Exception ex)
1423       {
1424         throw new ImageOutputException(
1425                 "couldn't write ImageMap due to unexpected error", ex);
1426       }
1427     } // /////////END OF IMAGE MAP
1428
1429   }
1430
1431   /**
1432    * Answers the height of the entire alignment in pixels, assuming it is in
1433    * wrapped mode
1434    *
1435    * @return
1436    */
1437   int getWrappedHeight()
1438   {
1439     int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1440
1441     if (Jalview.isHeadlessMode())
1442     {
1443       seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1444               - vscroll.getPreferredSize().width
1445               - alignFrame.getInsets().left - alignFrame.getInsets().right;
1446     }
1447
1448     int chunkWidth = getSeqPanel().seqCanvas
1449             .getWrappedCanvasWidth(seqPanelWidth);
1450
1451     int hgap = av.getCharHeight();
1452     if (av.getScaleAboveWrapped())
1453     {
1454       hgap += av.getCharHeight();
1455     }
1456
1457     int annotationHeight = 0;
1458     if (av.isShowAnnotation())
1459     {
1460       hgap += SeqCanvas.SEQS_ANNOTATION_GAP;
1461       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1462     }
1463
1464     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1465             + annotationHeight;
1466
1467     int maxwidth = av.getAlignment().getWidth();
1468     if (av.hasHiddenColumns())
1469     {
1470       maxwidth = av.getAlignment().getHiddenColumns()
1471               .absoluteToVisibleColumn(maxwidth) - 1;
1472     }
1473
1474     int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1475
1476     return height;
1477   }
1478
1479   /**
1480    * close the panel - deregisters all listeners and nulls any references to
1481    * alignment data.
1482    */
1483   public void closePanel()
1484   {
1485     PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1486     PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1487     PaintRefresher.RemoveComponent(this);
1488
1489     closeChildFrames();
1490
1491     /*
1492      * try to ensure references are nulled
1493      */
1494     if (annotationPanel != null)
1495     {
1496       annotationPanel.dispose();
1497       annotationPanel = null;
1498     }
1499
1500     if (av != null)
1501     {
1502       av.removePropertyChangeListener(propertyChangeListener);
1503       propertyChangeListener = null;
1504       StructureSelectionManager ssm = av.getStructureSelectionManager();
1505       ssm.removeStructureViewerListener(getSeqPanel(), null);
1506       ssm.removeSelectionListener(getSeqPanel());
1507       ssm.removeCommandListener(av);
1508       ssm.removeStructureViewerListener(getSeqPanel(), null);
1509       ssm.removeSelectionListener(getSeqPanel());
1510       av.dispose();
1511       av = null;
1512     }
1513     else
1514     {
1515       if (Console.isDebugEnabled())
1516       {
1517         Console.warn("Closing alignment panel which is already closed.");
1518       }
1519     }
1520   }
1521
1522   /**
1523    * Close any open dialogs that would be orphaned when this one is closed
1524    */
1525   protected void closeChildFrames()
1526   {
1527     if (overviewPanel != null)
1528     {
1529       overviewPanel.dispose();
1530       overviewPanel = null;
1531     }
1532     if (calculationDialog != null)
1533     {
1534       calculationDialog.closeFrame();
1535       calculationDialog = null;
1536     }
1537   }
1538
1539   /**
1540    * hides or shows dynamic annotation rows based on groups and av state flags
1541    */
1542   public void updateAnnotation()
1543   {
1544     updateAnnotation(false, false);
1545   }
1546
1547   public void updateAnnotation(boolean applyGlobalSettings)
1548   {
1549     updateAnnotation(applyGlobalSettings, false);
1550   }
1551
1552   public void updateAnnotation(boolean applyGlobalSettings,
1553           boolean preserveNewGroupSettings)
1554   {
1555     av.updateGroupAnnotationSettings(applyGlobalSettings,
1556             preserveNewGroupSettings);
1557     adjustAnnotationHeight();
1558   }
1559
1560   @Override
1561   public AlignmentI getAlignment()
1562   {
1563     return av == null ? null : av.getAlignment();
1564   }
1565
1566   @Override
1567   public String getViewName()
1568   {
1569     return av.getViewName();
1570   }
1571
1572   /**
1573    * Make/Unmake this alignment panel the current input focus
1574    *
1575    * @param b
1576    */
1577   public void setSelected(boolean b)
1578   {
1579     try
1580     {
1581       if (alignFrame.getSplitViewContainer() != null)
1582       {
1583         /*
1584          * bring enclosing SplitFrame to front first if there is one
1585          */
1586         ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1587       }
1588       alignFrame.setSelected(b);
1589     } catch (Exception ex)
1590     {
1591     }
1592     if (b)
1593     {
1594       setAlignFrameView();
1595     }
1596   }
1597
1598   public void setAlignFrameView()
1599   {
1600     alignFrame.setDisplayedView(this);
1601   }
1602
1603   @Override
1604   public StructureSelectionManager getStructureSelectionManager()
1605   {
1606     return av.getStructureSelectionManager();
1607   }
1608
1609   @Override
1610   public void raiseOOMWarning(String string, OutOfMemoryError error)
1611   {
1612     new OOMWarning(string, error, this);
1613   }
1614
1615   @Override
1616   public jalview.api.FeatureRenderer cloneFeatureRenderer()
1617   {
1618
1619     return new FeatureRenderer(this);
1620   }
1621
1622   @Override
1623   public jalview.api.FeatureRenderer getFeatureRenderer()
1624   {
1625     return seqPanel.seqCanvas.getFeatureRenderer();
1626   }
1627
1628   public void updateFeatureRenderer(
1629           jalview.renderer.seqfeatures.FeatureRenderer fr)
1630   {
1631     fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1632   }
1633
1634   public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1635   {
1636     if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1637     {
1638       getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1639     }
1640   }
1641
1642   public ScalePanel getScalePanel()
1643   {
1644     return scalePanel;
1645   }
1646
1647   public void setScalePanel(ScalePanel scalePanel)
1648   {
1649     this.scalePanel = scalePanel;
1650   }
1651
1652   public SeqPanel getSeqPanel()
1653   {
1654     return seqPanel;
1655   }
1656
1657   public void setSeqPanel(SeqPanel seqPanel)
1658   {
1659     this.seqPanel = seqPanel;
1660   }
1661
1662   public AnnotationPanel getAnnotationPanel()
1663   {
1664     return annotationPanel;
1665   }
1666
1667   public void setAnnotationPanel(AnnotationPanel annotationPanel)
1668   {
1669     this.annotationPanel = annotationPanel;
1670   }
1671
1672   public AnnotationLabels getAlabels()
1673   {
1674     return alabels;
1675   }
1676
1677   public void setAlabels(AnnotationLabels alabels)
1678   {
1679     this.alabels = alabels;
1680   }
1681
1682   public IdPanel getIdPanel()
1683   {
1684     return idPanel;
1685   }
1686
1687   public void setIdPanel(IdPanel idPanel)
1688   {
1689     this.idPanel = idPanel;
1690   }
1691
1692   /**
1693    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1694    * The aim is to keep the two alignments 'lined up' on their centre columns.
1695    *
1696    * @param sr
1697    *          holds mapped region(s) of this alignment that we are scrolling
1698    *          'to'; may be modified for sequence offset by this method
1699    * @param verticalOffset
1700    *          the number of visible sequences to show above the mapped region
1701    */
1702   protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1703   {
1704     scrollToPosition(sr, verticalOffset, true);
1705   }
1706
1707   /**
1708    * Set a flag to say do not scroll any (cDNA/protein) complement.
1709    *
1710    * @param b
1711    */
1712   protected void setToScrollComplementPanel(boolean b)
1713   {
1714     this.scrollComplementaryPanel = b;
1715   }
1716
1717   /**
1718    * Get whether to scroll complement panel
1719    *
1720    * @return true if cDNA/protein complement panels should be scrolled
1721    */
1722   protected boolean isSetToScrollComplementPanel()
1723   {
1724     return this.scrollComplementaryPanel;
1725   }
1726
1727   /**
1728    * Redraw sensibly.
1729    *
1730    * @adjustHeight if true, try to recalculate panel height for visible
1731    *               annotations
1732    */
1733   protected void refresh(boolean adjustHeight)
1734   {
1735     validateAnnotationDimensions(adjustHeight);
1736     addNotify();
1737     if (adjustHeight)
1738     {
1739       // sort, repaint, update overview
1740       paintAlignment(true, false);
1741     }
1742     else
1743     {
1744       // lightweight repaint
1745       repaint();
1746     }
1747   }
1748
1749   @Override
1750   /**
1751    * Property change event fired when a change is made to the viewport ranges
1752    * object associated with this alignment panel's viewport
1753    */
1754   public void propertyChange(PropertyChangeEvent evt)
1755   {
1756     // update this panel's scroll values based on the new viewport ranges values
1757     ViewportRanges ranges = av.getRanges();
1758     int x = ranges.getStartRes();
1759     int y = ranges.getStartSeq();
1760     setScrollValues(x, y);
1761
1762     // now update any complementary alignment (its viewport ranges object
1763     // is different so does not get automatically updated)
1764     if (isSetToScrollComplementPanel())
1765     {
1766       setToScrollComplementPanel(false);
1767       av.scrollComplementaryAlignment();
1768       setToScrollComplementPanel(true);
1769     }
1770   }
1771
1772   /**
1773    * Set the reference to the PCA/Tree chooser dialog for this panel. This
1774    * reference should be nulled when the dialog is closed.
1775    *
1776    * @param calculationChooser
1777    */
1778   public void setCalculationDialog(CalculationChooser calculationChooser)
1779   {
1780     calculationDialog = calculationChooser;
1781   }
1782
1783   /**
1784    * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1785    * if none is open)
1786    */
1787   public CalculationChooser getCalculationDialog()
1788   {
1789     return calculationDialog;
1790   }
1791
1792   /**
1793    * Constructs and sets the title for the Overview window (if there is one),
1794    * including the align frame's title, and view name (if applicable). Returns
1795    * the title, or null if this panel has no Overview window open.
1796    *
1797    * @param alignFrame
1798    * @return
1799    */
1800   public String setOverviewTitle(AlignFrame alignFrame)
1801   {
1802     if (this.overviewPanel == null)
1803     {
1804       return null;
1805     }
1806     String overviewTitle = MessageManager
1807             .formatMessage("label.overview_params", new Object[]
1808             { alignFrame.getTitle() });
1809     String viewName = getViewName();
1810     if (viewName != null)
1811     {
1812       overviewTitle += (" " + viewName);
1813     }
1814     overviewPanel.setTitle(overviewTitle);
1815     return overviewTitle;
1816   }
1817
1818   /**
1819    * If this alignment panel has an Overview panel open, closes it
1820    */
1821   public void closeOverviewPanel()
1822   {
1823     if (overviewPanel != null)
1824     {
1825       overviewPanel.close();
1826       overviewPanel = null;
1827     }
1828   }
1829
1830 }