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   OverviewPanel overviewPanel;
  80
  81   private SeqPanel seqPanel;
  82
  83   private IdPanel idPanel;
  84
  85   private boolean headless;
  86
  87   IdwidthAdjuster idwidthAdjuster;
  88
  89   /** DOCUMENT ME!! */
  90   public AlignFrame alignFrame;
  91
  92   private ScalePanel scalePanel;
  93
  94   private AnnotationPanel annotationPanel;
  95
  96   private AnnotationLabels alabels;
  97
  98   private int hextent = 0;
  99
 100   private int vextent = 0;
 101
 102   /*
 103    * Flag set while scrolling to follow complementary cDNA/protein scroll. When
 104    * false, suppresses invoking the same method recursively.
 105    */
 106   private boolean scrollComplementaryPanel = true;
 107
 108   private PropertyChangeListener propertyChangeListener;
 109
 110   private CalculationChooser calculationDialog;
 111
 112   /**
 113    * Creates a new AlignmentPanel object.
 114    *
 115    * @param af
 116    * @param av
 117    */
 118   public AlignmentPanel(AlignFrame af, final AlignViewport av)
 119   {
 120     alignFrame = af;
 121     this.av = av;
 122     setSeqPanel(new SeqPanel(av, this));
 123     setIdPanel(new IdPanel(av, this));
 124
 125     setScalePanel(new ScalePanel(av, this));
 126
 127     idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
 128     idwidthAdjuster = new IdwidthAdjuster(this);
 129     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
 130
 131     setAnnotationPanel(new AnnotationPanel(this));
 132     setAlabels(new AnnotationLabels(this));
 133
 134     annotationScroller.setViewportView(getAnnotationPanel());
 135     annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
 136
 137     scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
 138     seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
 139
 140     setScrollValues(0, 0);
 141
 142     hscroll.addAdjustmentListener(this);
 143     vscroll.addAdjustmentListener(this);
 144
 145     addComponentListener(new ComponentAdapter()
 146     {
 147       @Override
 148       public void componentResized(ComponentEvent evt)
 149       {
 150         // reset the viewport ranges when the alignment panel is resized
 151         // in particular, this initialises the end residue value when Jalview
 152         // is initialised
 153         ViewportRanges ranges = av.getRanges();
 154         if (av.getWrapAlignment())
 155         {
 156           int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
 157                   getSeqPanel().seqCanvas.getWidth());
 158           ranges.setViewportWidth(widthInRes);
 159         }
 160         else
 161         {
 162           int widthInRes = getSeqPanel().seqCanvas.getWidth()
 163                   / av.getCharWidth();
 164           int heightInSeq = getSeqPanel().seqCanvas.getHeight()
 165                   / av.getCharHeight();
 166
 167           ranges.setViewportWidth(widthInRes);
 168           ranges.setViewportHeight(heightInSeq);
 169         }
 170       }
 171
 172     });
 173
 174     final AlignmentPanel ap = this;
 175     propertyChangeListener = new PropertyChangeListener()
 176     {
 177       @Override
 178       public void propertyChange(PropertyChangeEvent evt)
 179       {
 180         if (evt.getPropertyName().equals("alignment"))
 181         {
 182           PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
 183           alignmentChanged();
 184         }
 185       }
 186     };
 187     av.addPropertyChangeListener(propertyChangeListener);
 188
 189     av.getRanges().addPropertyChangeListener(this);
 190     fontChanged();
 191     adjustAnnotationHeight();
 192     updateLayout();
 193   }
 194
 195   @Override
 196   public AlignViewportI getAlignViewport()
 197   {
 198     return av;
 199   }
 200
 201   public void alignmentChanged()
 202   {
 203     av.alignmentChanged(this);
 204
 205     if (getCalculationDialog() != null)
 206     {
 207       getCalculationDialog().validateCalcTypes();
 208     }
 209
 210     alignFrame.updateEditMenuBar();
 211
 212     // no idea if we need to update structure
 213     paintAlignment(true, true);
 214
 215   }
 216
 217   /**
 218    * DOCUMENT ME!
 219    */
 220   public void fontChanged()
 221   {
 222     // set idCanvas bufferedImage to null
 223     // to prevent drawing old image
 224     FontMetrics fm = getFontMetrics(av.getFont());
 225
 226     scalePanelHolder.setPreferredSize(
 227             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 228     idSpaceFillerPanel1.setPreferredSize(
 229             new Dimension(10, av.getCharHeight() + fm.getDescent()));
 230     idwidthAdjuster.invalidate();
 231     scalePanelHolder.invalidate();
 232     getIdPanel().getIdCanvas().gg = null;
 233     getSeqPanel().seqCanvas.img = null;
 234     getAnnotationPanel().adjustPanelHeight();
 235
 236     Dimension d = calculateIdWidth();
 237
 238     d.setSize(d.width + 4, d.height);
 239     getIdPanel().getIdCanvas().setPreferredSize(d);
 240     hscrollFillerPanel.setPreferredSize(d);
 241
 242     repaint();
 243   }
 244
 245   /**
 246    * Calculate the width of the alignment labels based on the displayed names
 247    * and any bounds on label width set in preferences.
 248    *
 249    * @return Dimension giving the maximum width of the alignment label panel
 250    *         that should be used.
 251    */
 252   public Dimension calculateIdWidth()
 253   {
 254     // calculate sensible default width when no preference is available
 255     Dimension r = null;
 256     if (av.getIdWidth() < 0)
 257     {
 258       int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
 259       int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
 260       r = calculateIdWidth(maxwidth);
 261       av.setIdWidth(r.width);
 262     }
 263     else
 264     {
 265       r = new Dimension();
 266       r.width = av.getIdWidth();
 267       r.height = 0;
 268     }
 269     return r;
 270   }
 271
 272   /**
 273    * Calculate the width of the alignment labels based on the displayed names
 274    * and any bounds on label width set in preferences.
 275    *
 276    * @param maxwidth
 277    *          -1 or maximum width allowed for IdWidth
 278    * @return Dimension giving the maximum width of the alignment label panel
 279    *         that should be used.
 280    */
 281   public Dimension calculateIdWidth(int maxwidth)
 282   {
 283     Container c = new Container();
 284
 285     FontMetrics fm = c.getFontMetrics(
 286             new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
 287
 288     AlignmentI al = av.getAlignment();
 289     int i = 0;
 290     int idWidth = 0;
 291     String id;
 292
 293     while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
 294     {
 295       SequenceI s = al.getSequenceAt(i);
 296
 297       id = s.getDisplayId(av.getShowJVSuffix());
 298
 299       if (fm.stringWidth(id) > idWidth)
 300       {
 301         idWidth = fm.stringWidth(id);
 302       }
 303
 304       i++;
 305     }
 306
 307     // Also check annotation label widths
 308     i = 0;
 309
 310     if (al.getAlignmentAnnotation() != null)
 311     {
 312       fm = c.getFontMetrics(getAlabels().getFont());
 313
 314       while (i < al.getAlignmentAnnotation().length)
 315       {
 316         String label = al.getAlignmentAnnotation()[i].label;
 317
 318         if (fm.stringWidth(label) > idWidth)
 319         {
 320           idWidth = fm.stringWidth(label);
 321         }
 322
 323         i++;
 324       }
 325     }
 326
 327     return new Dimension(
 328             maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth), 12);
 329   }
 330
 331   /**
 332    * Highlight the given results on the alignment.
 333    *
 334    */
 335   public void highlightSearchResults(SearchResultsI results)
 336   {
 337     boolean scrolled = scrollToPosition(results, 0, true, false);
 338
 339     boolean noFastPaint = scrolled && av.getWrapAlignment();
 340
 341     getSeqPanel().seqCanvas.highlightSearchResults(results, noFastPaint);
 342   }
 343
 344   /**
 345    * Scroll the view to show the position of the highlighted region in results
 346    * (if any)
 347    *
 348    * @param searchResults
 349    * @param redrawOverview
 350    * @return
 351    */
 352   public boolean scrollToPosition(SearchResultsI searchResults,
 353           boolean redrawOverview)
 354   {
 355     return scrollToPosition(searchResults, 0, redrawOverview, false);
 356   }
 357
 358   /**
 359    * Scrolls the view (if necessary) to show the position of the first
 360    * highlighted region in results (if any). Answers true if the view was
 361    * scrolled, or false if no matched region was found, or it is already
 362    * visible.
 363    *
 364    * @param results
 365    * @param verticalOffset
 366    *          if greater than zero, allows scrolling to a position below the
 367    *          first displayed sequence
 368    * @param redrawOverview
 369    *          - when set, the overview will be recalculated (takes longer)
 370    * @param centre
 371    *          if true, try to centre the search results horizontally in the view
 372    * @return
 373    */
 374   protected boolean scrollToPosition(SearchResultsI results,
 375           int verticalOffset, boolean redrawOverview, boolean centre)
 376   {
 377     int startv, endv, starts, ends;
 378     ViewportRanges ranges = av.getRanges();
 379
 380     if (results == null || results.isEmpty() || av == null
 381             || av.getAlignment() == null)
 382     {
 383       return false;
 384     }
 385     int seqIndex = av.getAlignment().findIndex(results);
 386     if (seqIndex == -1)
 387     {
 388       return false;
 389     }
 390     SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
 391
 392     int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
 393     if (r == null)
 394     {
 395       return false;
 396     }
 397     int start = r[0];
 398     int end = r[1];
 399
 400     /*
 401      * To centre results, scroll to positions half the visible width
 402      * left/right of the start/end positions
 403      */
 404     if (centre)
 405     {
 406       int offset = (ranges.getEndRes() - ranges.getStartRes() + 1) / 2 - 1;
 407       start = Math.max(start - offset, 0);
 408       end = end + offset - 1;
 409     }
 410     if (start < 0)
 411     {
 412       return false;
 413     }
 414     if (end == seq.getEnd())
 415     {
 416       return false;
 417     }
 418
 419     if (av.hasHiddenColumns())
 420     {
 421       HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 422       start = hidden.findColumnPosition(start);
 423       end = hidden.findColumnPosition(end);
 424       if (start == end)
 425       {
 426         if (!hidden.isVisible(r[0]))
 427         {
 428           // don't scroll - position isn't visible
 429           return false;
 430         }
 431       }
 432     }
 433
 434     /*
 435      * allow for offset of target sequence (actually scroll to one above it)
 436      */
 437     seqIndex = Math.max(0, seqIndex - verticalOffset);
 438     boolean scrollNeeded = true;
 439
 440     if (!av.getWrapAlignment())
 441     {
 442       if ((startv = ranges.getStartRes()) >= start)
 443       {
 444         /*
 445          * Scroll left to make start of search results visible
 446          */
 447         setScrollValues(start, seqIndex);
 448       }
 449       else if ((endv = ranges.getEndRes()) <= end)
 450       {
 451         /*
 452          * Scroll right to make end of search results visible
 453          */
 454         setScrollValues(startv + end - endv, seqIndex);
 455       }
 456       else if ((starts = ranges.getStartSeq()) > seqIndex)
 457       {
 458         /*
 459          * Scroll up to make start of search results visible
 460          */
 461         setScrollValues(ranges.getStartRes(), seqIndex);
 462       }
 463       else if ((ends = ranges.getEndSeq()) <= seqIndex)
 464       {
 465         /*
 466          * Scroll down to make end of search results visible
 467          */
 468         setScrollValues(ranges.getStartRes(), starts + seqIndex - ends
 469                 + 1);
 470       }
 471       /*
 472        * Else results are already visible - no need to scroll
 473        */
 474       scrollNeeded = false;
 475     }
 476     else
 477     {
 478       scrollNeeded = ranges.scrollToWrappedVisible(start);
 479     }
 480
 481     paintAlignment(redrawOverview, false);
 482
 483     return scrollNeeded;
 484   }
 485
 486   /**
 487    * DOCUMENT ME!
 488    *
 489    * @return DOCUMENT ME!
 490    */
 491   public OverviewPanel getOverviewPanel()
 492   {
 493     return overviewPanel;
 494   }
 495
 496   /**
 497    * DOCUMENT ME!
 498    *
 499    * @param op
 500    *          DOCUMENT ME!
 501    */
 502   public void setOverviewPanel(OverviewPanel op)
 503   {
 504     overviewPanel = op;
 505   }
 506
 507   /**
 508    *
 509    * @param b
 510    *          Hide or show annotation panel
 511    *
 512    */
 513   public void setAnnotationVisible(boolean b)
 514   {
 515     if (!av.getWrapAlignment())
 516     {
 517       annotationSpaceFillerHolder.setVisible(b);
 518       annotationScroller.setVisible(b);
 519     }
 520     repaint();
 521   }
 522
 523   /**
 524    * automatically adjust annotation panel height for new annotation whilst
 525    * ensuring the alignment is still visible.
 526    */
 527   @Override
 528   public void adjustAnnotationHeight()
 529   {
 530     // TODO: display vertical annotation scrollbar if necessary
 531     // this is called after loading new annotation onto alignment
 532     if (alignFrame.getHeight() == 0)
 533     {
 534       System.out.println("NEEDS FIXING");
 535     }
 536     validateAnnotationDimensions(true);
 537     addNotify();
 538     // TODO: many places call this method and also paintAlignment with various
 539     // different settings. this means multiple redraws are triggered...
 540     paintAlignment(true, false);
 541   }
 542
 543   /**
 544    * calculate the annotation dimensions and refresh slider values accordingly.
 545    * need to do repaints/notifys afterwards.
 546    */
 547   protected void validateAnnotationDimensions(boolean adjustPanelHeight)
 548   {
 549     int annotationHeight = getAnnotationPanel().adjustPanelHeight();
 550
 551     if (adjustPanelHeight)
 552     {
 553       int rowHeight = av.getCharHeight();
 554       int alignmentHeight = rowHeight * av.getAlignment().getHeight();
 555
 556       /*
 557        * Estimate available height in the AlignFrame for alignment +
 558        * annotations. Deduct an estimate for title bar, menu bar, scale panel,
 559        * hscroll, status bar (as these are not laid out we can't inspect their
 560        * actual heights). Insets gives frame borders.
 561        */
 562       int stuff = Platform.isAMac() ? 80 : 100;
 563       Insets insets = alignFrame.getInsets();
 564       int availableHeight = alignFrame.getHeight() - stuff - insets.top
 565               - insets.bottom;
 566
 567       /*
 568        * If not enough vertical space, maximize annotation height while keeping
 569        * at least two rows of alignment visible
 570        */
 571       if (annotationHeight + alignmentHeight > availableHeight)
 572       {
 573         annotationHeight = Math.min(annotationHeight,
 574                 availableHeight - 2 * rowHeight);
 575       }
 576     }
 577     else
 578     {
 579       // maintain same window layout whilst updating sliders
 580       annotationHeight = annotationScroller.getSize().height;
 581     }
 582     hscroll.addNotify();
 583
 584     annotationScroller.setPreferredSize(
 585             new Dimension(annotationScroller.getWidth(), annotationHeight));
 586
 587     Dimension e = idPanel.getSize();
 588     alabels.setSize(new Dimension(e.width, annotationHeight));
 589
 590     annotationSpaceFillerHolder.setPreferredSize(new Dimension(
 591             annotationSpaceFillerHolder.getWidth(), annotationHeight));
 592     annotationScroller.validate();
 593     annotationScroller.addNotify();
 594   }
 595
 596   /**
 597    * update alignment layout for viewport settings
 598    *
 599    * @param wrap
 600    *          DOCUMENT ME!
 601    */
 602   public void updateLayout()
 603   {
 604     fontChanged();
 605     setAnnotationVisible(av.isShowAnnotation());
 606     boolean wrap = av.getWrapAlignment();
 607     ViewportRanges ranges = av.getRanges();
 608     ranges.setStartSeq(0);
 609     scalePanelHolder.setVisible(!wrap);
 610     hscroll.setVisible(!wrap);
 611     idwidthAdjuster.setVisible(!wrap);
 612
 613     if (wrap)
 614     {
 615       annotationScroller.setVisible(false);
 616       annotationSpaceFillerHolder.setVisible(false);
 617     }
 618     else if (av.isShowAnnotation())
 619     {
 620       annotationScroller.setVisible(true);
 621       annotationSpaceFillerHolder.setVisible(true);
 622     }
 623
 624     int canvasWidth = getSeqPanel().seqCanvas.getWidth();
 625     if (canvasWidth > 0)
 626     { // may not yet be laid out
 627       if (wrap)
 628       {
 629         int widthInRes = getSeqPanel().seqCanvas
 630                 .getWrappedCanvasWidth(canvasWidth);
 631         ranges.setViewportWidth(widthInRes);
 632       }
 633       else
 634       {
 635         int widthInRes = (canvasWidth / av.getCharWidth());
 636         int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
 637                 / av.getCharHeight());
 638
 639         ranges.setViewportWidth(widthInRes);
 640         ranges.setViewportHeight(heightInSeq);
 641       }
 642     }
 643
 644     idSpaceFillerPanel1.setVisible(!wrap);
 645
 646     repaint();
 647   }
 648
 649   /**
 650    * Adjust row/column scrollers to show a visible position in the alignment.
 651    *
 652    * @param x
 653    *          visible column to scroll to
 654    * @param y
 655    *          visible row to scroll to
 656    *
 657    */
 658   public void setScrollValues(int xpos, int ypos)
 659   {
 660     int x = xpos;
 661     int y = ypos;
 662
 663     if (av == null || av.getAlignment() == null)
 664     {
 665       return;
 666     }
 667
 668     if (av.getWrapAlignment())
 669     {
 670       setScrollingForWrappedPanel(x);
 671     }
 672     else
 673     {
 674       int width = av.getAlignment().getWidth();
 675       int height = av.getAlignment().getHeight();
 676
 677       if (av.hasHiddenColumns())
 678       {
 679         // reset the width to exclude hidden columns
 680         width = av.getAlignment().getHiddenColumns()
 681                 .findColumnPosition(width);
 682       }
 683
 684       hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 685       vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 686
 687       if (hextent > width)
 688       {
 689         hextent = width;
 690       }
 691
 692       if (vextent > height)
 693       {
 694         vextent = height;
 695       }
 696
 697       if ((hextent + x) > width)
 698       {
 699         x = width - hextent;
 700       }
 701
 702       if ((vextent + y) > height)
 703       {
 704         y = height - vextent;
 705       }
 706
 707       if (y < 0)
 708       {
 709         y = 0;
 710       }
 711
 712       if (x < 0)
 713       {
 714         x = 0;
 715       }
 716
 717       // update the scroll values
 718       hscroll.setValues(x, hextent, 0, width);
 719       vscroll.setValues(y, vextent, 0, height);
 720     }
 721   }
 722
 723   /**
 724    * Respond to adjustment event when horizontal or vertical scrollbar is
 725    * changed
 726    *
 727    * @param evt
 728    *          adjustment event encoding whether hscroll or vscroll changed
 729    */
 730   @Override
 731   public void adjustmentValueChanged(AdjustmentEvent evt)
 732   {
 733     if (av.getWrapAlignment())
 734     {
 735       adjustScrollingWrapped(evt);
 736       return;
 737     }
 738
 739     ViewportRanges ranges = av.getRanges();
 740
 741     if (evt.getSource() == hscroll)
 742     {
 743       int oldX = ranges.getStartRes();
 744       int oldwidth = ranges.getViewportWidth();
 745       int x = hscroll.getValue();
 746       int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
 747
 748       // if we're scrolling to the position we're already at, stop
 749       // this prevents infinite recursion of events when the scroll/viewport
 750       // ranges values are the same
 751       if ((x == oldX) && (width == oldwidth))
 752       {
 753         return;
 754       }
 755       ranges.setViewportStartAndWidth(x, width);
 756     }
 757     else if (evt.getSource() == vscroll)
 758     {
 759       int oldY = ranges.getStartSeq();
 760       int oldheight = ranges.getViewportHeight();
 761       int y = vscroll.getValue();
 762       int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 763
 764       // if we're scrolling to the position we're already at, stop
 765       // this prevents infinite recursion of events when the scroll/viewport
 766       // ranges values are the same
 767       if ((y == oldY) && (height == oldheight))
 768       {
 769         return;
 770       }
 771       ranges.setViewportStartAndHeight(y, height);
 772     }
 773     repaint();
 774   }
 775
 776   /**
 777    * Responds to a scroll change by setting the start position of the viewport.
 778    * Does
 779    *
 780    * @param evt
 781    */
 782   protected void adjustScrollingWrapped(AdjustmentEvent evt)
 783   {
 784     if (evt.getSource() == hscroll)
 785     {
 786       return; // no horizontal scroll when wrapped
 787     }
 788     final ViewportRanges ranges = av.getRanges();
 789
 790     if (evt.getSource() == vscroll)
 791     {
 792       int newY = vscroll.getValue();
 793
 794       /*
 795        * if we're scrolling to the position we're already at, stop
 796        * this prevents infinite recursion of events when the scroll/viewport
 797        * ranges values are the same
 798        */
 799       int oldX = ranges.getStartRes();
 800       int oldY = ranges.getWrappedScrollPosition(oldX);
 801       if (oldY == newY)
 802       {
 803         return;
 804       }
 805       if (newY > -1)
 806       {
 807         /*
 808          * limit page up/down to one width's worth of positions
 809          */
 810         int rowSize = ranges.getViewportWidth();
 811         int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
 812         ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
 813       }
 814     }
 815     else
 816     {
 817       // This is only called if file loaded is a jar file that
 818       // was wrapped when saved and user has wrap alignment true
 819       // as preference setting
 820       SwingUtilities.invokeLater(new Runnable()
 821       {
 822         @Override
 823         public void run()
 824         {
 825           // When updating scrolling to use ViewportChange events, this code
 826           // could not be validated and it is not clear if it is now being
 827           // called. Log warning here in case it is called and unforeseen
 828           // problems occur
 829           Cache.log.warn(
 830                   "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
 831
 832           // scroll to start of panel
 833           ranges.setStartRes(0);
 834           ranges.setStartSeq(0);
 835         }
 836       });
 837     }
 838     repaint();
 839   }
 840
 841   /* (non-Javadoc)
 842    * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
 843    */
 844   @Override
 845   public void paintAlignment(boolean updateOverview,
 846           boolean updateStructures)
 847   {
 848     final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
 849             av.isShowAutocalculatedAbove());
 850     sorter.sort(getAlignment().getAlignmentAnnotation(),
 851             av.getSortAnnotationsBy());
 852     repaint();
 853
 854     if (updateStructures)
 855     {
 856       av.getStructureSelectionManager().sequenceColoursChanged(this);
 857     }
 858     if (updateOverview)
 859     {
 860
 861       if (overviewPanel != null)
 862       {
 863         overviewPanel.updateOverviewImage();
 864       }
 865     }
 866   }
 867
 868   /**
 869    * DOCUMENT ME!
 870    *
 871    * @param g
 872    *          DOCUMENT ME!
 873    */
 874   @Override
 875   public void paintComponent(Graphics g)
 876   {
 877     invalidate();
 878
 879     Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
 880     idPanelHolder.setPreferredSize(d);
 881     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
 882     validate();
 883
 884     /*
 885      * set scroll bar positions
 886      */
 887     ViewportRanges ranges = av.getRanges();
 888     setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
 889   }
 890
 891   /**
 892    * Set vertical scroll bar position, and number of increments, for wrapped
 893    * panel
 894    *
 895    * @param topLeftColumn
 896    *          the column position at top left (0..)
 897    */
 898   private void setScrollingForWrappedPanel(int topLeftColumn)
 899   {
 900     ViewportRanges ranges = av.getRanges();
 901     int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
 902     int maxScroll = ranges.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       annotationPanel = null;
1614     }
1615
1616     if (av != null)
1617     {
1618       av.removePropertyChangeListener(propertyChangeListener);
1619       propertyChangeListener = null;
1620       StructureSelectionManager ssm = av.getStructureSelectionManager();
1621       ssm.removeStructureViewerListener(getSeqPanel(), null);
1622       ssm.removeSelectionListener(getSeqPanel());
1623       ssm.removeCommandListener(av);
1624       ssm.removeStructureViewerListener(getSeqPanel(), null);
1625       ssm.removeSelectionListener(getSeqPanel());
1626       av.dispose();
1627       av = null;
1628     }
1629     else
1630     {
1631       if (Cache.log.isDebugEnabled())
1632       {
1633         Cache.log.warn("Closing alignment panel which is already closed.");
1634       }
1635     }
1636   }
1637
1638   /**
1639    * Close any open dialogs that would be orphaned when this one is closed
1640    */
1641   protected void closeChildFrames()
1642   {
1643     if (overviewPanel != null)
1644     {
1645       overviewPanel.dispose();
1646       overviewPanel = null;
1647     }
1648     if (calculationDialog != null)
1649     {
1650       calculationDialog.closeFrame();
1651       calculationDialog = null;
1652     }
1653   }
1654
1655   /**
1656    * hides or shows dynamic annotation rows based on groups and av state flags
1657    */
1658   public void updateAnnotation()
1659   {
1660     updateAnnotation(false, false);
1661   }
1662
1663   public void updateAnnotation(boolean applyGlobalSettings)
1664   {
1665     updateAnnotation(applyGlobalSettings, false);
1666   }
1667
1668   public void updateAnnotation(boolean applyGlobalSettings,
1669           boolean preserveNewGroupSettings)
1670   {
1671     av.updateGroupAnnotationSettings(applyGlobalSettings,
1672             preserveNewGroupSettings);
1673     adjustAnnotationHeight();
1674   }
1675
1676   @Override
1677   public AlignmentI getAlignment()
1678   {
1679     return av == null ? null : av.getAlignment();
1680   }
1681
1682   @Override
1683   public String getViewName()
1684   {
1685     return av.viewName;
1686   }
1687
1688   /**
1689    * Make/Unmake this alignment panel the current input focus
1690    *
1691    * @param b
1692    */
1693   public void setSelected(boolean b)
1694   {
1695     try
1696     {
1697       if (alignFrame.getSplitViewContainer() != null)
1698       {
1699         /*
1700          * bring enclosing SplitFrame to front first if there is one
1701          */
1702         ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1703       }
1704       alignFrame.setSelected(b);
1705     } catch (Exception ex)
1706     {
1707     }
1708
1709     if (b)
1710     {
1711       alignFrame.setDisplayedView(this);
1712     }
1713   }
1714
1715   @Override
1716   public StructureSelectionManager getStructureSelectionManager()
1717   {
1718     return av.getStructureSelectionManager();
1719   }
1720
1721   @Override
1722   public void raiseOOMWarning(String string, OutOfMemoryError error)
1723   {
1724     new OOMWarning(string, error, this);
1725   }
1726
1727   @Override
1728   public jalview.api.FeatureRenderer cloneFeatureRenderer()
1729   {
1730
1731     return new FeatureRenderer(this);
1732   }
1733
1734   @Override
1735   public jalview.api.FeatureRenderer getFeatureRenderer()
1736   {
1737     return seqPanel.seqCanvas.getFeatureRenderer();
1738   }
1739
1740   public void updateFeatureRenderer(
1741           jalview.renderer.seqfeatures.FeatureRenderer fr)
1742   {
1743     fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1744   }
1745
1746   public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1747   {
1748     if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1749     {
1750       getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1751     }
1752   }
1753
1754   public ScalePanel getScalePanel()
1755   {
1756     return scalePanel;
1757   }
1758
1759   public void setScalePanel(ScalePanel scalePanel)
1760   {
1761     this.scalePanel = scalePanel;
1762   }
1763
1764   public SeqPanel getSeqPanel()
1765   {
1766     return seqPanel;
1767   }
1768
1769   public void setSeqPanel(SeqPanel seqPanel)
1770   {
1771     this.seqPanel = seqPanel;
1772   }
1773
1774   public AnnotationPanel getAnnotationPanel()
1775   {
1776     return annotationPanel;
1777   }
1778
1779   public void setAnnotationPanel(AnnotationPanel annotationPanel)
1780   {
1781     this.annotationPanel = annotationPanel;
1782   }
1783
1784   public AnnotationLabels getAlabels()
1785   {
1786     return alabels;
1787   }
1788
1789   public void setAlabels(AnnotationLabels alabels)
1790   {
1791     this.alabels = alabels;
1792   }
1793
1794   public IdPanel getIdPanel()
1795   {
1796     return idPanel;
1797   }
1798
1799   public void setIdPanel(IdPanel idPanel)
1800   {
1801     this.idPanel = idPanel;
1802   }
1803
1804   /**
1805    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1806    * The aim is to keep the two alignments 'lined up' on their centre columns.
1807    *
1808    * @param sr
1809    *          holds mapped region(s) of this alignment that we are scrolling
1810    *          'to'; may be modified for sequence offset by this method
1811    * @param verticalOffset
1812    *          the number of visible sequences to show above the mapped region
1813    */
1814   protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1815   {
1816     /*
1817      * To avoid jumpy vertical scrolling (if some sequences are gapped or not
1818      * mapped), we can make the scroll-to location a sequence above the one
1819      * actually mapped.
1820      */
1821     SequenceI mappedTo = sr.getResults().get(0).getSequence();
1822     List<SequenceI> seqs = av.getAlignment().getSequences();
1823
1824     /*
1825      * This is like AlignmentI.findIndex(seq) but here we are matching the
1826      * dataset sequence not the aligned sequence
1827      */
1828     boolean matched = false;
1829     for (SequenceI seq : seqs)
1830     {
1831       if (mappedTo == seq.getDatasetSequence())
1832       {
1833         matched = true;
1834         break;
1835       }
1836     }
1837     if (!matched)
1838     {
1839       return; // failsafe, shouldn't happen
1840     }
1841
1842     /*
1843      * Scroll to position but centring the target residue.
1844      */
1845     scrollToPosition(sr, verticalOffset, true, true);
1846   }
1847
1848   /**
1849    * Set a flag to say do not scroll any (cDNA/protein) complement.
1850    *
1851    * @param b
1852    */
1853   protected void setToScrollComplementPanel(boolean b)
1854   {
1855     this.scrollComplementaryPanel = b;
1856   }
1857
1858   /**
1859    * Get whether to scroll complement panel
1860    *
1861    * @return true if cDNA/protein complement panels should be scrolled
1862    */
1863   protected boolean isSetToScrollComplementPanel()
1864   {
1865     return this.scrollComplementaryPanel;
1866   }
1867
1868   /**
1869    * Redraw sensibly.
1870    *
1871    * @adjustHeight if true, try to recalculate panel height for visible
1872    *               annotations
1873    */
1874   protected void refresh(boolean adjustHeight)
1875   {
1876     validateAnnotationDimensions(adjustHeight);
1877     addNotify();
1878     if (adjustHeight)
1879     {
1880       // sort, repaint, update overview
1881       paintAlignment(true, false);
1882     }
1883     else
1884     {
1885       // lightweight repaint
1886       repaint();
1887     }
1888   }
1889
1890   @Override
1891   /**
1892    * Property change event fired when a change is made to the viewport ranges
1893    * object associated with this alignment panel's viewport
1894    */
1895   public void propertyChange(PropertyChangeEvent evt)
1896   {
1897     // update this panel's scroll values based on the new viewport ranges values
1898     ViewportRanges ranges = av.getRanges();
1899     int x = ranges.getStartRes();
1900     int y = ranges.getStartSeq();
1901     setScrollValues(x, y);
1902
1903     // now update any complementary alignment (its viewport ranges object
1904     // is different so does not get automatically updated)
1905     if (isSetToScrollComplementPanel())
1906     {
1907       setToScrollComplementPanel(false);
1908       av.scrollComplementaryAlignment();
1909       setToScrollComplementPanel(true);
1910     }
1911   }
1912
1913   /**
1914    * Set the reference to the PCA/Tree chooser dialog for this panel. This
1915    * reference should be nulled when the dialog is closed.
1916    *
1917    * @param calculationChooser
1918    */
1919   public void setCalculationDialog(CalculationChooser calculationChooser)
1920   {
1921     calculationDialog = calculationChooser;
1922   }
1923
1924   /**
1925    * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1926    * if none is open)
1927    */
1928   public CalculationChooser getCalculationDialog()
1929   {
1930     return calculationDialog;
1931   }
1932 }