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