2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
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
10 * of the License, or (at your option) any later version.
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.
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.
23 import jalview.analysis.AnnotationSorter;
24 import jalview.api.AlignViewportI;
25 import jalview.api.AlignmentViewPanel;
26 import jalview.bin.Cache;
27 import jalview.datamodel.AlignmentI;
28 import jalview.datamodel.SearchResultsI;
29 import jalview.datamodel.SequenceFeature;
30 import jalview.datamodel.SequenceGroup;
31 import jalview.datamodel.SequenceI;
32 import jalview.jbgui.GAlignmentPanel;
33 import jalview.math.AlignmentDimension;
34 import jalview.schemes.ResidueProperties;
35 import jalview.structure.StructureSelectionManager;
36 import jalview.util.MessageManager;
37 import jalview.util.Platform;
38 import jalview.viewmodel.ViewportListenerI;
39 import jalview.viewmodel.ViewportRanges;
41 import java.awt.BorderLayout;
42 import java.awt.Color;
43 import java.awt.Container;
44 import java.awt.Dimension;
46 import java.awt.FontMetrics;
47 import java.awt.Graphics;
48 import java.awt.Insets;
49 import java.awt.event.AdjustmentEvent;
50 import java.awt.event.AdjustmentListener;
51 import java.awt.event.ComponentAdapter;
52 import java.awt.event.ComponentEvent;
53 import java.awt.print.PageFormat;
54 import java.awt.print.Printable;
55 import java.awt.print.PrinterException;
56 import java.beans.PropertyChangeEvent;
57 import java.beans.PropertyChangeListener;
59 import java.io.FileWriter;
60 import java.io.PrintWriter;
61 import java.util.List;
63 import javax.swing.SwingUtilities;
69 * @version $Revision: 1.161 $
71 public class AlignmentPanel extends GAlignmentPanel implements
72 AdjustmentListener, Printable, AlignmentViewPanel,
75 public AlignViewport av;
77 ViewportRanges vpRanges;
79 OverviewPanel overviewPanel;
81 private SeqPanel seqPanel;
83 private IdPanel idPanel;
85 private boolean headless;
87 IdwidthAdjuster idwidthAdjuster;
90 public AlignFrame alignFrame;
92 private ScalePanel scalePanel;
94 private AnnotationPanel annotationPanel;
96 private AnnotationLabels alabels;
98 // this value is set false when selection area being dragged
99 boolean fastPaint = true;
101 private int hextent = 0;
103 private int vextent = 0;
106 * Flag set while scrolling to follow complementary cDNA/protein scroll. When
107 * false, suppresses invoking the same method recursively.
109 private boolean scrollComplementaryPanel = true;
111 private PropertyChangeListener propertyChangeListener;
114 * Creates a new AlignmentPanel object.
119 public AlignmentPanel(AlignFrame af, final AlignViewport av)
123 vpRanges = av.getRanges();
124 setSeqPanel(new SeqPanel(av, this));
125 setIdPanel(new IdPanel(av, this));
127 setScalePanel(new ScalePanel(av, this));
129 idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
130 idwidthAdjuster = new IdwidthAdjuster(this);
131 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
133 setAnnotationPanel(new AnnotationPanel(this));
134 setAlabels(new AnnotationLabels(this));
136 annotationScroller.setViewportView(getAnnotationPanel());
137 annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
139 scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
140 seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
142 setScrollValues(0, 0);
144 hscroll.addAdjustmentListener(this);
145 vscroll.addAdjustmentListener(this);
147 addComponentListener(new ComponentAdapter()
150 public void componentResized(ComponentEvent evt)
152 // reset the viewport ranges when the alignment panel is resized
153 // in particular, this initialises the end residue value when Jalview
155 if (av.getWrapAlignment())
157 int widthInRes = getSeqPanel().seqCanvas
158 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
159 vpRanges.setViewportWidth(widthInRes);
163 int widthInRes = getSeqPanel().seqCanvas.getWidth()
165 int heightInSeq = getSeqPanel().seqCanvas.getHeight()
166 / av.getCharHeight();
168 vpRanges.setViewportWidth(widthInRes);
169 vpRanges.setViewportHeight(heightInSeq);
175 final AlignmentPanel ap = this;
176 propertyChangeListener = new PropertyChangeListener()
179 public void propertyChange(PropertyChangeEvent evt)
181 if (evt.getPropertyName().equals("alignment"))
183 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
188 av.addPropertyChangeListener(propertyChangeListener);
190 av.getRanges().addPropertyChangeListener(this);
192 adjustAnnotationHeight();
197 public AlignViewportI getAlignViewport()
202 public void alignmentChanged()
204 av.alignmentChanged(this);
206 alignFrame.updateEditMenuBar();
208 paintAlignment(true);
215 public void fontChanged()
217 // set idCanvas bufferedImage to null
218 // to prevent drawing old image
219 FontMetrics fm = getFontMetrics(av.getFont());
221 scalePanelHolder.setPreferredSize(new Dimension(10, av.getCharHeight()
223 idSpaceFillerPanel1.setPreferredSize(new Dimension(10, av
224 .getCharHeight() + fm.getDescent()));
226 getIdPanel().getIdCanvas().gg = null;
227 getSeqPanel().seqCanvas.img = null;
228 getAnnotationPanel().adjustPanelHeight();
230 Dimension d = calculateIdWidth();
232 d.setSize(d.width + 4, d.height);
233 getIdPanel().getIdCanvas().setPreferredSize(d);
234 hscrollFillerPanel.setPreferredSize(d);
236 if (this.alignFrame.getSplitViewContainer() != null)
238 ((SplitFrame) this.alignFrame.getSplitViewContainer()).adjustLayout();
245 * Calculate the width of the alignment labels based on the displayed names
246 * and any bounds on label width set in preferences.
248 * @return Dimension giving the maximum width of the alignment label panel
249 * that should be used.
251 public Dimension calculateIdWidth()
253 // calculate sensible default width when no preference is available
255 if (av.getIdWidth() < 0)
257 int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
258 int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
259 r = calculateIdWidth(maxwidth);
260 av.setIdWidth(r.width);
265 r.width = av.getIdWidth();
272 * Calculate the width of the alignment labels based on the displayed names
273 * and any bounds on label width set in preferences.
276 * -1 or maximum width allowed for IdWidth
277 * @return Dimension giving the maximum width of the alignment label panel
278 * that should be used.
280 public Dimension calculateIdWidth(int maxwidth)
282 Container c = new Container();
284 FontMetrics fm = c.getFontMetrics(new Font(av.font.getName(),
285 Font.ITALIC, av.font.getSize()));
287 AlignmentI al = av.getAlignment();
292 while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
294 SequenceI s = al.getSequenceAt(i);
296 id = s.getDisplayId(av.getShowJVSuffix());
298 if (fm.stringWidth(id) > idWidth)
300 idWidth = fm.stringWidth(id);
306 // Also check annotation label widths
309 if (al.getAlignmentAnnotation() != null)
311 fm = c.getFontMetrics(getAlabels().getFont());
313 while (i < al.getAlignmentAnnotation().length)
315 String label = al.getAlignmentAnnotation()[i].label;
317 if (fm.stringWidth(label) > idWidth)
319 idWidth = fm.stringWidth(label);
326 return new Dimension(maxwidth < 0 ? idWidth : Math.min(maxwidth,
331 * Highlight the given results on the alignment.
334 public void highlightSearchResults(SearchResultsI results)
336 scrollToPosition(results);
337 getSeqPanel().seqCanvas.highlightSearchResults(results);
341 * Scroll the view to show the position of the highlighted region in results
342 * (if any) and redraw the overview
346 public boolean scrollToPosition(SearchResultsI results)
348 return scrollToPosition(results, 0, true, false);
352 * Scroll the view to show the position of the highlighted region in results
355 * @param searchResults
356 * @param redrawOverview
359 public boolean scrollToPosition(SearchResultsI searchResults,
360 boolean redrawOverview)
362 return scrollToPosition(searchResults, 0, redrawOverview, false);
366 * Scroll the view to show the position of the highlighted region in results
370 * @param verticalOffset
371 * if greater than zero, allows scrolling to a position below the
372 * first displayed sequence
373 * @param redrawOverview
374 * - when set, the overview will be recalculated (takes longer)
376 * if true, try to centre the search results horizontally in the view
377 * @return false if results were not found
379 public boolean scrollToPosition(SearchResultsI results,
380 int verticalOffset, boolean redrawOverview, boolean centre)
382 int startv, endv, starts, ends;
383 // TODO: properly locate search results in view when large numbers of hidden
384 // columns exist before highlighted region
385 // do we need to scroll the panel?
386 // TODO: tons of nullpointerexceptions raised here.
387 if (results != null && results.getSize() > 0 && av != null
388 && av.getAlignment() != null)
390 int seqIndex = av.getAlignment().findIndex(results);
395 SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
397 int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
405 // System.err.println(this.av.viewName + " Seq : " + seqIndex
406 // + " Scroll to " + start + "," + end);
409 * To centre results, scroll to positions half the visible width
410 * left/right of the start/end positions
414 int offset = (vpRanges.getEndRes() - vpRanges.getStartRes() + 1) / 2 - 1;
415 start = Math.max(start - offset, 0);
416 end = end + offset - 1;
422 if (end == seq.getEnd())
426 if (av.hasHiddenColumns())
428 start = av.getColumnSelection().findColumnPosition(start);
429 end = av.getColumnSelection().findColumnPosition(end);
432 if (!av.getColumnSelection().isVisible(r[0]))
434 // don't scroll - position isn't visible
441 * allow for offset of target sequence (actually scroll to one above it)
443 seqIndex = Math.max(0, seqIndex - verticalOffset);
445 // System.out.println("start=" + start + ", end=" + end + ", startv="
446 // + av.getStartRes() + ", endv=" + av.getEndRes() + ", starts="
447 // + av.getStartSeq() + ", ends=" + av.getEndSeq());
448 if (!av.getWrapAlignment())
450 if ((startv = vpRanges.getStartRes()) >= start)
453 * Scroll left to make start of search results visible
455 // setScrollValues(start - 1, seqIndex); // plus one residue
456 setScrollValues(start, seqIndex);
458 else if ((endv = vpRanges.getEndRes()) <= end)
461 * Scroll right to make end of search results visible
463 // setScrollValues(startv + 1 + end - endv, seqIndex); // plus one
464 setScrollValues(startv + end - endv, seqIndex);
466 else if ((starts = vpRanges.getStartSeq()) > seqIndex)
469 * Scroll up to make start of search results visible
471 setScrollValues(vpRanges.getStartRes(), seqIndex);
473 else if ((ends = vpRanges.getEndSeq()) <= seqIndex)
476 * Scroll down to make end of search results visible
478 setScrollValues(vpRanges.getStartRes(), starts + seqIndex - ends
482 * Else results are already visible - no need to scroll
487 vpRanges.scrollToWrappedVisible(start);
491 paintAlignment(redrawOverview);
498 * @return DOCUMENT ME!
500 public OverviewPanel getOverviewPanel()
502 return overviewPanel;
511 public void setOverviewPanel(OverviewPanel op)
519 * Hide or show annotation panel
522 public void setAnnotationVisible(boolean b)
524 if (!av.getWrapAlignment())
526 annotationSpaceFillerHolder.setVisible(b);
527 annotationScroller.setVisible(b);
533 * automatically adjust annotation panel height for new annotation whilst
534 * ensuring the alignment is still visible.
537 public void adjustAnnotationHeight()
539 // TODO: display vertical annotation scrollbar if necessary
540 // this is called after loading new annotation onto alignment
541 if (alignFrame.getHeight() == 0)
543 System.out.println("NEEDS FIXING");
545 validateAnnotationDimensions(true);
547 paintAlignment(true);
551 * calculate the annotation dimensions and refresh slider values accordingly.
552 * need to do repaints/notifys afterwards.
554 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
556 int annotationHeight = getAnnotationPanel().adjustPanelHeight();
558 if (adjustPanelHeight)
560 int rowHeight = av.getCharHeight();
561 int alignmentHeight = rowHeight * av.getAlignment().getHeight();
564 * Estimate available height in the AlignFrame for alignment +
565 * annotations. Deduct an estimate for title bar, menu bar, scale panel,
566 * hscroll, status bar (as these are not laid out we can't inspect their
567 * actual heights). Insets gives frame borders.
569 int stuff = Platform.isAMac() ? 80 : 100;
570 Insets insets = alignFrame.getInsets();
571 int availableHeight = alignFrame.getHeight() - stuff - insets.top
575 * If not enough vertical space, maximize annotation height while keeping
576 * at least two rows of alignment visible
578 if (annotationHeight + alignmentHeight > availableHeight)
580 annotationHeight = Math.min(annotationHeight, availableHeight - 2
586 // maintain same window layout whilst updating sliders
587 annotationHeight = annotationScroller.getSize().height;
591 annotationScroller.setPreferredSize(new Dimension(annotationScroller
592 .getWidth(), annotationHeight));
594 Dimension e = idPanel.getSize();
595 alabels.setSize(new Dimension(e.width, annotationHeight));
597 annotationSpaceFillerHolder.setPreferredSize(new Dimension(
598 annotationSpaceFillerHolder.getWidth(), annotationHeight));
599 annotationScroller.validate();
600 annotationScroller.addNotify();
604 * update alignment layout for viewport settings
609 public void updateLayout()
612 setAnnotationVisible(av.isShowAnnotation());
613 boolean wrap = av.getWrapAlignment();
614 vpRanges.setStartSeq(0);
615 scalePanelHolder.setVisible(!wrap);
616 hscroll.setVisible(!wrap);
617 idwidthAdjuster.setVisible(!wrap);
621 annotationScroller.setVisible(false);
622 annotationSpaceFillerHolder.setVisible(false);
624 else if (av.isShowAnnotation())
626 annotationScroller.setVisible(true);
627 annotationSpaceFillerHolder.setVisible(true);
632 int widthInRes = getSeqPanel().seqCanvas
633 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
634 vpRanges.setViewportWidth(widthInRes);
638 int widthInRes = (getSeqPanel().seqCanvas.getWidth() / av
639 .getCharWidth()) - 1;
640 int heightInSeq = (getSeqPanel().seqCanvas.getHeight() / av
641 .getCharHeight()) - 1;
643 vpRanges.setViewportWidth(widthInRes);
644 vpRanges.setViewportHeight(heightInSeq);
647 idSpaceFillerPanel1.setVisible(!wrap);
654 * Adjust row/column scrollers to show a visible position in the alignment.
657 * visible column to scroll to
659 * visible row to scroll to
662 public void setScrollValues(int x, int y)
664 if (av == null || av.getAlignment() == null)
669 if (av.getWrapAlignment())
671 setScrollingForWrappedPanel(x);
676 int width = av.getAlignment().getWidth();
677 int height = av.getAlignment().getHeight();
679 if (av.hasHiddenColumns())
681 // reset the width to exclude hidden columns
682 width = av.getColumnSelection().findColumnPosition(width);
685 hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
686 vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
693 if (vextent > height)
698 if ((hextent + x) > width)
703 if ((vextent + y) > height)
705 y = height - vextent;
718 // update the scroll values
719 hscroll.setValues(x, hextent, 0, width);
720 vscroll.setValues(y, vextent, 0, height);
731 public void adjustmentValueChanged(AdjustmentEvent evt)
733 int oldX = vpRanges.getStartRes();
734 int oldwidth = vpRanges.getViewportWidth();
735 int oldY = vpRanges.getStartSeq();
736 int oldheight = vpRanges.getViewportHeight();
738 if (av.getWrapAlignment())
740 if (evt.getSource() == hscroll)
742 return; // no horizontal scroll when wrapped
744 else if (evt.getSource() == vscroll)
746 int offy = vscroll.getValue();
747 int rowSize = getSeqPanel().seqCanvas
748 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
750 // if we're scrolling to the position we're already at, stop
751 // this prevents infinite recursion of events when the scroll/viewport
752 // ranges values are the same
753 if ((offy * rowSize == oldX) && (oldwidth == rowSize))
759 vpRanges.setViewportStartAndWidth(offy * rowSize, rowSize);
764 // This is only called if file loaded is a jar file that
765 // was wrapped when saved and user has wrap alignment true
766 // as preference setting
767 SwingUtilities.invokeLater(new Runnable()
772 // When updating scrolling to use ViewportChange events, this code
773 // could not be validated and it is not clear if it is now being
774 // called. Log warning here in case it is called and unforeseen
777 .warn("Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
779 // scroll to start of panel
780 vpRanges.setStartRes(0);
781 vpRanges.setStartSeq(0);
790 if (evt.getSource() == hscroll)
792 int x = hscroll.getValue();
793 int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
795 // if we're scrolling to the position we're already at, stop
796 // this prevents infinite recursion of events when the scroll/viewport
797 // ranges values are the same
798 if ((x == oldX) && (width == oldwidth))
802 vpRanges.setViewportStartAndWidth(x, width);
804 else if (evt.getSource() == vscroll)
806 int y = vscroll.getValue();
807 int height = getSeqPanel().seqCanvas.getHeight()
808 / av.getCharHeight();
810 // if we're scrolling to the position we're already at, stop
811 // this prevents infinite recursion of events when the scroll/viewport
812 // ranges values are the same
813 if ((y == oldY) && (height == oldheight))
817 vpRanges.setViewportStartAndHeight(y, height);
827 * Repaint the alignment including the annotations and overview panels (if
831 public void paintAlignment(boolean updateOverview)
833 final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
834 av.isShowAutocalculatedAbove());
835 sorter.sort(getAlignment().getAlignmentAnnotation(),
836 av.getSortAnnotationsBy());
841 // TODO: determine if this paintAlignment changed structure colours
842 av.getStructureSelectionManager().sequenceColoursChanged(this);
844 if (overviewPanel != null)
846 overviewPanel.updateOverviewImage();
858 public void paintComponent(Graphics g)
862 Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
863 idPanelHolder.setPreferredSize(d);
864 hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
868 * set scroll bar positions
870 setScrollValues(vpRanges.getStartRes(), vpRanges.getStartSeq());
874 * Set vertical scroll bar parameters for wrapped panel
876 * the residue to scroll to
878 private void setScrollingForWrappedPanel(int res)
880 // get the width of the alignment in residues
881 int maxwidth = av.getAlignment().getWidth();
882 if (av.hasHiddenColumns())
884 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
887 // get the width of the canvas in residues
888 int canvasWidth = getSeqPanel().seqCanvas
889 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
892 // position we want to scroll to is number of canvasWidth's to get there
893 int current = res / canvasWidth;
895 // max scroll position: add one because extent is 1 and scrollbar value
896 // can only be set to at most max - extent
897 int max = maxwidth / canvasWidth + 1;
898 vscroll.setUnitIncrement(1);
899 vscroll.setValues(current, 1, 0, max);
913 * @return DOCUMENT ME!
915 * @throws PrinterException
919 public int print(Graphics pg, PageFormat pf, int pi)
920 throws PrinterException
922 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
924 int pwidth = (int) pf.getImageableWidth();
925 int pheight = (int) pf.getImageableHeight();
927 if (av.getWrapAlignment())
929 return printWrappedAlignment(pwidth, pheight, pi, pg);
933 return printUnwrapped(pwidth, pheight, pi, pg, pg);
949 * @return DOCUMENT ME!
951 * @throws PrinterException
955 * Draws the alignment image, including sequence ids, sequences, and
956 * annotation labels and annotations if shown, on either one or two Graphics
963 * the graphics context for sequence ids and annotation labels
964 * @param alignmentGraphics
965 * the graphics context for sequences and annotations (may or may not
966 * be the same context as idGraphics)
968 * @throws PrinterException
970 public int printUnwrapped(int pageWidth, int pageHeight, int pi,
971 Graphics idGraphics, Graphics alignmentGraphics)
972 throws PrinterException
974 final int idWidth = getVisibleIdWidth(false);
977 * Get the horizontal offset to where we draw the sequences.
978 * This is idWidth if using a single Graphics context, else zero.
980 final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0 : idWidth;
982 FontMetrics fm = getFontMetrics(av.getFont());
983 int charHeight = av.getCharHeight();
984 int scaleHeight = charHeight + fm.getDescent();
986 idGraphics.setColor(Color.white);
987 idGraphics.fillRect(0, 0, pageWidth, pageHeight);
988 idGraphics.setFont(av.getFont());
991 * How many sequences and residues can we fit on a printable page?
993 int totalRes = (pageWidth - idWidth) / av.getCharWidth();
995 int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
997 int alignmentWidth = av.getAlignment().getWidth();
998 int pagesWide = (alignmentWidth / totalRes) + 1;
1000 final int startRes = (pi % pagesWide) * totalRes;
1001 int endRes = (startRes + totalRes) - 1;
1003 if (endRes > (alignmentWidth - 1))
1005 endRes = alignmentWidth - 1;
1008 final int startSeq = (pi / pagesWide) * totalSeq;
1009 int endSeq = startSeq + totalSeq;
1011 int alignmentHeight = av.getAlignment().getHeight();
1012 if (endSeq > alignmentHeight)
1014 endSeq = alignmentHeight;
1017 int pagesHigh = ((alignmentHeight / totalSeq) + 1)
1020 if (av.isShowAnnotation())
1022 pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1025 pagesHigh /= pageHeight;
1027 if (pi >= (pagesWide * pagesHigh))
1029 return Printable.NO_SUCH_PAGE;
1031 final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight
1035 * draw the Scale at horizontal offset, then reset to top left (0, 0)
1037 alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1038 getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1039 pageWidth - idWidth, scaleHeight);
1040 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1043 * Draw the sequence ids, offset for scale height,
1044 * then reset to top left (0, 0)
1046 idGraphics.translate(0, scaleHeight);
1047 idGraphics.setFont(getIdPanel().getIdCanvas().getIdfont());
1048 Color currentColor = null;
1049 Color currentTextColor = null;
1052 for (int i = startSeq; i < endSeq; i++)
1054 seq = av.getAlignment().getSequenceAt(i);
1055 if ((av.getSelectionGroup() != null)
1056 && av.getSelectionGroup().getSequences(null).contains(seq))
1059 * gray out ids of sequences in selection group (if any)
1061 currentColor = Color.gray;
1062 currentTextColor = Color.black;
1066 currentColor = av.getSequenceColour(seq);
1067 currentTextColor = Color.black;
1070 idGraphics.setColor(currentColor);
1071 idGraphics.fillRect(0, (i - startSeq) * charHeight, idWidth,
1074 idGraphics.setColor(currentTextColor);
1077 String displayId = seq.getDisplayId(av.getShowJVSuffix());
1078 if (av.isRightAlignIds())
1080 fm = idGraphics.getFontMetrics();
1082 - fm.stringWidth(displayId)
1086 idGraphics.drawString(displayId, xPos,
1087 (((i - startSeq) * charHeight) + charHeight)
1088 - (charHeight / 5));
1090 idGraphics.setFont(av.getFont());
1091 idGraphics.translate(0, -scaleHeight);
1094 * draw the sequences, offset for scale height, and id width (if using a
1095 * single graphics context), then reset to (0, scale height)
1097 alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1098 getSeqPanel().seqCanvas.drawPanel(alignmentGraphics, startRes, endRes,
1099 startSeq, endSeq, 0);
1100 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1102 if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1105 * draw annotation labels; drawComponent() translates by
1106 * getScrollOffset(), so compensate for that first;
1107 * then reset to (0, scale height)
1109 int offset = getAlabels().getScrollOffset();
1110 idGraphics.translate(0, -offset);
1111 idGraphics.translate(0, alignmentDrawnHeight);
1112 getAlabels().drawComponent(idGraphics, idWidth);
1113 idGraphics.translate(0, -alignmentDrawnHeight);
1116 * draw the annotations starting at
1117 * (idOffset, alignmentHeight) from (0, scaleHeight)
1119 alignmentGraphics.translate(alignmentGraphicsOffset, alignmentDrawnHeight);
1120 getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1121 alignmentGraphics, -1, startRes, endRes + 1);
1124 return Printable.PAGE_EXISTS;
1139 * @return DOCUMENT ME!
1141 * @throws PrinterException
1144 public int printWrappedAlignment(int pwidth, int pheight, int pi,
1145 Graphics pg) throws PrinterException
1147 int annotationHeight = 0;
1148 AnnotationLabels labels = null;
1149 if (av.isShowAnnotation())
1151 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1152 labels = new AnnotationLabels(av);
1155 int hgap = av.getCharHeight();
1156 if (av.getScaleAboveWrapped())
1158 hgap += av.getCharHeight();
1161 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1164 int idWidth = getVisibleIdWidth(false);
1166 int maxwidth = av.getAlignment().getWidth();
1167 if (av.hasHiddenColumns())
1169 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1172 int resWidth = getSeqPanel().seqCanvas.getWrappedCanvasWidth(pwidth
1175 int totalHeight = cHeight * (maxwidth / resWidth + 1);
1177 pg.setColor(Color.white);
1178 pg.fillRect(0, 0, pwidth, pheight);
1179 pg.setFont(av.getFont());
1183 pg.setColor(Color.black);
1185 pg.translate(0, -pi * pheight);
1187 pg.setClip(0, pi * pheight, pwidth, pheight);
1193 for (int i = 0; i < av.getAlignment().getHeight(); i++)
1195 pg.setFont(getIdPanel().getIdCanvas().getIdfont());
1196 SequenceI s = av.getAlignment().getSequenceAt(i);
1197 String string = s.getDisplayId(av.getShowJVSuffix());
1199 if (av.isRightAlignIds())
1201 FontMetrics fm = pg.getFontMetrics();
1202 xPos = idWidth - fm.stringWidth(string) - 4;
1204 pg.drawString(string, xPos,
1205 ((i * av.getCharHeight()) + ypos + av.getCharHeight())
1206 - (av.getCharHeight() / 5));
1211 ypos + (av.getAlignment().getHeight() * av.getCharHeight()));
1213 pg.setFont(av.getFont());
1214 labels.drawComponent(pg, idWidth);
1218 - (av.getAlignment().getHeight() * av
1223 } while (ypos < totalHeight);
1225 pg.translate(idWidth, 0);
1227 getSeqPanel().seqCanvas.drawWrappedPanel(pg, pwidth - idWidth,
1230 if ((pi * pheight) < totalHeight)
1232 return Printable.PAGE_EXISTS;
1237 return Printable.NO_SUCH_PAGE;
1242 * get current sequence ID panel width, or nominal value if panel were to be
1243 * displayed using default settings
1247 public int getVisibleIdWidth()
1249 return getVisibleIdWidth(true);
1253 * get current sequence ID panel width, or nominal value if panel were to be
1254 * displayed using default settings
1257 * indicate if the Id width for onscreen or offscreen display should
1261 public int getVisibleIdWidth(boolean onscreen)
1263 // see if rendering offscreen - check preferences and calc width accordingly
1264 if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1266 return calculateIdWidth(-1).width + 4;
1268 Integer idwidth = null;
1270 || (idwidth = Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1272 int w = getIdPanel().getWidth();
1273 return (w > 0 ? w : calculateIdWidth().width + 4);
1275 return idwidth.intValue() + 4;
1278 void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1280 int boarderBottomOffset = 5;
1281 long pSessionId = System.currentTimeMillis();
1282 headless = (System.getProperty("java.awt.headless") != null && System
1283 .getProperty("java.awt.headless").equals("true"));
1284 if (alignFrame != null && !headless)
1288 alignFrame.setProgressBar(MessageManager.formatMessage(
1289 "status.saving_file", new Object[] { type.getLabel() }),
1295 AlignmentDimension aDimension = getAlignmentDimension();
1298 jalview.util.ImageMaker im;
1299 final String imageAction, imageTitle;
1300 if (type == jalview.util.ImageMaker.TYPE.PNG)
1302 imageAction = "Create PNG image from alignment";
1305 else if (type == jalview.util.ImageMaker.TYPE.EPS)
1307 imageAction = "Create EPS file from alignment";
1308 imageTitle = alignFrame.getTitle();
1312 imageAction = "Create SVG file from alignment";
1313 imageTitle = alignFrame.getTitle();
1316 im = new jalview.util.ImageMaker(this, type, imageAction,
1317 aDimension.getWidth(), aDimension.getHeight()
1318 + boarderBottomOffset, file, imageTitle,
1319 alignFrame, pSessionId, headless);
1320 Graphics graphics = im.getGraphics();
1321 if (av.getWrapAlignment())
1323 if (graphics != null)
1325 printWrappedAlignment(aDimension.getWidth(),
1326 aDimension.getHeight() + boarderBottomOffset, 0,
1333 if (graphics != null)
1335 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(),
1336 0, graphics, graphics);
1341 } catch (OutOfMemoryError err)
1344 System.out.println("########################\n" + "OUT OF MEMORY "
1345 + file + "\n" + "########################");
1346 new OOMWarning("Creating Image for " + file, err);
1347 // System.out.println("Create IMAGE: " + err);
1348 } catch (Exception ex)
1350 ex.printStackTrace();
1358 public AlignmentDimension getAlignmentDimension()
1360 int maxwidth = av.getAlignment().getWidth();
1361 if (av.hasHiddenColumns())
1363 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);
1366 int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1367 + getScalePanel().getHeight();
1368 int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1370 if (av.getWrapAlignment())
1372 height = getWrappedHeight();
1375 // need to obtain default alignment width and then add in any
1376 // additional allowance for id margin
1377 // this duplicates the calculation in getWrappedHeight but adjusts for
1379 width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1380 - alignFrame.getInsets().left
1381 - alignFrame.getInsets().right - getVisibleIdWidth()
1382 + getVisibleIdWidth(false);
1386 width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1390 else if (av.isShowAnnotation())
1392 height += getAnnotationPanel().adjustPanelHeight() + 3;
1394 return new AlignmentDimension(width, height);
1401 public void makeEPS(File epsFile)
1403 makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1409 public void makePNG(File pngFile)
1411 makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1414 public void makeSVG(File svgFile)
1416 makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1419 public void makePNGImageMap(File imgMapFile, String imageName)
1421 // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1422 // ////////////////////////////////////////////
1423 int idWidth = getVisibleIdWidth(false);
1424 FontMetrics fm = getFontMetrics(av.getFont());
1425 int scaleHeight = av.getCharHeight() + fm.getDescent();
1428 // ////////////////////////////////
1429 if (imgMapFile != null)
1433 int s, sSize = av.getAlignment().getHeight(), res, alwidth = av
1434 .getAlignment().getWidth(), g, gSize, f, fSize, sy;
1435 PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1436 out.println(jalview.io.HTMLOutput.getImageMapHTML());
1437 out.println("<img src=\"" + imageName
1438 + "\" border=\"0\" usemap=\"#Map\" >"
1439 + "<map name=\"Map\">");
1441 for (s = 0; s < sSize; s++)
1443 sy = s * av.getCharHeight() + scaleHeight;
1445 SequenceI seq = av.getAlignment().getSequenceAt(s);
1446 SequenceFeature[] features = seq.getSequenceFeatures();
1447 SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1448 for (res = 0; res < alwidth; res++)
1450 StringBuilder text = new StringBuilder();
1451 String triplet = null;
1452 if (av.getAlignment().isNucleotide())
1454 triplet = ResidueProperties.nucleotideName.get(seq
1455 .getCharAt(res) + "");
1459 triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(res)
1463 if (triplet == null)
1468 int alIndex = seq.findPosition(res);
1469 gSize = groups.length;
1470 for (g = 0; g < gSize; g++)
1472 if (text.length() < 1)
1474 text.append("<area shape=\"rect\" coords=\"")
1475 .append((idWidth + res * av.getCharWidth()))
1476 .append(",").append(sy).append(",")
1477 .append((idWidth + (res + 1) * av.getCharWidth()))
1478 .append(",").append((av.getCharHeight() + sy))
1479 .append("\"").append(" onMouseOver=\"toolTip('")
1480 .append(alIndex).append(" ").append(triplet);
1483 if (groups[g].getStartRes() < res
1484 && groups[g].getEndRes() > res)
1486 text.append("<br><em>").append(groups[g].getName())
1491 if (features != null)
1493 if (text.length() < 1)
1495 text.append("<area shape=\"rect\" coords=\"")
1496 .append((idWidth + res * av.getCharWidth()))
1497 .append(",").append(sy).append(",")
1498 .append((idWidth + (res + 1) * av.getCharWidth()))
1499 .append(",").append((av.getCharHeight() + sy))
1500 .append("\"").append(" onMouseOver=\"toolTip('")
1501 .append(alIndex).append(" ").append(triplet);
1503 fSize = features.length;
1504 for (f = 0; f < fSize; f++)
1507 if ((features[f].getBegin() <= seq.findPosition(res))
1508 && (features[f].getEnd() >= seq.findPosition(res)))
1510 if (features[f].isContactFeature())
1512 if (features[f].getBegin() == seq.findPosition(res)
1513 || features[f].getEnd() == seq
1516 text.append("<br>").append(features[f].getType())
1517 .append(" ").append(features[f].getBegin())
1518 .append(":").append(features[f].getEnd());
1523 text.append("<br>");
1524 text.append(features[f].getType());
1525 if (features[f].getDescription() != null
1526 && !features[f].getType().equals(
1527 features[f].getDescription()))
1529 text.append(" ").append(features[f].getDescription());
1532 if (features[f].getValue("status") != null)
1534 text.append(" (").append(features[f].getValue("status"))
1542 if (text.length() > 1)
1544 text.append("')\"; onMouseOut=\"toolTip()\"; href=\"#\">");
1545 out.println(text.toString());
1549 out.println("</map></body></html>");
1552 } catch (Exception ex)
1554 ex.printStackTrace();
1556 } // /////////END OF IMAGE MAP
1560 int getWrappedHeight()
1562 int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1564 if (System.getProperty("java.awt.headless") != null
1565 && System.getProperty("java.awt.headless").equals("true"))
1567 seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1568 - vscroll.getPreferredSize().width
1569 - alignFrame.getInsets().left - alignFrame.getInsets().right;
1572 int chunkWidth = getSeqPanel().seqCanvas
1573 .getWrappedCanvasWidth(seqPanelWidth);
1575 int hgap = av.getCharHeight();
1576 if (av.getScaleAboveWrapped())
1578 hgap += av.getCharHeight();
1581 int annotationHeight = 0;
1582 if (av.isShowAnnotation())
1584 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1587 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1590 int maxwidth = av.getAlignment().getWidth();
1591 if (av.hasHiddenColumns())
1593 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1596 int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1602 * close the panel - deregisters all listeners and nulls any references to
1605 public void closePanel()
1607 PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1608 PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1609 PaintRefresher.RemoveComponent(this);
1612 * try to ensure references are nulled
1614 if (annotationPanel != null)
1616 annotationPanel.dispose();
1621 av.removePropertyChangeListener(propertyChangeListener);
1622 jalview.structure.StructureSelectionManager ssm = av
1623 .getStructureSelectionManager();
1624 ssm.removeStructureViewerListener(getSeqPanel(), null);
1625 ssm.removeSelectionListener(getSeqPanel());
1626 ssm.removeCommandListener(av);
1627 ssm.removeStructureViewerListener(getSeqPanel(), null);
1628 ssm.removeSelectionListener(getSeqPanel());
1634 if (Cache.log.isDebugEnabled())
1636 Cache.log.warn("Closing alignment panel which is already closed.");
1642 * hides or shows dynamic annotation rows based on groups and av state flags
1644 public void updateAnnotation()
1646 updateAnnotation(false, false);
1649 public void updateAnnotation(boolean applyGlobalSettings)
1651 updateAnnotation(applyGlobalSettings, false);
1654 public void updateAnnotation(boolean applyGlobalSettings,
1655 boolean preserveNewGroupSettings)
1657 av.updateGroupAnnotationSettings(applyGlobalSettings,
1658 preserveNewGroupSettings);
1659 adjustAnnotationHeight();
1663 public AlignmentI getAlignment()
1665 return av == null ? null : av.getAlignment();
1669 public String getViewName()
1675 * Make/Unmake this alignment panel the current input focus
1679 public void setSelected(boolean b)
1683 if (alignFrame.getSplitViewContainer() != null)
1686 * bring enclosing SplitFrame to front first if there is one
1688 ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1690 alignFrame.setSelected(b);
1691 } catch (Exception ex)
1697 alignFrame.setDisplayedView(this);
1702 public StructureSelectionManager getStructureSelectionManager()
1704 return av.getStructureSelectionManager();
1708 public void raiseOOMWarning(String string, OutOfMemoryError error)
1710 new OOMWarning(string, error, this);
1714 public jalview.api.FeatureRenderer cloneFeatureRenderer()
1717 return new FeatureRenderer(this);
1721 public jalview.api.FeatureRenderer getFeatureRenderer()
1723 return seqPanel.seqCanvas.getFeatureRenderer();
1726 public void updateFeatureRenderer(
1727 jalview.renderer.seqfeatures.FeatureRenderer fr)
1729 fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1732 public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1734 if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1736 getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1740 public ScalePanel getScalePanel()
1745 public void setScalePanel(ScalePanel scalePanel)
1747 this.scalePanel = scalePanel;
1750 public SeqPanel getSeqPanel()
1755 public void setSeqPanel(SeqPanel seqPanel)
1757 this.seqPanel = seqPanel;
1760 public AnnotationPanel getAnnotationPanel()
1762 return annotationPanel;
1765 public void setAnnotationPanel(AnnotationPanel annotationPanel)
1767 this.annotationPanel = annotationPanel;
1770 public AnnotationLabels getAlabels()
1775 public void setAlabels(AnnotationLabels alabels)
1777 this.alabels = alabels;
1780 public IdPanel getIdPanel()
1785 public void setIdPanel(IdPanel idPanel)
1787 this.idPanel = idPanel;
1791 * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1792 * The aim is to keep the two alignments 'lined up' on their centre columns.
1795 * holds mapped region(s) of this alignment that we are scrolling
1796 * 'to'; may be modified for sequence offset by this method
1797 * @param verticalOffset
1798 * the number of visible sequences to show above the mapped region
1800 public void scrollToCentre(SearchResultsI sr, int verticalOffset)
1803 * To avoid jumpy vertical scrolling (if some sequences are gapped or not
1804 * mapped), we can make the scroll-to location a sequence above the one
1807 SequenceI mappedTo = sr.getResults().get(0).getSequence();
1808 List<SequenceI> seqs = av.getAlignment().getSequences();
1811 * This is like AlignmentI.findIndex(seq) but here we are matching the
1812 * dataset sequence not the aligned sequence
1814 boolean matched = false;
1815 for (SequenceI seq : seqs)
1817 if (mappedTo == seq.getDatasetSequence())
1825 return; // failsafe, shouldn't happen
1829 * Scroll to position but centring the target residue.
1831 scrollToPosition(sr, verticalOffset, true, true);
1835 * Set a flag to say do not scroll any (cDNA/protein) complement.
1839 protected void setToScrollComplementPanel(boolean b)
1841 this.scrollComplementaryPanel = b;
1844 protected boolean isSetToScrollComplementPanel()
1846 return this.scrollComplementaryPanel;
1852 * @adjustHeight if true, try to recalculate panel height for visible
1855 protected void refresh(boolean adjustHeight)
1857 validateAnnotationDimensions(adjustHeight);
1861 // sort, repaint, update overview
1862 paintAlignment(true);
1866 // lightweight repaint
1873 * Property change event fired when a change is made to the viewport ranges
1874 * object associated with this alignment panel's viewport
1876 public void propertyChange(PropertyChangeEvent evt)
1878 // update this panel's scroll values based on the new viewport ranges values
1879 int x = vpRanges.getStartRes();
1880 int y = vpRanges.getStartSeq();
1881 setScrollValues(x, y);
1883 // now update any complementary alignment (its viewport ranges object
1884 // is different so does not get automatically updated)
1885 if (isSetToScrollComplementPanel())
1887 setToScrollComplementPanel(false);
1888 av.scrollComplementaryAlignment();
1889 setToScrollComplementPanel(true);