src/jalview/gui/AlignmentPanel.java

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