JAL-1834 removed quotes around truncated strings with ellipsis
[jalview.git] / src / jalview / appletgui / 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.appletgui;
22
23 import jalview.analysis.AnnotationSorter;
24 import jalview.api.AlignViewportI;
25 import jalview.api.AlignmentViewPanel;
26 import jalview.bin.JalviewLite;
27 import jalview.datamodel.AlignmentI;
28 import jalview.datamodel.SearchResults;
29 import jalview.datamodel.SequenceI;
30 import jalview.structure.StructureSelectionManager;
31
32 import java.awt.BorderLayout;
33 import java.awt.Color;
34 import java.awt.Dimension;
35 import java.awt.FontMetrics;
36 import java.awt.Frame;
37 import java.awt.Graphics;
38 import java.awt.Panel;
39 import java.awt.Scrollbar;
40 import java.awt.event.AdjustmentEvent;
41 import java.awt.event.AdjustmentListener;
42 import java.awt.event.ComponentAdapter;
43 import java.awt.event.ComponentEvent;
44 import java.util.List;
45
46 public class AlignmentPanel extends Panel implements AdjustmentListener,
47         AlignmentViewPanel
48 {
49
50   public AlignViewport av;
51
52   OverviewPanel overviewPanel;
53
54   SeqPanel seqPanel;
55
56   IdPanel idPanel;
57
58   IdwidthAdjuster idwidthAdjuster;
59
60   public AlignFrame alignFrame;
61
62   ScalePanel scalePanel;
63
64   AnnotationPanel annotationPanel;
65
66   AnnotationLabels alabels;
67
68   // this value is set false when selection area being dragged
69   boolean fastPaint = true;
70
71   public void finalize()
72   {
73     alignFrame = null;
74     av = null;
75     seqPanel = null;
76     seqPanelHolder = null;
77     sequenceHolderPanel = null;
78     scalePanel = null;
79     scalePanelHolder = null;
80     annotationPanel = null;
81     annotationPanelHolder = null;
82     annotationSpaceFillerHolder = null;
83   }
84
85   public AlignmentPanel(AlignFrame af, final AlignViewport av)
86   {
87     try
88     {
89       jbInit();
90     } catch (Exception e)
91     {
92       e.printStackTrace();
93     }
94
95     alignFrame = af;
96     this.av = av;
97     seqPanel = new SeqPanel(av, this);
98     idPanel = new IdPanel(av, this);
99     scalePanel = new ScalePanel(av, this);
100     idwidthAdjuster = new IdwidthAdjuster(this);
101     annotationPanel = new AnnotationPanel(this);
102     annotationPanelHolder.add(annotationPanel, BorderLayout.CENTER);
103
104     sequenceHolderPanel.add(annotationPanelHolder, BorderLayout.SOUTH);
105     alabels = new AnnotationLabels(this);
106
107     setAnnotationVisible(av.isShowAnnotation());
108
109     idPanelHolder.add(idPanel, BorderLayout.CENTER);
110     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
111     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);
112     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);
113     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);
114
115     fontChanged();
116     setScrollValues(0, 0);
117
118     apvscroll.addAdjustmentListener(this);
119     hscroll.addAdjustmentListener(this);
120     vscroll.addAdjustmentListener(this);
121
122     addComponentListener(new ComponentAdapter()
123     {
124       public void componentResized(ComponentEvent evt)
125       {
126         setScrollValues(av.getStartRes(), av.getStartSeq());
127         if (getSize().height > 0
128                 && annotationPanelHolder.getSize().height > 0)
129         {
130           validateAnnotationDimensions(false);
131         }
132         repaint();
133       }
134
135     });
136
137     Dimension d = calculateIdWidth();
138     idPanel.idCanvas.setSize(d);
139
140     hscrollFillerPanel.setSize(d.width, annotationPanel.getSize().height);
141
142     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);
143     annotationSpaceFillerHolder.setSize(d.width,
144             annotationPanel.getSize().height);
145     alabels.setSize(d.width, annotationPanel.getSize().height);
146     final AlignmentPanel ap = this;
147     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
148     {
149       public void propertyChange(java.beans.PropertyChangeEvent evt)
150       {
151         if (evt.getPropertyName().equals("alignment"))
152         {
153           PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
154           alignmentChanged();
155         }
156       }
157     });
158   }
159
160   @Override
161   public AlignViewportI getAlignViewport()
162   {
163     return av;
164   }
165   public SequenceRenderer getSequenceRenderer()
166   {
167     return seqPanel.seqCanvas.sr;
168   }
169   @Override
170   public jalview.api.FeatureRenderer getFeatureRenderer()
171   {
172     return seqPanel.seqCanvas.fr;
173   }
174   @Override
175   public jalview.api.FeatureRenderer cloneFeatureRenderer()
176   {
177     FeatureRenderer nfr = new FeatureRenderer(av);
178     nfr.transferSettings(seqPanel.seqCanvas.fr);
179     return nfr;
180   }
181   public void alignmentChanged()
182   {
183     av.alignmentChanged(this);
184
185     if (overviewPanel != null)
186     {
187       overviewPanel.updateOverviewImage();
188     }
189
190     alignFrame.updateEditMenuBar();
191
192     repaint();
193   }
194
195   public void fontChanged()
196   {
197     // set idCanvas bufferedImage to null
198     // to prevent drawing old image
199     idPanel.idCanvas.image = null;
200     FontMetrics fm = getFontMetrics(av.getFont());
201
202     scalePanel.setSize(new Dimension(10, av.getCharHeight()
203             + fm.getDescent()));
204     idwidthAdjuster.setSize(new Dimension(10, av.getCharHeight()
205             + fm.getDescent()));
206     av.updateSequenceIdColours();
207     annotationPanel.image = null;
208     int ap = annotationPanel.adjustPanelHeight(false);
209     Dimension d = calculateIdWidth();
210     d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);
211     alabels.setSize(d.width + 4, ap);
212
213     idPanel.idCanvas.setSize(d);
214     hscrollFillerPanel.setSize(d);
215
216     validateAnnotationDimensions(false);
217     annotationPanel.repaint();
218     validate();
219     repaint();
220
221     if (overviewPanel != null)
222     {
223       overviewPanel.updateOverviewImage();
224     }
225   }
226
227   public void setIdWidth(int w, int h)
228   {
229     idPanel.idCanvas.setSize(w, h);
230     idPanelHolder.setSize(w, idPanelHolder.getSize().height);
231     annotationSpaceFillerHolder.setSize(w,
232             annotationSpaceFillerHolder.getSize().height);
233     alabels.setSize(w, alabels.getSize().height);
234     validate();
235   }
236
237   Dimension calculateIdWidth()
238   {
239     if (av.nullFrame == null)
240     {
241       av.nullFrame = new Frame();
242       av.nullFrame.addNotify();
243     }
244
245     Graphics g = av.nullFrame.getGraphics();
246
247     FontMetrics fm = g.getFontMetrics(av.font);
248     AlignmentI al = av.getAlignment();
249
250     int i = 0;
251     int idWidth = 0;
252     String id;
253     while (i < al.getHeight() && al.getSequenceAt(i) != null)
254     {
255       SequenceI s = al.getSequenceAt(i);
256       id = s.getDisplayId(av.getShowJVSuffix());
257
258       if (fm.stringWidth(id) > idWidth)
259       {
260         idWidth = fm.stringWidth(id);
261       }
262       i++;
263     }
264
265     // Also check annotation label widths
266     i = 0;
267     if (al.getAlignmentAnnotation() != null)
268     {
269       fm = g.getFontMetrics(av.nullFrame.getFont());
270       while (i < al.getAlignmentAnnotation().length)
271       {
272         String label = al.getAlignmentAnnotation()[i].label;
273         if (fm.stringWidth(label) > idWidth)
274         {
275           idWidth = fm.stringWidth(label);
276         }
277         i++;
278       }
279     }
280
281     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);
282   }
283
284   /**
285    * Highlight the given results on the alignment.
286    * 
287    */
288   public void highlightSearchResults(SearchResults results)
289   {
290     scrollToPosition(results);
291     seqPanel.seqCanvas.highlightSearchResults(results);
292   }
293
294   /**
295    * scroll the view to show the position of the highlighted region in results
296    * (if any) and redraw the overview
297    * 
298    * @param results
299    * @return false if results were not found
300    */
301   public boolean scrollToPosition(SearchResults results)
302   {
303     return scrollToPosition(results, true);
304   }
305
306   /**
307    * scroll the view to show the position of the highlighted region in results
308    * (if any)
309    * 
310    * @param results
311    * @param redrawOverview
312    *          - when set, the overview will be recalculated (takes longer)
313    * @return false if results were not found
314    */
315   public boolean scrollToPosition(SearchResults results,
316           boolean redrawOverview)
317   {
318     return scrollToPosition(results, redrawOverview, false);
319   }
320
321   /**
322    * scroll the view to show the position of the highlighted region in results
323    * (if any)
324    * 
325    * @param results
326    * @param redrawOverview
327    *          - when set, the overview will be recalculated (takes longer)
328    * @return false if results were not found
329    */
330   public boolean scrollToPosition(SearchResults results,
331           boolean redrawOverview, boolean centre)
332   {
333     // do we need to scroll the panel?
334     if (results != null && results.getSize() > 0)
335     {
336       AlignmentI alignment = av.getAlignment();
337       int seqIndex = alignment.findIndex(results);
338       if (seqIndex == -1)
339       {
340         return false;
341       }
342       SequenceI seq = alignment.getSequenceAt(seqIndex);
343       int[] r = results.getResults(seq, 0, alignment.getWidth());
344       if (r == null)
345       {
346         if (JalviewLite.debug)
347         {// DEBUG
348           System.out
349                   .println("DEBUG: scroll didn't happen - results not within alignment : "
350                           + seq.getStart() + "," + seq.getEnd());
351         }
352         return false;
353       }
354       if (JalviewLite.debug)
355       {
356         // DEBUG
357         /*
358          * System.out.println("DEBUG: scroll: start=" + r[0] +
359          * " av.getStartRes()=" + av.getStartRes() + " end=" + r[1] +
360          * " seq.end=" + seq.getEnd() + " av.getEndRes()=" + av.getEndRes() +
361          * " hextent=" + hextent);
362          */
363       }
364       int start = r[0];
365       int end = r[1];
366
367       /*
368        * To centre results, scroll to positions half the visible width
369        * left/right of the start/end positions
370        */
371       if (centre)
372       {
373         int offset = (av.getEndRes() - av.getStartRes() + 1) / 2 - 1;
374         start = Math.max(start - offset, 0);
375         end = Math.min(end + offset, seq.getEnd() - 1);
376       }
377
378       if (start < 0)
379       {
380         return false;
381       }
382       if (end == seq.getEnd())
383       {
384         return false;
385       }
386       return scrollTo(start, end, seqIndex, false, redrawOverview);
387     }
388     return true;
389   }
390
391   public boolean scrollTo(int ostart, int end, int seqIndex,
392           boolean scrollToNearest, boolean redrawOverview)
393   {
394     int startv, endv, starts, ends, width;
395
396     int start = -1;
397     if (av.hasHiddenColumns())
398     {
399       start = av.getColumnSelection().findColumnPosition(ostart);
400       end = av.getColumnSelection().findColumnPosition(end);
401       if (start == end)
402       {
403         if (!scrollToNearest && !av.getColumnSelection().isVisible(ostart))
404         {
405           // don't scroll - position isn't visible
406           return false;
407         }
408       }
409     }
410     else
411     {
412       start = ostart;
413     }
414     if (!av.getWrapAlignment())
415     {
416       /*
417        * int spos=av.getStartRes(),sqpos=av.getStartSeq(); if ((startv =
418        * av.getStartRes()) >= start) { spos=start-1; // seqIn //
419        * setScrollValues(start - 1, seqIndex); } else if ((endv =
420        * av.getEndRes()) <= end) { // setScrollValues(spos=startv + 1 + end -
421        * endv, seqIndex); spos=startv + 1 + end - endv; } else if ((starts =
422        * av.getStartSeq()) > seqIndex) { setScrollValues(av.getStartRes(),
423        * seqIndex); } else if ((ends = av.getEndSeq()) <= seqIndex) {
424        * setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1); }
425        */
426
427       // below is scrolling logic up to Jalview 2.8.2
428       // if ((av.getStartRes() > end)
429       // || (av.getEndRes() < start)
430       // || ((av.getStartSeq() > seqIndex) || (av.getEndSeq() < seqIndex)))
431       // {
432       // if (start > av.getAlignment().getWidth() - hextent)
433       // {
434       // start = av.getAlignment().getWidth() - hextent;
435       // if (start < 0)
436       // {
437       // start = 0;
438       // }
439       //
440       // }
441       // if (seqIndex > av.getAlignment().getHeight() - vextent)
442       // {
443       // seqIndex = av.getAlignment().getHeight() - vextent;
444       // if (seqIndex < 0)
445       // {
446       // seqIndex = 0;
447       // }
448       // }
449       // setScrollValues(start, seqIndex);
450       // }
451       // logic copied from jalview.gui.AlignmentPanel:
452         if ((startv = av.getStartRes()) >= start)
453         {
454           /*
455            * Scroll left to make start of search results visible
456            */
457           setScrollValues(start - 1, seqIndex);
458         }
459         else if ((endv = av.getEndRes()) <= end)
460         {
461           /*
462            * Scroll right to make end of search results visible
463            */
464           setScrollValues(startv + 1 + end - endv, seqIndex);
465         }
466         else if ((starts = av.getStartSeq()) > seqIndex)
467         {
468           /*
469            * Scroll up to make start of search results visible
470            */
471           setScrollValues(av.getStartRes(), seqIndex);
472         }
473         else if ((ends = av.getEndSeq()) <= seqIndex)
474         {
475           /*
476            * Scroll down to make end of search results visible
477            */
478           setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1);
479         }
480         /*
481          * Else results are already visible - no need to scroll
482          */
483     }
484     else
485     {
486       scrollToWrappedVisible(start);
487     }
488     if (redrawOverview && overviewPanel != null)
489     {
490       overviewPanel.setBoxPosition();
491     }
492     paintAlignment(redrawOverview);
493     return true;
494   }
495
496   void scrollToWrappedVisible(int res)
497   {
498     int cwidth = seqPanel.seqCanvas
499             .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
500     if (res <= av.getStartRes() || res >= (av.getStartRes() + cwidth))
501     {
502       vscroll.setValue(res / cwidth);
503       av.startRes = vscroll.getValue() * cwidth;
504     }
505   }
506
507   public OverviewPanel getOverviewPanel()
508   {
509     return overviewPanel;
510   }
511
512   public void setOverviewPanel(OverviewPanel op)
513   {
514     overviewPanel = op;
515   }
516
517   public void setAnnotationVisible(boolean b)
518   {
519     if (!av.getWrapAlignment())
520     {
521       annotationSpaceFillerHolder.setVisible(b);
522       annotationPanelHolder.setVisible(b);
523     }
524     else
525     {
526       annotationSpaceFillerHolder.setVisible(false);
527       annotationPanelHolder.setVisible(false);
528     }
529     validate();
530     repaint();
531   }
532
533   /**
534    * automatically adjust annotation panel height for new annotation whilst
535    * ensuring the alignment is still visible.
536    */
537   public void adjustAnnotationHeight()
538   {
539     // TODO: display vertical annotation scrollbar if necessary
540     // this is called after loading new annotation onto alignment
541     if (alignFrame.getSize().height == 0)
542     {
543       System.out
544               .println("adjustAnnotationHeight frame size zero NEEDS FIXING");
545     }
546     fontChanged();
547     validateAnnotationDimensions(true);
548     apvscroll.addNotify();
549     hscroll.addNotify();
550     validate();
551     paintAlignment(true);
552   }
553
554   /**
555    * Calculate the annotation dimensions and refresh slider values accordingly.
556    * Need to do repaints/notifys afterwards.
557    */
558   protected void validateAnnotationDimensions(boolean adjustPanelHeight)
559   {
560     int rowHeight = av.getCharHeight();
561     int alignmentHeight = rowHeight * av.getAlignment().getHeight();
562     int annotationHeight = av.calcPanelHeight();
563
564     int mheight = annotationHeight;
565     Dimension d = sequenceHolderPanel.getSize();
566
567     int availableHeight = d.height - scalePanelHolder.getHeight();
568
569     if (adjustPanelHeight)
570     {
571       /*
572        * If not enough vertical space, maximize annotation height while keeping
573        * at least two rows of alignment visible
574        */
575       if (annotationHeight + alignmentHeight > availableHeight)
576       {
577         annotationHeight = Math.min(annotationHeight, availableHeight - 2
578                 * rowHeight);
579       }
580     }
581     else
582     {
583       // maintain same window layout whilst updating sliders
584       annotationHeight = annotationPanelHolder.getSize().height;
585     }
586
587     if (availableHeight - annotationHeight < 5)
588     {
589       annotationHeight = availableHeight;
590     }
591
592     annotationPanel.setSize(new Dimension(d.width, annotationHeight));
593     annotationPanelHolder.setSize(new Dimension(d.width, annotationHeight));
594     // seqPanelHolder.setSize(d.width, seqandannot - height);
595     seqPanel.seqCanvas
596             .setSize(d.width, seqPanel.seqCanvas.getSize().height);
597
598     Dimension e = idPanel.getSize();
599     alabels.setSize(new Dimension(e.width, annotationHeight));
600     annotationSpaceFillerHolder.setSize(new Dimension(e.width,
601             annotationHeight));
602
603     int s = apvscroll.getValue();
604     if (s > mheight - annotationHeight)
605     {
606       s = 0;
607     }
608     apvscroll.setValues(s, annotationHeight, 0, mheight);
609     annotationPanel.setScrollOffset(apvscroll.getValue(), false);
610     alabels.setScrollOffset(apvscroll.getValue(), false);
611   }
612
613   public void setWrapAlignment(boolean wrap)
614   {
615     av.startSeq = 0;
616     av.startRes = 0;
617     scalePanelHolder.setVisible(!wrap);
618
619     hscroll.setVisible(!wrap);
620     idwidthAdjuster.setVisible(!wrap);
621
622     if (wrap)
623     {
624       annotationPanelHolder.setVisible(false);
625       annotationSpaceFillerHolder.setVisible(false);
626     }
627     else if (av.isShowAnnotation())
628     {
629       annotationPanelHolder.setVisible(true);
630       annotationSpaceFillerHolder.setVisible(true);
631     }
632
633     idSpaceFillerPanel1.setVisible(!wrap);
634
635     fontChanged(); // This is so that the scalePanel is resized correctly
636
637     validate();
638     sequenceHolderPanel.validate();
639     repaint();
640
641   }
642
643   int hextent = 0;
644
645   int vextent = 0;
646
647   // return value is true if the scroll is valid
648   public boolean scrollUp(boolean up)
649   {
650     if (up)
651     {
652       if (vscroll.getValue() < 1)
653       {
654         return false;
655       }
656       setScrollValues(hscroll.getValue(), vscroll.getValue() - 1);
657     }
658     else
659     {
660       if (vextent + vscroll.getValue() >= av.getAlignment().getHeight())
661       {
662         return false;
663       }
664       setScrollValues(hscroll.getValue(), vscroll.getValue() + 1);
665     }
666
667     repaint();
668     return true;
669   }
670
671   public boolean scrollRight(boolean right)
672   {
673     if (!right)
674     {
675       if (hscroll.getValue() < 1)
676       {
677         return false;
678       }
679       setScrollValues(hscroll.getValue() - 1, vscroll.getValue());
680     }
681     else
682     {
683       if (hextent + hscroll.getValue() >= av.getAlignment().getWidth())
684       {
685         return false;
686       }
687       setScrollValues(hscroll.getValue() + 1, vscroll.getValue());
688     }
689
690     repaint();
691     return true;
692   }
693
694   public void setScrollValues(int x, int y)
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     if (x < 0)
704     {
705       x = 0;
706     }
707     ;
708
709     hextent = seqPanel.seqCanvas.getSize().width / av.getCharWidth();
710     vextent = seqPanel.seqCanvas.getSize().height / av.getCharHeight();
711
712     if (hextent > width)
713     {
714       hextent = width;
715     }
716
717     if (vextent > height)
718     {
719       vextent = height;
720     }
721
722     if ((hextent + x) > width)
723     {
724       System.err.println("hextent was " + hextent + " and x was " + x);
725
726       x = width - hextent;
727     }
728
729     if ((vextent + y) > height)
730     {
731       y = height - vextent;
732     }
733
734     if (y < 0)
735     {
736       y = 0;
737     }
738
739     if (x < 0)
740     {
741       System.err.println("x was " + x);
742       x = 0;
743     }
744
745     av.setStartSeq(y);
746
747     int endSeq = y + vextent;
748     if (endSeq > av.getAlignment().getHeight())
749     {
750       endSeq = av.getAlignment().getHeight();
751     }
752
753     av.setEndSeq(endSeq);
754     av.setStartRes(x);
755     av.setEndRes((x + (seqPanel.seqCanvas.getSize().width / av
756             .getCharWidth())) - 1);
757
758     hscroll.setValues(x, hextent, 0, width);
759     vscroll.setValues(y, vextent, 0, height);
760
761     if (overviewPanel != null)
762     {
763       overviewPanel.setBoxPosition();
764     }
765     sendViewPosition();
766
767   }
768
769   public void adjustmentValueChanged(AdjustmentEvent evt)
770   {
771     int oldX = av.getStartRes();
772     int oldY = av.getStartSeq();
773
774     if (evt == null || evt.getSource() == apvscroll)
775     {
776       annotationPanel.setScrollOffset(apvscroll.getValue(), false);
777       alabels.setScrollOffset(apvscroll.getValue(), false);
778       // annotationPanel.image=null;
779       // alabels.image=null;
780       // alabels.repaint();
781       // annotationPanel.repaint();
782     }
783     if (evt == null || evt.getSource() == hscroll)
784     {
785       int x = hscroll.getValue();
786       av.setStartRes(x);
787       av.setEndRes(x + seqPanel.seqCanvas.getSize().width
788               / av.getCharWidth() - 1);
789     }
790
791     if (evt == null || evt.getSource() == vscroll)
792     {
793       int offy = vscroll.getValue();
794       if (av.getWrapAlignment())
795       {
796         int rowSize = seqPanel.seqCanvas
797                 .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
798         av.setStartRes(vscroll.getValue() * rowSize);
799         av.setEndRes((vscroll.getValue() + 1) * rowSize);
800       }
801       else
802       {
803         av.setStartSeq(offy);
804         av.setEndSeq(offy + seqPanel.seqCanvas.getSize().height
805                 / av.getCharHeight());
806       }
807     }
808
809     if (overviewPanel != null)
810     {
811       overviewPanel.setBoxPosition();
812     }
813
814     int scrollX = av.startRes - oldX;
815     int scrollY = av.startSeq - oldY;
816
817     if (av.getWrapAlignment() || !fastPaint || av.MAC)
818     {
819       repaint();
820     }
821     else
822     {
823       // Make sure we're not trying to draw a panel
824       // larger than the visible window
825       if (scrollX > av.endRes - av.startRes)
826       {
827         scrollX = av.endRes - av.startRes;
828       }
829       else if (scrollX < av.startRes - av.endRes)
830       {
831         scrollX = av.startRes - av.endRes;
832       }
833
834       idPanel.idCanvas.fastPaint(scrollY);
835       seqPanel.seqCanvas.fastPaint(scrollX, scrollY);
836
837       scalePanel.repaint();
838       if (av.isShowAnnotation())
839       {
840         annotationPanel.fastPaint(av.getStartRes() - oldX);
841       }
842     }
843     sendViewPosition();
844
845     /*
846      * If there is one, scroll the (Protein/cDNA) complementary alignment to
847      * match, unless we are ourselves doing that.
848      */
849     if (isFollowingComplementScroll())
850     {
851       setFollowingComplementScroll(false);
852     }
853     else
854     {
855       AlignmentPanel ap = getComplementPanel();
856       av.scrollComplementaryAlignment(ap);
857     }
858
859   }
860
861   /**
862    * A helper method to return the AlignmentPanel in the other (complementary)
863    * half of a SplitFrame view. Returns null if not in a SplitFrame.
864    * 
865    * @return
866    */
867   private AlignmentPanel getComplementPanel()
868   {
869     AlignmentPanel ap = null;
870     if (alignFrame != null)
871     {
872       SplitFrame sf = alignFrame.getSplitFrame();
873       if (sf != null)
874       {
875         AlignFrame other = sf.getComplement(alignFrame);
876         if (other != null)
877         {
878           ap = other.alignPanel;
879         }
880       }
881     }
882     return ap;
883   }
884
885   /**
886    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
887    * The aim is to keep the two alignments 'lined up' on their centre columns.
888    * 
889    * @param sr
890    *          holds mapped region(s) of this alignment that we are scrolling
891    *          'to'; may be modified for sequence offset by this method
892    * @param seqOffset
893    *          the number of visible sequences to show above the mapped region
894    */
895   protected void scrollToCentre(SearchResults sr, int seqOffset)
896   {
897     /*
898      * To avoid jumpy vertical scrolling (if some sequences are gapped or not
899      * mapped), we can make the scroll-to location a sequence above the one
900      * actually mapped.
901      */
902     SequenceI mappedTo = sr.getResultSequence(0);
903     List<SequenceI> seqs = av.getAlignment().getSequences();
904
905     /*
906      * This is like AlignmentI.findIndex(seq) but here we are matching the
907      * dataset sequence not the aligned sequence
908      */
909     int sequenceIndex = 0;
910     boolean matched = false;
911     for (SequenceI seq : seqs)
912     {
913       if (mappedTo == seq.getDatasetSequence())
914       {
915         matched = true;
916         break;
917       }
918       sequenceIndex++;
919     }
920     if (!matched)
921     {
922       return; // failsafe, shouldn't happen
923     }
924     sequenceIndex = Math.max(0, sequenceIndex - seqOffset);
925     sr.getResults().get(0)
926             .setSequence(av.getAlignment().getSequenceAt(sequenceIndex));
927
928     /*
929      * Scroll to position but centring the target residue. Also set a state flag
930      * to prevent adjustmentValueChanged performing this recursively.
931      */
932     setFollowingComplementScroll(true);
933     scrollToPosition(sr, true, true);
934   }
935
936   private void sendViewPosition()
937   {
938     StructureSelectionManager.getStructureSelectionManager(av.applet)
939             .sendViewPosition(this, av.startRes, av.endRes, av.startSeq,
940                     av.endSeq);
941   }
942
943   /**
944    * Repaint the alignment and annotations, and, optionally, any overview window
945    */
946   public void paintAlignment(boolean updateOverview)
947   {
948     final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
949             av.isShowAutocalculatedAbove());
950     sorter.sort(getAlignment().getAlignmentAnnotation(),
951             av.getSortAnnotationsBy());
952     repaint();
953
954     if (updateOverview)
955     {
956       jalview.structure.StructureSelectionManager
957               .getStructureSelectionManager(av.applet)
958               .sequenceColoursChanged(this);
959
960       if (overviewPanel != null)
961       {
962         overviewPanel.updateOverviewImage();
963       }
964     }
965   }
966
967   public void update(Graphics g)
968   {
969     paint(g);
970   }
971
972   public void paint(Graphics g)
973   {
974     invalidate();
975     Dimension d = idPanel.idCanvas.getSize();
976     final int canvasHeight = seqPanel.seqCanvas.getSize().height;
977     if (canvasHeight != d.height)
978     {
979       idPanel.idCanvas.setSize(d.width, canvasHeight);
980     }
981
982     if (av.getWrapAlignment())
983     {
984       int maxwidth = av.getAlignment().getWidth();
985
986       if (av.hasHiddenColumns())
987       {
988         maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
989       }
990
991       int canvasWidth = seqPanel.seqCanvas
992               .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
993
994       if (canvasWidth > 0)
995       {
996         int max = maxwidth / canvasWidth;
997         vscroll.setMaximum(1 + max);
998         vscroll.setUnitIncrement(1);
999         vscroll.setVisibleAmount(1);
1000       }
1001     }
1002     else
1003     {
1004       setScrollValues(av.getStartRes(), av.getStartSeq());
1005     }
1006
1007     seqPanel.seqCanvas.repaint();
1008     idPanel.idCanvas.repaint();
1009     if (!av.getWrapAlignment())
1010     {
1011       if (av.isShowAnnotation())
1012       {
1013         alabels.repaint();
1014         annotationPanel.repaint();
1015       }
1016       scalePanel.repaint();
1017     }
1018
1019   }
1020
1021   protected Panel sequenceHolderPanel = new Panel();
1022
1023   protected Scrollbar vscroll = new Scrollbar();
1024
1025   protected Scrollbar hscroll = new Scrollbar();
1026
1027   protected Panel seqPanelHolder = new Panel();
1028
1029   protected Panel scalePanelHolder = new Panel();
1030
1031   protected Panel idPanelHolder = new Panel();
1032
1033   protected Panel idSpaceFillerPanel1 = new Panel();
1034
1035   public Panel annotationSpaceFillerHolder = new Panel();
1036
1037   protected Panel hscrollFillerPanel = new Panel();
1038
1039   Panel annotationPanelHolder = new Panel();
1040
1041   protected Scrollbar apvscroll = new Scrollbar();
1042
1043   /*
1044    * Flag set while scrolling to follow complementary cDNA/protein scroll. When
1045    * true, suppresses invoking the same method recursively.
1046    */
1047   private boolean followingComplementScroll;
1048
1049   private void jbInit() throws Exception
1050   {
1051     // idPanelHolder.setPreferredSize(new Dimension(70, 10));
1052     this.setLayout(new BorderLayout());
1053
1054     // sequenceHolderPanel.setPreferredSize(new Dimension(150, 150));
1055     sequenceHolderPanel.setLayout(new BorderLayout());
1056     seqPanelHolder.setLayout(new BorderLayout());
1057     scalePanelHolder.setBackground(Color.white);
1058
1059     // scalePanelHolder.setPreferredSize(new Dimension(10, 30));
1060     scalePanelHolder.setLayout(new BorderLayout());
1061     idPanelHolder.setLayout(new BorderLayout());
1062     idSpaceFillerPanel1.setBackground(Color.white);
1063
1064     // idSpaceFillerPanel1.setPreferredSize(new Dimension(10, 30));
1065     idSpaceFillerPanel1.setLayout(new BorderLayout());
1066     annotationSpaceFillerHolder.setBackground(Color.white);
1067
1068     // annotationSpaceFillerHolder.setPreferredSize(new Dimension(10, 80));
1069     annotationSpaceFillerHolder.setLayout(new BorderLayout());
1070     hscroll.setOrientation(Scrollbar.HORIZONTAL);
1071
1072     Panel hscrollHolder = new Panel();
1073     hscrollHolder.setLayout(new BorderLayout());
1074     hscrollFillerPanel.setBackground(Color.white);
1075     apvscroll.setOrientation(Scrollbar.VERTICAL);
1076     apvscroll.setVisible(true);
1077     apvscroll.addAdjustmentListener(this);
1078
1079     annotationPanelHolder.setBackground(Color.white);
1080     annotationPanelHolder.setLayout(new BorderLayout());
1081     annotationPanelHolder.add(apvscroll, BorderLayout.EAST);
1082     // hscrollFillerPanel.setPreferredSize(new Dimension(70, 10));
1083     hscrollHolder.setBackground(Color.white);
1084
1085     // annotationScroller.setPreferredSize(new Dimension(10, 80));
1086     // this.setPreferredSize(new Dimension(220, 166));
1087     seqPanelHolder.setBackground(Color.white);
1088     idPanelHolder.setBackground(Color.white);
1089     sequenceHolderPanel.add(scalePanelHolder, BorderLayout.NORTH);
1090     sequenceHolderPanel.add(seqPanelHolder, BorderLayout.CENTER);
1091     seqPanelHolder.add(vscroll, BorderLayout.EAST);
1092
1093     // Panel3.add(secondaryPanelHolder, BorderLayout.SOUTH);
1094     this.add(idPanelHolder, BorderLayout.WEST);
1095     idPanelHolder.add(idSpaceFillerPanel1, BorderLayout.NORTH);
1096     idPanelHolder.add(annotationSpaceFillerHolder, BorderLayout.SOUTH);
1097     this.add(hscrollHolder, BorderLayout.SOUTH);
1098     hscrollHolder.add(hscroll, BorderLayout.CENTER);
1099     hscrollHolder.add(hscrollFillerPanel, BorderLayout.WEST);
1100     this.add(sequenceHolderPanel, BorderLayout.CENTER);
1101   }
1102
1103   /**
1104    * hides or shows dynamic annotation rows based on groups and av state flags
1105    */
1106   public void updateAnnotation()
1107   {
1108     updateAnnotation(false);
1109   }
1110
1111   public void updateAnnotation(boolean applyGlobalSettings)
1112   {
1113     updateAnnotation(applyGlobalSettings, false);
1114   }
1115
1116   public void updateAnnotation(boolean applyGlobalSettings,
1117           boolean preserveNewGroupSettings)
1118   {
1119     av.updateGroupAnnotationSettings(applyGlobalSettings,
1120             preserveNewGroupSettings);
1121     adjustAnnotationHeight();
1122   }
1123
1124   @Override
1125   public AlignmentI getAlignment()
1126   {
1127     return av.getAlignment();
1128   }
1129
1130   @Override
1131   public String getViewName()
1132   {
1133     return getName();
1134   }
1135
1136   @Override
1137   public StructureSelectionManager getStructureSelectionManager()
1138   {
1139     return StructureSelectionManager
1140             .getStructureSelectionManager(av.applet);
1141   }
1142
1143   @Override
1144   public void raiseOOMWarning(String string, OutOfMemoryError error)
1145   {
1146     // TODO: JAL-960
1147     System.err.println("Out of memory whilst '" + string + "'");
1148     error.printStackTrace();
1149   }
1150
1151   /**
1152    * Set a flag to say we are scrolling to follow a (cDNA/protein) complement.
1153    * 
1154    * @param b
1155    */
1156   protected void setFollowingComplementScroll(boolean b)
1157   {
1158     this.followingComplementScroll = b;
1159   }
1160
1161   protected boolean isFollowingComplementScroll()
1162   {
1163     return this.followingComplementScroll;
1164   }
1165
1166 }