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