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