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