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