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.analysis.AnnotationSorter.SequenceAnnotationOrder;
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.AlignmentViewPanel;
  27 import jalview.bin.Cache;
  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.io.HTMLOutput;
  35 import jalview.jbgui.GAlignmentPanel;
  36 import jalview.math.AlignmentDimension;
  37 import jalview.schemes.ResidueProperties;
  38 import jalview.structure.StructureSelectionManager;
  39 import jalview.util.Comparison;
  40 import jalview.util.MessageManager;
  41 import jalview.viewmodel.ViewportListenerI;
  42 import jalview.viewmodel.ViewportRanges;
  43
  44 import java.awt.BorderLayout;
  45 import java.awt.Color;
  46 import java.awt.Container;
  47 import java.awt.Dimension;
  48 import java.awt.Font;
  49 import java.awt.FontMetrics;
  50 import java.awt.Graphics;
  51 import java.awt.Graphics2D;
  52 import java.awt.event.AdjustmentEvent;
  53 import java.awt.event.AdjustmentListener;
  54 import java.awt.event.ComponentAdapter;
  55 import java.awt.event.ComponentEvent;
  56 import java.awt.print.PageFormat;
  57 import java.awt.print.Printable;
  58 import java.awt.print.PrinterException;
  59 import java.beans.PropertyChangeEvent;
  60 import java.beans.PropertyChangeListener;
  61 import java.io.File;
  62 import java.io.FileWriter;
  63 import java.io.PrintWriter;
  64 import java.util.List;
  65
  66 import javax.swing.SwingUtilities;
  67
  68 /**
  69  * DOCUMENT ME!
  70  *
  71  * @author $author$
  72  * @version $Revision: 1.161 $
  73  */
  74 public class AlignmentPanel extends GAlignmentPanel implements
  75         AdjustmentListener, Printable, AlignmentViewPanel, ViewportListenerI
  76 {
  77   public AlignViewport av;
  78
  79   OverviewPanel overviewPanel;
  80
  81   private SeqPanel seqPanel;
  82
  83   private IdPanel idPanel;
  84
  85   private boolean headless;
  86
  87   IdwidthAdjuster idwidthAdjuster;
  88
  89   /** DOCUMENT ME!! */
  90   public AlignFrame alignFrame;
  91
  92   private ScalePanel scalePanel;
  93
  94   private AnnotationPanel annotationPanel;
  95
  96   private AnnotationLabels alabels;
  97
  98   private int hextent = 0;
  99
 100   private int vextent = 0;
 101
 102   /*
 103    * Flag set while scrolling to follow complementary cDNA/protein scroll. When
 104    * false, suppresses invoking the same method recursively.
 105    */
 106   private boolean scrollComplementaryPanel = true;
 107
 108   private PropertyChangeListener propertyChangeListener;
 109
 110   private CalculationChooser calculationDialog;
 111
 112   /**
 113    * Creates a new AlignmentPanel object.
 114    *
 115    * @param af
 116    * @param av
 117    */
 118   public AlignmentPanel(AlignFrame af, final AlignViewport av)
 119   {
 120     alignFrame = af;
 121     this.av = av;
 122     setSeqPanel(new SeqPanel(av, this));
 123     setIdPanel(new IdPanel(av, this));
 124
 125     setScalePanel(new ScalePanel(av, this));
 126
 127     idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
 128     idwidthAdjuster = new IdwidthAdjuster(this);
 129     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
 130
 131     setAnnotationPanel(new AnnotationPanel(this));
 132     setAlabels(new AnnotationLabels(this));
 133
 134     annotationScroller.setViewportView(getAnnotationPanel());
 135     annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
 136
 137     scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
 138     seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
 139
 140     setScrollValues(0, 0);
 141
 142     hscroll.addAdjustmentListener(this);
 143     vscroll.addAdjustmentListener(this);
 144
 145     addComponentListener(new ComponentAdapter()
 146     {
 147       @Override
 148       public void componentResized(ComponentEvent evt)
 149       {
 150         // reset the viewport ranges when the alignment panel is resized
 151         // in particular, this initialises the end residue value when Jalview
 152         // is initialised
 153         ViewportRanges ranges = av.getRanges();
 154         if (av.getWrapAlignment())
 155         {
 156           int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
 157                   getSeqPanel().seqCanvas.getWidth());
 158           ranges.setViewportWidth(widthInRes);
 159         }
 160         else
 161         {
 162           int widthInRes = getSeqPanel().seqCanvas.getWidth()
 163                   / av.getCharWidth();
 164           int heightInSeq = getSeqPanel().seqCanvas.getHeight()
 165                   / av.getCharHeight();
 166
 167           ranges.setViewportWidth(widthInRes);
 168           ranges.setViewportHeight(heightInSeq);
 169         }
 170       }
 171
 172     });
 173
 174     final AlignmentPanel ap = this;
 175     propertyChangeListener = new PropertyChangeListener()
 176     {
 177       @Override
 178       public void propertyChange(PropertyChangeEvent evt)
 179       {
 180         if (evt.getPropertyName().equals("alignment"))
 181         {
 182           PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
 183           alignmentChanged();
 184         }
 185       }
 186     };
 187     av.addPropertyChangeListener(propertyChangeListener);
 188
 189     av.getRanges().addPropertyChangeListener(this);
 190     fontChanged();
 191     adjustAnnotationHeight();
 192     updateLayout();
 193   }
 194
 195   @Override
 196   public AlignViewportI getAlignViewport()
 197   {
 198     return av;
 199   }
 200
 201   public void alignmentChanged()
 202   {
 203     av.alignmentChanged(this);
 204
 205     if (getCalculationDialog() != null)
 206     {
 207       getCalculationDialog().validateCalcTypes();
 208     }
 209
 210     alignFrame.updateEditMenuBar();
 211
 212     // no idea if we need to update structure
 213     paintAlignment(true, true);
 214
 215   }
 216
 217   /**
 218    * DOCUMENT ME!
 219    */
 220   public void fontChanged()
 221   {
 222     // set idCanvas bufferedImage to null
 223     // to prevent drawing old image
 224     FontMetrics fm = getFontMetrics(av.getFont());
 225
 226     scalePanelHolder.setPreferredSize(
 227             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 228     idSpaceFillerPanel1.setPreferredSize(
 229             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 230     idwidthAdjuster.invalidate();
 231     scalePanelHolder.invalidate();
 232     getIdPanel().getIdCanvas().gg = null;
 233     getSeqPanel().seqCanvas.img = null;
 234     getAnnotationPanel().adjustPanelHeight();
 235
 236     Dimension d = calculateIdWidth();
 237
 238     d.setSize(d.width + 4, d.height);
 239     getIdPanel().getIdCanvas().setPreferredSize(d);
 240     hscrollFillerPanel.setPreferredSize(d);
 241
 242     repaint();
 243   }
 244
 245   /**
 246    * Calculate the width of the alignment labels based on the displayed names
 247    * and any bounds on label width set in preferences.
 248    *
 249    * @return Dimension giving the maximum width of the alignment label panel
 250    *         that should be used.
 251    */
 252   public Dimension calculateIdWidth()
 253   {
 254     // calculate sensible default width when no preference is available
 255     Dimension r = null;
 256     if (av.getIdWidth() < 0)
 257     {
 258       int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
 259       int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
 260       r = calculateIdWidth(maxwidth);
 261       av.setIdWidth(r.width);
 262     }
 263     else
 264     {
 265       r = new Dimension();
 266       r.width = av.getIdWidth();
 267       r.height = 0;
 268     }
 269     return r;
 270   }
 271
 272   /**
 273    * Calculate the width of the alignment labels based on the displayed names
 274    * and any bounds on label width set in preferences.
 275    *
 276    * @param maxwidth
 277    *          -1 or maximum width allowed for IdWidth
 278    * @return Dimension giving the maximum width of the alignment label panel
 279    *         that should be used.
 280    */
 281   public Dimension calculateIdWidth(int maxwidth)
 282   {
 283     Container c = new Container();
 284
 285     FontMetrics fm = c.getFontMetrics(
 286             new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
 287
 288     AlignmentI al = av.getAlignment();
 289     int i = 0;
 290     int idWidth = 0;
 291     String id;
 292
 293     while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
 294     {
 295       SequenceI s = al.getSequenceAt(i);
 296
 297       id = s.getDisplayId(av.getShowJVSuffix());
 298
 299       if (fm.stringWidth(id) > idWidth)
 300       {
 301         idWidth = fm.stringWidth(id);
 302       }
 303
 304       i++;
 305     }
 306
 307     // Also check annotation label widths
 308     i = 0;
 309
 310     if (al.getAlignmentAnnotation() != null)
 311     {
 312       fm = c.getFontMetrics(getAlabels().getFont());
 313
 314       while (i < al.getAlignmentAnnotation().length)
 315       {
 316         String label = al.getAlignmentAnnotation()[i].label;
 317
 318         if (fm.stringWidth(label) > idWidth)
 319         {
 320           idWidth = fm.stringWidth(label);
 321         }
 322
 323         i++;
 324       }
 325     }
 326
 327     return new Dimension(
 328             maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth), 12);
 329   }
 330
 331   /**
 332    * Highlight the given results on the alignment
 333    *
 334    */
 335   public void highlightSearchResults(SearchResultsI results)
 336   {
 337     boolean scrolled = scrollToPosition(results, 0, false);
 338
 339     boolean noFastPaint = scrolled && av.getWrapAlignment();
 340
 341     getSeqPanel().seqCanvas.highlightSearchResults(results, noFastPaint);
 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     repaint();
 809
 810     if (updateStructures)
 811     {
 812       av.getStructureSelectionManager().sequenceColoursChanged(this);
 813     }
 814     if (updateOverview)
 815     {
 816
 817       if (overviewPanel != null)
 818       {
 819         overviewPanel.updateOverviewImage();
 820       }
 821     }
 822   }
 823
 824   /**
 825    * Sorts annotations according to currently selected preferences. Does nothing
 826    * if currently set to 'Custom' (manual) ordering.
 827    */
 828   void sortAnnotations()
 829   {
 830     SequenceAnnotationOrder sortBy = av.getSortAnnotationsBy();
 831     if (sortBy != SequenceAnnotationOrder.CUSTOM)
 832     {
 833       final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
 834               av.isShowAutocalculatedAbove());
 835       sorter.sort(getAlignment().getAlignmentAnnotation(), sortBy);
 836     }
 837   }
 838
 839   /**
 840    * DOCUMENT ME!
 841    *
 842    * @param g
 843    *          DOCUMENT ME!
 844    */
 845   @Override
 846   public void paintComponent(Graphics g)
 847   {
 848     invalidate(); // needed so that the id width adjuster works correctly
 849
 850     Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
 851     idPanelHolder.setPreferredSize(d);
 852     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
 853
 854     validate(); // needed so that the id width adjuster works correctly
 855
 856     /*
 857      * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
 858      * though I still think this call should be elsewhere.
 859      */
 860     ViewportRanges ranges = av.getRanges();
 861     setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
 862   }
 863
 864   /**
 865    * Set vertical scroll bar position, and number of increments, for wrapped
 866    * panel
 867    *
 868    * @param topLeftColumn
 869    *          the column position at top left (0..)
 870    */
 871   private void setScrollingForWrappedPanel(int topLeftColumn)
 872   {
 873     ViewportRanges ranges = av.getRanges();
 874     int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
 875     int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
 876
 877     /*
 878      * a scrollbar's value can be set to at most (maximum-extent)
 879      * so we add extent (1) to the maxScroll value
 880      */
 881     vscroll.setUnitIncrement(1);
 882     vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
 883   }
 884
 885   /**
 886    * DOCUMENT ME!
 887    *
 888    * @param pg
 889    *          DOCUMENT ME!
 890    * @param pf
 891    *          DOCUMENT ME!
 892    * @param pi
 893    *          DOCUMENT ME!
 894    *
 895    * @return DOCUMENT ME!
 896    *
 897    * @throws PrinterException
 898    *           DOCUMENT ME!
 899    */
 900   @Override
 901   public int print(Graphics pg, PageFormat pf, int pi)
 902           throws PrinterException
 903   {
 904     pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 905
 906     int pwidth = (int) pf.getImageableWidth();
 907     int pheight = (int) pf.getImageableHeight();
 908
 909     if (av.getWrapAlignment())
 910     {
 911       return printWrappedAlignment(pwidth, pheight, pi, pg);
 912     }
 913     else
 914     {
 915       return printUnwrapped(pwidth, pheight, pi, pg, pg);
 916     }
 917   }
 918
 919   /**
 920    * Draws the alignment image, including sequence ids, sequences, and
 921    * annotation labels and annotations if shown, on either one or two Graphics
 922    * contexts.
 923    *
 924    * @param pageWidth
 925    *          in pixels
 926    * @param pageHeight
 927    *          in pixels
 928    * @param pageIndex
 929    *          (0, 1, ...)
 930    * @param idGraphics
 931    *          the graphics context for sequence ids and annotation labels
 932    * @param alignmentGraphics
 933    *          the graphics context for sequences and annotations (may or may not
 934    *          be the same context as idGraphics)
 935    * @return
 936    * @throws PrinterException
 937    */
 938   public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
 939           Graphics idGraphics, Graphics alignmentGraphics)
 940           throws PrinterException
 941   {
 942     final int idWidth = getVisibleIdWidth(false);
 943
 944     /*
 945      * Get the horizontal offset to where we draw the sequences.
 946      * This is idWidth if using a single Graphics context, else zero.
 947      */
 948     final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
 949             : idWidth;
 950
 951     FontMetrics fm = getFontMetrics(av.getFont());
 952     final int charHeight = av.getCharHeight();
 953     final int scaleHeight = charHeight + fm.getDescent();
 954
 955     idGraphics.setColor(Color.white);
 956     idGraphics.fillRect(0, 0, pageWidth, pageHeight);
 957     idGraphics.setFont(av.getFont());
 958
 959     /*
 960      * How many sequences and residues can we fit on a printable page?
 961      */
 962     final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
 963
 964     final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
 965
 966     final int alignmentWidth = av.getAlignment().getVisibleWidth();
 967     int pagesWide = (alignmentWidth / totalRes) + 1;
 968
 969     final int startRes = (pageIndex % pagesWide) * totalRes;
 970     final int endRes = Math.min(startRes + totalRes - 1,
 971             alignmentWidth - 1);
 972
 973     final int startSeq = (pageIndex / pagesWide) * totalSeq;
 974     final int alignmentHeight = av.getAlignment().getHeight();
 975     final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
 976
 977     int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
 978
 979     if (av.isShowAnnotation())
 980     {
 981       pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
 982     }
 983
 984     pagesHigh /= pageHeight;
 985
 986     if (pageIndex >= (pagesWide * pagesHigh))
 987     {
 988       return Printable.NO_SUCH_PAGE;
 989     }
 990     final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
 991
 992     /*
 993      * draw the Scale at horizontal offset, then reset to top left (0, 0)
 994      */
 995     alignmentGraphics.translate(alignmentGraphicsOffset, 0);
 996     getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
 997             pageWidth - idWidth, scaleHeight);
 998     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
 999
