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