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
  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(SearchResultsI 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(SearchResultsI 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(SearchResultsI 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(SearchResultsI 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, 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   /**
 985    * Draws the alignment image, including sequence ids, sequences, and
 986    * annotation labels and annotations if shown, on either one or two Graphics
 987    * context.
 988    *
 989    * @param pageWidth
 990    * @param pageHeight
 991    * @param pi
 992    * @param idGraphics
 993    *          the graphics context for sequence ids and annotation labels
 994    * @param alignmentGraphics
 995    *          the graphics context for sequences and annotations (may or may not
 996    *          be the same context as idGraphics)
 997    * @return
 998    * @throws PrinterException
 999    */
1000   public int printUnwrapped(int pageWidth, int pageHeight, int pi,
1001           Graphics idGraphics, Graphics alignmentGraphics)
1002           throws PrinterException
1003   {
1004     final int idWidth = getVisibleIdWidth(false);
1005
1006     /*
1007      * Get the horizontal offset to where we draw the sequences.
1008      * This is idWidth if using a single Graphics context, else zero.
1009      */
1010     final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0 : idWidth;
1011
1012     FontMetrics fm = getFontMetrics(av.getFont());
1013     int charHeight = av.getCharHeight();
1014     int scaleHeight = charHeight + fm.getDescent();
1015
1016     idGraphics.setColor(Color.white);
1017     idGraphics.fillRect(0, 0, pageWidth, pageHeight);
1018     idGraphics.setFont(av.getFont());
1019
1020     /*
1021      * How many sequences and residues can we fit on a printable page?
1022      */
1023     int totalRes = (pageWidth - idWidth) / av.getCharWidth();
1024
1025     int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1026
1027     int alignmentWidth = av.getAlignment().getWidth();
1028     int pagesWide = (alignmentWidth / totalRes) + 1;
1029
1030     final int startRes = (pi % pagesWide) * totalRes;
1031     int endRes = (startRes + totalRes) - 1;
1032
1033     if (endRes > (alignmentWidth - 1))
1034     {
1035       endRes = alignmentWidth - 1;
1036     }
1037
1038     final int startSeq = (pi / pagesWide) * totalSeq;
1039     int endSeq = startSeq + totalSeq;
1040
1041     int alignmentHeight = av.getAlignment().getHeight();
1042     if (endSeq > alignmentHeight)
1043     {
1044       endSeq = alignmentHeight;
1045     }
1046
1047     int pagesHigh = ((alignmentHeight / totalSeq) + 1)
1048             * pageHeight;
1049
1050     if (av.isShowAnnotation())
1051     {
1052       pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1053     }
1054
1055     pagesHigh /= pageHeight;
1056
1057     if (pi >= (pagesWide * pagesHigh))
1058     {
1059       return Printable.NO_SUCH_PAGE;
1060     }
1061     final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight
1062             + 3;
1063
1064     /*
1065      * draw the Scale at horizontal offset, then reset to top left (0, 0)
1066      */
1067     alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1068     getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1069             pageWidth - idWidth, scaleHeight);
1070     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1071
1072     /*
1073      * Draw the sequence ids, offset for scale height,
1074      * then reset to top left (0, 0)
1075      */
1076     idGraphics.translate(0, scaleHeight);
1077     idGraphics.setFont(getIdPanel().getIdCanvas().getIdfont());
1078     Color currentColor = null;
1079     Color currentTextColor = null;
1080
1081     SequenceI seq;
1082     for (int i = startSeq; i < endSeq; i++)
1083     {
1084       seq = av.getAlignment().getSequenceAt(i);
1085       if ((av.getSelectionGroup() != null)
1086               && av.getSelectionGroup().getSequences(null).contains(seq))
1087       {
1088         /*
1089          * gray out ids of sequences in selection group (if any)
1090          */
1091         currentColor = Color.gray;
1092         currentTextColor = Color.black;
1093       }
1094       else
1095       {
1096         currentColor = av.getSequenceColour(seq);
1097         currentTextColor = Color.black;
1098       }
1099
1100       idGraphics.setColor(currentColor);
1101       idGraphics.fillRect(0, (i - startSeq) * charHeight, idWidth,
1102               charHeight);
1103
1104       idGraphics.setColor(currentTextColor);
1105
1106       int xPos = 0;
1107       String displayId = seq.getDisplayId(av.getShowJVSuffix());
1108       if (av.isRightAlignIds())
1109       {
1110         fm = idGraphics.getFontMetrics();
1111         xPos = idWidth
1112                 - fm.stringWidth(displayId)
1113                 - 4;
1114       }
1115
1116       idGraphics.drawString(displayId, xPos,
1117               (((i - startSeq) * charHeight) + charHeight)
1118                       - (charHeight / 5));
1119     }
1120     idGraphics.setFont(av.getFont());
1121     idGraphics.translate(0, -scaleHeight);
1122
1123     /*
1124      * draw the sequences, offset for scale height, and id width (if using a
1125      * single graphics context), then reset to (0, scale height)
1126      */
1127     alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1128     getSeqPanel().seqCanvas.drawPanel(alignmentGraphics, startRes, endRes,
1129             startSeq, endSeq, 0);
1130     alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1131
1132     if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1133     {
1134       /*
1135        * draw annotation labels; drawComponent() translates by
1136        * getScrollOffset(), so compensate for that first;
1137        * then reset to (0, scale height)
1138        */
1139       int offset = getAlabels().getScrollOffset();
1140       idGraphics.translate(0, -offset);
1141       idGraphics.translate(0, alignmentDrawnHeight);
1142       getAlabels().drawComponent(idGraphics, idWidth);
1143       idGraphics.translate(0, -alignmentDrawnHeight);
1144
1145       /*
1146        * draw the annotations starting at
1147        * (idOffset, alignmentHeight) from (0, scaleHeight)
1148        */
1149       alignmentGraphics.translate(alignmentGraphicsOffset, alignmentDrawnHeight);
1150       getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1151               alignmentGraphics, -1, startRes, endRes + 1);
1152     }
1153
1154     return Printable.PAGE_EXISTS;
1155   }
1156
1157   /**
1158    * DOCUMENT ME!
1159    *
1160    * @param pg
1161    *          DOCUMENT ME!
1162    * @param pwidth
1163    *          DOCUMENT ME!
1164    * @param pheight
1165    *          DOCUMENT ME!
1166    * @param pi
1167    *          DOCUMENT ME!
1168    *
1169    * @return DOCUMENT ME!
1170    *
1171    * @throws PrinterException
1172    *           DOCUMENT ME!
1173    */
1174   public int printWrappedAlignment(int pwidth, int pheight, int pi,
1175           Graphics pg) throws PrinterException
1176   {
1177     int annotationHeight = 0;
1178     AnnotationLabels labels = null;
1179     if (av.isShowAnnotation())
1180     {
1181       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1182       labels = new AnnotationLabels(av);
1183     }
1184
1185     int hgap = av.getCharHeight();
1186     if (av.getScaleAboveWrapped())
1187     {
1188       hgap += av.getCharHeight();
1189     }
1190
1191     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1192             + annotationHeight;
1193
1194     int idWidth = getVisibleIdWidth(false);
1195
1196     int maxwidth = av.getAlignment().getWidth();
1197     if (av.hasHiddenColumns())
1198     {
1199       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1200     }
1201
1202     int resWidth = getSeqPanel().seqCanvas.getWrappedCanvasWidth(pwidth
1203             - idWidth);
1204
1205     int totalHeight = cHeight * (maxwidth / resWidth + 1);
1206
1207     pg.setColor(Color.white);
1208     pg.fillRect(0, 0, pwidth, pheight);
1209     pg.setFont(av.getFont());
1210
1211     // //////////////
1212     // Draw the ids
1213     pg.setColor(Color.black);
1214
1215     pg.translate(0, -pi * pheight);
1216
1217     pg.setClip(0, pi * pheight, pwidth, pheight);
1218
1219     int ypos = hgap;
1220
1221     do
1222     {
1223       for (int i = 0; i < av.getAlignment().getHeight(); i++)
1224       {
1225         pg.setFont(getIdPanel().getIdCanvas().getIdfont());
1226         SequenceI s = av.getAlignment().getSequenceAt(i);
1227         String string = s.getDisplayId(av.getShowJVSuffix());
1228         int xPos = 0;
1229         if (av.isRightAlignIds())
1230         {
1231           FontMetrics fm = pg.getFontMetrics();
1232           xPos = idWidth - fm.stringWidth(string) - 4;
1233         }
1234         pg.drawString(string, xPos,
1235                 ((i * av.getCharHeight()) + ypos + av.getCharHeight())
1236                         - (av.getCharHeight() / 5));
1237       }
1238       if (labels != null)
1239       {
1240         pg.translate(-3,
1241                 ypos + (av.getAlignment().getHeight() * av.getCharHeight()));
1242
1243         pg.setFont(av.getFont());
1244         labels.drawComponent(pg, idWidth);
1245         pg.translate(
1246                 +3,
1247                 -ypos
1248                         - (av.getAlignment().getHeight() * av
1249                                 .getCharHeight()));
1250       }
1251
1252       ypos += cHeight;
1253     } while (ypos < totalHeight);
1254
1255     pg.translate(idWidth, 0);
1256
1257     getSeqPanel().seqCanvas.drawWrappedPanel(pg, pwidth - idWidth,
1258             totalHeight, 0);
1259
1260     if ((pi * pheight) < totalHeight)
1261     {
1262       return Printable.PAGE_EXISTS;
1263
1264     }
1265     else
1266     {
1267       return Printable.NO_SUCH_PAGE;
1268     }
1269   }
1270
1271   /**
1272    * get current sequence ID panel width, or nominal value if panel were to be
1273    * displayed using default settings
1274    *
1275    * @return
1276    */
1277   public int getVisibleIdWidth()
1278   {
1279     return getVisibleIdWidth(true);
1280   }
1281
1282   /**
1283    * get current sequence ID panel width, or nominal value if panel were to be
1284    * displayed using default settings
1285    *
1286    * @param onscreen
1287    *          indicate if the Id width for onscreen or offscreen display should
1288    *          be returned
1289    * @return
1290    */
1291   public int getVisibleIdWidth(boolean onscreen)
1292   {
1293     // see if rendering offscreen - check preferences and calc width accordingly
1294     if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1295     {
1296       return calculateIdWidth(-1).width + 4;
1297     }
1298     Integer idwidth = null;
1299     if (onscreen
1300             || (idwidth = Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1301     {
1302       int w = getIdPanel().getWidth();
1303       return (w > 0 ? w : calculateIdWidth().width + 4);
1304     }
1305     return idwidth.intValue() + 4;
1306   }
1307
1308   void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1309   {
1310     int boarderBottomOffset = 5;
1311     long pSessionId = System.currentTimeMillis();
1312     headless = (System.getProperty("java.awt.headless") != null && System
1313             .getProperty("java.awt.headless").equals("true"));
1314     if (alignFrame != null && !headless)
1315     {
1316       if (file != null)
1317       {
1318         alignFrame.setProgressBar(MessageManager.formatMessage(
1319                 "status.saving_file", new Object[] { type.getLabel() }),
1320                 pSessionId);
1321       }
1322     }
1323     try
1324     {
1325       AlignmentDimension aDimension = getAlignmentDimension();
1326       try
1327       {
1328         jalview.util.ImageMaker im;
1329         final String imageAction, imageTitle;
1330         if (type == jalview.util.ImageMaker.TYPE.PNG)
1331         {
1332           imageAction = "Create PNG image from alignment";
1333           imageTitle = null;
1334         }
1335         else if (type == jalview.util.ImageMaker.TYPE.EPS)
1336         {
1337           imageAction = "Create EPS file from alignment";
1338           imageTitle = alignFrame.getTitle();
1339         }
1340         else
1341         {
1342           imageAction = "Create SVG file from alignment";
1343           imageTitle = alignFrame.getTitle();
1344         }
1345
1346         im = new jalview.util.ImageMaker(this, type, imageAction,
1347                 aDimension.getWidth(), aDimension.getHeight()
1348                         + boarderBottomOffset, file, imageTitle,
1349                 alignFrame, pSessionId, headless);
1350         Graphics graphics = im.getGraphics();
1351         if (av.getWrapAlignment())
1352         {
1353           if (graphics != null)
1354           {
1355             printWrappedAlignment(aDimension.getWidth(),
1356                     aDimension.getHeight() + boarderBottomOffset, 0,
1357                     graphics);
1358             im.writeImage();
1359           }
1360         }
1361         else
1362         {
1363           if (graphics != null)
1364           {
1365             printUnwrapped(aDimension.getWidth(), aDimension.getHeight(),
1366                     0, graphics, graphics);
1367             im.writeImage();
1368           }
1369         }
1370
1371       } catch (OutOfMemoryError err)
1372       {
1373         // Be noisy here.
1374         System.out.println("########################\n" + "OUT OF MEMORY "
1375                 + file + "\n" + "########################");
1376         new OOMWarning("Creating Image for " + file, err);
1377         // System.out.println("Create IMAGE: " + err);
1378       } catch (Exception ex)
1379       {
1380         ex.printStackTrace();
1381       }
1382     } finally
1383     {
1384
1385     }
1386   }
1387
1388   public AlignmentDimension getAlignmentDimension()
1389   {
1390     int maxwidth = av.getAlignment().getWidth();
1391     if (av.hasHiddenColumns())
1392     {
1393       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);
1394     }
1395
1396     int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1397             + getScalePanel().getHeight();
1398     int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1399
1400     if (av.getWrapAlignment())
1401     {
1402       height = getWrappedHeight();
1403       if (headless)
1404       {
1405         // need to obtain default alignment width and then add in any
1406         // additional allowance for id margin
1407         // this duplicates the calculation in getWrappedHeight but adjusts for
1408         // offscreen idWith
1409         width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1410                 - alignFrame.getInsets().left
1411                 - alignFrame.getInsets().right - getVisibleIdWidth()
1412                 + getVisibleIdWidth(false);
1413       }
1414       else
1415       {
1416         width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1417       }
1418
1419     }
1420     else if (av.isShowAnnotation())
1421     {
1422       height += getAnnotationPanel().adjustPanelHeight() + 3;
1423     }
1424     return new AlignmentDimension(width, height);
1425
1426   }
1427
1428   /**
1429    * DOCUMENT ME!
1430    */
1431   public void makeEPS(File epsFile)
1432   {
1433     makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1434   }
1435
1436   /**
1437    * DOCUMENT ME!
1438    */
1439   public void makePNG(File pngFile)
1440   {
1441     makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1442   }
1443
1444   public void makeSVG(File svgFile)
1445   {
1446     makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1447   }
1448
1449   public void makePNGImageMap(File imgMapFile, String imageName)
1450   {
1451     // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1452     // ////////////////////////////////////////////
1453     int idWidth = getVisibleIdWidth(false);
1454     FontMetrics fm = getFontMetrics(av.getFont());
1455     int scaleHeight = av.getCharHeight() + fm.getDescent();
1456
1457     // Gen image map
1458     // ////////////////////////////////
1459     if (imgMapFile != null)
1460     {
1461       try
1462       {
1463         int s, sSize = av.getAlignment().getHeight(), res, alwidth = av
1464                 .getAlignment().getWidth(), g, gSize, f, fSize, sy;
1465         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1466         out.println(jalview.io.HTMLOutput.getImageMapHTML());
1467         out.println("<img src=\"" + imageName
1468                 + "\" border=\"0\" usemap=\"#Map\" >"
1469                 + "<map name=\"Map\">");
1470
1471         for (s = 0; s < sSize; s++)
1472         {
1473           sy = s * av.getCharHeight() + scaleHeight;
1474
1475           SequenceI seq = av.getAlignment().getSequenceAt(s);
1476           SequenceFeature[] features = seq.getSequenceFeatures();
1477           SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1478           for (res = 0; res < alwidth; res++)
1479           {
1480             StringBuilder text = new StringBuilder();
1481             String triplet = null;
1482             if (av.getAlignment().isNucleotide())
1483             {
1484               triplet = ResidueProperties.nucleotideName.get(seq
1485                       .getCharAt(res) + "");
1486             }
1487             else
1488             {
1489               triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(res)
1490                       + "");
1491             }
1492
1493             if (triplet == null)
1494             {
1495               continue;
1496             }
1497
1498             int alIndex = seq.findPosition(res);
1499             gSize = groups.length;
1500             for (g = 0; g < gSize; g++)
1501             {
1502               if (text.length() < 1)
1503               {
1504                 text.append("<area shape=\"rect\" coords=\"")
1505                         .append((idWidth + res * av.getCharWidth()))
1506                         .append(",").append(sy).append(",")
1507                         .append((idWidth + (res + 1) * av.getCharWidth()))
1508                         .append(",").append((av.getCharHeight() + sy))
1509                         .append("\"").append(" onMouseOver=\"toolTip('")
1510                         .append(alIndex).append(" ").append(triplet);
1511               }
1512
1513               if (groups[g].getStartRes() < res
1514                       && groups[g].getEndRes() > res)
1515               {
1516                 text.append("<br><em>").append(groups[g].getName())
1517                         .append("</em>");
1518               }
1519             }
1520
1521             if (features != null)
1522             {
1523               if (text.length() < 1)
1524               {
1525                 text.append("<area shape=\"rect\" coords=\"")
1526                         .append((idWidth + res * av.getCharWidth()))
1527                         .append(",").append(sy).append(",")
1528                         .append((idWidth + (res + 1) * av.getCharWidth()))
1529                         .append(",").append((av.getCharHeight() + sy))
1530                         .append("\"").append(" onMouseOver=\"toolTip('")
1531                         .append(alIndex).append(" ").append(triplet);
1532               }
1533               fSize = features.length;
1534               for (f = 0; f < fSize; f++)
1535               {
1536
1537                 if ((features[f].getBegin() <= seq.findPosition(res))
1538                         && (features[f].getEnd() >= seq.findPosition(res)))
1539                 {
1540                   if (features[f].isContactFeature())
1541                   {
1542                     if (features[f].getBegin() == seq.findPosition(res)
1543                             || features[f].getEnd() == seq
1544                                     .findPosition(res))
1545                     {
1546                       text.append("<br>").append(features[f].getType())
1547                               .append(" ").append(features[f].getBegin())
1548                               .append(":").append(features[f].getEnd());
1549                     }
1550                   }
1551                   else
1552                   {
1553                     text.append("<br>");
1554                     text.append(features[f].getType());
1555                     if (features[f].getDescription() != null
1556                             && !features[f].getType().equals(
1557                                     features[f].getDescription()))
1558                     {
1559                       text.append(" ").append(features[f].getDescription());
1560                     }
1561
1562                     if (features[f].getValue("status") != null)
1563                     {
1564                       text.append(" (").append(features[f].getValue("status"))
1565                               .append(")");
1566                     }
1567                   }
1568                 }
1569
1570               }
1571             }
1572             if (text.length() > 1)
1573             {
1574               text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");
1575               out.println(text.toString());
1576             }
1577           }
1578         }
1579         out.println("</map></body></html>");
1580         out.close();
1581
1582       } catch (Exception ex)
1583       {
1584         ex.printStackTrace();
1585       }
1586     } // /////////END OF IMAGE MAP
1587
1588   }
1589
1590   int getWrappedHeight()
1591   {
1592     int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1593
1594     if (System.getProperty("java.awt.headless") != null
1595             && System.getProperty("java.awt.headless").equals("true"))
1596     {
1597       seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1598               - vscroll.getPreferredSize().width
1599               - alignFrame.getInsets().left - alignFrame.getInsets().right;
1600     }
1601
1602     int chunkWidth = getSeqPanel().seqCanvas
1603             .getWrappedCanvasWidth(seqPanelWidth);
1604
1605     int hgap = av.getCharHeight();
1606     if (av.getScaleAboveWrapped())
1607     {
1608       hgap += av.getCharHeight();
1609     }
1610
1611     int annotationHeight = 0;
1612     if (av.isShowAnnotation())
1613     {
1614       annotationHeight = getAnnotationPanel().adjustPanelHeight();
1615     }
1616
1617     int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1618             + annotationHeight;
1619
1620     int maxwidth = av.getAlignment().getWidth();
1621     if (av.hasHiddenColumns())
1622     {
1623       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1624     }
1625
1626     int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1627
1628     return height;
1629   }
1630
1631   /**
1632    * close the panel - deregisters all listeners and nulls any references to
1633    * alignment data.
1634    */
1635   public void closePanel()
1636   {
1637     PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1638     PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1639     PaintRefresher.RemoveComponent(this);
1640
1641     /*
1642      * try to ensure references are nulled
1643      */
1644     if (annotationPanel != null)
1645     {
1646       annotationPanel.dispose();
1647     }
1648
1649     if (av != null)
1650     {
1651       av.removePropertyChangeListener(propertyChangeListener);
1652       jalview.structure.StructureSelectionManager ssm = av
1653               .getStructureSelectionManager();
1654       ssm.removeStructureViewerListener(getSeqPanel(), null);
1655       ssm.removeSelectionListener(getSeqPanel());
1656       ssm.removeCommandListener(av);
1657       ssm.removeStructureViewerListener(getSeqPanel(), null);
1658       ssm.removeSelectionListener(getSeqPanel());
1659       av.dispose();
1660       av = null;
1661     }
1662     else
1663     {
1664       if (Cache.log.isDebugEnabled())
1665       {
1666         Cache.log.warn("Closing alignment panel which is already closed.");
1667       }
1668     }
1669   }
1670
1671   /**
1672    * hides or shows dynamic annotation rows based on groups and av state flags
1673    */
1674   public void updateAnnotation()
1675   {
1676     updateAnnotation(false, false);
1677   }
1678
1679   public void updateAnnotation(boolean applyGlobalSettings)
1680   {
1681     updateAnnotation(applyGlobalSettings, false);
1682   }
1683
1684   public void updateAnnotation(boolean applyGlobalSettings,
1685           boolean preserveNewGroupSettings)
1686   {
1687     av.updateGroupAnnotationSettings(applyGlobalSettings,
1688             preserveNewGroupSettings);
1689     adjustAnnotationHeight();
1690   }
1691
1692   @Override
1693   public AlignmentI getAlignment()
1694   {
1695     return av == null ? null : av.getAlignment();
1696   }
1697
1698   @Override
1699   public String getViewName()
1700   {
1701     return av.viewName;
1702   }
1703
1704   /**
1705    * Make/Unmake this alignment panel the current input focus
1706    *
1707    * @param b
1708    */
1709   public void setSelected(boolean b)
1710   {
1711     try
1712     {
1713       if (alignFrame.getSplitViewContainer() != null)
1714       {
1715         /*
1716          * bring enclosing SplitFrame to front first if there is one
1717          */
1718         ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1719       }
1720       alignFrame.setSelected(b);
1721     } catch (Exception ex)
1722     {
1723     }
1724
1725     if (b)
1726     {
1727       alignFrame.setDisplayedView(this);
1728     }
1729   }
1730
1731   @Override
1732   public StructureSelectionManager getStructureSelectionManager()
1733   {
1734     return av.getStructureSelectionManager();
1735   }
1736
1737   @Override
1738   public void raiseOOMWarning(String string, OutOfMemoryError error)
1739   {
1740     new OOMWarning(string, error, this);
1741   }
1742
1743   @Override
1744   public jalview.api.FeatureRenderer cloneFeatureRenderer()
1745   {
1746
1747     return new FeatureRenderer(this);
1748   }
1749
1750   @Override
1751   public jalview.api.FeatureRenderer getFeatureRenderer()
1752   {
1753     return seqPanel.seqCanvas.getFeatureRenderer();
1754   }
1755
1756   public void updateFeatureRenderer(
1757           jalview.renderer.seqfeatures.FeatureRenderer fr)
1758   {
1759     fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1760   }
1761
1762   public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1763   {
1764     if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1765     {
1766       getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1767     }
1768   }
1769
1770   public ScalePanel getScalePanel()
1771   {
1772     return scalePanel;
1773   }
1774
1775   public void setScalePanel(ScalePanel scalePanel)
1776   {
1777     this.scalePanel = scalePanel;
1778   }
1779
1780   public SeqPanel getSeqPanel()
1781   {
1782     return seqPanel;
1783   }
1784
1785   public void setSeqPanel(SeqPanel seqPanel)
1786   {
1787     this.seqPanel = seqPanel;
1788   }
1789
1790   public AnnotationPanel getAnnotationPanel()
1791   {
1792     return annotationPanel;
1793   }
1794
1795   public void setAnnotationPanel(AnnotationPanel annotationPanel)
1796   {
1797     this.annotationPanel = annotationPanel;
1798   }
1799
1800   public AnnotationLabels getAlabels()
1801   {
1802     return alabels;
1803   }
1804
1805   public void setAlabels(AnnotationLabels alabels)
1806   {
1807     this.alabels = alabels;
1808   }
1809
1810   public IdPanel getIdPanel()
1811   {
1812     return idPanel;
1813   }
1814
1815   public void setIdPanel(IdPanel idPanel)
1816   {
1817     this.idPanel = idPanel;
1818   }
1819
1820   /**
1821    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1822    * The aim is to keep the two alignments 'lined up' on their centre columns.
1823    *
1824    * @param sr
1825    *          holds mapped region(s) of this alignment that we are scrolling
1826    *          'to'; may be modified for sequence offset by this method
1827    * @param verticalOffset
1828    *          the number of visible sequences to show above the mapped region
1829    */
1830   public void scrollToCentre(SearchResultsI sr, int verticalOffset)
1831   {
1832     /*
1833      * To avoid jumpy vertical scrolling (if some sequences are gapped or not
1834      * mapped), we can make the scroll-to location a sequence above the one
1835      * actually mapped.
1836      */
1837     SequenceI mappedTo = sr.getResults().get(0).getSequence();
1838     List<SequenceI> seqs = av.getAlignment().getSequences();
1839
1840     /*
1841      * This is like AlignmentI.findIndex(seq) but here we are matching the
1842      * dataset sequence not the aligned sequence
1843      */
1844     boolean matched = false;
1845     for (SequenceI seq : seqs)
1846     {
1847       if (mappedTo == seq.getDatasetSequence())
1848       {
1849         matched = true;
1850         break;
1851       }
1852     }
1853     if (!matched)
1854     {
1855       return; // failsafe, shouldn't happen
1856     }
1857
1858     /*
1859      * Scroll to position but centring the target residue.
1860      */
1861     scrollToPosition(sr, verticalOffset, true, true);
1862   }
1863
1864   /**
1865    * Set a flag to say do not scroll any (cDNA/protein) complement.
1866    *
1867    * @param b
1868    */
1869   protected void setDontScrollComplement(boolean b)
1870   {
1871     this.dontScrollComplement = b;
1872   }
1873
1874   protected boolean isDontScrollComplement()
1875   {
1876     return this.dontScrollComplement;
1877   }
1878 }