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