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 java.awt.BorderLayout;
24 import java.awt.Color;
25 import java.awt.Container;
26 import java.awt.Dimension;
28 import java.awt.FontMetrics;
29 import java.awt.Graphics;
30 import java.awt.Graphics2D;
31 import java.awt.event.AdjustmentEvent;
32 import java.awt.event.AdjustmentListener;
33 import java.awt.event.ComponentAdapter;
34 import java.awt.event.ComponentEvent;
35 import java.awt.print.PageFormat;
36 import java.awt.print.Printable;
37 import java.awt.print.PrinterException;
38 import java.beans.PropertyChangeEvent;
39 import java.beans.PropertyChangeListener;
41 import java.io.FileWriter;
42 import java.io.PrintWriter;
43 import java.util.List;
45 import javax.swing.SwingUtilities;
47 import jalview.analysis.AnnotationSorter;
48 import jalview.api.AlignViewportI;
49 import jalview.api.AlignmentViewPanel;
50 import jalview.bin.Cache;
51 import jalview.bin.Console;
52 import jalview.bin.Jalview;
53 import jalview.datamodel.AlignmentAnnotation;
54 import jalview.datamodel.AlignmentI;
55 import jalview.datamodel.HiddenColumns;
56 import jalview.datamodel.SearchResultsI;
57 import jalview.datamodel.SequenceFeature;
58 import jalview.datamodel.SequenceGroup;
59 import jalview.datamodel.SequenceI;
60 import jalview.gui.ImageExporter.ImageWriterI;
61 import jalview.io.HTMLOutput;
62 import jalview.io.exceptions.ImageOutputException;
63 import jalview.jbgui.GAlignmentPanel;
64 import jalview.math.AlignmentDimension;
65 import jalview.schemes.ResidueProperties;
66 import jalview.structure.StructureSelectionManager;
67 import jalview.util.Comparison;
68 import jalview.util.ImageMaker;
69 import jalview.util.MessageManager;
70 import jalview.util.imagemaker.BitmapImageSizing;
71 import jalview.viewmodel.ViewportListenerI;
72 import jalview.viewmodel.ViewportRanges;
78 * @version $Revision: 1.161 $
80 @SuppressWarnings("serial")
81 public class AlignmentPanel extends GAlignmentPanel implements
82 AdjustmentListener, Printable, AlignmentViewPanel, ViewportListenerI
85 * spare space in pixels between sequence id and alignment panel
87 private static final int ID_WIDTH_PADDING = 4;
89 public AlignViewport av;
91 OverviewPanel overviewPanel;
93 private SeqPanel seqPanel;
95 private IdPanel idPanel;
97 IdwidthAdjuster idwidthAdjuster;
99 public AlignFrame alignFrame;
101 private ScalePanel scalePanel;
103 private AnnotationPanel annotationPanel;
105 private AnnotationLabels alabels;
107 private int hextent = 0;
109 private int vextent = 0;
112 * Flag set while scrolling to follow complementary cDNA/protein scroll. When
113 * false, suppresses invoking the same method recursively.
115 private boolean scrollComplementaryPanel = true;
117 private PropertyChangeListener propertyChangeListener;
119 private CalculationChooser calculationDialog;
122 * Creates a new AlignmentPanel object.
127 public AlignmentPanel(AlignFrame af, final AlignViewport av)
129 // setBackground(Color.white); // BH 2019
132 setSeqPanel(new SeqPanel(av, this));
133 setIdPanel(new IdPanel(av, this));
135 setScalePanel(new ScalePanel(av, this));
137 idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
138 idwidthAdjuster = new IdwidthAdjuster(this);
139 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
141 setAnnotationPanel(new AnnotationPanel(this));
142 setAlabels(new AnnotationLabels(this));
144 annotationScroller.setViewportView(getAnnotationPanel());
145 annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
147 scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
148 seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
150 setScrollValues(0, 0);
152 hscroll.addAdjustmentListener(this);
153 vscroll.addAdjustmentListener(this);
155 addComponentListener(new ComponentAdapter()
158 public void componentResized(ComponentEvent evt)
160 // reset the viewport ranges when the alignment panel is resized
161 // in particular, this initialises the end residue value when Jalview
163 ViewportRanges ranges = av.getRanges();
164 if (av.getWrapAlignment())
166 int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
167 getSeqPanel().seqCanvas.getWidth());
168 ranges.setViewportWidth(widthInRes);
172 int widthInRes = getSeqPanel().seqCanvas.getWidth()
174 int heightInSeq = getSeqPanel().seqCanvas.getHeight()
175 / av.getCharHeight();
177 ranges.setViewportWidth(widthInRes);
178 ranges.setViewportHeight(heightInSeq);
184 final AlignmentPanel ap = this;
185 propertyChangeListener = new PropertyChangeListener()
188 public void propertyChange(PropertyChangeEvent evt)
190 if (evt.getPropertyName().equals("alignment"))
192 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
197 av.addPropertyChangeListener(propertyChangeListener);
199 av.getRanges().addPropertyChangeListener(this);
201 adjustAnnotationHeight();
206 public AlignViewportI getAlignViewport()
211 public void alignmentChanged()
213 av.alignmentChanged(this);
215 if (getCalculationDialog() != null)
217 getCalculationDialog().validateCalcTypes();
220 alignFrame.updateEditMenuBar();
222 // no idea if we need to update structure
223 paintAlignment(true, true);
230 public void fontChanged()
232 // set idCanvas bufferedImage to null
233 // to prevent drawing old image
234 FontMetrics fm = getFontMetrics(av.getFont());
236 // update the flag controlling whether the grid is too small to render the
238 av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
240 scalePanelHolder.setPreferredSize(
241 new Dimension(10, av.getCharHeight() + fm.getDescent()));
242 idSpaceFillerPanel1.setPreferredSize(
243 new Dimension(10, av.getCharHeight() + fm.getDescent()));
244 idwidthAdjuster.invalidate();
245 scalePanelHolder.invalidate();
246 // BH 2018 getIdPanel().getIdCanvas().gg = null;
247 getSeqPanel().seqCanvas.img = null;
248 getAnnotationPanel().adjustPanelHeight();
250 Dimension d = calculateIdWidth();
251 getIdPanel().getIdCanvas().setPreferredSize(d);
252 hscrollFillerPanel.setPreferredSize(d);
258 * Calculates the width of the alignment labels based on the displayed names
259 * and any bounds on label width set in preferences. The calculated width is
260 * also set as a property of the viewport.
262 * @return Dimension giving the maximum width of the alignment label panel
263 * that should be used.
265 public Dimension calculateIdWidth()
267 int oldWidth = av.getIdWidth();
269 // calculate sensible default width when no preference is available
271 if (av.getIdWidth() < 0)
273 r = calculateDefaultAlignmentIdWidth();
274 av.setIdWidth(r.width);
279 r.width = av.getIdWidth();
284 * fudge: if desired width has changed, update layout
285 * (see also paintComponent - updates layout on a repaint)
287 if (r.width != oldWidth)
289 idPanelHolder.setPreferredSize(r);
295 public Dimension calculateDefaultAlignmentIdWidth()
297 int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
298 int idWidth = Math.min(afwidth - 200, 2 * afwidth / 3);
299 int maxwidth = Math.max(IdwidthAdjuster.MIN_ID_WIDTH, idWidth);
300 return calculateIdWidth(-1, false, false);
304 * Calculate the width of the alignment labels based on the displayed names
305 * and any bounds on label width set in preferences.
308 * -1 or maximum width allowed for IdWidth
309 * @return Dimension giving the maximum width of the alignment label panel
310 * that should be used.
312 protected Dimension calculateIdWidth(int maxwidth)
314 return calculateIdWidth(maxwidth, true, false);
317 public Dimension calculateIdWidth(int maxwidth,
318 boolean includeAnnotations, boolean visibleOnly)
320 Container c = new Container();
322 FontMetrics fm = c.getFontMetrics(
323 new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
325 AlignmentI al = av.getAlignment();
329 while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
331 SequenceI s = al.getSequenceAt(i);
332 String id = s.getDisplayId(av.getShowJVSuffix());
333 int stringWidth = fm.stringWidth(id);
334 idWidth = Math.max(idWidth, stringWidth);
338 // Also check annotation label widths
339 if (includeAnnotations && al.getAlignmentAnnotation() != null)
341 if (Jalview.isHeadlessMode())
343 AnnotationLabels aal = this.getAlabels();
344 int stringWidth = aal.drawLabels(null, false, idWidth, false, fm);
345 idWidth = Math.max(idWidth, stringWidth);
349 fm = c.getFontMetrics(getAlabels().getFont());
351 for (i = 0; i < al.getAlignmentAnnotation().length; i++)
353 AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
354 if (visibleOnly && !aa.visible)
358 String label = aa.label;
359 int stringWidth = fm.stringWidth(label);
360 idWidth = Math.max(idWidth, stringWidth);
365 int w = maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth);
366 w += ID_WIDTH_PADDING;
368 return new Dimension(w, 12);
372 * Highlight the given results on the alignment
375 public void highlightSearchResults(SearchResultsI results)
377 boolean scrolled = scrollToPosition(results, 0, false);
379 boolean fastPaint = !(scrolled && av.getWrapAlignment());
381 getSeqPanel().seqCanvas.highlightSearchResults(results, fastPaint);
385 * Scroll the view to show the position of the highlighted region in results
388 * @param searchResults
391 public boolean scrollToPosition(SearchResultsI searchResults)
393 return scrollToPosition(searchResults, 0, false);
397 * Scrolls the view (if necessary) to show the position of the first
398 * highlighted region in results (if any). Answers true if the view was
399 * scrolled, or false if no matched region was found, or it is already
403 * @param verticalOffset
404 * if greater than zero, allows scrolling to a position below the
405 * first displayed sequence
407 * if true, try to centre the search results horizontally in the view
410 protected boolean scrollToPosition(SearchResultsI results,
411 int verticalOffset, boolean centre)
413 int startv, endv, starts, ends;
414 ViewportRanges ranges = av.getRanges();
416 if (results == null || results.isEmpty() || av == null
417 || av.getAlignment() == null)
421 int seqIndex = av.getAlignment().findIndex(results);
426 SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
428 int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
437 * To centre results, scroll to positions half the visible width
438 * left/right of the start/end positions
442 int offset = (ranges.getEndRes() - ranges.getStartRes() + 1) / 2 - 1;
443 start = Math.max(start - offset, 0);
444 end = end + offset - 1;
450 if (end == seq.getEnd())
455 if (av.hasHiddenColumns())
457 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
458 start = hidden.absoluteToVisibleColumn(start);
459 end = hidden.absoluteToVisibleColumn(end);
462 if (!hidden.isVisible(r[0]))
464 // don't scroll - position isn't visible
471 * allow for offset of target sequence (actually scroll to one above it)
473 seqIndex = Math.max(0, seqIndex - verticalOffset);
474 boolean scrollNeeded = true;
476 if (!av.getWrapAlignment())
478 if ((startv = ranges.getStartRes()) >= start)
481 * Scroll left to make start of search results visible
483 setScrollValues(start, seqIndex);
485 else if ((endv = ranges.getEndRes()) <= end)
488 * Scroll right to make end of search results visible
490 setScrollValues(startv + end - endv, seqIndex);
492 else if ((starts = ranges.getStartSeq()) > seqIndex)
495 * Scroll up to make start of search results visible
497 setScrollValues(ranges.getStartRes(), seqIndex);
499 else if ((ends = ranges.getEndSeq()) <= seqIndex)
502 * Scroll down to make end of search results visible
504 setScrollValues(ranges.getStartRes(), starts + seqIndex - ends + 1);
507 * Else results are already visible - no need to scroll
509 scrollNeeded = false;
513 scrollNeeded = ranges.scrollToWrappedVisible(start);
516 paintAlignment(false, false);
524 * @return DOCUMENT ME!
526 public OverviewPanel getOverviewPanel()
528 return overviewPanel;
537 public void setOverviewPanel(OverviewPanel op)
545 * Hide or show annotation panel
548 public void setAnnotationVisible(boolean b)
550 if (!av.getWrapAlignment())
552 annotationSpaceFillerHolder.setVisible(b);
553 annotationScroller.setVisible(b);
559 * automatically adjust annotation panel height for new annotation whilst
560 * ensuring the alignment is still visible.
563 public void adjustAnnotationHeight()
565 // TODO: display vertical annotation scrollbar if necessary
566 // this is called after loading new annotation onto alignment
567 if (alignFrame.getHeight() == 0)
569 System.out.println("NEEDS FIXING");
571 validateAnnotationDimensions(true);
573 // TODO: many places call this method and also paintAlignment with various
574 // different settings. this means multiple redraws are triggered...
575 paintAlignment(true, av.needToUpdateStructureViews());
579 * calculate the annotation dimensions and refresh slider values accordingly.
580 * need to do repaints/notifys afterwards.
582 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
584 // BH 2018.04.18 comment: addNotify() is not appropriate here. We
585 // are not changing ancestors, and keyboard action listeners do
586 // not need to be reset. addNotify() is a very expensive operation,
587 // requiring a full re-layout of all parents and children.
588 // Note in JComponent:
589 // This method is called by the toolkit internally and should
590 // not be called directly by programs.
591 // I note that addNotify() is called in several areas of Jalview.
593 AnnotationPanel ap = getAnnotationPanel();
594 int annotationHeight = ap.adjustPanelHeight();
595 annotationHeight = ap.adjustForAlignFrame(adjustPanelHeight,
599 Dimension e = idPanel.getSize();
600 int idWidth = e.width;
601 boolean manuallyAdjusted = this.getIdPanel().getIdCanvas()
603 annotationScroller.setPreferredSize(new Dimension(
604 manuallyAdjusted ? idWidth : annotationScroller.getWidth(),
607 alabels.setPreferredSize(new Dimension(idWidth, annotationHeight));
609 annotationSpaceFillerHolder.setPreferredSize(new Dimension(
610 manuallyAdjusted ? idWidth
611 : annotationSpaceFillerHolder.getWidth(),
613 annotationScroller.validate();
614 annotationScroller.addNotify();
619 * update alignment layout for viewport settings
624 public void updateLayout()
627 setAnnotationVisible(av.isShowAnnotation());
628 boolean wrap = av.getWrapAlignment();
629 ViewportRanges ranges = av.getRanges();
630 ranges.setStartSeq(0);
631 scalePanelHolder.setVisible(!wrap);
632 hscroll.setVisible(!wrap);
633 // Allow idPanel width adjustment in wrap mode
634 idwidthAdjuster.setVisible(true);
638 annotationScroller.setVisible(false);
639 annotationSpaceFillerHolder.setVisible(false);
641 else if (av.isShowAnnotation())
643 annotationScroller.setVisible(true);
644 annotationSpaceFillerHolder.setVisible(true);
645 validateAnnotationDimensions(false);
648 int canvasWidth = getSeqPanel().seqCanvas.getWidth();
650 { // may not yet be laid out
653 int widthInRes = getSeqPanel().seqCanvas
654 .getWrappedCanvasWidth(canvasWidth);
655 ranges.setViewportWidth(widthInRes);
659 int widthInRes = (canvasWidth / av.getCharWidth());
660 int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
661 / av.getCharHeight());
663 ranges.setViewportWidth(widthInRes);
664 ranges.setViewportHeight(heightInSeq);
668 // idSpaceFillerPanel1.setVisible(!wrap);
674 * Adjust row/column scrollers to show a visible position in the alignment.
677 * visible column to scroll to
679 * visible row to scroll to
682 public void setScrollValues(int xpos, int ypos)
687 if (av == null || av.getAlignment() == null)
692 if (av.getWrapAlignment())
694 setScrollingForWrappedPanel(x);
698 int width = av.getAlignment().getVisibleWidth();
699 int height = av.getAlignment().getHeight();
701 hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
702 vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
709 if (vextent > height)
714 if ((hextent + x) > width)
719 if ((vextent + y) > height)
721 y = height - vextent;
734 // update the scroll values
735 hscroll.setValues(x, hextent, 0, width);
736 vscroll.setValues(y, vextent, 0, height);
741 * Respond to adjustment event when horizontal or vertical scrollbar is
745 * adjustment event encoding whether hscroll or vscroll changed
748 public void adjustmentValueChanged(AdjustmentEvent evt)
750 if (av.getWrapAlignment())
752 adjustScrollingWrapped(evt);
756 ViewportRanges ranges = av.getRanges();
758 if (evt.getSource() == hscroll)
760 int oldX = ranges.getStartRes();
761 int oldwidth = ranges.getViewportWidth();
762 int x = hscroll.getValue();
763 int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
765 // if we're scrolling to the position we're already at, stop
766 // this prevents infinite recursion of events when the scroll/viewport
767 // ranges values are the same
768 if ((x == oldX) && (width == oldwidth))
772 ranges.setViewportStartAndWidth(x, width);
774 else if (evt.getSource() == vscroll)
776 int oldY = ranges.getStartSeq();
777 int oldheight = ranges.getViewportHeight();
778 int y = vscroll.getValue();
779 int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
781 // if we're scrolling to the position we're already at, stop
782 // this prevents infinite recursion of events when the scroll/viewport
783 // ranges values are the same
784 if ((y == oldY) && (height == oldheight))
788 ranges.setViewportStartAndHeight(y, height);
794 * Responds to a scroll change by setting the start position of the viewport.
799 protected void adjustScrollingWrapped(AdjustmentEvent evt)
801 if (evt.getSource() == hscroll)
803 return; // no horizontal scroll when wrapped
805 final ViewportRanges ranges = av.getRanges();
807 if (evt.getSource() == vscroll)
809 int newY = vscroll.getValue();
812 * if we're scrolling to the position we're already at, stop
813 * this prevents infinite recursion of events when the scroll/viewport
814 * ranges values are the same
816 int oldX = ranges.getStartRes();
817 int oldY = ranges.getWrappedScrollPosition(oldX);
825 * limit page up/down to one width's worth of positions
827 int rowSize = ranges.getViewportWidth();
828 int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
829 ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
834 // This is only called if file loaded is a jar file that
835 // was wrapped when saved and user has wrap alignment true
836 // as preference setting
837 SwingUtilities.invokeLater(new Runnable()
842 // When updating scrolling to use ViewportChange events, this code
843 // could not be validated and it is not clear if it is now being
844 // called. Log warning here in case it is called and unforeseen
847 "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
849 // scroll to start of panel
850 ranges.setStartRes(0);
851 ranges.setStartSeq(0);
859 * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
862 public void paintAlignment(boolean updateOverview,
863 boolean updateStructures)
865 final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
866 av.isShowAutocalculatedAbove());
867 sorter.sort(getAlignment().getAlignmentAnnotation(),
868 av.getSortAnnotationsBy());
871 if (updateStructures)
873 av.getStructureSelectionManager().sequenceColoursChanged(this);
878 if (overviewPanel != null)
880 overviewPanel.updateOverviewImage();
886 public void paintComponent(Graphics g)
888 invalidate(); // needed so that the id width adjuster works correctly
889 Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
890 int idWidth = d.width;
892 // check wrapped alignment as at least 1 residue width
893 if (av.getWrapAlignment())
895 SeqCanvas sc = this.getSeqPanel().seqCanvas;
896 if (sc != null && sc.getWidth() < sc.getMinimumWrappedCanvasWidth())
898 // need to make some adjustments
899 idWidth -= (sc.getMinimumWrappedCanvasWidth() - sc.getWidth());
900 av.setIdWidth(idWidth);
901 validateAnnotationDimensions(false);
905 idPanelHolder.setPreferredSize(new Dimension(idWidth, d.height));
906 hscrollFillerPanel.setPreferredSize(new Dimension(idWidth, 12));
908 validate(); // needed so that the id width adjuster works correctly
911 * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
912 * though I still think this call should be elsewhere.
914 ViewportRanges ranges = av.getRanges();
915 setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
916 super.paintComponent(g);
920 * Set vertical scroll bar position, and number of increments, for wrapped
923 * @param topLeftColumn
924 * the column position at top left (0..)
926 private void setScrollingForWrappedPanel(int topLeftColumn)
928 ViewportRanges ranges = av.getRanges();
929 int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
930 int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
933 * a scrollbar's value can be set to at most (maximum-extent)
934 * so we add extent (1) to the maxScroll value
936 vscroll.setUnitIncrement(1);
937 vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
950 * @return DOCUMENT ME!
952 * @throws PrinterException
956 public int print(Graphics pg, PageFormat pf, int pi)
957 throws PrinterException
959 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
961 int pwidth = (int) pf.getImageableWidth();
962 int pheight = (int) pf.getImageableHeight();
964 if (av.getWrapAlignment())
966 return printWrappedAlignment(pwidth, pheight, pi, pg);
970 return printUnwrapped(pwidth, pheight, pi, pg, pg);
975 * Draws the alignment image, including sequence ids, sequences, and
976 * annotation labels and annotations if shown, on either one or two Graphics
986 * the graphics context for sequence ids and annotation labels
987 * @param alignmentGraphics
988 * the graphics context for sequences and annotations (may or may not
989 * be the same context as idGraphics)
991 * @throws PrinterException
993 public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
994 Graphics idGraphics, Graphics alignmentGraphics)
995 throws PrinterException
997 final int idWidth = getVisibleIdWidth(false);
1000 * Get the horizontal offset to where we draw the sequences.
1001 * This is idWidth if using a single Graphics context, else zero.
1003 final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
1006 FontMetrics fm = getFontMetrics(av.getFont());
1007 final int charHeight = av.getCharHeight();
1008 final int scaleHeight = charHeight + fm.getDescent();
1010 idGraphics.setColor(Color.white);
1011 idGraphics.fillRect(0, 0, pageWidth, pageHeight);
1012 idGraphics.setFont(av.getFont());
1015 * How many sequences and residues can we fit on a printable page?
1017 final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
1019 final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1021 final int alignmentWidth = av.getAlignment().getVisibleWidth();
1022 int pagesWide = (alignmentWidth / totalRes) + 1;
1024 final int startRes = (pageIndex % pagesWide) * totalRes;
1025 final int endRes = Math.min(startRes + totalRes - 1,
1026 alignmentWidth - 1);
1028 final int startSeq = (pageIndex / pagesWide) * totalSeq;
1029 final int alignmentHeight = av.getAlignment().getHeight();
1030 final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
1032 int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
1034 if (av.isShowAnnotation())
1036 pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1039 pagesHigh /= pageHeight;
1041 if (pageIndex >= (pagesWide * pagesHigh))
1043 return Printable.NO_SUCH_PAGE;
1045 final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
1048 * draw the Scale at horizontal offset, then reset to top left (0, 0)
1050 alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1051 getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1052 pageWidth - idWidth, scaleHeight);
1053 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1056 * Draw the sequence ids, offset for scale height,
1057 * then reset to top left (0, 0)
1059 idGraphics.translate(0, scaleHeight);
1060 IdCanvas idCanvas = getIdPanel().getIdCanvas();
1061 List<SequenceI> selection = av.getSelectionGroup() == null ? null
1062 : av.getSelectionGroup().getSequences(null);
1063 idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
1066 idGraphics.setFont(av.getFont());
1067 idGraphics.translate(0, -scaleHeight);
1070 * draw the sequences, offset for scale height, and id width (if using a
1071 * single graphics context), then reset to (0, scale height)
1073 alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1074 getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics,
1075 startRes, endRes, startSeq, endSeq - 1);
1076 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1078 if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1081 * draw annotation labels; drawComponent() translates by
1082 * getScrollOffset(), so compensate for that first;
1083 * then reset to (0, scale height)
1085 int offset = getAlabels().getScrollOffset();
1086 idGraphics.translate(0, -offset);
1087 idGraphics.translate(0, alignmentDrawnHeight);
1088 getAlabels().drawComponent(idGraphics, idWidth);
1089 idGraphics.translate(0, -alignmentDrawnHeight);
1092 * draw the annotations starting at
1093 * (idOffset, alignmentHeight) from (0, scaleHeight)
1095 alignmentGraphics.translate(alignmentGraphicsOffset,
1096 alignmentDrawnHeight);
1098 getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1099 alignmentGraphics, -1, startRes, endRes + 1);
1102 return Printable.PAGE_EXISTS;
1106 * Prints one page of an alignment in wrapped mode. Returns
1107 * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
1108 * no page could be drawn (page number out of range).
1118 * @throws PrinterException
1120 public int printWrappedAlignment(int pageWidth, int pageHeight,
1121 int pageNumber, Graphics g) throws PrinterException
1123 getSeqPanel().seqCanvas.calculateWrappedGeometry(getWidth(),
1125 int annotationHeight = 0;
1126 if (av.isShowAnnotation())
1128 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1131 int hgap = av.getCharHeight();
1132 if (av.getScaleAboveWrapped())
1134 hgap += av.getCharHeight();
1137 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1140 int idWidth = getVisibleIdWidth(false);
1142 int maxwidth = av.getAlignment().getVisibleWidth();
1144 int resWidth = getSeqPanel().seqCanvas
1145 .getWrappedCanvasWidth(pageWidth - idWidth);
1146 av.getRanges().setViewportStartAndWidth(0, resWidth);
1148 int totalHeight = cHeight * (maxwidth / resWidth + 1);
1150 g.setColor(Color.white);
1151 g.fillRect(0, 0, pageWidth, pageHeight);
1152 g.setFont(av.getFont());
1153 g.setColor(Color.black);
1156 * method: print the whole wrapped alignment, but with a clip region that
1157 * is restricted to the requested page; this supports selective print of
1158 * single pages or ranges, (at the cost of repeated processing in the
1159 * 'normal' case, when all pages are printed)
1161 g.translate(0, -pageNumber * pageHeight);
1163 g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
1166 * draw sequence ids and annotation labels (if shown)
1168 IdCanvas idCanvas = getIdPanel().getIdCanvas();
1169 idCanvas.drawIdsWrapped((Graphics2D) g, av, 0, totalHeight);
1171 g.translate(idWidth, 0);
1173 getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g,
1174 pageWidth - idWidth, totalHeight, 0);
1176 if ((pageNumber * pageHeight) < totalHeight)
1178 return Printable.PAGE_EXISTS;
1182 return Printable.NO_SUCH_PAGE;
1187 * get current sequence ID panel width, or nominal value if panel were to be
1188 * displayed using default settings
1192 public int getVisibleIdWidth()
1194 return getVisibleIdWidth(true);
1198 * get current sequence ID panel width, or nominal value if panel were to be
1199 * displayed using default settings
1202 * indicate if the Id width for onscreen or offscreen display should
1206 protected int getVisibleIdWidth(boolean onscreen)
1208 // see if rendering offscreen - check preferences and calc width accordingly
1209 if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1211 return calculateIdWidth(-1).width;
1213 Integer idwidth = onscreen ? null
1214 : Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH");
1215 if (idwidth != null)
1217 return idwidth.intValue() + ID_WIDTH_PADDING;
1220 int w = getIdPanel().getWidth();
1221 w = this.calculateIdWidth(-1, true, true).width;
1222 return (w > 0 ? w : calculateIdWidth().width);
1225 void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer)
1226 throws ImageOutputException
1228 makeAlignmentImage(type, file, renderer,
1229 BitmapImageSizing.nullBitmapImageSizing());
1233 * Builds an image of the alignment of the specified type (EPS/PNG/SVG) and
1234 * writes it to the specified file
1238 * @param textrenderer
1239 * @param bitmapscale
1241 void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer,
1242 BitmapImageSizing userBis) throws ImageOutputException
1244 final int borderBottomOffset = 5;
1246 AlignmentDimension aDimension = getAlignmentDimension();
1248 // todo use a lambda function in place of callback here?
1249 ImageWriterI writer = new ImageWriterI()
1252 public void exportImage(Graphics graphics) throws Exception
1254 if (av.getWrapAlignment())
1256 printWrappedAlignment(aDimension.getWidth(),
1257 aDimension.getHeight() + borderBottomOffset, 0, graphics);
1261 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
1262 graphics, graphics);
1267 String fileTitle = alignFrame.getTitle();
1268 ImageExporter exporter = new ImageExporter(writer, alignFrame, type,
1270 int imageWidth = aDimension.getWidth();
1271 int imageHeight = aDimension.getHeight() + borderBottomOffset;
1272 String of = MessageManager.getString("label.alignment");
1273 exporter.doExport(file, this, imageWidth, imageHeight, of, renderer,
1278 * Calculates and returns a suitable width and height (in pixels) for an
1283 public AlignmentDimension getAlignmentDimension()
1285 int maxwidth = av.getAlignment().getVisibleWidth();
1287 int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1288 + getScalePanel().getHeight();
1289 int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1291 if (av.getWrapAlignment())
1293 height = getWrappedHeight();
1294 if (Jalview.isHeadlessMode())
1296 // need to obtain default alignment width and then add in any
1297 // additional allowance for id margin
1298 // this duplicates the calculation in getWrappedHeight but adjusts for
1300 width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1301 - alignFrame.getInsets().left - alignFrame.getInsets().right
1302 - getVisibleIdWidth() + getVisibleIdWidth(false);
1306 width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1310 else if (av.isShowAnnotation())
1312 height += getAnnotationPanel().adjustPanelHeight() + 3;
1314 return new AlignmentDimension(width, height);
1318 public void makePNGImageMap(File imgMapFile, String imageName)
1319 throws ImageOutputException
1321 // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
1322 // ////////////////////////////////////////////
1323 int idWidth = getVisibleIdWidth(false);
1324 FontMetrics fm = getFontMetrics(av.getFont());
1325 int scaleHeight = av.getCharHeight() + fm.getDescent();
1328 // ////////////////////////////////
1329 if (imgMapFile != null)
1333 int sSize = av.getAlignment().getHeight();
1334 int alwidth = av.getAlignment().getWidth();
1335 PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1336 out.println(HTMLOutput.getImageMapHTML());
1337 out.println("<img src=\"" + imageName
1338 + "\" border=\"0\" usemap=\"#Map\" >"
1339 + "<map name=\"Map\">");
1341 for (int s = 0; s < sSize; s++)
1343 int sy = s * av.getCharHeight() + scaleHeight;
1345 SequenceI seq = av.getAlignment().getSequenceAt(s);
1346 SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1347 for (int column = 0; column < alwidth; column++)
1349 StringBuilder text = new StringBuilder(512);
1350 String triplet = null;
1351 if (av.getAlignment().isNucleotide())
1353 triplet = ResidueProperties.nucleotideName
1354 .get(seq.getCharAt(column) + "");
1358 triplet = ResidueProperties.aa2Triplet
1359 .get(seq.getCharAt(column) + "");
1362 if (triplet == null)
1367 int seqPos = seq.findPosition(column);
1368 int gSize = groups.length;
1369 for (int g = 0; g < gSize; g++)
1371 if (text.length() < 1)
1373 text.append("<area shape=\"rect\" coords=\"")
1374 .append((idWidth + column * av.getCharWidth()))
1375 .append(",").append(sy).append(",")
1377 + (column + 1) * av.getCharWidth()))
1378 .append(",").append((av.getCharHeight() + sy))
1379 .append("\"").append(" onMouseOver=\"toolTip('")
1380 .append(seqPos).append(" ").append(triplet);
1383 if (groups[g].getStartRes() < column
1384 && groups[g].getEndRes() > column)
1386 text.append("<br><em>").append(groups[g].getName())
1391 if (text.length() < 1)
1393 text.append("<area shape=\"rect\" coords=\"")
1394 .append((idWidth + column * av.getCharWidth()))
1395 .append(",").append(sy).append(",")
1396 .append((idWidth + (column + 1) * av.getCharWidth()))
1397 .append(",").append((av.getCharHeight() + sy))
1398 .append("\"").append(" onMouseOver=\"toolTip('")
1399 .append(seqPos).append(" ").append(triplet);
1401 if (!Comparison.isGap(seq.getCharAt(column)))
1403 List<SequenceFeature> features = seq.findFeatures(column,
1405 for (SequenceFeature sf : features)
1407 if (sf.isContactFeature())
1409 text.append("<br>").append(sf.getType()).append(" ")
1410 .append(sf.getBegin()).append(":")
1411 .append(sf.getEnd());
1415 text.append("<br>");
1416 text.append(sf.getType());
1417 String description = sf.getDescription();
1418 if (description != null
1419 && !sf.getType().equals(description))
1421 description = description.replace("\"", """);
1422 text.append(" ").append(description);
1425 String status = sf.getStatus();
1426 if (status != null && !"".equals(status))
1428 text.append(" (").append(status).append(")");
1431 if (text.length() > 1)
1433 text.append("')\"; onMouseOut=\"toolTip()\"; href=\"#\">");
1434 out.println(text.toString());
1439 out.println("</map></body></html>");
1442 } catch (Exception ex)
1444 throw new ImageOutputException(
1445 "couldn't write ImageMap due to unexpected error", ex);
1447 } // /////////END OF IMAGE MAP
1452 * Answers the height of the entire alignment in pixels, assuming it is in
1457 int getWrappedHeight()
1459 int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1461 if (Jalview.isHeadlessMode())
1463 seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1464 - vscroll.getPreferredSize().width
1465 - alignFrame.getInsets().left - alignFrame.getInsets().right;
1468 int chunkWidth = getSeqPanel().seqCanvas
1469 .getWrappedCanvasWidth(seqPanelWidth);
1471 int hgap = av.getCharHeight();
1472 if (av.getScaleAboveWrapped())
1474 hgap += av.getCharHeight();
1477 int annotationHeight = 0;
1478 if (av.isShowAnnotation())
1480 hgap += SeqCanvas.SEQS_ANNOTATION_GAP;
1481 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1484 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1487 int maxwidth = av.getAlignment().getWidth();
1488 if (av.hasHiddenColumns())
1490 maxwidth = av.getAlignment().getHiddenColumns()
1491 .absoluteToVisibleColumn(maxwidth) - 1;
1494 int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1500 * close the panel - deregisters all listeners and nulls any references to
1503 public void closePanel()
1505 PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1506 PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1507 PaintRefresher.RemoveComponent(this);
1512 * try to ensure references are nulled
1514 if (annotationPanel != null)
1516 annotationPanel.dispose();
1517 annotationPanel = null;
1522 av.removePropertyChangeListener(propertyChangeListener);
1523 propertyChangeListener = null;
1524 StructureSelectionManager ssm = av.getStructureSelectionManager();
1525 ssm.removeStructureViewerListener(getSeqPanel(), null);
1526 ssm.removeSelectionListener(getSeqPanel());
1527 ssm.removeCommandListener(av);
1528 ssm.removeStructureViewerListener(getSeqPanel(), null);
1529 ssm.removeSelectionListener(getSeqPanel());
1535 if (Console.isDebugEnabled())
1537 Console.warn("Closing alignment panel which is already closed.");
1543 * Close any open dialogs that would be orphaned when this one is closed
1545 protected void closeChildFrames()
1547 if (overviewPanel != null)
1549 overviewPanel.dispose();
1550 overviewPanel = null;
1552 if (calculationDialog != null)
1554 calculationDialog.closeFrame();
1555 calculationDialog = null;
1560 * hides or shows dynamic annotation rows based on groups and av state flags
1562 public void updateAnnotation()
1564 updateAnnotation(false, false);
1567 public void updateAnnotation(boolean applyGlobalSettings)
1569 updateAnnotation(applyGlobalSettings, false);
1572 public void updateAnnotation(boolean applyGlobalSettings,
1573 boolean preserveNewGroupSettings)
1575 av.updateGroupAnnotationSettings(applyGlobalSettings,
1576 preserveNewGroupSettings);
1577 adjustAnnotationHeight();
1581 public AlignmentI getAlignment()
1583 return av == null ? null : av.getAlignment();
1587 public String getViewName()
1589 return av.getViewName();
1593 * Make/Unmake this alignment panel the current input focus
1597 public void setSelected(boolean b)
1601 if (alignFrame.getSplitViewContainer() != null)
1604 * bring enclosing SplitFrame to front first if there is one
1606 ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1608 alignFrame.setSelected(b);
1609 } catch (Exception ex)
1614 setAlignFrameView();
1618 public void setAlignFrameView()
1620 alignFrame.setDisplayedView(this);
1624 public StructureSelectionManager getStructureSelectionManager()
1626 return av.getStructureSelectionManager();
1630 public void raiseOOMWarning(String string, OutOfMemoryError error)
1632 new OOMWarning(string, error, this);
1636 public jalview.api.FeatureRenderer cloneFeatureRenderer()
1639 return new FeatureRenderer(this);
1643 public jalview.api.FeatureRenderer getFeatureRenderer()
1645 return seqPanel.seqCanvas.getFeatureRenderer();
1648 public void updateFeatureRenderer(
1649 jalview.renderer.seqfeatures.FeatureRenderer fr)
1651 fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1654 public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1656 if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1658 getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1662 public ScalePanel getScalePanel()
1667 public void setScalePanel(ScalePanel scalePanel)
1669 this.scalePanel = scalePanel;
1672 public SeqPanel getSeqPanel()
1677 public void setSeqPanel(SeqPanel seqPanel)
1679 this.seqPanel = seqPanel;
1682 public AnnotationPanel getAnnotationPanel()
1684 return annotationPanel;
1687 public void setAnnotationPanel(AnnotationPanel annotationPanel)
1689 this.annotationPanel = annotationPanel;
1692 public AnnotationLabels getAlabels()
1697 public void setAlabels(AnnotationLabels alabels)
1699 this.alabels = alabels;
1702 public IdPanel getIdPanel()
1707 public void setIdPanel(IdPanel idPanel)
1709 this.idPanel = idPanel;
1713 * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1714 * The aim is to keep the two alignments 'lined up' on their centre columns.
1717 * holds mapped region(s) of this alignment that we are scrolling
1718 * 'to'; may be modified for sequence offset by this method
1719 * @param verticalOffset
1720 * the number of visible sequences to show above the mapped region
1722 protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
1724 scrollToPosition(sr, verticalOffset, true);
1728 * Set a flag to say do not scroll any (cDNA/protein) complement.
1732 protected void setToScrollComplementPanel(boolean b)
1734 this.scrollComplementaryPanel = b;
1738 * Get whether to scroll complement panel
1740 * @return true if cDNA/protein complement panels should be scrolled
1742 protected boolean isSetToScrollComplementPanel()
1744 return this.scrollComplementaryPanel;
1750 * @adjustHeight if true, try to recalculate panel height for visible
1753 protected void refresh(boolean adjustHeight)
1755 validateAnnotationDimensions(adjustHeight);
1759 // sort, repaint, update overview
1760 paintAlignment(true, false);
1764 // lightweight repaint
1771 * Property change event fired when a change is made to the viewport ranges
1772 * object associated with this alignment panel's viewport
1774 public void propertyChange(PropertyChangeEvent evt)
1776 // update this panel's scroll values based on the new viewport ranges values
1777 ViewportRanges ranges = av.getRanges();
1778 int x = ranges.getStartRes();
1779 int y = ranges.getStartSeq();
1780 setScrollValues(x, y);
1782 // now update any complementary alignment (its viewport ranges object
1783 // is different so does not get automatically updated)
1784 if (isSetToScrollComplementPanel())
1786 setToScrollComplementPanel(false);
1787 av.scrollComplementaryAlignment();
1788 setToScrollComplementPanel(true);
1793 * Set the reference to the PCA/Tree chooser dialog for this panel. This
1794 * reference should be nulled when the dialog is closed.
1796 * @param calculationChooser
1798 public void setCalculationDialog(CalculationChooser calculationChooser)
1800 calculationDialog = calculationChooser;
1804 * Returns the reference to the PCA/Tree chooser dialog for this panel (null
1807 public CalculationChooser getCalculationDialog()
1809 return calculationDialog;
1813 * Constructs and sets the title for the Overview window (if there is one),
1814 * including the align frame's title, and view name (if applicable). Returns
1815 * the title, or null if this panel has no Overview window open.
1820 public String setOverviewTitle(AlignFrame alignFrame)
1822 if (this.overviewPanel == null)
1826 String overviewTitle = MessageManager
1827 .formatMessage("label.overview_params", new Object[]
1828 { alignFrame.getTitle() });
1829 String viewName = getViewName();
1830 if (viewName != null)
1832 overviewTitle += (" " + viewName);
1834 overviewPanel.setTitle(overviewTitle);
1835 return overviewTitle;
1839 * If this alignment panel has an Overview panel open, closes it
1841 public void closeOverviewPanel()
1843 if (overviewPanel != null)
1845 overviewPanel.close();
1846 overviewPanel = null;