2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3 * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
18 package jalview.appletgui;
21 import java.awt.event.*;
22 import java.util.Hashtable;
23 import java.util.Vector;
25 import jalview.api.AlignmentViewPanel;
26 import jalview.datamodel.*;
27 import jalview.structure.StructureSelectionManager;
29 public class AlignmentPanel extends Panel implements AdjustmentListener,
33 public AlignViewport av;
35 OverviewPanel overviewPanel;
41 IdwidthAdjuster idwidthAdjuster;
43 public AlignFrame alignFrame;
45 ScalePanel scalePanel;
47 AnnotationPanel annotationPanel;
49 AnnotationLabels alabels;
51 // this value is set false when selection area being dragged
52 boolean fastPaint = true;
54 public void finalize()
59 seqPanelHolder = null;
60 sequenceHolderPanel = null;
62 scalePanelHolder = null;
63 annotationPanel = null;
64 annotationPanelHolder = null;
65 annotationSpaceFillerHolder = null;
68 public AlignmentPanel(AlignFrame af, final AlignViewport av)
80 seqPanel = new SeqPanel(av, this);
81 idPanel = new IdPanel(av, this);
82 scalePanel = new ScalePanel(av, this);
83 idwidthAdjuster = new IdwidthAdjuster(this);
84 annotationPanel = new AnnotationPanel(this);
85 annotationPanelHolder.add(annotationPanel, BorderLayout.CENTER);
87 sequenceHolderPanel.add(annotationPanelHolder, BorderLayout.SOUTH);
89 alabels = new AnnotationLabels(this);
91 setAnnotationVisible(av.showAnnotation);
93 idPanelHolder.add(idPanel, BorderLayout.CENTER);
94 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
95 annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);
96 scalePanelHolder.add(scalePanel, BorderLayout.CENTER);
97 seqPanelHolder.add(seqPanel, BorderLayout.CENTER);
100 setScrollValues(0, 0);
102 apvscroll.addAdjustmentListener(this);
103 hscroll.addAdjustmentListener(this);
104 vscroll.addAdjustmentListener(this);
106 addComponentListener(new ComponentAdapter()
108 public void componentResized(ComponentEvent evt)
110 setScrollValues(av.getStartRes(), av.getStartSeq());
111 if (getSize().height > 0
112 && annotationPanelHolder.getSize().height > 0)
114 validateAnnotationDimensions(false);
121 Dimension d = calculateIdWidth();
122 idPanel.idCanvas.setSize(d);
124 hscrollFillerPanel.setSize(d.width, annotationPanel.getSize().height);
126 idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);
127 annotationSpaceFillerHolder.setSize(d.width,
128 annotationPanel.getSize().height);
129 alabels.setSize(d.width, annotationPanel.getSize().height);
130 final AlignmentPanel ap = this;
131 av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
133 public void propertyChange(java.beans.PropertyChangeEvent evt)
135 if (evt.getPropertyName().equals("alignment"))
137 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
145 public SequenceRenderer getSequenceRenderer()
147 return seqPanel.seqCanvas.sr;
150 public FeatureRenderer getFeatureRenderer()
152 return seqPanel.seqCanvas.fr;
155 public void alignmentChanged()
157 av.alignmentChanged(this);
159 if (overviewPanel != null)
161 overviewPanel.updateOverviewImage();
164 alignFrame.updateEditMenuBar();
169 public void fontChanged()
171 // set idCanvas bufferedImage to null
172 // to prevent drawing old image
173 idPanel.idCanvas.image = null;
174 FontMetrics fm = getFontMetrics(av.getFont());
176 scalePanel.setSize(new Dimension(10, av.charHeight + fm.getDescent()));
177 idwidthAdjuster.setSize(new Dimension(10, av.charHeight
179 av.updateSequenceIdColours();
180 annotationPanel.image = null;
181 int ap = annotationPanel.adjustPanelHeight(false);
182 Dimension d = calculateIdWidth();
183 d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);
184 alabels.setSize(d.width + 4, ap);
186 idPanel.idCanvas.setSize(d);
187 hscrollFillerPanel.setSize(d);
189 validateAnnotationDimensions(false);
190 annotationPanel.repaint();
194 if (overviewPanel != null)
196 overviewPanel.updateOverviewImage();
200 public void setIdWidth(int w, int h)
202 idPanel.idCanvas.setSize(w, h);
203 idPanelHolder.setSize(w, idPanelHolder.getSize().height);
204 annotationSpaceFillerHolder.setSize(w,
205 annotationSpaceFillerHolder.getSize().height);
206 alabels.setSize(w, alabels.getSize().height);
210 Dimension calculateIdWidth()
212 if (av.nullFrame == null)
214 av.nullFrame = new Frame();
215 av.nullFrame.addNotify();
218 Graphics g = av.nullFrame.getGraphics();
220 FontMetrics fm = g.getFontMetrics(av.font);
221 AlignmentI al = av.getAlignment();
226 while (i < al.getHeight() && al.getSequenceAt(i) != null)
228 SequenceI s = al.getSequenceAt(i);
229 id = s.getDisplayId(av.getShowJVSuffix());
231 if (fm.stringWidth(id) > idWidth)
233 idWidth = fm.stringWidth(id);
238 // Also check annotation label widths
240 if (al.getAlignmentAnnotation() != null)
242 fm = g.getFontMetrics(av.nullFrame.getFont());
243 while (i < al.getAlignmentAnnotation().length)
245 String label = al.getAlignmentAnnotation()[i].label;
246 if (fm.stringWidth(label) > idWidth)
248 idWidth = fm.stringWidth(label);
254 return new Dimension(idWidth, idPanel.idCanvas.getSize().height);
258 * Highlight the given results on the alignment.
261 public void highlightSearchResults(SearchResults results)
263 scrollToPosition(results);
264 seqPanel.seqCanvas.highlightSearchResults(results);
268 * scroll the view to show the position of the highlighted region in results
269 * (if any) and redraw the overview
272 * @return false if results were not found
274 public boolean scrollToPosition(SearchResults results)
276 return scrollToPosition(results, true);
280 * scroll the view to show the position of the highlighted region in results
284 * @param redrawOverview
285 * - when set, the overview will be recalculated (takes longer)
286 * @return false if results were not found
288 public boolean scrollToPosition(SearchResults results,
289 boolean redrawOverview)
292 // do we need to scroll the panel?
293 if (results != null && results.getSize() > 0)
295 AlignmentI alignment = av.getAlignment();
296 int seqIndex = alignment.findIndex(results);
301 SequenceI seq = alignment.getSequenceAt(seqIndex);
302 int[] r = results.getResults(seq, 0, alignment.getWidth());
308 .println("DEBUG: scroll didn't happen - results not within alignment : "
309 + seq.getStart() + "," + seq.getEnd());
317 * System.out.println("DEBUG: scroll: start=" + r[0] +
318 * " av.getStartRes()=" + av.getStartRes() + " end=" + r[1] +
319 * " seq.end=" + seq.getEnd() + " av.getEndRes()=" + av.getEndRes() +
320 * " hextent=" + hextent);
329 if (end == seq.getEnd())
333 return scrollTo(start, end, seqIndex, false, redrawOverview);
338 public boolean scrollTo(int ostart, int end, int seqIndex,
339 boolean scrollToNearest, boolean redrawOverview)
341 int startv, endv, starts, ends, width;
344 if (av.hasHiddenColumns())
346 start = av.getColumnSelection().findColumnPosition(ostart);
347 end = av.getColumnSelection().findColumnPosition(end);
350 if (!scrollToNearest && !av.getColumnSelection().isVisible(ostart))
352 // don't scroll - position isn't visible
361 if (!av.wrapAlignment)
364 * int spos=av.getStartRes(),sqpos=av.getStartSeq(); if ((startv =
365 * av.getStartRes()) >= start) { spos=start-1; // seqIn //
366 * setScrollValues(start - 1, seqIndex); } else if ((endv =
367 * av.getEndRes()) <= end) { // setScrollValues(spos=startv + 1 + end -
368 * endv, seqIndex); spos=startv + 1 + end - endv; } else if ((starts =
369 * av.getStartSeq()) > seqIndex) { setScrollValues(av.getStartRes(),
370 * seqIndex); } else if ((ends = av.getEndSeq()) <= seqIndex) {
371 * setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1); }
375 if ((av.getStartRes() > end)
376 || (av.getEndRes() < start)
377 || ((av.getStartSeq() > seqIndex) || (av.getEndSeq() < seqIndex)))
379 if (start > av.getAlignment().getWidth() - hextent)
381 start = av.getAlignment().getWidth() - hextent;
388 if (seqIndex > av.getAlignment().getHeight() - vextent)
390 seqIndex = av.getAlignment().getHeight() - vextent;
396 // System.out.println("trying to scroll to: "+start+" "+seqIndex);
397 setScrollValues(start, seqIndex);
402 scrollToWrappedVisible(start);
404 if (redrawOverview && overviewPanel != null)
406 overviewPanel.setBoxPosition();
408 paintAlignment(redrawOverview);
412 void scrollToWrappedVisible(int res)
414 int cwidth = seqPanel.seqCanvas
415 .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
416 if (res <= av.getStartRes() || res >= (av.getStartRes() + cwidth))
418 vscroll.setValue(res / cwidth);
419 av.startRes = vscroll.getValue() * cwidth;
423 public OverviewPanel getOverviewPanel()
425 return overviewPanel;
428 public void setOverviewPanel(OverviewPanel op)
433 public void setAnnotationVisible(boolean b)
435 if (!av.wrapAlignment)
437 annotationSpaceFillerHolder.setVisible(b);
438 annotationPanelHolder.setVisible(b);
445 * automatically adjust annotation panel height for new annotation whilst
446 * ensuring the alignment is still visible.
448 public void adjustAnnotationHeight()
450 // TODO: display vertical annotation scrollbar if necessary
451 // this is called after loading new annotation onto alignment
452 if (alignFrame.getSize().height == 0)
454 System.out.println("NEEDS FIXING");
457 validateAnnotationDimensions(true);
458 apvscroll.addNotify();
461 paintAlignment(true);
465 * calculate the annotation dimensions and refresh slider values accordingly.
466 * need to do repaints/notifys afterwards.
468 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
470 boolean modified = false;
471 int height = av.calcPanelHeight();
473 if (hscroll.isVisible())
475 height += (minsize = hscroll.getPreferredSize().height);
477 if (apvscroll.isVisible())
479 minsize += apvscroll.getPreferredSize().height;
481 int mheight = height;
482 Dimension d = sequenceHolderPanel.getSize(), e = idPanel.getSize();
483 int seqandannot = d.height - scalePanelHolder.getSize().height;
484 // sets initial preferred height
485 if ((height + 40) > seqandannot / 2)
487 height = seqandannot / 2;
489 if (!adjustPanelHeight)
491 // maintain same window layout whilst updating sliders
492 height = annotationPanelHolder.getSize().height;
495 if (seqandannot - height < 5)
497 height = seqandannot;
499 annotationPanel.setSize(new Dimension(d.width, height));
500 alabels.setSize(new Dimension(e.width, height));
501 annotationSpaceFillerHolder.setSize(new Dimension(e.width, height));
502 annotationPanelHolder.setSize(new Dimension(d.width, height));
503 seqPanelHolder.setSize(d.width, seqandannot - height);
505 .setSize(d.width, seqPanel.seqCanvas.getSize().height);
506 int s = apvscroll.getValue();
507 if (s > mheight - height)
511 apvscroll.setValues(s, height, 0, mheight);
512 annotationPanel.setScrollOffset(apvscroll.getValue());
513 alabels.setScrollOffset(apvscroll.getValue());
516 public void setWrapAlignment(boolean wrap)
520 scalePanelHolder.setVisible(!wrap);
522 hscroll.setVisible(!wrap);
523 idwidthAdjuster.setVisible(!wrap);
527 annotationPanelHolder.setVisible(false);
528 annotationSpaceFillerHolder.setVisible(false);
530 else if (av.showAnnotation)
532 annotationPanelHolder.setVisible(true);
533 annotationSpaceFillerHolder.setVisible(true);
536 idSpaceFillerPanel1.setVisible(!wrap);
538 fontChanged(); // This is so that the scalePanel is resized correctly
549 // return value is true if the scroll is valid
550 public boolean scrollUp(boolean up)
554 if (vscroll.getValue() < 1)
558 setScrollValues(hscroll.getValue(), vscroll.getValue() - 1);
562 if (vextent + vscroll.getValue() >= av.getAlignment().getHeight())
566 setScrollValues(hscroll.getValue(), vscroll.getValue() + 1);
573 public boolean scrollRight(boolean right)
577 if (hscroll.getValue() < 1)
581 setScrollValues(hscroll.getValue() - 1, vscroll.getValue());
585 if (hextent + hscroll.getValue() >= av.getAlignment().getWidth())
589 setScrollValues(hscroll.getValue() + 1, vscroll.getValue());
596 public void setScrollValues(int x, int y)
598 int width = av.getAlignment().getWidth();
599 int height = av.getAlignment().getHeight();
601 if (av.hasHiddenColumns())
603 width = av.getColumnSelection().findColumnPosition(width);
611 hextent = seqPanel.seqCanvas.getSize().width / av.charWidth;
612 vextent = seqPanel.seqCanvas.getSize().height / av.charHeight;
619 if (vextent > height)
624 if ((hextent + x) > width)
626 System.err.println("hextent was " + hextent + " and x was " + x);
631 if ((vextent + y) > height)
633 y = height - vextent;
643 System.err.println("x was " + x);
649 int endSeq = y + vextent;
650 if (endSeq > av.getAlignment().getHeight())
652 endSeq = av.getAlignment().getHeight();
655 av.setEndSeq(endSeq);
657 av.setEndRes((x + (seqPanel.seqCanvas.getSize().width / av.charWidth)) - 1);
659 hscroll.setValues(x, hextent, 0, width);
660 vscroll.setValues(y, vextent, 0, height);
662 if (overviewPanel != null)
664 overviewPanel.setBoxPosition();
670 public void adjustmentValueChanged(AdjustmentEvent evt)
672 int oldX = av.getStartRes();
673 int oldY = av.getStartSeq();
675 if (evt == null || evt.getSource() == apvscroll)
677 annotationPanel.setScrollOffset(apvscroll.getValue());
678 alabels.setScrollOffset(apvscroll.getValue());
679 // annotationPanel.image=null;
680 // alabels.image=null;
681 // alabels.repaint();
682 // annotationPanel.repaint();
684 if (evt == null || evt.getSource() == hscroll)
686 int x = hscroll.getValue();
688 av.setEndRes(x + seqPanel.seqCanvas.getSize().width
689 / av.getCharWidth() - 1);
692 if (evt == null || evt.getSource() == vscroll)
694 int offy = vscroll.getValue();
695 if (av.getWrapAlignment())
697 int rowSize = seqPanel.seqCanvas
698 .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
699 av.setStartRes(vscroll.getValue() * rowSize);
700 av.setEndRes((vscroll.getValue() + 1) * rowSize);
704 av.setStartSeq(offy);
705 av.setEndSeq(offy + seqPanel.seqCanvas.getSize().height
706 / av.getCharHeight());
710 if (overviewPanel != null)
712 overviewPanel.setBoxPosition();
715 int scrollX = av.startRes - oldX;
716 int scrollY = av.startSeq - oldY;
718 if (av.getWrapAlignment() || !fastPaint || av.MAC)
724 // Make sure we're not trying to draw a panel
725 // larger than the visible window
726 if (scrollX > av.endRes - av.startRes)
728 scrollX = av.endRes - av.startRes;
730 else if (scrollX < av.startRes - av.endRes)
732 scrollX = av.startRes - av.endRes;
735 idPanel.idCanvas.fastPaint(scrollY);
736 seqPanel.seqCanvas.fastPaint(scrollX, scrollY);
738 scalePanel.repaint();
739 if (av.getShowAnnotation())
741 annotationPanel.fastPaint(av.getStartRes() - oldX);
748 private void sendViewPosition()
750 StructureSelectionManager.getStructureSelectionManager(av.applet)
751 .sendViewPosition(this, av.startRes, av.endRes, av.startSeq,
755 public void paintAlignment(boolean updateOverview)
761 jalview.structure.StructureSelectionManager
762 .getStructureSelectionManager(av.applet)
763 .sequenceColoursChanged(this);
765 if (overviewPanel != null)
767 overviewPanel.updateOverviewImage();
772 public void update(Graphics g)
777 public void paint(Graphics g)
780 Dimension d = idPanel.idCanvas.getSize();
781 idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);
783 if (av.getWrapAlignment())
785 int maxwidth = av.getAlignment().getWidth();
787 if (av.hasHiddenColumns())
789 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
792 int canvasWidth = seqPanel.seqCanvas
793 .getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);
797 int max = maxwidth / canvasWidth;
798 vscroll.setMaximum(1 + max);
799 vscroll.setUnitIncrement(1);
800 vscroll.setVisibleAmount(1);
805 setScrollValues(av.getStartRes(), av.getStartSeq());
810 seqPanel.seqCanvas.repaint();
811 scalePanel.repaint();
812 annotationPanel.repaint();
813 idPanel.idCanvas.repaint();
816 protected Panel sequenceHolderPanel = new Panel();
818 protected Scrollbar vscroll = new Scrollbar();
820 protected Scrollbar hscroll = new Scrollbar();
822 protected Panel seqPanelHolder = new Panel();
824 BorderLayout borderLayout1 = new BorderLayout();
826 BorderLayout borderLayout3 = new BorderLayout();
828 protected Panel scalePanelHolder = new Panel();
830 protected Panel idPanelHolder = new Panel();
832 BorderLayout borderLayout5 = new BorderLayout();
834 protected Panel idSpaceFillerPanel1 = new Panel();
836 public Panel annotationSpaceFillerHolder = new Panel();
838 BorderLayout borderLayout6 = new BorderLayout();
840 BorderLayout borderLayout7 = new BorderLayout();
842 Panel hscrollHolder = new Panel();
844 BorderLayout borderLayout10 = new BorderLayout();
846 protected Panel hscrollFillerPanel = new Panel();
848 BorderLayout borderLayout11 = new BorderLayout();
850 BorderLayout borderLayout4 = new BorderLayout();
852 BorderLayout borderLayout2 = new BorderLayout();
854 Panel annotationPanelHolder = new Panel();
856 protected Scrollbar apvscroll = new Scrollbar();
858 BorderLayout borderLayout12 = new BorderLayout();
860 private void jbInit() throws Exception
862 // idPanelHolder.setPreferredSize(new Dimension(70, 10));
863 this.setLayout(borderLayout7);
865 // sequenceHolderPanel.setPreferredSize(new Dimension(150, 150));
866 sequenceHolderPanel.setLayout(borderLayout3);
867 seqPanelHolder.setLayout(borderLayout1);
868 scalePanelHolder.setBackground(Color.white);
870 // scalePanelHolder.setPreferredSize(new Dimension(10, 30));
871 scalePanelHolder.setLayout(borderLayout6);
872 idPanelHolder.setLayout(borderLayout5);
873 idSpaceFillerPanel1.setBackground(Color.white);
875 // idSpaceFillerPanel1.setPreferredSize(new Dimension(10, 30));
876 idSpaceFillerPanel1.setLayout(borderLayout11);
877 annotationSpaceFillerHolder.setBackground(Color.white);
879 // annotationSpaceFillerHolder.setPreferredSize(new Dimension(10, 80));
880 annotationSpaceFillerHolder.setLayout(borderLayout4);
881 hscroll.setOrientation(Scrollbar.HORIZONTAL);
882 hscrollHolder.setLayout(borderLayout10);
883 hscrollFillerPanel.setBackground(Color.white);
884 apvscroll.setOrientation(Scrollbar.VERTICAL);
885 apvscroll.setVisible(true);
886 apvscroll.addAdjustmentListener(this);
888 annotationPanelHolder.setBackground(Color.white);
889 annotationPanelHolder.setLayout(borderLayout12);
890 annotationPanelHolder.add(apvscroll, BorderLayout.EAST);
891 // hscrollFillerPanel.setPreferredSize(new Dimension(70, 10));
892 hscrollHolder.setBackground(Color.white);
894 // annotationScroller.setPreferredSize(new Dimension(10, 80));
895 // this.setPreferredSize(new Dimension(220, 166));
896 seqPanelHolder.setBackground(Color.white);
897 idPanelHolder.setBackground(Color.white);
898 sequenceHolderPanel.add(scalePanelHolder, BorderLayout.NORTH);
899 sequenceHolderPanel.add(seqPanelHolder, BorderLayout.CENTER);
900 seqPanelHolder.add(vscroll, BorderLayout.EAST);
902 // Panel3.add(secondaryPanelHolder, BorderLayout.SOUTH);
903 this.add(idPanelHolder, BorderLayout.WEST);
904 idPanelHolder.add(idSpaceFillerPanel1, BorderLayout.NORTH);
905 idPanelHolder.add(annotationSpaceFillerHolder, BorderLayout.SOUTH);
906 this.add(hscrollHolder, BorderLayout.SOUTH);
907 hscrollHolder.add(hscroll, BorderLayout.CENTER);
908 hscrollHolder.add(hscrollFillerPanel, BorderLayout.WEST);
909 this.add(sequenceHolderPanel, BorderLayout.CENTER);
913 * hides or shows dynamic annotation rows based on groups and av state flags
915 public void updateAnnotation()
917 updateAnnotation(false);
920 public void updateAnnotation(boolean applyGlobalSettings)
922 updateAnnotation(applyGlobalSettings, false);
925 public void updateAnnotation(boolean applyGlobalSettings,
926 boolean preserveNewGroupSettings)
928 av.updateGroupAnnotationSettings(applyGlobalSettings,
929 preserveNewGroupSettings);
930 adjustAnnotationHeight();
934 public AlignmentI getAlignment()
936 return av.getAlignment();
940 public StructureSelectionManager getStructureSelectionManager()
942 return StructureSelectionManager
943 .getStructureSelectionManager(av.applet);
947 public void raiseOOMWarning(String string, OutOfMemoryError error)
950 System.err.println("Out of memory whilst '" + string + "'");
951 error.printStackTrace();