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.HiddenColumns;
29 import jalview.datamodel.SearchResultsI;
30 import jalview.datamodel.SequenceFeature;
31 import jalview.datamodel.SequenceGroup;
32 import jalview.datamodel.SequenceI;
33 import jalview.io.HTMLOutput;
34 import jalview.jbgui.GAlignmentPanel;
35 import jalview.math.AlignmentDimension;
36 import jalview.schemes.ResidueProperties;
37 import jalview.structure.StructureSelectionManager;
38 import jalview.util.Comparison;
39 import jalview.util.MessageManager;
40 import jalview.util.Platform;
41 import jalview.viewmodel.ViewportListenerI;
42 import jalview.viewmodel.ViewportRanges;
44 import java.awt.BorderLayout;
45 import java.awt.Color;
46 import java.awt.Container;
47 import java.awt.Dimension;
49 import java.awt.FontMetrics;
50 import java.awt.Graphics;
51 import java.awt.Insets;
52 import java.awt.event.AdjustmentEvent;
53 import java.awt.event.AdjustmentListener;
54 import java.awt.event.ComponentAdapter;
55 import java.awt.event.ComponentEvent;
56 import java.awt.print.PageFormat;
57 import java.awt.print.Printable;
58 import java.awt.print.PrinterException;
59 import java.beans.PropertyChangeEvent;
60 import java.beans.PropertyChangeListener;
62 import java.io.FileWriter;
63 import java.io.PrintWriter;
64 import java.util.List;
66 import javax.swing.SwingUtilities;
72 * @version $Revision: 1.161 $
74 public class AlignmentPanel extends GAlignmentPanel implements
75 AdjustmentListener, Printable, AlignmentViewPanel, ViewportListenerI
77 public AlignViewport av;
79 ViewportRanges vpRanges;
81 OverviewPanel overviewPanel;
83 private SeqPanel seqPanel;
85 private IdPanel idPanel;
87 private boolean headless;
89 IdwidthAdjuster idwidthAdjuster;
92 public AlignFrame alignFrame;
94 private ScalePanel scalePanel;
96 private AnnotationPanel annotationPanel;
98 private AnnotationLabels alabels;
100 // this value is set false when selection area being dragged
101 boolean fastPaint = true;
103 private int hextent = 0;
105 private int vextent = 0;
108 * Flag set while scrolling to follow complementary cDNA/protein scroll. When
109 * false, suppresses invoking the same method recursively.
111 private boolean scrollComplementaryPanel = true;
113 private PropertyChangeListener propertyChangeListener;
115 private CalculationChooser calculationDialog;
118 * Creates a new AlignmentPanel object.
123 public AlignmentPanel(AlignFrame af, final AlignViewport av)
127 vpRanges = av.getRanges();
128 setSeqPanel(new SeqPanel(av, this));
129 setIdPanel(new IdPanel(av, this));
131 setScalePanel(new ScalePanel(av, this));
133 idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
134 idwidthAdjuster = new IdwidthAdjuster(this);
135 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
137 setAnnotationPanel(new AnnotationPanel(this));
138 setAlabels(new AnnotationLabels(this));
140 annotationScroller.setViewportView(getAnnotationPanel());
141 annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
143 scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
144 seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
146 setScrollValues(0, 0);
148 hscroll.addAdjustmentListener(this);
149 vscroll.addAdjustmentListener(this);
151 addComponentListener(new ComponentAdapter()
154 public void componentResized(ComponentEvent evt)
156 // reset the viewport ranges when the alignment panel is resized
157 // in particular, this initialises the end residue value when Jalview
159 if (av.getWrapAlignment())
161 int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
162 getSeqPanel().seqCanvas.getWidth());
163 vpRanges.setViewportWidth(widthInRes);
167 int widthInRes = getSeqPanel().seqCanvas.getWidth()
169 int heightInSeq = getSeqPanel().seqCanvas.getHeight()
170 / av.getCharHeight();
172 vpRanges.setViewportWidth(widthInRes);
173 vpRanges.setViewportHeight(heightInSeq);
179 final AlignmentPanel ap = this;
180 propertyChangeListener = new PropertyChangeListener()
183 public void propertyChange(PropertyChangeEvent evt)
185 if (evt.getPropertyName().equals("alignment"))
187 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
192 av.addPropertyChangeListener(propertyChangeListener);
194 av.getRanges().addPropertyChangeListener(this);
196 adjustAnnotationHeight();
201 public AlignViewportI getAlignViewport()
206 public void alignmentChanged()
208 av.alignmentChanged(this);
210 if (getCalculationDialog() != null)
212 getCalculationDialog().validateCalcTypes();
215 alignFrame.updateEditMenuBar();
217 paintAlignment(true);
224 public void fontChanged()
226 // set idCanvas bufferedImage to null
227 // to prevent drawing old image
228 FontMetrics fm = getFontMetrics(av.getFont());
230 scalePanelHolder.setPreferredSize(
231 new Dimension(10, av.getCharHeight() + fm.getDescent()));
232 idSpaceFillerPanel1.setPreferredSize(
233 new Dimension(10, av.getCharHeight() + fm.getDescent()));
234 idwidthAdjuster.invalidate();
235 scalePanelHolder.invalidate();
236 getIdPanel().getIdCanvas().gg = null;
237 getSeqPanel().seqCanvas.img = null;
238 getAnnotationPanel().adjustPanelHeight();
240 Dimension d = calculateIdWidth();
242 d.setSize(d.width + 4, d.height);
243 getIdPanel().getIdCanvas().setPreferredSize(d);
244 hscrollFillerPanel.setPreferredSize(d);
246 if (this.alignFrame.getSplitViewContainer() != null)
248 ((SplitFrame) this.alignFrame.getSplitViewContainer()).adjustLayout();
255 * Calculate the width of the alignment labels based on the displayed names
256 * and any bounds on label width set in preferences.
258 * @return Dimension giving the maximum width of the alignment label panel
259 * that should be used.
261 public Dimension calculateIdWidth()
263 // calculate sensible default width when no preference is available
265 if (av.getIdWidth() < 0)
267 int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
268 int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
269 r = calculateIdWidth(maxwidth);
270 av.setIdWidth(r.width);
275 r.width = av.getIdWidth();
282 * Calculate the width of the alignment labels based on the displayed names
283 * and any bounds on label width set in preferences.
286 * -1 or maximum width allowed for IdWidth
287 * @return Dimension giving the maximum width of the alignment label panel
288 * that should be used.
290 public Dimension calculateIdWidth(int maxwidth)
292 Container c = new Container();
294 FontMetrics fm = c.getFontMetrics(
295 new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
297 AlignmentI al = av.getAlignment();
302 while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
304 SequenceI s = al.getSequenceAt(i);
306 id = s.getDisplayId(av.getShowJVSuffix());
308 if (fm.stringWidth(id) > idWidth)
310 idWidth = fm.stringWidth(id);
316 // Also check annotation label widths
319 if (al.getAlignmentAnnotation() != null)
321 fm = c.getFontMetrics(getAlabels().getFont());
323 while (i < al.getAlignmentAnnotation().length)
325 String label = al.getAlignmentAnnotation()[i].label;
327 if (fm.stringWidth(label) > idWidth)
329 idWidth = fm.stringWidth(label);
336 return new Dimension(
337 maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth), 12);
341 * Highlight the given results on the alignment.
344 public void highlightSearchResults(SearchResultsI results)
346 boolean scrolled = scrollToPosition(results, 0, true, false);
348 boolean noFastPaint = scrolled && av.getWrapAlignment();
350 getSeqPanel().seqCanvas.highlightSearchResults(results, noFastPaint);
354 * Scroll the view to show the position of the highlighted region in results
357 * @param searchResults
358 * @param redrawOverview
361 public boolean scrollToPosition(SearchResultsI searchResults,
362 boolean redrawOverview)
364 return scrollToPosition(searchResults, 0, redrawOverview, false);
368 * Scrolls the view (if necessary) to show the position of the first
369 * highlighted region in results (if any). Answers true if the view was
370 * scrolled, or false if no matched region was found, or it is already
374 * @param verticalOffset
375 * if greater than zero, allows scrolling to a position below the
376 * first displayed sequence
377 * @param redrawOverview
378 * - when set, the overview will be recalculated (takes longer)
380 * if true, try to centre the search results horizontally in the view
383 protected boolean scrollToPosition(SearchResultsI results,
384 int verticalOffset, boolean redrawOverview, boolean centre)
386 int startv, endv, starts, ends;
388 if (results == null || results.isEmpty() || av == null
389 || av.getAlignment() == null)
393 int seqIndex = av.getAlignment().findIndex(results);
398 SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
400 int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
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())
427 if (av.hasHiddenColumns())
429 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
430 start = hidden.findColumnPosition(start);
431 end = hidden.findColumnPosition(end);
434 if (!hidden.isVisible(r[0]))
436 // don't scroll - position isn't visible
443 * allow for offset of target sequence (actually scroll to one above it)
445 seqIndex = Math.max(0, seqIndex - verticalOffset);
446 boolean scrollNeeded = true;
448 if (!av.getWrapAlignment())
450 if ((startv = vpRanges.getStartRes()) >= start)
453 * Scroll left to make start of search results visible
455 setScrollValues(start, seqIndex);
457 else if ((endv = vpRanges.getEndRes()) <= end)
460 * Scroll right to make end of search results visible
462 setScrollValues(startv + end - endv, seqIndex);
464 else if ((starts = vpRanges.getStartSeq()) > seqIndex)
467 * Scroll up to make start of search results visible
469 setScrollValues(vpRanges.getStartRes(), seqIndex);
471 else if ((ends = vpRanges.getEndSeq()) <= seqIndex)
474 * Scroll down to make end of search results visible
476 setScrollValues(vpRanges.getStartRes(), starts + seqIndex - ends
480 * Else results are already visible - no need to scroll
482 scrollNeeded = false;
486 scrollNeeded = vpRanges.scrollToWrappedVisible(start);
489 paintAlignment(redrawOverview);
497 * @return DOCUMENT ME!
499 public OverviewPanel getOverviewPanel()
501 return overviewPanel;
510 public void setOverviewPanel(OverviewPanel op)
518 * Hide or show annotation panel
521 public void setAnnotationVisible(boolean b)
523 if (!av.getWrapAlignment())
525 annotationSpaceFillerHolder.setVisible(b);
526 annotationScroller.setVisible(b);
532 * automatically adjust annotation panel height for new annotation whilst
533 * ensuring the alignment is still visible.
536 public void adjustAnnotationHeight()
538 // TODO: display vertical annotation scrollbar if necessary
539 // this is called after loading new annotation onto alignment
540 if (alignFrame.getHeight() == 0)
542 System.out.println("NEEDS FIXING");
544 validateAnnotationDimensions(true);
546 paintAlignment(true);
550 * calculate the annotation dimensions and refresh slider values accordingly.
551 * need to do repaints/notifys afterwards.
553 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
555 int annotationHeight = getAnnotationPanel().adjustPanelHeight();
557 if (adjustPanelHeight)
559 int rowHeight = av.getCharHeight();
560 int alignmentHeight = rowHeight * av.getAlignment().getHeight();
563 * Estimate available height in the AlignFrame for alignment +
564 * annotations. Deduct an estimate for title bar, menu bar, scale panel,
565 * hscroll, status bar (as these are not laid out we can't inspect their
566 * actual heights). Insets gives frame borders.
568 int stuff = Platform.isAMac() ? 80 : 100;
569 Insets insets = alignFrame.getInsets();
570 int availableHeight = alignFrame.getHeight() - stuff - insets.top
574 * If not enough vertical space, maximize annotation height while keeping
575 * at least two rows of alignment visible
577 if (annotationHeight + alignmentHeight > availableHeight)
579 annotationHeight = Math.min(annotationHeight,
580 availableHeight - 2 * rowHeight);
585 // maintain same window layout whilst updating sliders
586 annotationHeight = annotationScroller.getSize().height;
590 annotationScroller.setPreferredSize(
591 new Dimension(annotationScroller.getWidth(), annotationHeight));
593 Dimension e = idPanel.getSize();
594 alabels.setSize(new Dimension(e.width, annotationHeight));
596 annotationSpaceFillerHolder.setPreferredSize(new Dimension(
597 annotationSpaceFillerHolder.getWidth(), annotationHeight));
598 annotationScroller.validate();
599 annotationScroller.addNotify();
603 * update alignment layout for viewport settings
608 public void updateLayout()
611 setAnnotationVisible(av.isShowAnnotation());
612 boolean wrap = av.getWrapAlignment();
613 vpRanges.setStartSeq(0);
614 scalePanelHolder.setVisible(!wrap);
615 hscroll.setVisible(!wrap);
616 idwidthAdjuster.setVisible(!wrap);
620 annotationScroller.setVisible(false);
621 annotationSpaceFillerHolder.setVisible(false);
623 else if (av.isShowAnnotation())
625 annotationScroller.setVisible(true);
626 annotationSpaceFillerHolder.setVisible(true);
629 int canvasWidth = getSeqPanel().seqCanvas.getWidth();
631 { // may not yet be laid out
634 int widthInRes = getSeqPanel().seqCanvas
635 .getWrappedCanvasWidth(canvasWidth);
636 vpRanges.setViewportWidth(widthInRes);
640 int widthInRes = (canvasWidth / av.getCharWidth()) - 1;
641 int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
642 / av.getCharHeight()) - 1;
644 vpRanges.setViewportWidth(widthInRes);
645 vpRanges.setViewportHeight(heightInSeq);
649 idSpaceFillerPanel1.setVisible(!wrap);
655 * Adjust row/column scrollers to show a visible position in the alignment.
658 * visible column to scroll to
660 * visible row to scroll to
663 public void setScrollValues(int xpos, int ypos)
668 if (av == null || av.getAlignment() == null)
673 if (av.getWrapAlignment())
675 setScrollingForWrappedPanel(x);
679 int width = av.getAlignment().getWidth();
680 int height = av.getAlignment().getHeight();
682 if (av.hasHiddenColumns())
684 // reset the width to exclude hidden columns
685 width = av.getAlignment().getHiddenColumns()
686 .findColumnPosition(width);
689 hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
690 vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
697 if (vextent > height)
702 if ((hextent + x) > width)
707 if ((vextent + y) > height)
709 y = height - vextent;
722 // update the scroll values
723 hscroll.setValues(x, hextent, 0, width);
724 vscroll.setValues(y, vextent, 0, height);
729 * Respond to adjustment event when horizontal or vertical scrollbar is
733 * adjustment event encoding whether hscroll or vscroll changed
736 public void adjustmentValueChanged(AdjustmentEvent evt)
738 if (av.getWrapAlignment())
740 adjustScrollingWrapped(evt);
744 if (evt.getSource() == hscroll)
746 int oldX = vpRanges.getStartRes();
747 int oldwidth = vpRanges.getViewportWidth();
748 int x = hscroll.getValue();
749 int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
751 // if we're scrolling to the position we're already at, stop
752 // this prevents infinite recursion of events when the scroll/viewport
753 // ranges values are the same
754 if ((x == oldX) && (width == oldwidth))
758 vpRanges.setViewportStartAndWidth(x, width);
760 else if (evt.getSource() == vscroll)
762 int oldY = vpRanges.getStartSeq();
763 int oldheight = vpRanges.getViewportHeight();
764 int y = vscroll.getValue();
765 int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
767 // if we're scrolling to the position we're already at, stop
768 // this prevents infinite recursion of events when the scroll/viewport
769 // ranges values are the same
770 if ((y == oldY) && (height == oldheight))
774 vpRanges.setViewportStartAndHeight(y, height);
783 * Responds to a scroll change by setting the start position of the viewport.
788 protected void adjustScrollingWrapped(AdjustmentEvent evt)
790 if (evt.getSource() == hscroll)
792 return; // no horizontal scroll when wrapped
794 if (evt.getSource() == vscroll)
796 int newY = vscroll.getValue();
799 * if we're scrolling to the position we're already at, stop
800 * this prevents infinite recursion of events when the scroll/viewport
801 * ranges values are the same
803 int oldX = vpRanges.getStartRes();
804 int oldY = vpRanges.getWrappedScrollPosition(oldX);
812 * limit page up/down to one width's worth of positions
814 int rowSize = vpRanges.getViewportWidth();
815 int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
816 vpRanges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
821 // This is only called if file loaded is a jar file that
822 // was wrapped when saved and user has wrap alignment true
823 // as preference setting
824 SwingUtilities.invokeLater(new Runnable()
829 // When updating scrolling to use ViewportChange events, this code
830 // could not be validated and it is not clear if it is now being
831 // called. Log warning here in case it is called and unforeseen
834 "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
836 // scroll to start of panel
837 vpRanges.setStartRes(0);
838 vpRanges.setStartSeq(0);
846 * Repaint the alignment including the annotations and overview panels (if
850 public void paintAlignment(boolean updateOverview)
852 final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
853 av.isShowAutocalculatedAbove());
854 sorter.sort(getAlignment().getAlignmentAnnotation(),
855 av.getSortAnnotationsBy());
860 // TODO: determine if this paintAlignment changed structure colours
861 av.getStructureSelectionManager().sequenceColoursChanged(this);
863 if (overviewPanel != null)
865 overviewPanel.updateOverviewImage();
877 public void paintComponent(Graphics g)
881 Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
882 idPanelHolder.setPreferredSize(d);
883 hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
887 * set scroll bar positions
889 setScrollValues(vpRanges.getStartRes(), vpRanges.getStartSeq());
893 * Set vertical scroll bar position, and number of increments, for wrapped
896 * @param topLeftColumn
897 * the column position at top left (0..)
899 private void setScrollingForWrappedPanel(int topLeftColumn)
901 int scrollPosition = vpRanges.getWrappedScrollPosition(topLeftColumn);
902 int maxScroll = vpRanges.getWrappedMaxScroll(topLeftColumn);
905 * a scrollbar's value can be set to at most (maximum-extent)
906 * so we add extent (1) to the maxScroll value
908 vscroll.setUnitIncrement(1);
909 vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
922 * @return DOCUMENT ME!
924 * @throws PrinterException
928 public int print(Graphics pg, PageFormat pf, int pi)
929 throws PrinterException
931 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
933 int pwidth = (int) pf.getImageableWidth();
934 int pheight = (int) pf.getImageableHeight();
936 if (av.getWrapAlignment())
938 return printWrappedAlignment(pwidth, pheight, pi, pg);
942 return printUnwrapped(pwidth, pheight, pi, pg, pg);
958 * @return DOCUMENT ME!
960 * @throws PrinterException
964 * Draws the alignment image, including sequence ids, sequences, and
965 * annotation labels and annotations if shown, on either one or two Graphics
972 * the graphics context for sequence ids and annotation labels
973 * @param alignmentGraphics
974 * the graphics context for sequences and annotations (may or may not
975 * be the same context as idGraphics)
977 * @throws PrinterException
979 public int printUnwrapped(int pageWidth, int pageHeight, int pi,
980 Graphics idGraphics, Graphics alignmentGraphics)
981 throws PrinterException
983 final int idWidth = getVisibleIdWidth(false);
986 * Get the horizontal offset to where we draw the sequences.
987 * This is idWidth if using a single Graphics context, else zero.
989 final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
992 FontMetrics fm = getFontMetrics(av.getFont());
993 int charHeight = av.getCharHeight();
994 int scaleHeight = charHeight + fm.getDescent();
996 idGraphics.setColor(Color.white);
997 idGraphics.fillRect(0, 0, pageWidth, pageHeight);
998 idGraphics.setFont(av.getFont());
1001 * How many sequences and residues can we fit on a printable page?
1003 int totalRes = (pageWidth - idWidth) / av.getCharWidth();
1005 int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1007 int alignmentWidth = av.getAlignment().getWidth();
1008 int pagesWide = (alignmentWidth / totalRes) + 1;
1010 final int startRes = (pi % pagesWide) * totalRes;
1011 int endRes = (startRes + totalRes) - 1;
1013 if (endRes > (alignmentWidth - 1))
1015 endRes = alignmentWidth - 1;
1018 final int startSeq = (pi / pagesWide) * totalSeq;
1019 int endSeq = startSeq + totalSeq;
1021 int alignmentHeight = av.getAlignment().getHeight();
1022 if (endSeq > alignmentHeight)
1024 endSeq = alignmentHeight;
1027 int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
1029 if (av.isShowAnnotation())
1031 pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1034 pagesHigh /= pageHeight;
1036 if (pi >= (pagesWide * pagesHigh))
1038 return Printable.NO_SUCH_PAGE;
1040 final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
1043 * draw the Scale at horizontal offset, then reset to top left (0, 0)
1045 alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1046 getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1047 pageWidth - idWidth, scaleHeight);
1048 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1051 * Draw the sequence ids, offset for scale height,
1052 * then reset to top left (0, 0)
1054 idGraphics.translate(0, scaleHeight);
1055 idGraphics.setFont(getIdPanel().getIdCanvas().getIdfont());
1056 Color currentColor = null;
1057 Color currentTextColor = null;
1060 for (int i = startSeq; i < endSeq; i++)
1062 seq = av.getAlignment().getSequenceAt(i);
1063 if ((av.getSelectionGroup() != null)
1064 && av.getSelectionGroup().getSequences(null).contains(seq))
1067 * gray out ids of sequences in selection group (if any)
1069 currentColor = Color.gray;
1070 currentTextColor = Color.black;
1074 currentColor = av.getSequenceColour(seq);
1075 currentTextColor = Color.black;
1078 idGraphics.setColor(currentColor);
1079 idGraphics.fillRect(0, (i - startSeq) * charHeight, idWidth,
1082 idGraphics.setColor(currentTextColor);
1085 String displayId = seq.getDisplayId(av.getShowJVSuffix());
1086 if (av.isRightAlignIds())
1088 fm = idGraphics.getFontMetrics();
1089 xPos = idWidth - fm.stringWidth(displayId) - 4;
1092 idGraphics.drawString(displayId, xPos,
1093 (((i - startSeq) * charHeight) + charHeight)
1094 - (charHeight / 5));
1096 idGraphics.setFont(av.getFont());
1097 idGraphics.translate(0, -scaleHeight);
1100 * draw the sequences, offset for scale height, and id width (if using a
1101 * single graphics context), then reset to (0, scale height)
1103 alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1104 getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics, startRes,
1105 endRes, startSeq, endSeq);
1106 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1108 if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1111 * draw annotation labels; drawComponent() translates by
1112 * getScrollOffset(), so compensate for that first;
1113 * then reset to (0, scale height)
1115 int offset = getAlabels().getScrollOffset();
1116 idGraphics.translate(0, -offset);
1117 idGraphics.translate(0, alignmentDrawnHeight);
1118 getAlabels().drawComponent(idGraphics, idWidth);
1119 idGraphics.translate(0, -alignmentDrawnHeight);
1122 * draw the annotations starting at
1123 * (idOffset, alignmentHeight) from (0, scaleHeight)
1125 alignmentGraphics.translate(alignmentGraphicsOffset,
1126 alignmentDrawnHeight);
1127 getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1128 alignmentGraphics, -1, startRes, endRes + 1);
1131 return Printable.PAGE_EXISTS;
1146 * @return DOCUMENT ME!
1148 * @throws PrinterException
1151 public int printWrappedAlignment(int pwidth, int pheight, int pi,
1152 Graphics pg) throws PrinterException
1154 int annotationHeight = 0;
1155 AnnotationLabels labels = null;
1156 if (av.isShowAnnotation())
1158 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1159 labels = new AnnotationLabels(av);
1162 int hgap = av.getCharHeight();
1163 if (av.getScaleAboveWrapped())
1165 hgap += av.getCharHeight();
1168 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1171 int idWidth = getVisibleIdWidth(false);
1173 int maxwidth = av.getAlignment().getWidth();
1174 if (av.hasHiddenColumns())
1176 maxwidth = av.getAlignment().getHiddenColumns()
1177 .findColumnPosition(maxwidth) - 1;
1180 int resWidth = getSeqPanel().seqCanvas
1181 .getWrappedCanvasWidth(pwidth - idWidth);
1183 int totalHeight = cHeight * (maxwidth / resWidth + 1);
1185 pg.setColor(Color.white);
1186 pg.fillRect(0, 0, pwidth, pheight);
1187 pg.setFont(av.getFont());
1191 pg.setColor(Color.black);
1193 pg.translate(0, -pi * pheight);
1195 pg.setClip(0, pi * pheight, pwidth, pheight);
1201 for (int i = 0; i < av.getAlignment().getHeight(); i++)
1203 pg.setFont(getIdPanel().getIdCanvas().getIdfont());
1204 SequenceI s = av.getAlignment().getSequenceAt(i);
1205 String string = s.getDisplayId(av.getShowJVSuffix());
1207 if (av.isRightAlignIds())
1209 FontMetrics fm = pg.getFontMetrics();
1210 xPos = idWidth - fm.stringWidth(string) - 4;
1212 pg.drawString(string, xPos,
1213 ((i * av.getCharHeight()) + ypos + av.getCharHeight())
1214 - (av.getCharHeight() / 5));
1218 pg.translate(-3, ypos
1219 + (av.getAlignment().getHeight() * av.getCharHeight()));
1221 pg.setFont(av.getFont());
1222 labels.drawComponent(pg, idWidth);
1223 pg.translate(+3, -ypos
1224 - (av.getAlignment().getHeight() * av.getCharHeight()));
1228 } while (ypos < totalHeight);
1230 pg.translate(idWidth, 0);
1232 getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(pg, pwidth - idWidth,
1235 if ((pi * pheight) < totalHeight)
1237 return Printable.PAGE_EXISTS;
1242 return Printable.NO_SUCH_PAGE;
1247 * get current sequence ID panel width, or nominal value if panel were to be
1248 * displayed using default settings
1252 public int getVisibleIdWidth()
1254 return getVisibleIdWidth(true);
1258 * get current sequence ID panel width, or nominal value if panel were to be
1259 * displayed using default settings
1262 * indicate if the Id width for onscreen or offscreen display should
1266 public int getVisibleIdWidth(boolean onscreen)
1268 // see if rendering offscreen - check preferences and calc width accordingly
1269 if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1271 return calculateIdWidth(-1).width + 4;
1273 Integer idwidth = null;
1274 if (onscreen || (idwidth = Cache
1275 .getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1277 int w = getIdPanel().getWidth();
1278 return (w > 0 ? w : calculateIdWidth().width + 4);
1280 return idwidth.intValue() + 4;
1283 void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1285 int boarderBottomOffset = 5;
1286 long pSessionId = System.currentTimeMillis();
1287 headless = (System.getProperty("java.awt.headless") != null
1288 && System.getProperty("java.awt.headless").equals("true"));
1289 if (alignFrame != null && !headless)
1293 alignFrame.setProgressBar(MessageManager
1294 .formatMessage("status.saving_file", new Object[]
1295 { type.getLabel() }), pSessionId);
1300 AlignmentDimension aDimension = getAlignmentDimension();
1303 jalview.util.ImageMaker im;
1304 final String imageAction, imageTitle;
1305 if (type == jalview.util.ImageMaker.TYPE.PNG)
1307 imageAction = "Create PNG image from alignment";
1310 else if (type == jalview.util.ImageMaker.TYPE.EPS)
1312 imageAction = "Create EPS file from alignment";
1313 imageTitle = alignFrame.getTitle();
1317 imageAction = "Create SVG file from alignment";
1318 imageTitle = alignFrame.getTitle();
1321 im = new jalview.util.ImageMaker(this, type, imageAction,
1322 aDimension.getWidth(),
1323 aDimension.getHeight() + boarderBottomOffset, file,
1324 imageTitle, alignFrame, pSessionId, headless);
1325 Graphics graphics = im.getGraphics();
1326 if (av.getWrapAlignment())
1328 if (graphics != null)
1330 printWrappedAlignment(aDimension.getWidth(),
1331 aDimension.getHeight() + boarderBottomOffset, 0,
1338 if (graphics != null)
1340 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1341 graphics, graphics);
1346 } catch (OutOfMemoryError err)
1349 System.out.println("########################\n" + "OUT OF MEMORY "
1350 + file + "\n" + "########################");
1351 new OOMWarning("Creating Image for " + file, err);
1352 // System.out.println("Create IMAGE: " + err);
1353 } catch (Exception ex)
1355 ex.printStackTrace();
1363 public AlignmentDimension getAlignmentDimension()
1365 int maxwidth = av.getAlignment().getWidth();
1366 if (av.hasHiddenColumns())
1368 maxwidth = av.getAlignment().getHiddenColumns()
1369 .findColumnPosition(maxwidth);
1372 int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1373 + getScalePanel().getHeight();
1374 int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1376 if (av.getWrapAlignment())
1378 height = getWrappedHeight();
1381 // need to obtain default alignment width and then add in any
1382 // additional allowance for id margin
1383 // this duplicates the calculation in getWrappedHeight but adjusts for
1385 width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1386 - alignFrame.getInsets().left - alignFrame.getInsets().right
1387 - getVisibleIdWidth() + getVisibleIdWidth(false);
1391 width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1395 else if (av.isShowAnnotation())
1397 height += getAnnotationPanel().adjustPanelHeight() + 3;
1399 return new AlignmentDimension(width, height);
1406 public void makeEPS(File epsFile)
1408 makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1414 public void makePNG(File pngFile)
1416 makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1419 public void makeSVG(File svgFile)
1421 makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1424 public void makePNGImageMap(File imgMapFile, String imageName)
1426 // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1427 // ////////////////////////////////////////////
1428 int idWidth = getVisibleIdWidth(false);
1429 FontMetrics fm = getFontMetrics(av.getFont());
1430 int scaleHeight = av.getCharHeight() + fm.getDescent();
1433 // ////////////////////////////////
1434 if (imgMapFile != null)
1438 int sSize = av.getAlignment().getHeight();
1439 int alwidth = av.getAlignment().getWidth();
1440 PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1441 out.println(HTMLOutput.getImageMapHTML());
1442 out.println("<img src=\"" + imageName
1443 + "\" border=\"0\" usemap=\"#Map\" >"
1444 + "<map name=\"Map\">");
1446 for (int s = 0; s < sSize; s++)
1448 int sy = s * av.getCharHeight() + scaleHeight;
1450 SequenceI seq = av.getAlignment().getSequenceAt(s);
1451 SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1452 for (int column = 0; column < alwidth; column++)
1454 StringBuilder text = new StringBuilder(512);
1455 String triplet = null;
1456 if (av.getAlignment().isNucleotide())
1458 triplet = ResidueProperties.nucleotideName.get(seq
1459 .getCharAt(column) + "");
1463 triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(column)
1467 if (triplet == null)
1472 int seqPos = seq.findPosition(column);
1473 int gSize = groups.length;
1474 for (int g = 0; g < gSize; g++)
1476 if (text.length() < 1)
1478 text.append("<area shape=\"rect\" coords=\"")
1479 .append((idWidth + column * av.getCharWidth()))
1480 .append(",").append(sy).append(",")
1481 .append((idWidth + (column + 1) * av.getCharWidth()))
1482 .append(",").append((av.getCharHeight() + sy))
1483 .append("\"").append(" onMouseOver=\"toolTip('")
1484 .append(seqPos).append(" ").append(triplet);
1487 if (groups[g].getStartRes() < column
1488 && groups[g].getEndRes() > column)
1490 text.append("<br><em>").append(groups[g].getName())
1495 if (text.length() < 1)
1497 text.append("<area shape=\"rect\" coords=\"")
1498 .append((idWidth + column * av.getCharWidth()))
1499 .append(",").append(sy).append(",")
1500 .append((idWidth + (column + 1) * av.getCharWidth()))
1501 .append(",").append((av.getCharHeight() + sy))
1502 .append("\"").append(" onMouseOver=\"toolTip('")
1503 .append(seqPos).append(" ").append(triplet);
1505 if (!Comparison.isGap(seq.getCharAt(column)))
1507 List<SequenceFeature> features = seq.findFeatures(column, column);
1508 for (SequenceFeature sf : features)
1510 if (sf.isContactFeature())
1512 text.append("<br>").append(sf.getType()).append(" ")
1513 .append(sf.getBegin()).append(":")
1514 .append(sf.getEnd());
1518 text.append("<br>");
1519 text.append(sf.getType());
1520 String description = sf.getDescription();
1521 if (description != null
1522 && !sf.getType().equals(description))
1524 description = description.replace("\"", """);
1525 text.append(" ").append(description);
1528 String status = sf.getStatus();
1529 if (status != null && !"".equals(status))
1531 text.append(" (").append(status).append(")");
1534 if (text.length() > 1)
1536 text.append("')\"; onMouseOut=\"toolTip()\"; href=\"#\">");
1537 out.println(text.toString());
1542 out.println("</map></body></html>");
1545 } catch (Exception ex)
1547 ex.printStackTrace();
1549 } // /////////END OF IMAGE MAP
1553 int getWrappedHeight()
1555 int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1557 if (System.getProperty("java.awt.headless") != null
1558 && System.getProperty("java.awt.headless").equals("true"))
1560 seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1561 - vscroll.getPreferredSize().width
1562 - alignFrame.getInsets().left - alignFrame.getInsets().right;
1565 int chunkWidth = getSeqPanel().seqCanvas
1566 .getWrappedCanvasWidth(seqPanelWidth);
1568 int hgap = av.getCharHeight();
1569 if (av.getScaleAboveWrapped())
1571 hgap += av.getCharHeight();
1574 int annotationHeight = 0;
1575 if (av.isShowAnnotation())
1577 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1580 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1583 int maxwidth = av.getAlignment().getWidth();
1584 if (av.hasHiddenColumns())
1586 maxwidth = av.getAlignment().getHiddenColumns()
1587 .findColumnPosition(maxwidth) - 1;
1590 int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1596 * close the panel - deregisters all listeners and nulls any references to
1599 public void closePanel()
1601 PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1602 PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1603 PaintRefresher.RemoveComponent(this);
1608 * try to ensure references are nulled
1610 if (annotationPanel != null)
1612 annotationPanel.dispose();
1617 av.removePropertyChangeListener(propertyChangeListener);
1618 jalview.structure.StructureSelectionManager ssm = av
1619 .getStructureSelectionManager();
1620 ssm.removeStructureViewerListener(getSeqPanel(), null);
1621 ssm.removeSelectionListener(getSeqPanel());
1622 ssm.removeCommandListener(av);
1623 ssm.removeStructureViewerListener(getSeqPanel(), null);
1624 ssm.removeSelectionListener(getSeqPanel());
1630 if (Cache.log.isDebugEnabled())
1632 Cache.log.warn("Closing alignment panel which is already closed.");
1638 * Close any open dialogs that would be orphaned when this one is closed
1640 protected void closeChildFrames()
1642 if (calculationDialog != null)
1644 calculationDialog.closeFrame();
1649 * hides or shows dynamic annotation rows based on groups and av state flags
1651 public void updateAnnotation()
1653 updateAnnotation(false, false);
1656 public void updateAnnotation(boolean applyGlobalSettings)
1658 updateAnnotation(applyGlobalSettings, false);
1661 public void updateAnnotation(boolean applyGlobalSettings,
1662 boolean preserveNewGroupSettings)
1664 av.updateGroupAnnotationSettings(applyGlobalSettings,
1665 preserveNewGroupSettings);
1666 adjustAnnotationHeight();
1670 public AlignmentI getAlignment()
1672 return av == null ? null : av.getAlignment();
1676 public String getViewName()
1682 * Make/Unmake this alignment panel the current input focus
1686 public void setSelected(boolean b)
1690 if (alignFrame.getSplitViewContainer() != null)
1693 * bring enclosing SplitFrame to front first if there is one
1695 ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1697 alignFrame.setSelected(b);
1698 } catch (Exception ex)
1704 alignFrame.setDisplayedView(this);
1709 public StructureSelectionManager getStructureSelectionManager()
1711 return av.getStructureSelectionManager();
1715 public void raiseOOMWarning(String string, OutOfMemoryError error)
1717 new OOMWarning(string, error, this);
1721 public jalview.api.FeatureRenderer cloneFeatureRenderer()
1724 return new FeatureRenderer(this);
1728 public jalview.api.FeatureRenderer getFeatureRenderer()
1730 return seqPanel.seqCanvas.getFeatureRenderer();
1733 public void updateFeatureRenderer(
1734 jalview.renderer.seqfeatures.FeatureRenderer fr)
1736 fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1739 public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1741 if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1743 getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1747 public ScalePanel getScalePanel()
1752 public void setScalePanel(ScalePanel scalePanel)
1754 this.scalePanel = scalePanel;
1757 public SeqPanel getSeqPanel()
1762 public void setSeqPanel(SeqPanel seqPanel)
1764 this.seqPanel = seqPanel;
1767 public AnnotationPanel getAnnotationPanel()
1769 return annotationPanel;
1772 public void setAnnotationPanel(AnnotationPanel annotationPanel)
1774 this.annotationPanel = annotationPanel;
1777 public AnnotationLabels getAlabels()
1782 public void setAlabels(AnnotationLabels alabels)
1784 this.alabels = alabels;
1787 public IdPanel getIdPanel()
1792 public void setIdPanel(IdPanel idPanel)
1794 this.idPanel = idPanel;
1798 * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1799 * The aim is to keep the two alignments 'lined up' on their centre columns.
1802 * holds mapped region(s) of this alignment that we are scrolling
1803 * 'to'; may be modified for sequence offset by this method
1804 * @param verticalOffset
1805 * the number of visible sequences to show above the mapped region
1807 protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1810 * To avoid jumpy vertical scrolling (if some sequences are gapped or not
1811 * mapped), we can make the scroll-to location a sequence above the one
1814 SequenceI mappedTo = sr.getResults().get(0).getSequence();
1815 List<SequenceI> seqs = av.getAlignment().getSequences();
1818 * This is like AlignmentI.findIndex(seq) but here we are matching the
1819 * dataset sequence not the aligned sequence
1821 boolean matched = false;
1822 for (SequenceI seq : seqs)
1824 if (mappedTo == seq.getDatasetSequence())
1832 return; // failsafe, shouldn't happen
1836 * Scroll to position but centring the target residue.
1838 scrollToPosition(sr, verticalOffset, true, true);
1842 * Set a flag to say do not scroll any (cDNA/protein) complement.
1846 protected void setToScrollComplementPanel(boolean b)
1848 this.scrollComplementaryPanel = b;
1852 * Get whether to scroll complement panel
1854 * @return true if cDNA/protein complement panels should be scrolled
1856 protected boolean isSetToScrollComplementPanel()
1858 return this.scrollComplementaryPanel;
1864 * @adjustHeight if true, try to recalculate panel height for visible
1867 protected void refresh(boolean adjustHeight)
1869 validateAnnotationDimensions(adjustHeight);
1873 // sort, repaint, update overview
1874 paintAlignment(true);
1878 // lightweight repaint
1885 * Property change event fired when a change is made to the viewport ranges
1886 * object associated with this alignment panel's viewport
1888 public void propertyChange(PropertyChangeEvent evt)
1890 // update this panel's scroll values based on the new viewport ranges values
1891 int x = vpRanges.getStartRes();
1892 int y = vpRanges.getStartSeq();
1893 setScrollValues(x, y);
1895 // now update any complementary alignment (its viewport ranges object
1896 // is different so does not get automatically updated)
1897 if (isSetToScrollComplementPanel())
1899 setToScrollComplementPanel(false);
1900 av.scrollComplementaryAlignment();
1901 setToScrollComplementPanel(true);
1906 * Set the reference to the PCA/Tree chooser dialog for this panel. This
1907 * reference should be nulled when the dialog is closed.
1909 * @param calculationChooser
1911 public void setCalculationDialog(CalculationChooser calculationChooser)
1913 calculationDialog = calculationChooser;
1917 * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1920 public CalculationChooser getCalculationDialog()
1922 return calculationDialog;