1000     /*
1001      * Draw the sequence ids, offset for scale height,
1002      * then reset to top left (0, 0)
1003      */
1004     idGraphics.translate(0, scaleHeight);
1005     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1006     List<SequenceI> selection = av.getSelectionGroup() == null ? null
1007             : av.getSelectionGroup().getSequences(null);
1008     idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
1009             selection);
1010
1011     idGraphics.setFont(av.getFont());
1012     idGraphics.translate(0, -scaleHeight);
1013
1014     /*
1015      * draw the sequences, offset for scale height, and id width (if using a
1016      * single graphics context), then reset to (0, scale height)
1017      */
1018     alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1019     getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics, startRes,
1020             endRes, startSeq, endSeq - 1);
1021     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1022
1023     if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1024     {
1025       /*
1026        * draw annotation labels; drawComponent() translates by
1027        * getScrollOffset(), so compensate for that first;
1028        * then reset to (0, scale height)
1029        */
1030       int offset = getAlabels().getScrollOffset();
1031       idGraphics.translate(0, -offset);
1032       idGraphics.translate(0, alignmentDrawnHeight);
1033       getAlabels().drawComponent(idGraphics, idWidth);
1034       idGraphics.translate(0, -alignmentDrawnHeight);
1035
1036       /*
1037        * draw the annotations starting at
1038        * (idOffset, alignmentHeight) from (0, scaleHeight)
1039        */
1040       alignmentGraphics.translate(alignmentGraphicsOffset,
1041               alignmentDrawnHeight);
1042       getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1043               alignmentGraphics, -1, startRes, endRes + 1);
1044     }
1045
1046     return Printable.PAGE_EXISTS;
1047   }
1048
1049   /**
1050    * Prints one page of an alignment in wrapped mode. Returns
1051    * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
1052    * no page could be drawn (page number out of range).
1053    *
1054    * @param pageWidth
1055    * @param pageHeight
1056    * @param pageNumber
1057    *          (0, 1, ...)
1058    * @param g
1059    *
1060    * @return
1061    *
1062    * @throws PrinterException
1063    */
1064   public int printWrappedAlignment(int pageWidth, int pageHeight, int pageNumber,
1065           Graphics g) throws PrinterException
1066   {
1067     int annotationHeight = 0;
1068     if (av.isShowAnnotation())
1069     {
1070       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1071     }
1072
1073     int hgap = av.getCharHeight();
1074     if (av.getScaleAboveWrapped())
1075     {
1076       hgap += av.getCharHeight();
1077     }
1078
1079     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1080             + annotationHeight;
1081
1082     int idWidth = getVisibleIdWidth(false);
1083
1084     int maxwidth = av.getAlignment().getVisibleWidth();
1085
1086     int resWidth = getSeqPanel().seqCanvas
1087             .getWrappedCanvasWidth(pageWidth - idWidth);
1088
1089     int totalHeight = cHeight * (maxwidth / resWidth + 1);
1090
1091     g.setColor(Color.white);
1092     g.fillRect(0, 0, pageWidth, pageHeight);
1093     g.setFont(av.getFont());
1094     g.setColor(Color.black);
1095
1096     /*
1097      * method: print the whole wrapped alignment, but with a clip region that
1098      * is restricted to the requested page; this supports selective print of
1099      * single  pages or ranges, (at the cost of some repeated processing in
1100      * the 'normal' case, when all pages are printed)
1101      */
1102     g.translate(0, -pageNumber * pageHeight);
1103
1104     g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
1105
1106     /*
1107      * draw sequence ids and annotation labels (if shown)
1108      */
1109     IdCanvas idCanvas = getIdPanel().getIdCanvas();
1110     idCanvas.drawIdsWrapped((Graphics2D) g, av, 0, totalHeight);
1111
1112     g.translate(idWidth, 0);
1113
1114     getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g, pageWidth - idWidth,
1115             totalHeight, 0);
1116
1117     if ((pageNumber * pageHeight) < totalHeight)
1118     {
1119       return Printable.PAGE_EXISTS;
1120     }
1121     else
1122     {
1123       return Printable.NO_SUCH_PAGE;
1124     }
1125   }
1126
1127   /**
1128    * get current sequence ID panel width, or nominal value if panel were to be
1129    * displayed using default settings
1130    *
1131    * @return
1132    */
1133   public int getVisibleIdWidth()
1134   {
1135     return getVisibleIdWidth(true);
1136   }
1137
1138   /**
1139    * get current sequence ID panel width, or nominal value if panel were to be
1140    * displayed using default settings
1141    *
1142    * @param onscreen
1143    *          indicate if the Id width for onscreen or offscreen display should
1144    *          be returned
1145    * @return
1146    */
1147   public int getVisibleIdWidth(boolean onscreen)
1148   {
1149     // see if rendering offscreen - check preferences and calc width accordingly
1150     if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1151     {
1152       return calculateIdWidth(-1).width + 4;
1153     }
1154     Integer idwidth = null;
1155     if (onscreen || (idwidth = Cache
1156             .getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1157     {
1158       int w = getIdPanel().getWidth();
1159       return (w > 0 ? w : calculateIdWidth().width + 4);
1160     }
1161     return idwidth.intValue() + 4;
1162   }
1163
1164   void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1165   {
1166     int boarderBottomOffset = 5;
1167     long pSessionId = System.currentTimeMillis();
1168     headless = (System.getProperty("java.awt.headless") != null
1169             && System.getProperty("java.awt.headless").equals("true"));
1170     if (alignFrame != null && !headless)
1171     {
1172       if (file != null)
1173       {
1174         alignFrame.setProgressBar(MessageManager
1175                 .formatMessage("status.saving_file", new Object[]
1176                 { type.getLabel() }), pSessionId);
1177       }
1178     }
1179     try
1180     {
1181       AlignmentDimension aDimension = getAlignmentDimension();
1182       try
1183       {
1184         jalview.util.ImageMaker im;
1185         final String imageAction, imageTitle;
1186         if (type == jalview.util.ImageMaker.TYPE.PNG)
1187         {
1188           imageAction = "Create PNG image from alignment";
1189           imageTitle = null;
1190         }
1191         else if (type == jalview.util.ImageMaker.TYPE.EPS)
1192         {
1193           imageAction = "Create EPS file from alignment";
1194           imageTitle = alignFrame.getTitle();
1195         }
1196         else
1197         {
1198           imageAction = "Create SVG file from alignment";
1199           imageTitle = alignFrame.getTitle();
1200         }
1201
1202         im = new jalview.util.ImageMaker(this, type, imageAction,
1203                 aDimension.getWidth(),
1204                 aDimension.getHeight() + boarderBottomOffset, file,
1205                 imageTitle, alignFrame, pSessionId, headless);
1206         Graphics graphics = im.getGraphics();
1207         if (av.getWrapAlignment())
1208         {
1209           if (graphics != null)
1210           {
1211             printWrappedAlignment(aDimension.getWidth(),
1212                     aDimension.getHeight() + boarderBottomOffset, 0,
1213                     graphics);
1214             im.writeImage();
1215           }
1216         }
1217         else
1218         {
1219           if (graphics != null)
1220           {
1221             printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1222                     graphics, graphics);
1223             im.writeImage();
1224           }
1225         }
1226
1227       } catch (OutOfMemoryError err)
1228       {
1229         // Be noisy here.
1230         System.out.println("########################\n" + "OUT OF MEMORY "
1231                 + file + "\n" + "########################");
1232         new OOMWarning("Creating Image for " + file, err);
1233         // System.out.println("Create IMAGE: " + err);
1234       } catch (Exception ex)
1235       {
1236         ex.printStackTrace();
1237       }
1238     } finally
1239     {
1240
1241     }
1242   }
1243
1244   public AlignmentDimension getAlignmentDimension()
1245   {
1246     int maxwidth = av.getAlignment().getVisibleWidth();
1247
1248     int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1249             + getScalePanel().getHeight();
1250     int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1251
1252     if (av.getWrapAlignment())
1253     {
1254       height = getWrappedHeight();
1255       if (headless)
1256       {
1257         // need to obtain default alignment width and then add in any
1258         // additional allowance for id margin
1259         // this duplicates the calculation in getWrappedHeight but adjusts for
1260         // offscreen idWith
1261         width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1262                 - alignFrame.getInsets().left - alignFrame.getInsets().right
1263                 - getVisibleIdWidth() + getVisibleIdWidth(false);
1264       }
1265       else
1266       {
1267         width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1268       }
1269
1270     }
1271     else if (av.isShowAnnotation())
1272     {
1273       height += getAnnotationPanel().adjustPanelHeight() + 3;
1274     }
1275     return new AlignmentDimension(width, height);
1276
1277   }
1278
1279   /**
1280    * DOCUMENT ME!
1281    */
1282   public void makeEPS(File epsFile)
1283   {
1284     makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1285   }
1286
1287   /**
1288    * DOCUMENT ME!
1289    */
1290   public void makePNG(File pngFile)
1291   {
1292     makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1293   }
1294
1295   public void makeSVG(File svgFile)
1296   {
1297     makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1298   }
1299
1300   public void makePNGImageMap(File imgMapFile, String imageName)
1301   {
1302     // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1303     // ////////////////////////////////////////////
1304     int idWidth = getVisibleIdWidth(false);
1305     FontMetrics fm = getFontMetrics(av.getFont());
1306     int scaleHeight = av.getCharHeight() + fm.getDescent();
1307
1308     // Gen image map
1309     // ////////////////////////////////
1310     if (imgMapFile != null)
1311     {
1312       try
1313       {
1314         int sSize = av.getAlignment().getHeight();
1315         int alwidth = av.getAlignment().getWidth();
1316         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1317         out.println(HTMLOutput.getImageMapHTML());
1318         out.println("<img src=\"" + imageName
1319                 + "\" border=\"0\" usemap=\"#Map\" >"
1320                 + "<map name=\"Map\">");
1321
1322         for (int s = 0; s < sSize; s++)
1323         {
1324           int sy = s * av.getCharHeight() + scaleHeight;
1325
1326           SequenceI seq = av.getAlignment().getSequenceAt(s);
1327           SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1328           for (int column = 0; column < alwidth; column++)
1329           {
1330             StringBuilder text = new StringBuilder(512);
1331             String triplet = null;
1332             if (av.getAlignment().isNucleotide())
1333             {
1334               triplet = ResidueProperties.nucleotideName.get(seq
1335                       .getCharAt(column) + "");
1336             }
1337             else
1338             {
1339               triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(column)
1340                       + "");
1341             }
1342
1343             if (triplet == null)
1344             {
1345               continue;
1346             }
1347
1348             int seqPos = seq.findPosition(column);
1349             int gSize = groups.length;
1350             for (int g = 0; g < gSize; g++)
1351             {
1352               if (text.length() < 1)
1353               {
1354                 text.append("<area shape=\"rect\" coords=\"")
1355                         .append((idWidth + column * av.getCharWidth()))
1356                         .append(",").append(sy).append(",")
1357                         .append((idWidth + (column + 1) * av.getCharWidth()))
1358                         .append(",").append((av.getCharHeight() + sy))
1359                         .append("\"").append(" onMouseOver=\"toolTip('")
1360                         .append(seqPos).append(" ").append(triplet);
1361               }
1362
1363               if (groups[g].getStartRes() < column
1364                       && groups[g].getEndRes() > column)
1365               {
1366                 text.append("<br><em>").append(groups[g].getName())
1367                         .append("</em>");
1368               }
1369             }
1370
1371             if (text.length() < 1)
1372             {
1373               text.append("<area shape=\"rect\" coords=\"")
1374                       .append((idWidth + column * av.getCharWidth()))
1375                       .append(",").append(sy).append(",")
1376                       .append((idWidth + (column + 1) * av.getCharWidth()))
1377                       .append(",").append((av.getCharHeight() + sy))
1378                       .append("\"").append(" onMouseOver=\"toolTip('")
1379                       .append(seqPos).append(" ").append(triplet);
1380             }
1381             if (!Comparison.isGap(seq.getCharAt(column)))
1382             {
1383               List<SequenceFeature> features = seq.findFeatures(column, column);
1384               for (SequenceFeature sf : features)
1385               {
1386                 if (sf.isContactFeature())
1387                 {
1388                   text.append("<br>").append(sf.getType()).append(" ")
1389                           .append(sf.getBegin()).append(":")
1390                           .append(sf.getEnd());
1391                 }
1392                 else
1393                 {
1394                   text.append("<br>");
1395                   text.append(sf.getType());
1396                   String description = sf.getDescription();
1397                   if (description != null
1398                           && !sf.getType().equals(description))
1399                   {
1400                     description = description.replace("\"", "&quot;");
1401                     text.append(" ").append(description);
1402                   }
1403                 }
1404                 String status = sf.getStatus();
1405                 if (status != null && !"".equals(status))
1406                 {
1407                   text.append(" (").append(status).append(")");
1408                 }
1409               }
1410               if (text.length() > 1)
1411               {
1412                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");
1413                 out.println(text.toString());
1414               }
1415             }
1416           }
1417         }
1418         out.println("</map></body></html>");
1419         out.close();
1420
1421       } catch (Exception ex)
1422       {
1423         ex.printStackTrace();
1424       }
1425     } // /////////END OF IMAGE MAP
1426
1427   }
1428
1429   int getWrappedHeight()
1430   {
1431     int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1432
1433     if (System.getProperty("java.awt.headless") != null
1434             && System.getProperty("java.awt.headless").equals("true"))
1435     {
1436       seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1437               - vscroll.getPreferredSize().width
1438               - alignFrame.getInsets().left - alignFrame.getInsets().right;
1439     }
1440
1441     int chunkWidth = getSeqPanel().seqCanvas
1442             .getWrappedCanvasWidth(seqPanelWidth);
1443
1444     int hgap = av.getCharHeight();
1445     if (av.getScaleAboveWrapped())
1446     {
1447       hgap += av.getCharHeight();
1448     }
1449
1450     int annotationHeight = 0;
1451     if (av.isShowAnnotation())
1452     {
1453       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1454     }
1455
1456     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1457             + annotationHeight;
1458
1459     int maxwidth = av.getAlignment().getWidth();
1460     if (av.hasHiddenColumns())
1461     {
1462       maxwidth = av.getAlignment().getHiddenColumns()
1463               .absoluteToVisibleColumn(maxwidth) - 1;
1464     }
1465
1466     int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1467
1468     return height;
1469   }
1470
1471   /**
1472    * close the panel - deregisters all listeners and nulls any references to
1473    * alignment data.
1474    */
1475   public void closePanel()
1476   {
1477     PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1478     PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1479     PaintRefresher.RemoveComponent(this);
1480
1481     closeChildFrames();
1482
1483     /*
1484      * try to ensure references are nulled
1485      */
1486     if (annotationPanel != null)
1487     {
1488       annotationPanel.dispose();
1489       annotationPanel = null;
1490     }
1491
1492     if (av != null)
1493     {
1494       av.removePropertyChangeListener(propertyChangeListener);
1495       propertyChangeListener = null;
1496       StructureSelectionManager ssm = av.getStructureSelectionManager();
1497       ssm.removeStructureViewerListener(getSeqPanel(), null);
1498       ssm.removeSelectionListener(getSeqPanel());
1499       ssm.removeCommandListener(av);
1500       ssm.removeStructureViewerListener(getSeqPanel(), null);
1501       ssm.removeSelectionListener(getSeqPanel());
1502       av.dispose();
1503       av = null;
1504     }
1505     else
1506     {
1507       if (Cache.log.isDebugEnabled())
1508       {
1509         Cache.log.warn("Closing alignment panel which is already closed.");
1510       }
1511     }
1512   }
1513
1514   /**
1515    * Close any open dialogs that would be orphaned when this one is closed
1516    */
1517   protected void closeChildFrames()
1518   {
1519     if (overviewPanel != null)
1520     {
1521       overviewPanel.dispose();
1522       overviewPanel = null;
1523     }
1524     if (calculationDialog != null)
1525     {
1526       calculationDialog.closeFrame();
1527       calculationDialog = null;
1528     }
1529   }
1530
1531   /**
1532    * hides or shows dynamic annotation rows based on groups and av state flags
1533    */
1534   public void updateAnnotation()
1535   {
1536     updateAnnotation(false, false);
1537   }
1538
1539   public void updateAnnotation(boolean applyGlobalSettings)
1540   {
1541     updateAnnotation(applyGlobalSettings, false);
1542   }
1543
1544   public void updateAnnotation(boolean applyGlobalSettings,
1545           boolean preserveNewGroupSettings)
1546   {
1547     av.updateGroupAnnotationSettings(applyGlobalSettings,
1548             preserveNewGroupSettings);
1549     adjustAnnotationHeight();
1550   }
1551
1552   @Override
1553   public AlignmentI getAlignment()
1554   {
1555     return av == null ? null : av.getAlignment();
1556   }
1557
1558   @Override
1559   public String getViewName()
1560   {
1561     return av.getViewName();
1562   }
1563
1564   /**
1565    * Make/Unmake this alignment panel the current input focus
1566    *
1567    * @param b
1568    */
1569   public void setSelected(boolean b)
1570   {
1571     try
1572     {
1573       if (alignFrame.getSplitViewContainer() != null)
1574       {
1575         /*
1576          * bring enclosing SplitFrame to front first if there is one
1577          */
1578         ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1579       }
1580       alignFrame.setSelected(b);
1581     } catch (Exception ex)
1582     {
1583     }
1584
1585     if (b)
1586     {
1587       alignFrame.setDisplayedView(this);
1588     }
1589   }
1590
1591   @Override
1592   public StructureSelectionManager getStructureSelectionManager()
1593   {
1594     return av.getStructureSelectionManager();
1595   }
1596
1597   @Override
1598   public void raiseOOMWarning(String string, OutOfMemoryError error)
1599   {
1600     new OOMWarning(string, error, this);
1601   }
1602
1603   @Override
1604   public jalview.api.FeatureRenderer cloneFeatureRenderer()
1605   {
1606
1607     return new FeatureRenderer(this);
1608   }
1609
1610   @Override
1611   public jalview.api.FeatureRenderer getFeatureRenderer()
1612   {
1613     return seqPanel.seqCanvas.getFeatureRenderer();
1614   }
1615
1616   public void updateFeatureRenderer(
1617           jalview.renderer.seqfeatures.FeatureRenderer fr)
1618   {
1619     fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1620   }
1621
1622   public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1623   {
1624     if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1625     {
1626       getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1627     }
1628   }
1629
1630   public ScalePanel getScalePanel()
1631   {
1632     return scalePanel;
1633   }
1634
1635   public void setScalePanel(ScalePanel scalePanel)
1636   {
1637     this.scalePanel = scalePanel;
1638   }
1639
1640   public SeqPanel getSeqPanel()
1641   {
1642     return seqPanel;
1643   }
1644
1645   public void setSeqPanel(SeqPanel seqPanel)
1646   {
1647     this.seqPanel = seqPanel;
1648   }
1649
1650   public AnnotationPanel getAnnotationPanel()
1651   {
1652     return annotationPanel;
1653   }
1654
1655   public void setAnnotationPanel(AnnotationPanel annotationPanel)
1656   {
1657     this.annotationPanel = annotationPanel;
1658   }
1659
1660   public AnnotationLabels getAlabels()
1661   {
1662     return alabels;
1663   }
1664
1665   public void setAlabels(AnnotationLabels alabels)
1666   {
1667     this.alabels = alabels;
1668   }
1669
1670   public IdPanel getIdPanel()
1671   {
1672     return idPanel;
1673   }
1674
1675   public void setIdPanel(IdPanel idPanel)
1676   {
1677     this.idPanel = idPanel;
1678   }
1679
1680   /**
1681    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1682    * The aim is to keep the two alignments 'lined up' on their centre columns.
1683    *
1684    * @param sr
1685    *          holds mapped region(s) of this alignment that we are scrolling
1686    *          'to'; may be modified for sequence offset by this method
1687    * @param verticalOffset
1688    *          the number of visible sequences to show above the mapped region
1689    */
1690   protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1691   {
1692     scrollToPosition(sr, verticalOffset, true);
1693   }
1694
1695   /**
1696    * Set a flag to say do not scroll any (cDNA/protein) complement.
1697    *
1698    * @param b
1699    */
1700   protected void setToScrollComplementPanel(boolean b)
1701   {
1702     this.scrollComplementaryPanel = b;
1703   }
1704
1705   /**
1706    * Get whether to scroll complement panel
1707    *
1708    * @return true if cDNA/protein complement panels should be scrolled
1709    */
1710   protected boolean isSetToScrollComplementPanel()
1711   {
1712     return this.scrollComplementaryPanel;
1713   }
1714
1715   /**
1716    * Redraw sensibly.
1717    *
1718    * @adjustHeight if true, try to recalculate panel height for visible
1719    *               annotations
1720    */
1721   protected void refresh(boolean adjustHeight)
1722   {
1723     validateAnnotationDimensions(adjustHeight);
1724     addNotify();
1725     if (adjustHeight)
1726     {
1727       // sort, repaint, update overview
1728       paintAlignment(true, false);
1729     }
1730     else
1731     {
1732       // lightweight repaint
1733       repaint();
1734     }
1735   }
1736
1737   @Override
1738   /**
1739    * Property change event fired when a change is made to the viewport ranges
1740    * object associated with this alignment panel's viewport
1741    */
1742   public void propertyChange(PropertyChangeEvent evt)
1743   {
1744     // update this panel's scroll values based on the new viewport ranges values
1745     ViewportRanges ranges = av.getRanges();
1746     int x = ranges.getStartRes();
1747     int y = ranges.getStartSeq();
1748     setScrollValues(x, y);
1749
1750     // now update any complementary alignment (its viewport ranges object
1751     // is different so does not get automatically updated)
1752     if (isSetToScrollComplementPanel())
1753     {
1754       setToScrollComplementPanel(false);
1755       av.scrollComplementaryAlignment();
1756       setToScrollComplementPanel(true);
1757     }
1758   }
1759
1760   /**
1761    * Set the reference to the PCA/Tree chooser dialog for this panel. This
1762    * reference should be nulled when the dialog is closed.
1763    *
1764    * @param calculationChooser
1765    */
1766   public void setCalculationDialog(CalculationChooser calculationChooser)
1767   {
1768     calculationDialog = calculationChooser;
1769   }
1770
1771   /**
1772    * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1773    * if none is open)
1774    */
1775   public CalculationChooser getCalculationDialog()
1776   {
1777     return calculationDialog;
1778   }
1779 }