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