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