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.analysis.AnnotationSorter.SequenceAnnotationOrder;
25 import jalview.api.AlignViewportI;
26 import jalview.api.AlignmentViewPanel;
27 import jalview.bin.Cache;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.HiddenColumns;
30 import jalview.datamodel.SearchResultsI;
31 import jalview.datamodel.SequenceFeature;
32 import jalview.datamodel.SequenceGroup;
33 import jalview.datamodel.SequenceI;
34 import jalview.io.HTMLOutput;
35 import jalview.jbgui.GAlignmentPanel;
36 import jalview.math.AlignmentDimension;
37 import jalview.schemes.ResidueProperties;
38 import jalview.structure.StructureSelectionManager;
39 import jalview.util.Comparison;
40 import jalview.util.MessageManager;
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.Graphics2D;
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 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 private int hextent = 0;
100 private int vextent = 0;
103 * Flag set while scrolling to follow complementary cDNA/protein scroll. When
104 * false, suppresses invoking the same method recursively.
106 private boolean scrollComplementaryPanel = true;
108 private PropertyChangeListener propertyChangeListener;
110 private CalculationChooser calculationDialog;
113 * Creates a new AlignmentPanel object.
118 public AlignmentPanel(AlignFrame af, final AlignViewport av)
122 setSeqPanel(new SeqPanel(av, this));
123 setIdPanel(new IdPanel(av, this));
125 setScalePanel(new ScalePanel(av, this));
127 idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
128 idwidthAdjuster = new IdwidthAdjuster(this);
129 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
131 setAnnotationPanel(new AnnotationPanel(this));
132 setAlabels(new AnnotationLabels(this));
134 annotationScroller.setViewportView(getAnnotationPanel());
135 annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
137 scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
138 seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
140 setScrollValues(0, 0);
142 hscroll.addAdjustmentListener(this);
143 vscroll.addAdjustmentListener(this);
145 addComponentListener(new ComponentAdapter()
148 public void componentResized(ComponentEvent evt)
150 // reset the viewport ranges when the alignment panel is resized
151 // in particular, this initialises the end residue value when Jalview
153 ViewportRanges ranges = av.getRanges();
154 if (av.getWrapAlignment())
156 int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
157 getSeqPanel().seqCanvas.getWidth());
158 ranges.setViewportWidth(widthInRes);
162 int widthInRes = getSeqPanel().seqCanvas.getWidth()
164 int heightInSeq = getSeqPanel().seqCanvas.getHeight()
165 / av.getCharHeight();
167 ranges.setViewportWidth(widthInRes);
168 ranges.setViewportHeight(heightInSeq);
174 final AlignmentPanel ap = this;
175 propertyChangeListener = new PropertyChangeListener()
178 public void propertyChange(PropertyChangeEvent evt)
180 if (evt.getPropertyName().equals("alignment"))
182 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
187 av.addPropertyChangeListener(propertyChangeListener);
189 av.getRanges().addPropertyChangeListener(this);
191 adjustAnnotationHeight();
196 public AlignViewportI getAlignViewport()
201 public void alignmentChanged()
203 av.alignmentChanged(this);
205 if (getCalculationDialog() != null)
207 getCalculationDialog().validateCalcTypes();
210 alignFrame.updateEditMenuBar();
212 // no idea if we need to update structure
213 paintAlignment(true, true);
220 public void fontChanged()
222 // set idCanvas bufferedImage to null
223 // to prevent drawing old image
224 FontMetrics fm = getFontMetrics(av.getFont());
226 scalePanelHolder.setPreferredSize(
227 new Dimension(10, av.getCharHeight() + fm.getDescent()));
228 idSpaceFillerPanel1.setPreferredSize(
229 new Dimension(10, av.getCharHeight() + fm.getDescent()));
230 idwidthAdjuster.invalidate();
231 scalePanelHolder.invalidate();
232 getIdPanel().getIdCanvas().gg = null;
233 getSeqPanel().seqCanvas.img = null;
234 getAnnotationPanel().adjustPanelHeight();
236 Dimension d = calculateIdWidth();
238 d.setSize(d.width + 4, d.height);
239 getIdPanel().getIdCanvas().setPreferredSize(d);
240 hscrollFillerPanel.setPreferredSize(d);
246 * Calculate the width of the alignment labels based on the displayed names
247 * and any bounds on label width set in preferences.
249 * @return Dimension giving the maximum width of the alignment label panel
250 * that should be used.
252 public Dimension calculateIdWidth()
254 // calculate sensible default width when no preference is available
256 if (av.getIdWidth() < 0)
258 int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
259 int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
260 r = calculateIdWidth(maxwidth);
261 av.setIdWidth(r.width);
266 r.width = av.getIdWidth();
273 * Calculate the width of the alignment labels based on the displayed names
274 * and any bounds on label width set in preferences.
277 * -1 or maximum width allowed for IdWidth
278 * @return Dimension giving the maximum width of the alignment label panel
279 * that should be used.
281 public Dimension calculateIdWidth(int maxwidth)
283 Container c = new Container();
285 FontMetrics fm = c.getFontMetrics(
286 new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
288 AlignmentI al = av.getAlignment();
293 while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
295 SequenceI s = al.getSequenceAt(i);
297 id = s.getDisplayId(av.getShowJVSuffix());
299 if (fm.stringWidth(id) > idWidth)
301 idWidth = fm.stringWidth(id);
307 // Also check annotation label widths
310 if (al.getAlignmentAnnotation() != null)
312 fm = c.getFontMetrics(getAlabels().getFont());
314 while (i < al.getAlignmentAnnotation().length)
316 String label = al.getAlignmentAnnotation()[i].label;
318 if (fm.stringWidth(label) > idWidth)
320 idWidth = fm.stringWidth(label);
327 return new Dimension(
328 maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth), 12);
332 * Highlight the given results on the alignment
335 public void highlightSearchResults(SearchResultsI results)
337 boolean scrolled = scrollToPosition(results, 0, false);
339 boolean noFastPaint = scrolled && av.getWrapAlignment();
341 getSeqPanel().seqCanvas.highlightSearchResults(results, noFastPaint);
345 * Scroll the view to show the position of the highlighted region in results
348 * @param searchResults
351 public boolean scrollToPosition(SearchResultsI searchResults)
353 return scrollToPosition(searchResults, 0, false);
357 * Scrolls the view (if necessary) to show the position of the first
358 * highlighted region in results (if any). Answers true if the view was
359 * scrolled, or false if no matched region was found, or it is already
363 * @param verticalOffset
364 * if greater than zero, allows scrolling to a position below the
365 * first displayed sequence
367 * if true, try to centre the search results horizontally in the view
370 protected boolean scrollToPosition(SearchResultsI results,
371 int verticalOffset, boolean centre)
373 int startv, endv, starts, ends;
374 ViewportRanges ranges = av.getRanges();
376 if (results == null || results.isEmpty() || av == null
377 || av.getAlignment() == null)
381 int seqIndex = av.getAlignment().findIndex(results);
386 SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
388 int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
397 * To centre results, scroll to positions half the visible width
398 * left/right of the start/end positions
402 int offset = (ranges.getEndRes() - ranges.getStartRes() + 1) / 2 - 1;
403 start = Math.max(start - offset, 0);
404 end = end + offset - 1;
410 if (end == seq.getEnd())
415 if (av.hasHiddenColumns())
417 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
418 start = hidden.absoluteToVisibleColumn(start);
419 end = hidden.absoluteToVisibleColumn(end);
422 if (!hidden.isVisible(r[0]))
424 // don't scroll - position isn't visible
431 * allow for offset of target sequence (actually scroll to one above it)
433 seqIndex = Math.max(0, seqIndex - verticalOffset);
434 boolean scrollNeeded = true;
436 if (!av.getWrapAlignment())
438 if ((startv = ranges.getStartRes()) >= start)
441 * Scroll left to make start of search results visible
443 setScrollValues(start, seqIndex);
445 else if ((endv = ranges.getEndRes()) <= end)
448 * Scroll right to make end of search results visible
450 setScrollValues(startv + end - endv, seqIndex);
452 else if ((starts = ranges.getStartSeq()) > seqIndex)
455 * Scroll up to make start of search results visible
457 setScrollValues(ranges.getStartRes(), seqIndex);
459 else if ((ends = ranges.getEndSeq()) <= seqIndex)
462 * Scroll down to make end of search results visible
464 setScrollValues(ranges.getStartRes(), starts + seqIndex - ends
468 * Else results are already visible - no need to scroll
470 scrollNeeded = false;
474 scrollNeeded = ranges.scrollToWrappedVisible(start);
477 paintAlignment(false, false);
485 * @return DOCUMENT ME!
487 public OverviewPanel getOverviewPanel()
489 return overviewPanel;
498 public void setOverviewPanel(OverviewPanel op)
506 * Hide or show annotation panel
509 public void setAnnotationVisible(boolean b)
511 if (!av.getWrapAlignment())
513 annotationSpaceFillerHolder.setVisible(b);
514 annotationScroller.setVisible(b);
520 * automatically adjust annotation panel height for new annotation whilst
521 * ensuring the alignment is still visible.
524 public void adjustAnnotationHeight()
526 // TODO: display vertical annotation scrollbar if necessary
527 // this is called after loading new annotation onto alignment
528 if (alignFrame.getHeight() == 0)
530 System.out.println("NEEDS FIXING");
532 validateAnnotationDimensions(true);
534 // TODO: many places call this method and also paintAlignment with various
535 // different settings. this means multiple redraws are triggered...
536 paintAlignment(true, av.needToUpdateStructureViews());
540 * calculate the annotation dimensions and refresh slider values accordingly.
541 * need to do repaints/notifys afterwards.
543 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
545 int annotationHeight = getAnnotationPanel().adjustPanelHeight();
546 annotationHeight = getAnnotationPanel()
547 .adjustForAlignFrame(adjustPanelHeight, annotationHeight);
550 annotationScroller.setPreferredSize(
551 new Dimension(annotationScroller.getWidth(), annotationHeight));
553 Dimension e = idPanel.getSize();
554 alabels.setSize(new Dimension(e.width, annotationHeight));
556 annotationSpaceFillerHolder.setPreferredSize(new Dimension(
557 annotationSpaceFillerHolder.getWidth(), annotationHeight));
558 annotationScroller.validate();
559 annotationScroller.addNotify();
563 * update alignment layout for viewport settings
568 public void updateLayout()
571 setAnnotationVisible(av.isShowAnnotation());
572 boolean wrap = av.getWrapAlignment();
573 ViewportRanges ranges = av.getRanges();
574 ranges.setStartSeq(0);
575 scalePanelHolder.setVisible(!wrap);
576 hscroll.setVisible(!wrap);
577 idwidthAdjuster.setVisible(!wrap);
581 annotationScroller.setVisible(false);
582 annotationSpaceFillerHolder.setVisible(false);
584 else if (av.isShowAnnotation())
586 annotationScroller.setVisible(true);
587 annotationSpaceFillerHolder.setVisible(true);
588 validateAnnotationDimensions(false);
591 int canvasWidth = getSeqPanel().seqCanvas.getWidth();
593 { // may not yet be laid out
596 int widthInRes = getSeqPanel().seqCanvas
597 .getWrappedCanvasWidth(canvasWidth);
598 ranges.setViewportWidth(widthInRes);
602 int widthInRes = (canvasWidth / av.getCharWidth());
603 int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
604 / av.getCharHeight());
606 ranges.setViewportWidth(widthInRes);
607 ranges.setViewportHeight(heightInSeq);
611 idSpaceFillerPanel1.setVisible(!wrap);
617 * Adjust row/column scrollers to show a visible position in the alignment.
620 * visible column to scroll to
622 * visible row to scroll to
625 public void setScrollValues(int xpos, int ypos)
630 if (av == null || av.getAlignment() == null)
635 if (av.getWrapAlignment())
637 setScrollingForWrappedPanel(x);
641 int width = av.getAlignment().getVisibleWidth();
642 int height = av.getAlignment().getHeight();
644 hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
645 vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
652 if (vextent > height)
657 if ((hextent + x) > width)
662 if ((vextent + y) > height)
664 y = height - vextent;
677 // update the scroll values
678 hscroll.setValues(x, hextent, 0, width);
679 vscroll.setValues(y, vextent, 0, height);
684 * Respond to adjustment event when horizontal or vertical scrollbar is
688 * adjustment event encoding whether hscroll or vscroll changed
691 public void adjustmentValueChanged(AdjustmentEvent evt)
693 if (av.getWrapAlignment())
695 adjustScrollingWrapped(evt);
699 ViewportRanges ranges = av.getRanges();
701 if (evt.getSource() == hscroll)
703 int oldX = ranges.getStartRes();
704 int oldwidth = ranges.getViewportWidth();
705 int x = hscroll.getValue();
706 int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
708 // if we're scrolling to the position we're already at, stop
709 // this prevents infinite recursion of events when the scroll/viewport
710 // ranges values are the same
711 if ((x == oldX) && (width == oldwidth))
715 ranges.setViewportStartAndWidth(x, width);
717 else if (evt.getSource() == vscroll)
719 int oldY = ranges.getStartSeq();
720 int oldheight = ranges.getViewportHeight();
721 int y = vscroll.getValue();
722 int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
724 // if we're scrolling to the position we're already at, stop
725 // this prevents infinite recursion of events when the scroll/viewport
726 // ranges values are the same
727 if ((y == oldY) && (height == oldheight))
731 ranges.setViewportStartAndHeight(y, height);
737 * Responds to a scroll change by setting the start position of the viewport.
742 protected void adjustScrollingWrapped(AdjustmentEvent evt)
744 if (evt.getSource() == hscroll)
746 return; // no horizontal scroll when wrapped
748 final ViewportRanges ranges = av.getRanges();
750 if (evt.getSource() == vscroll)
752 int newY = vscroll.getValue();
755 * if we're scrolling to the position we're already at, stop
756 * this prevents infinite recursion of events when the scroll/viewport
757 * ranges values are the same
759 int oldX = ranges.getStartRes();
760 int oldY = ranges.getWrappedScrollPosition(oldX);
768 * limit page up/down to one width's worth of positions
770 int rowSize = ranges.getViewportWidth();
771 int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
772 ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
777 // This is only called if file loaded is a jar file that
778 // was wrapped when saved and user has wrap alignment true
779 // as preference setting
780 SwingUtilities.invokeLater(new Runnable()
785 // When updating scrolling to use ViewportChange events, this code
786 // could not be validated and it is not clear if it is now being
787 // called. Log warning here in case it is called and unforeseen
790 "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
792 // scroll to start of panel
793 ranges.setStartRes(0);
794 ranges.setStartSeq(0);
802 * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
805 public void paintAlignment(boolean updateOverview,
806 boolean updateStructures)
810 if (updateStructures)
812 av.getStructureSelectionManager().sequenceColoursChanged(this);
817 if (overviewPanel != null)
819 overviewPanel.updateOverviewImage();
825 * Sorts annotations according to currently selected preferences. Does nothing
826 * if currently set to 'Custom' (manual) ordering.
828 void sortAnnotations()
830 SequenceAnnotationOrder sortBy = av.getSortAnnotationsBy();
831 if (sortBy != SequenceAnnotationOrder.CUSTOM)
833 final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
834 av.isShowAutocalculatedAbove());
835 sorter.sort(getAlignment().getAlignmentAnnotation(), sortBy);
846 public void paintComponent(Graphics g)
848 invalidate(); // needed so that the id width adjuster works correctly
850 Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
851 idPanelHolder.setPreferredSize(d);
852 hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
854 validate(); // needed so that the id width adjuster works correctly
857 * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
858 * though I still think this call should be elsewhere.
860 ViewportRanges ranges = av.getRanges();
861 setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
865 * Set vertical scroll bar position, and number of increments, for wrapped
868 * @param topLeftColumn
869 * the column position at top left (0..)
871 private void setScrollingForWrappedPanel(int topLeftColumn)
873 ViewportRanges ranges = av.getRanges();
874 int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
875 int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
878 * a scrollbar's value can be set to at most (maximum-extent)
879 * so we add extent (1) to the maxScroll value
881 vscroll.setUnitIncrement(1);
882 vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
895 * @return DOCUMENT ME!
897 * @throws PrinterException
901 public int print(Graphics pg, PageFormat pf, int pi)
902 throws PrinterException
904 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
906 int pwidth = (int) pf.getImageableWidth();
907 int pheight = (int) pf.getImageableHeight();
909 if (av.getWrapAlignment())
911 return printWrappedAlignment(pwidth, pheight, pi, pg);
915 return printUnwrapped(pwidth, pheight, pi, pg, pg);
920 * Draws the alignment image, including sequence ids, sequences, and
921 * annotation labels and annotations if shown, on either one or two Graphics
931 * the graphics context for sequence ids and annotation labels
932 * @param alignmentGraphics
933 * the graphics context for sequences and annotations (may or may not
934 * be the same context as idGraphics)
936 * @throws PrinterException
938 public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
939 Graphics idGraphics, Graphics alignmentGraphics)
940 throws PrinterException
942 final int idWidth = getVisibleIdWidth(false);
945 * Get the horizontal offset to where we draw the sequences.
946 * This is idWidth if using a single Graphics context, else zero.
948 final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
951 FontMetrics fm = getFontMetrics(av.getFont());
952 final int charHeight = av.getCharHeight();
953 final int scaleHeight = charHeight + fm.getDescent();
955 idGraphics.setColor(Color.white);
956 idGraphics.fillRect(0, 0, pageWidth, pageHeight);
957 idGraphics.setFont(av.getFont());
960 * How many sequences and residues can we fit on a printable page?
962 final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
964 final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
966 final int alignmentWidth = av.getAlignment().getVisibleWidth();
967 int pagesWide = (alignmentWidth / totalRes) + 1;
969 final int startRes = (pageIndex % pagesWide) * totalRes;
970 final int endRes = Math.min(startRes + totalRes - 1,
973 final int startSeq = (pageIndex / pagesWide) * totalSeq;
974 final int alignmentHeight = av.getAlignment().getHeight();
975 final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
977 int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
979 if (av.isShowAnnotation())
981 pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
984 pagesHigh /= pageHeight;
986 if (pageIndex >= (pagesWide * pagesHigh))
988 return Printable.NO_SUCH_PAGE;
990 final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
993 * draw the Scale at horizontal offset, then reset to top left (0, 0)
995 alignmentGraphics.translate(alignmentGraphicsOffset, 0);
996 getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
997 pageWidth - idWidth, scaleHeight);
998 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1001 * Draw the sequence ids, offset for scale height,
1002 * then reset to top left (0, 0)
1004 idGraphics.translate(0, scaleHeight);
1005 IdCanvas idCanvas = getIdPanel().getIdCanvas();
1006 List<SequenceI> selection = av.getSelectionGroup() == null ? null
1007 : av.getSelectionGroup().getSequences(null);
1008 idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
1011 idGraphics.setFont(av.getFont());
1012 idGraphics.translate(0, -scaleHeight);
1015 * draw the sequences, offset for scale height, and id width (if using a
1016 * single graphics context), then reset to (0, scale height)
1018 alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1019 getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics, startRes,
1020 endRes, startSeq, endSeq - 1);
1021 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1023 if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1026 * draw annotation labels; drawComponent() translates by
1027 * getScrollOffset(), so compensate for that first;
1028 * then reset to (0, scale height)
1030 int offset = getAlabels().getScrollOffset();
1031 idGraphics.translate(0, -offset);
1032 idGraphics.translate(0, alignmentDrawnHeight);
1033 getAlabels().drawComponent(idGraphics, idWidth);
1034 idGraphics.translate(0, -alignmentDrawnHeight);
1037 * draw the annotations starting at
1038 * (idOffset, alignmentHeight) from (0, scaleHeight)
1040 alignmentGraphics.translate(alignmentGraphicsOffset,
1041 alignmentDrawnHeight);
1042 getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1043 alignmentGraphics, -1, startRes, endRes + 1);
1046 return Printable.PAGE_EXISTS;
1050 * Prints one page of an alignment in wrapped mode. Returns
1051 * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
1052 * no page could be drawn (page number out of range).
1062 * @throws PrinterException
1064 public int printWrappedAlignment(int pageWidth, int pageHeight, int pageNumber,
1065 Graphics g) throws PrinterException
1067 int annotationHeight = 0;
1068 if (av.isShowAnnotation())
1070 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1073 int hgap = av.getCharHeight();
1074 if (av.getScaleAboveWrapped())
1076 hgap += av.getCharHeight();
1079 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1082 int idWidth = getVisibleIdWidth(false);
1084 int maxwidth = av.getAlignment().getVisibleWidth();
1086 int resWidth = getSeqPanel().seqCanvas
1087 .getWrappedCanvasWidth(pageWidth - idWidth);
1089 int totalHeight = cHeight * (maxwidth / resWidth + 1);
1091 g.setColor(Color.white);
1092 g.fillRect(0, 0, pageWidth, pageHeight);
1093 g.setFont(av.getFont());
1094 g.setColor(Color.black);
1097 * method: print the whole wrapped alignment, but with a clip region that
1098 * is restricted to the requested page; this supports selective print of
1099 * single pages or ranges, (at the cost of some repeated processing in
1100 * the 'normal' case, when all pages are printed)
1102 g.translate(0, -pageNumber * pageHeight);
1104 g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
1107 * draw sequence ids and annotation labels (if shown)
1109 IdCanvas idCanvas = getIdPanel().getIdCanvas();
1110 idCanvas.drawIdsWrapped((Graphics2D) g, av, 0, totalHeight);
1112 g.translate(idWidth, 0);
1114 getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g, pageWidth - idWidth,
1117 if ((pageNumber * pageHeight) < totalHeight)
1119 return Printable.PAGE_EXISTS;
1123 return Printable.NO_SUCH_PAGE;
1128 * get current sequence ID panel width, or nominal value if panel were to be
1129 * displayed using default settings
1133 public int getVisibleIdWidth()
1135 return getVisibleIdWidth(true);
1139 * get current sequence ID panel width, or nominal value if panel were to be
1140 * displayed using default settings
1143 * indicate if the Id width for onscreen or offscreen display should
1147 public int getVisibleIdWidth(boolean onscreen)
1149 // see if rendering offscreen - check preferences and calc width accordingly
1150 if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1152 return calculateIdWidth(-1).width + 4;
1154 Integer idwidth = null;
1155 if (onscreen || (idwidth = Cache
1156 .getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1158 int w = getIdPanel().getWidth();
1159 return (w > 0 ? w : calculateIdWidth().width + 4);
1161 return idwidth.intValue() + 4;
1164 void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1166 int boarderBottomOffset = 5;
1167 long pSessionId = System.currentTimeMillis();
1168 headless = (System.getProperty("java.awt.headless") != null
1169 && System.getProperty("java.awt.headless").equals("true"));
1170 if (alignFrame != null && !headless)
1174 alignFrame.setProgressBar(MessageManager
1175 .formatMessage("status.saving_file", new Object[]
1176 { type.getLabel() }), pSessionId);
1181 AlignmentDimension aDimension = getAlignmentDimension();
1184 jalview.util.ImageMaker im;
1185 final String imageAction, imageTitle;
1186 if (type == jalview.util.ImageMaker.TYPE.PNG)
1188 imageAction = "Create PNG image from alignment";
1191 else if (type == jalview.util.ImageMaker.TYPE.EPS)
1193 imageAction = "Create EPS file from alignment";
1194 imageTitle = alignFrame.getTitle();
1198 imageAction = "Create SVG file from alignment";
1199 imageTitle = alignFrame.getTitle();
1202 im = new jalview.util.ImageMaker(this, type, imageAction,
1203 aDimension.getWidth(),
1204 aDimension.getHeight() + boarderBottomOffset, file,
1205 imageTitle, alignFrame, pSessionId, headless);
1206 Graphics graphics = im.getGraphics();
1207 if (av.getWrapAlignment())
1209 if (graphics != null)
1211 printWrappedAlignment(aDimension.getWidth(),
1212 aDimension.getHeight() + boarderBottomOffset, 0,
1219 if (graphics != null)
1221 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1222 graphics, graphics);
1227 } catch (OutOfMemoryError err)
1230 System.out.println("########################\n" + "OUT OF MEMORY "
1231 + file + "\n" + "########################");
1232 new OOMWarning("Creating Image for " + file, err);
1233 // System.out.println("Create IMAGE: " + err);
1234 } catch (Exception ex)
1236 ex.printStackTrace();
1244 public AlignmentDimension getAlignmentDimension()
1246 int maxwidth = av.getAlignment().getVisibleWidth();
1248 int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1249 + getScalePanel().getHeight();
1250 int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1252 if (av.getWrapAlignment())
1254 height = getWrappedHeight();
1257 // need to obtain default alignment width and then add in any
1258 // additional allowance for id margin
1259 // this duplicates the calculation in getWrappedHeight but adjusts for
1261 width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1262 - alignFrame.getInsets().left - alignFrame.getInsets().right
1263 - getVisibleIdWidth() + getVisibleIdWidth(false);
1267 width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1271 else if (av.isShowAnnotation())
1273 height += getAnnotationPanel().adjustPanelHeight() + 3;
1275 return new AlignmentDimension(width, height);
1282 public void makeEPS(File epsFile)
1284 makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1290 public void makePNG(File pngFile)
1292 makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1295 public void makeSVG(File svgFile)
1297 makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1300 public void makePNGImageMap(File imgMapFile, String imageName)
1302 // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1303 // ////////////////////////////////////////////
1304 int idWidth = getVisibleIdWidth(false);
1305 FontMetrics fm = getFontMetrics(av.getFont());
1306 int scaleHeight = av.getCharHeight() + fm.getDescent();
1309 // ////////////////////////////////
1310 if (imgMapFile != null)
1314 int sSize = av.getAlignment().getHeight();
1315 int alwidth = av.getAlignment().getWidth();
1316 PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1317 out.println(HTMLOutput.getImageMapHTML());
1318 out.println("<img src=\"" + imageName
1319 + "\" border=\"0\" usemap=\"#Map\" >"
1320 + "<map name=\"Map\">");
1322 for (int s = 0; s < sSize; s++)
1324 int sy = s * av.getCharHeight() + scaleHeight;
1326 SequenceI seq = av.getAlignment().getSequenceAt(s);
1327 SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1328 for (int column = 0; column < alwidth; column++)
1330 StringBuilder text = new StringBuilder(512);
1331 String triplet = null;
1332 if (av.getAlignment().isNucleotide())
1334 triplet = ResidueProperties.nucleotideName.get(seq
1335 .getCharAt(column) + "");
1339 triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(column)
1343 if (triplet == null)
1348 int seqPos = seq.findPosition(column);
1349 int gSize = groups.length;
1350 for (int g = 0; g < gSize; g++)
1352 if (text.length() < 1)
1354 text.append("<area shape=\"rect\" coords=\"")
1355 .append((idWidth + column * av.getCharWidth()))
1356 .append(",").append(sy).append(",")
1357 .append((idWidth + (column + 1) * av.getCharWidth()))
1358 .append(",").append((av.getCharHeight() + sy))
1359 .append("\"").append(" onMouseOver=\"toolTip('")
1360 .append(seqPos).append(" ").append(triplet);
1363 if (groups[g].getStartRes() < column
1364 && groups[g].getEndRes() > column)
1366 text.append("<br><em>").append(groups[g].getName())
1371 if (text.length() < 1)
1373 text.append("<area shape=\"rect\" coords=\"")
1374 .append((idWidth + column * av.getCharWidth()))
1375 .append(",").append(sy).append(",")
1376 .append((idWidth + (column + 1) * av.getCharWidth()))
1377 .append(",").append((av.getCharHeight() + sy))
1378 .append("\"").append(" onMouseOver=\"toolTip('")
1379 .append(seqPos).append(" ").append(triplet);
1381 if (!Comparison.isGap(seq.getCharAt(column)))
1383 List<SequenceFeature> features = seq.findFeatures(column, column);
1384 for (SequenceFeature sf : features)
1386 if (sf.isContactFeature())
1388 text.append("<br>").append(sf.getType()).append(" ")
1389 .append(sf.getBegin()).append(":")
1390 .append(sf.getEnd());
1394 text.append("<br>");
1395 text.append(sf.getType());
1396 String description = sf.getDescription();
1397 if (description != null
1398 && !sf.getType().equals(description))
1400 description = description.replace("\"", """);
1401 text.append(" ").append(description);
1404 String status = sf.getStatus();
1405 if (status != null && !"".equals(status))
1407 text.append(" (").append(status).append(")");
1410 if (text.length() > 1)
1412 text.append("')\"; onMouseOut=\"toolTip()\"; href=\"#\">");
1413 out.println(text.toString());
1418 out.println("</map></body></html>");
1421 } catch (Exception ex)
1423 ex.printStackTrace();
1425 } // /////////END OF IMAGE MAP
1429 int getWrappedHeight()
1431 int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1433 if (System.getProperty("java.awt.headless") != null
1434 && System.getProperty("java.awt.headless").equals("true"))
1436 seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1437 - vscroll.getPreferredSize().width
1438 - alignFrame.getInsets().left - alignFrame.getInsets().right;
1441 int chunkWidth = getSeqPanel().seqCanvas
1442 .getWrappedCanvasWidth(seqPanelWidth);
1444 int hgap = av.getCharHeight();
1445 if (av.getScaleAboveWrapped())
1447 hgap += av.getCharHeight();
1450 int annotationHeight = 0;
1451 if (av.isShowAnnotation())
1453 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1456 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1459 int maxwidth = av.getAlignment().getWidth();
1460 if (av.hasHiddenColumns())
1462 maxwidth = av.getAlignment().getHiddenColumns()
1463 .absoluteToVisibleColumn(maxwidth) - 1;
1466 int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1472 * close the panel - deregisters all listeners and nulls any references to
1475 public void closePanel()
1477 PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1478 PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1479 PaintRefresher.RemoveComponent(this);
1484 * try to ensure references are nulled
1486 if (annotationPanel != null)
1488 annotationPanel.dispose();
1489 annotationPanel = null;
1494 av.removePropertyChangeListener(propertyChangeListener);
1495 propertyChangeListener = null;
1496 StructureSelectionManager ssm = av.getStructureSelectionManager();
1497 ssm.removeStructureViewerListener(getSeqPanel(), null);
1498 ssm.removeSelectionListener(getSeqPanel());
1499 ssm.removeCommandListener(av);
1500 ssm.removeStructureViewerListener(getSeqPanel(), null);
1501 ssm.removeSelectionListener(getSeqPanel());
1507 if (Cache.log.isDebugEnabled())
1509 Cache.log.warn("Closing alignment panel which is already closed.");
1515 * Close any open dialogs that would be orphaned when this one is closed
1517 protected void closeChildFrames()
1519 if (overviewPanel != null)
1521 overviewPanel.dispose();
1522 overviewPanel = null;
1524 if (calculationDialog != null)
1526 calculationDialog.closeFrame();
1527 calculationDialog = null;
1532 * hides or shows dynamic annotation rows based on groups and av state flags
1534 public void updateAnnotation()
1536 updateAnnotation(false, false);
1539 public void updateAnnotation(boolean applyGlobalSettings)
1541 updateAnnotation(applyGlobalSettings, false);
1544 public void updateAnnotation(boolean applyGlobalSettings,
1545 boolean preserveNewGroupSettings)
1547 av.updateGroupAnnotationSettings(applyGlobalSettings,
1548 preserveNewGroupSettings);
1549 adjustAnnotationHeight();
1553 public AlignmentI getAlignment()
1555 return av == null ? null : av.getAlignment();
1559 public String getViewName()
1561 return av.getViewName();
1565 * Make/Unmake this alignment panel the current input focus
1569 public void setSelected(boolean b)
1573 if (alignFrame.getSplitViewContainer() != null)
1576 * bring enclosing SplitFrame to front first if there is one
1578 ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1580 alignFrame.setSelected(b);
1581 } catch (Exception ex)
1587 alignFrame.setDisplayedView(this);
1592 public StructureSelectionManager getStructureSelectionManager()
1594 return av.getStructureSelectionManager();
1598 public void raiseOOMWarning(String string, OutOfMemoryError error)
1600 new OOMWarning(string, error, this);
1604 public jalview.api.FeatureRenderer cloneFeatureRenderer()
1607 return new FeatureRenderer(this);
1611 public jalview.api.FeatureRenderer getFeatureRenderer()
1613 return seqPanel.seqCanvas.getFeatureRenderer();
1616 public void updateFeatureRenderer(
1617 jalview.renderer.seqfeatures.FeatureRenderer fr)
1619 fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1622 public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1624 if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1626 getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1630 public ScalePanel getScalePanel()
1635 public void setScalePanel(ScalePanel scalePanel)
1637 this.scalePanel = scalePanel;
1640 public SeqPanel getSeqPanel()
1645 public void setSeqPanel(SeqPanel seqPanel)
1647 this.seqPanel = seqPanel;
1650 public AnnotationPanel getAnnotationPanel()
1652 return annotationPanel;
1655 public void setAnnotationPanel(AnnotationPanel annotationPanel)
1657 this.annotationPanel = annotationPanel;
1660 public AnnotationLabels getAlabels()
1665 public void setAlabels(AnnotationLabels alabels)
1667 this.alabels = alabels;
1670 public IdPanel getIdPanel()
1675 public void setIdPanel(IdPanel idPanel)
1677 this.idPanel = idPanel;
1681 * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1682 * The aim is to keep the two alignments 'lined up' on their centre columns.
1685 * holds mapped region(s) of this alignment that we are scrolling
1686 * 'to'; may be modified for sequence offset by this method
1687 * @param verticalOffset
1688 * the number of visible sequences to show above the mapped region
1690 protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1692 scrollToPosition(sr, verticalOffset, true);
1696 * Set a flag to say do not scroll any (cDNA/protein) complement.
1700 protected void setToScrollComplementPanel(boolean b)
1702 this.scrollComplementaryPanel = b;
1706 * Get whether to scroll complement panel
1708 * @return true if cDNA/protein complement panels should be scrolled
1710 protected boolean isSetToScrollComplementPanel()
1712 return this.scrollComplementaryPanel;
1718 * @adjustHeight if true, try to recalculate panel height for visible
1721 protected void refresh(boolean adjustHeight)
1723 validateAnnotationDimensions(adjustHeight);
1727 // sort, repaint, update overview
1728 paintAlignment(true, false);
1732 // lightweight repaint
1739 * Property change event fired when a change is made to the viewport ranges
1740 * object associated with this alignment panel's viewport
1742 public void propertyChange(PropertyChangeEvent evt)
1744 // update this panel's scroll values based on the new viewport ranges values
1745 ViewportRanges ranges = av.getRanges();
1746 int x = ranges.getStartRes();
1747 int y = ranges.getStartSeq();
1748 setScrollValues(x, y);
1750 // now update any complementary alignment (its viewport ranges object
1751 // is different so does not get automatically updated)
1752 if (isSetToScrollComplementPanel())
1754 setToScrollComplementPanel(false);
1755 av.scrollComplementaryAlignment();
1756 setToScrollComplementPanel(true);
1761 * Set the reference to the PCA/Tree chooser dialog for this panel. This
1762 * reference should be nulled when the dialog is closed.
1764 * @param calculationChooser
1766 public void setCalculationDialog(CalculationChooser calculationChooser)
1768 calculationDialog = calculationChooser;
1772 * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1775 public CalculationChooser getCalculationDialog()
1777 return calculationDialog;