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