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