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.SearchResults;
29 import jalview.datamodel.SequenceFeature;
30 import jalview.datamodel.SequenceGroup;
31 import jalview.datamodel.SequenceI;
32 import jalview.jbgui.GAlignmentPanel;
33 import jalview.math.AlignmentDimension;
34 import jalview.schemes.ResidueProperties;
35 import jalview.structure.StructureSelectionManager;
36 import jalview.util.MessageManager;
37 import jalview.util.Platform;
39 import java.awt.BorderLayout;
40 import java.awt.Color;
41 import java.awt.Container;
42 import java.awt.Dimension;
44 import java.awt.FontMetrics;
45 import java.awt.Graphics;
46 import java.awt.Insets;
47 import java.awt.event.AdjustmentEvent;
48 import java.awt.event.AdjustmentListener;
49 import java.awt.print.PageFormat;
50 import java.awt.print.Printable;
51 import java.awt.print.PrinterException;
52 import java.beans.PropertyChangeEvent;
53 import java.beans.PropertyChangeListener;
55 import java.io.FileWriter;
56 import java.io.PrintWriter;
57 import java.util.List;
59 import javax.swing.SwingUtilities;
65 * @version $Revision: 1.161 $
67 public class AlignmentPanel extends GAlignmentPanel implements
68 AdjustmentListener, Printable, AlignmentViewPanel
70 public AlignViewport av;
72 OverviewPanel overviewPanel;
74 private SeqPanel seqPanel;
76 private IdPanel idPanel;
78 private boolean headless;
80 IdwidthAdjuster idwidthAdjuster;
83 public AlignFrame alignFrame;
85 private ScalePanel scalePanel;
87 private AnnotationPanel annotationPanel;
89 private AnnotationLabels alabels;
91 // this value is set false when selection area being dragged
92 boolean fastPaint = true;
99 * Flag set while scrolling to follow complementary cDNA/protein scroll. When
100 * true, suppresses invoking the same method recursively.
102 private boolean dontScrollComplement;
104 private PropertyChangeListener propertyChangeListener;
107 * Creates a new AlignmentPanel object.
112 public AlignmentPanel(AlignFrame af, final AlignViewport av)
116 setSeqPanel(new SeqPanel(av, this));
117 setIdPanel(new IdPanel(av, this));
119 setScalePanel(new ScalePanel(av, this));
121 idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
122 idwidthAdjuster = new IdwidthAdjuster(this);
123 idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
125 setAnnotationPanel(new AnnotationPanel(this));
126 setAlabels(new AnnotationLabels(this));
128 annotationScroller.setViewportView(getAnnotationPanel());
129 annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
131 scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
132 seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
134 setScrollValues(0, 0);
136 hscroll.addAdjustmentListener(this);
137 vscroll.addAdjustmentListener(this);
139 final AlignmentPanel ap = this;
140 propertyChangeListener = new PropertyChangeListener()
143 public void propertyChange(PropertyChangeEvent evt)
145 if (evt.getPropertyName().equals("alignment"))
147 PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
152 av.addPropertyChangeListener(propertyChangeListener);
154 adjustAnnotationHeight();
159 public AlignViewportI getAlignViewport()
164 public void alignmentChanged()
166 av.alignmentChanged(this);
168 alignFrame.updateEditMenuBar();
170 paintAlignment(true);
177 public void fontChanged()
179 // set idCanvas bufferedImage to null
180 // to prevent drawing old image
181 FontMetrics fm = getFontMetrics(av.getFont());
183 scalePanelHolder.setPreferredSize(new Dimension(10, av.getCharHeight()
185 idSpaceFillerPanel1.setPreferredSize(new Dimension(10, av
186 .getCharHeight() + fm.getDescent()));
188 getIdPanel().getIdCanvas().gg = null;
189 getSeqPanel().seqCanvas.img = null;
190 getAnnotationPanel().adjustPanelHeight();
192 Dimension d = calculateIdWidth();
194 d.setSize(d.width + 4, d.height);
195 getIdPanel().getIdCanvas().setPreferredSize(d);
196 hscrollFillerPanel.setPreferredSize(d);
198 if (overviewPanel != null)
200 overviewPanel.setBoxPosition();
202 if (this.alignFrame.getSplitViewContainer() != null)
204 ((SplitFrame) this.alignFrame.getSplitViewContainer()).adjustLayout();
211 * Calculate the width of the alignment labels based on the displayed names
212 * and any bounds on label width set in preferences.
214 * @return Dimension giving the maximum width of the alignment label panel
215 * that should be used.
217 public Dimension calculateIdWidth()
219 // calculate sensible default width when no preference is available
221 if (av.getIdWidth() < 0)
223 int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
224 int maxwidth = Math.max(20, Math.min(afwidth - 200, 2 * afwidth / 3));
225 r = calculateIdWidth(maxwidth);
226 av.setIdWidth(r.width);
231 r.width = av.getIdWidth();
238 * Calculate the width of the alignment labels based on the displayed names
239 * and any bounds on label width set in preferences.
242 * -1 or maximum width allowed for IdWidth
243 * @return Dimension giving the maximum width of the alignment label panel
244 * that should be used.
246 public Dimension calculateIdWidth(int maxwidth)
248 Container c = new Container();
250 FontMetrics fm = c.getFontMetrics(new Font(av.font.getName(),
251 Font.ITALIC, av.font.getSize()));
253 AlignmentI al = av.getAlignment();
258 while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
260 SequenceI s = al.getSequenceAt(i);
262 id = s.getDisplayId(av.getShowJVSuffix());
264 if (fm.stringWidth(id) > idWidth)
266 idWidth = fm.stringWidth(id);
272 // Also check annotation label widths
275 if (al.getAlignmentAnnotation() != null)
277 fm = c.getFontMetrics(getAlabels().getFont());
279 while (i < al.getAlignmentAnnotation().length)
281 String label = al.getAlignmentAnnotation()[i].label;
283 if (fm.stringWidth(label) > idWidth)
285 idWidth = fm.stringWidth(label);
292 return new Dimension(maxwidth < 0 ? idWidth : Math.min(maxwidth,
297 * Highlight the given results on the alignment.
300 public void highlightSearchResults(SearchResults results)
302 scrollToPosition(results);
303 getSeqPanel().seqCanvas.highlightSearchResults(results);
307 * Scroll the view to show the position of the highlighted region in results
308 * (if any) and redraw the overview
312 public boolean scrollToPosition(SearchResults results)
314 return scrollToPosition(results, 0, true, false);
318 * Scroll the view to show the position of the highlighted region in results
321 * @param searchResults
322 * @param redrawOverview
325 public boolean scrollToPosition(SearchResults searchResults,
326 boolean redrawOverview)
328 return scrollToPosition(searchResults, 0, redrawOverview, false);
332 * Scroll the view to show the position of the highlighted region in results
336 * @param verticalOffset
337 * if greater than zero, allows scrolling to a position below the
338 * first displayed sequence
339 * @param redrawOverview
340 * - when set, the overview will be recalculated (takes longer)
342 * if true, try to centre the search results horizontally in the view
343 * @return false if results were not found
345 public boolean scrollToPosition(SearchResults results,
346 int verticalOffset, boolean redrawOverview, boolean centre)
348 int startv, endv, starts, ends;
349 // TODO: properly locate search results in view when large numbers of hidden
350 // columns exist before highlighted region
351 // do we need to scroll the panel?
352 // TODO: tons of nullpointerexceptions raised here.
353 if (results != null && results.getSize() > 0 && av != null
354 && av.getAlignment() != null)
356 int seqIndex = av.getAlignment().findIndex(results);
361 SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
363 int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
371 // System.err.println(this.av.viewName + " Seq : " + seqIndex
372 // + " Scroll to " + start + "," + end);
375 * To centre results, scroll to positions half the visible width
376 * left/right of the start/end positions
380 int offset = (av.getEndRes() - av.getStartRes() + 1) / 2 - 1;
381 start = Math.max(start - offset, 0);
382 end = end + offset - 1;
388 if (end == seq.getEnd())
392 if (av.hasHiddenColumns())
394 start = av.getColumnSelection().findColumnPosition(start);
395 end = av.getColumnSelection().findColumnPosition(end);
398 if (!av.getColumnSelection().isVisible(r[0]))
400 // don't scroll - position isn't visible
407 * allow for offset of target sequence (actually scroll to one above it)
409 seqIndex = Math.max(0, seqIndex - verticalOffset);
411 // System.out.println("start=" + start + ", end=" + end + ", startv="
412 // + av.getStartRes() + ", endv=" + av.getEndRes() + ", starts="
413 // + av.getStartSeq() + ", ends=" + av.getEndSeq());
414 if (!av.getWrapAlignment())
416 if ((startv = av.getStartRes()) >= start)
419 * Scroll left to make start of search results visible
421 // setScrollValues(start - 1, seqIndex); // plus one residue
422 setScrollValues(start, seqIndex);
424 else if ((endv = av.getEndRes()) <= end)
427 * Scroll right to make end of search results visible
429 // setScrollValues(startv + 1 + end - endv, seqIndex); // plus one
430 setScrollValues(startv + end - endv, seqIndex);
432 else if ((starts = av.getStartSeq()) > seqIndex)
435 * Scroll up to make start of search results visible
437 setScrollValues(av.getStartRes(), seqIndex);
439 else if ((ends = av.getEndSeq()) <= seqIndex)
442 * Scroll down to make end of search results visible
444 setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1);
447 * Else results are already visible - no need to scroll
452 scrollToWrappedVisible(start);
455 if (redrawOverview && overviewPanel != null)
457 overviewPanel.setBoxPosition();
459 paintAlignment(redrawOverview);
463 void scrollToWrappedVisible(int res)
465 int cwidth = getSeqPanel().seqCanvas
466 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
467 if (res < av.getStartRes() || res >= (av.getStartRes() + cwidth))
469 vscroll.setValue((res / cwidth));
470 av.startRes = vscroll.getValue() * cwidth;
478 * @return DOCUMENT ME!
480 public OverviewPanel getOverviewPanel()
482 return overviewPanel;
491 public void setOverviewPanel(OverviewPanel op)
499 * Hide or show annotation panel
502 public void setAnnotationVisible(boolean b)
504 if (!av.getWrapAlignment())
506 annotationSpaceFillerHolder.setVisible(b);
507 annotationScroller.setVisible(b);
513 * automatically adjust annotation panel height for new annotation whilst
514 * ensuring the alignment is still visible.
517 public void adjustAnnotationHeight()
519 // TODO: display vertical annotation scrollbar if necessary
520 // this is called after loading new annotation onto alignment
521 if (alignFrame.getHeight() == 0)
523 System.out.println("NEEDS FIXING");
525 validateAnnotationDimensions(true);
527 paintAlignment(true);
531 * calculate the annotation dimensions and refresh slider values accordingly.
532 * need to do repaints/notifys afterwards.
534 protected void validateAnnotationDimensions(boolean adjustPanelHeight)
536 int annotationHeight = getAnnotationPanel().adjustPanelHeight();
538 if (adjustPanelHeight)
540 int rowHeight = av.getCharHeight();
541 int alignmentHeight = rowHeight * av.getAlignment().getHeight();
544 * Estimate available height in the AlignFrame for alignment +
545 * annotations. Deduct an estimate for title bar, menu bar, scale panel,
546 * hscroll, status bar (as these are not laid out we can't inspect their
547 * actual heights). Insets gives frame borders.
549 int stuff = Platform.isAMac() ? 80 : 100;
550 Insets insets = alignFrame.getInsets();
551 int availableHeight = alignFrame.getHeight() - stuff - insets.top
555 * If not enough vertical space, maximize annotation height while keeping
556 * at least two rows of alignment visible
558 if (annotationHeight + alignmentHeight > availableHeight)
560 annotationHeight = Math.min(annotationHeight, availableHeight - 2
566 // maintain same window layout whilst updating sliders
567 annotationHeight = annotationScroller.getSize().height;
571 annotationScroller.setPreferredSize(new Dimension(annotationScroller
572 .getWidth(), annotationHeight));
574 Dimension e = idPanel.getSize();
575 alabels.setSize(new Dimension(e.width, annotationHeight));
577 annotationSpaceFillerHolder.setPreferredSize(new Dimension(
578 annotationSpaceFillerHolder.getWidth(), annotationHeight));
579 annotationScroller.validate();
580 annotationScroller.addNotify();
584 * update alignment layout for viewport settings
589 public void updateLayout()
592 setAnnotationVisible(av.isShowAnnotation());
593 boolean wrap = av.getWrapAlignment();
595 scalePanelHolder.setVisible(!wrap);
596 hscroll.setVisible(!wrap);
597 idwidthAdjuster.setVisible(!wrap);
601 annotationScroller.setVisible(false);
602 annotationSpaceFillerHolder.setVisible(false);
604 else if (av.isShowAnnotation())
606 annotationScroller.setVisible(true);
607 annotationSpaceFillerHolder.setVisible(true);
610 idSpaceFillerPanel1.setVisible(!wrap);
615 // return value is true if the scroll is valid
616 public boolean scrollUp(boolean up)
620 if (vscroll.getValue() < 1)
626 vscroll.setValue(vscroll.getValue() - 1);
630 if ((vextent + vscroll.getValue()) >= av.getAlignment().getHeight())
636 vscroll.setValue(vscroll.getValue() + 1);
650 * @return DOCUMENT ME!
652 public boolean scrollRight(boolean right)
656 if (hscroll.getValue() < 1)
662 hscroll.setValue(hscroll.getValue() - 1);
666 if ((hextent + hscroll.getValue()) >= av.getAlignment().getWidth())
672 hscroll.setValue(hscroll.getValue() + 1);
681 * Adjust row/column scrollers to show a visible position in the alignment.
684 * visible column to scroll to
686 * visible row to scroll to
689 public void setScrollValues(int x, int y)
691 // System.err.println("Scroll " + this.av.viewName + " to " + x + "," + y);
692 if (av == null || av.getAlignment() == null)
696 int width = av.getAlignment().getWidth();
697 int height = av.getAlignment().getHeight();
699 if (av.hasHiddenColumns())
701 width = av.getColumnSelection().findColumnPosition(width);
704 av.setEndRes((x + (getSeqPanel().seqCanvas.getWidth() / av
705 .getCharWidth())) - 1);
707 hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
708 vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
715 if (vextent > height)
720 if ((hextent + x) > width)
725 if ((vextent + y) > height)
727 y = height - vextent;
741 * each scroll adjustment triggers adjustmentValueChanged, which resets the
742 * 'do not scroll complement' flag; ensure it is the same for both
745 boolean flag = isDontScrollComplement();
746 hscroll.setValues(x, hextent, 0, width);
747 setDontScrollComplement(flag);
748 vscroll.setValues(y, vextent, 0, height);
758 public void adjustmentValueChanged(AdjustmentEvent evt)
760 int oldX = av.getStartRes();
761 int oldY = av.getStartSeq();
763 if (evt.getSource() == hscroll)
765 int x = hscroll.getValue();
767 av.setEndRes((x + (getSeqPanel().seqCanvas.getWidth() / av
768 .getCharWidth())) - 1);
771 if (evt.getSource() == vscroll)
773 int offy = vscroll.getValue();
775 if (av.getWrapAlignment())
779 int rowSize = getSeqPanel().seqCanvas
780 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
781 av.setStartRes(offy * rowSize);
782 av.setEndRes((offy + 1) * rowSize);
786 // This is only called if file loaded is a jar file that
787 // was wrapped when saved and user has wrap alignment true
788 // as preference setting
789 SwingUtilities.invokeLater(new Runnable()
794 setScrollValues(av.getStartRes(), av.getStartSeq());
801 av.setStartSeq(offy);
803 + (getSeqPanel().seqCanvas.getHeight() / av.getCharHeight()));
807 if (overviewPanel != null)
809 overviewPanel.setBoxPosition();
812 int scrollX = av.startRes - oldX;
813 int scrollY = av.startSeq - oldY;
815 if (av.getWrapAlignment() || !fastPaint)
821 // Make sure we're not trying to draw a panel
822 // larger than the visible window
823 if (scrollX > av.endRes - av.startRes)
825 scrollX = av.endRes - av.startRes;
827 else if (scrollX < av.startRes - av.endRes)
829 scrollX = av.startRes - av.endRes;
832 if (scrollX != 0 || scrollY != 0)
834 getIdPanel().getIdCanvas().fastPaint(scrollY);
835 getSeqPanel().seqCanvas.fastPaint(scrollX, scrollY);
836 getScalePanel().repaint();
838 if (av.isShowAnnotation() && scrollX != 0)
840 getAnnotationPanel().fastPaint(scrollX);
845 * If there is one, scroll the (Protein/cDNA) complementary alignment to
846 * match, unless we are ourselves doing that.
848 if (isDontScrollComplement())
850 setDontScrollComplement(false);
854 av.scrollComplementaryAlignment();
859 * Repaint the alignment including the annotations and overview panels (if
863 public void paintAlignment(boolean updateOverview)
865 final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
866 av.isShowAutocalculatedAbove());
867 sorter.sort(getAlignment().getAlignmentAnnotation(),
868 av.getSortAnnotationsBy());
873 // TODO: determine if this paintAlignment changed structure colours
874 av.getStructureSelectionManager().sequenceColoursChanged(this);
876 if (overviewPanel != null)
878 overviewPanel.updateOverviewImage();
890 public void paintComponent(Graphics g)
894 Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
895 idPanelHolder.setPreferredSize(d);
896 hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
900 * set scroll bar positions; first suppress this being 'followed' in any
901 * complementary split pane
903 setDontScrollComplement(true);
905 if (av.getWrapAlignment())
907 int maxwidth = av.getAlignment().getWidth();
909 if (av.hasHiddenColumns())
911 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
914 int canvasWidth = getSeqPanel().seqCanvas
915 .getWrappedCanvasWidth(getSeqPanel().seqCanvas.getWidth());
919 / getSeqPanel().seqCanvas
920 .getWrappedCanvasWidth(getSeqPanel().seqCanvas
922 vscroll.setMaximum(max);
923 vscroll.setUnitIncrement(1);
924 vscroll.setVisibleAmount(1);
929 setScrollValues(av.getStartRes(), av.getStartSeq());
943 * @return DOCUMENT ME!
945 * @throws PrinterException
949 public int print(Graphics pg, PageFormat pf, int pi)
950 throws PrinterException
952 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
954 int pwidth = (int) pf.getImageableWidth();
955 int pheight = (int) pf.getImageableHeight();
957 if (av.getWrapAlignment())
959 return printWrappedAlignment(pwidth, pheight, pi, pg);
963 return printUnwrapped(pwidth, pheight, pi, pg, pg);
979 * @return DOCUMENT ME!
981 * @throws PrinterException
985 * Draws the alignment image, including sequence ids, sequences, and
986 * annotation labels and annotations if shown, on either one or two Graphics
993 * the graphics context for sequence ids and annotation labels
994 * @param alignmentGraphics
995 * the graphics context for sequences and annotations (may or may not
996 * be the same context as idGraphics)
998 * @throws PrinterException
1000 public int printUnwrapped(int pageWidth, int pageHeight, int pi,
1001 Graphics idGraphics, Graphics alignmentGraphics)
1002 throws PrinterException
1004 final int idWidth = getVisibleIdWidth(false);
1007 * Get the horizontal offset to where we draw the sequences.
1008 * This is idWidth if using a single Graphics context, else zero.
1010 final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0 : idWidth;
1012 FontMetrics fm = getFontMetrics(av.getFont());
1013 int charHeight = av.getCharHeight();
1014 int scaleHeight = charHeight + fm.getDescent();
1016 idGraphics.setColor(Color.white);
1017 idGraphics.fillRect(0, 0, pageWidth, pageHeight);
1018 idGraphics.setFont(av.getFont());
1021 * How many sequences and residues can we fit on a printable page?
1023 int totalRes = (pageWidth - idWidth) / av.getCharWidth();
1025 int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
1027 int alignmentWidth = av.getAlignment().getWidth();
1028 int pagesWide = (alignmentWidth / totalRes) + 1;
1030 final int startRes = (pi % pagesWide) * totalRes;
1031 int endRes = (startRes + totalRes) - 1;
1033 if (endRes > (alignmentWidth - 1))
1035 endRes = alignmentWidth - 1;
1038 final int startSeq = (pi / pagesWide) * totalSeq;
1039 int endSeq = startSeq + totalSeq;
1041 int alignmentHeight = av.getAlignment().getHeight();
1042 if (endSeq > alignmentHeight)
1044 endSeq = alignmentHeight;
1047 int pagesHigh = ((alignmentHeight / totalSeq) + 1)
1050 if (av.isShowAnnotation())
1052 pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
1055 pagesHigh /= pageHeight;
1057 if (pi >= (pagesWide * pagesHigh))
1059 return Printable.NO_SUCH_PAGE;
1061 final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight
1065 * draw the Scale at horizontal offset, then reset to origin
1067 alignmentGraphics.translate(alignmentGraphicsOffset, 0);
1068 getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
1069 pageWidth - idWidth, scaleHeight);
1070 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1073 * Draw the sequence ids, offset for scale height,
1074 * then reset to origin
1076 idGraphics.translate(0, scaleHeight);
1077 idGraphics.setFont(getIdPanel().getIdCanvas().getIdfont());
1078 Color currentColor = null;
1079 Color currentTextColor = null;
1082 for (int i = startSeq; i < endSeq; i++)
1084 seq = av.getAlignment().getSequenceAt(i);
1085 if ((av.getSelectionGroup() != null)
1086 && av.getSelectionGroup().getSequences(null).contains(seq))
1089 * gray out ids of sequences in selection group (if any)
1091 currentColor = Color.gray;
1092 currentTextColor = Color.black;
1096 currentColor = av.getSequenceColour(seq);
1097 currentTextColor = Color.black;
1100 idGraphics.setColor(currentColor);
1101 idGraphics.fillRect(0, (i - startSeq) * charHeight, idWidth,
1104 idGraphics.setColor(currentTextColor);
1107 String displayId = seq.getDisplayId(av.getShowJVSuffix());
1108 if (av.isRightAlignIds())
1110 fm = idGraphics.getFontMetrics();
1112 - fm.stringWidth(displayId)
1116 idGraphics.drawString(displayId, xPos,
1117 (((i - startSeq) * charHeight) + charHeight)
1118 - (charHeight / 5));
1120 idGraphics.setFont(av.getFont());
1121 idGraphics.translate(0, -scaleHeight);
1124 * draw the sequences, offset for scale height, and id width (if using a
1125 * single graphics context), then reset to origin + scale height
1127 alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
1128 getSeqPanel().seqCanvas.drawPanel(alignmentGraphics, startRes, endRes,
1129 startSeq, endSeq, 0);
1130 alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
1132 if (av.isShowAnnotation() && (endSeq == alignmentHeight))
1135 * draw annotation labels, offset for current scroll position
1136 * then reset to origin + scale height
1138 int offset = -getAlabels().getScrollOffset();
1139 idGraphics.translate(0, offset + alignmentDrawnHeight);
1140 getAlabels().drawComponent(idGraphics, idWidth);
1141 idGraphics.translate(0, -offset - alignmentDrawnHeight);
1144 * draw the annotations
1146 alignmentGraphics.translate(alignmentGraphicsOffset, alignmentDrawnHeight);
1147 getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
1148 alignmentGraphics, -1, startRes, endRes + 1);
1151 return Printable.PAGE_EXISTS;
1166 * @return DOCUMENT ME!
1168 * @throws PrinterException
1171 public int printWrappedAlignment(int pwidth, int pheight, int pi,
1172 Graphics pg) throws PrinterException
1174 int annotationHeight = 0;
1175 AnnotationLabels labels = null;
1176 if (av.isShowAnnotation())
1178 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1179 labels = new AnnotationLabels(av);
1182 int hgap = av.getCharHeight();
1183 if (av.getScaleAboveWrapped())
1185 hgap += av.getCharHeight();
1188 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1191 int idWidth = getVisibleIdWidth(false);
1193 int maxwidth = av.getAlignment().getWidth();
1194 if (av.hasHiddenColumns())
1196 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1199 int resWidth = getSeqPanel().seqCanvas.getWrappedCanvasWidth(pwidth
1202 int totalHeight = cHeight * (maxwidth / resWidth + 1);
1204 pg.setColor(Color.white);
1205 pg.fillRect(0, 0, pwidth, pheight);
1206 pg.setFont(av.getFont());
1210 pg.setColor(Color.black);
1212 pg.translate(0, -pi * pheight);
1214 pg.setClip(0, pi * pheight, pwidth, pheight);
1220 for (int i = 0; i < av.getAlignment().getHeight(); i++)
1222 pg.setFont(getIdPanel().getIdCanvas().getIdfont());
1223 SequenceI s = av.getAlignment().getSequenceAt(i);
1224 String string = s.getDisplayId(av.getShowJVSuffix());
1226 if (av.isRightAlignIds())
1228 FontMetrics fm = pg.getFontMetrics();
1229 xPos = idWidth - fm.stringWidth(string) - 4;
1231 pg.drawString(string, xPos,
1232 ((i * av.getCharHeight()) + ypos + av.getCharHeight())
1233 - (av.getCharHeight() / 5));
1238 ypos + (av.getAlignment().getHeight() * av.getCharHeight()));
1240 pg.setFont(av.getFont());
1241 labels.drawComponent(pg, idWidth);
1245 - (av.getAlignment().getHeight() * av
1250 } while (ypos < totalHeight);
1252 pg.translate(idWidth, 0);
1254 getSeqPanel().seqCanvas.drawWrappedPanel(pg, pwidth - idWidth,
1257 if ((pi * pheight) < totalHeight)
1259 return Printable.PAGE_EXISTS;
1264 return Printable.NO_SUCH_PAGE;
1269 * get current sequence ID panel width, or nominal value if panel were to be
1270 * displayed using default settings
1274 public int getVisibleIdWidth()
1276 return getVisibleIdWidth(true);
1280 * get current sequence ID panel width, or nominal value if panel were to be
1281 * displayed using default settings
1284 * indicate if the Id width for onscreen or offscreen display should
1288 public int getVisibleIdWidth(boolean onscreen)
1290 // see if rendering offscreen - check preferences and calc width accordingly
1291 if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
1293 return calculateIdWidth(-1).width + 4;
1295 Integer idwidth = null;
1297 || (idwidth = Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH")) == null)
1299 return (getIdPanel().getWidth() > 0 ? getIdPanel().getWidth()
1300 : calculateIdWidth().width + 4);
1302 return idwidth.intValue() + 4;
1305 void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
1307 int boarderBottomOffset = 5;
1308 long pSessionId = System.currentTimeMillis();
1309 headless = (System.getProperty("java.awt.headless") != null && System
1310 .getProperty("java.awt.headless").equals("true"));
1311 if (alignFrame != null && !headless)
1315 alignFrame.setProgressBar(MessageManager.formatMessage(
1316 "status.saving_file", new Object[] { type.getLabel() }),
1322 AlignmentDimension aDimension = getAlignmentDimension();
1325 jalview.util.ImageMaker im;
1326 final String imageAction, imageTitle;
1327 if (type == jalview.util.ImageMaker.TYPE.PNG)
1329 imageAction = "Create PNG image from alignment";
1332 else if (type == jalview.util.ImageMaker.TYPE.EPS)
1334 imageAction = "Create EPS file from alignment";
1335 imageTitle = alignFrame.getTitle();
1339 imageAction = "Create SVG file from alignment";
1340 imageTitle = alignFrame.getTitle();
1343 im = new jalview.util.ImageMaker(this, type, imageAction,
1344 aDimension.getWidth(), aDimension.getHeight()
1345 + boarderBottomOffset, file, imageTitle,
1346 alignFrame, pSessionId, headless);
1347 Graphics graphics = im.getGraphics();
1348 if (av.getWrapAlignment())
1350 if (graphics != null)
1352 printWrappedAlignment(aDimension.getWidth(),
1353 aDimension.getHeight() + boarderBottomOffset, 0,
1360 if (graphics != null)
1362 printUnwrapped(aDimension.getWidth(), aDimension.getHeight(),
1363 0, graphics, graphics);
1368 } catch (OutOfMemoryError err)
1371 System.out.println("########################\n" + "OUT OF MEMORY "
1372 + file + "\n" + "########################");
1373 new OOMWarning("Creating Image for " + file, err);
1374 // System.out.println("Create IMAGE: " + err);
1375 } catch (Exception ex)
1377 ex.printStackTrace();
1385 public AlignmentDimension getAlignmentDimension()
1387 int maxwidth = av.getAlignment().getWidth();
1388 if (av.hasHiddenColumns())
1390 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);
1393 int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
1394 + getScalePanel().getHeight();
1395 int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
1397 if (av.getWrapAlignment())
1399 height = getWrappedHeight();
1402 // need to obtain default alignment width and then add in any
1403 // additional allowance for id margin
1404 // this duplicates the calculation in getWrappedHeight but adjusts for
1406 width = alignFrame.getWidth() - vscroll.getPreferredSize().width
1407 - alignFrame.getInsets().left
1408 - alignFrame.getInsets().right - getVisibleIdWidth()
1409 + getVisibleIdWidth(false);
1413 width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
1417 else if (av.isShowAnnotation())
1419 height += getAnnotationPanel().adjustPanelHeight() + 3;
1421 return new AlignmentDimension(width, height);
1428 public void makeEPS(File epsFile)
1430 makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
1436 public void makePNG(File pngFile)
1438 makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
1441 public void makeSVG(File svgFile)
1443 makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
1446 public void makePNGImageMap(File imgMapFile, String imageName)
1448 // /////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS
1449 // ////////////////////////////////////////////
1450 int idWidth = getVisibleIdWidth(false);
1451 FontMetrics fm = getFontMetrics(av.getFont());
1452 int scaleHeight = av.getCharHeight() + fm.getDescent();
1455 // ////////////////////////////////
1456 if (imgMapFile != null)
1460 int s, sSize = av.getAlignment().getHeight(), res, alwidth = av
1461 .getAlignment().getWidth(), g, gSize, f, fSize, sy;
1462 StringBuffer text = new StringBuffer();
1463 PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
1464 out.println(jalview.io.HTMLOutput.getImageMapHTML());
1465 out.println("<img src=\"" + imageName
1466 + "\" border=\"0\" usemap=\"#Map\" >"
1467 + "<map name=\"Map\">");
1469 for (s = 0; s < sSize; s++)
1471 sy = s * av.getCharHeight() + scaleHeight;
1473 SequenceI seq = av.getAlignment().getSequenceAt(s);
1474 SequenceFeature[] features = seq.getSequenceFeatures();
1475 SequenceGroup[] groups = av.getAlignment().findAllGroups(seq);
1476 for (res = 0; res < alwidth; res++)
1478 text = new StringBuffer();
1479 String triplet = null;
1480 if (av.getAlignment().isNucleotide())
1482 triplet = ResidueProperties.nucleotideName.get(seq
1483 .getCharAt(res) + "");
1487 triplet = ResidueProperties.aa2Triplet.get(seq.getCharAt(res)
1491 if (triplet == null)
1496 int alIndex = seq.findPosition(res);
1497 gSize = groups.length;
1498 for (g = 0; g < gSize; g++)
1500 if (text.length() < 1)
1502 text.append("<area shape=\"rect\" coords=\""
1503 + (idWidth + res * av.getCharWidth()) + "," + sy
1504 + "," + (idWidth + (res + 1) * av.getCharWidth())
1505 + "," + (av.getCharHeight() + sy) + "\""
1506 + " onMouseOver=\"toolTip('" + alIndex + " "
1510 if (groups[g].getStartRes() < res
1511 && groups[g].getEndRes() > res)
1513 text.append("<br><em>" + groups[g].getName() + "</em>");
1517 if (features != null)
1519 if (text.length() < 1)
1521 text.append("<area shape=\"rect\" coords=\""
1522 + (idWidth + res * av.getCharWidth()) + "," + sy
1523 + "," + (idWidth + (res + 1) * av.getCharWidth())
1524 + "," + (av.getCharHeight() + sy) + "\""
1525 + " onMouseOver=\"toolTip('" + alIndex + " "
1528 fSize = features.length;
1529 for (f = 0; f < fSize; f++)
1532 if ((features[f].getBegin() <= seq.findPosition(res))
1533 && (features[f].getEnd() >= seq.findPosition(res)))
1535 if (features[f].getType().equals("disulfide bond"))
1537 if (features[f].getBegin() == seq.findPosition(res)
1538 || features[f].getEnd() == seq
1541 text.append("<br>disulfide bond "
1542 + features[f].getBegin() + ":"
1543 + features[f].getEnd());
1548 text.append("<br>");
1549 text.append(features[f].getType());
1550 if (features[f].getDescription() != null
1551 && !features[f].getType().equals(
1552 features[f].getDescription()))
1554 text.append(" " + features[f].getDescription());
1557 if (features[f].getValue("status") != null)
1559 text.append(" (" + features[f].getValue("status")
1567 if (text.length() > 1)
1569 text.append("')\"; onMouseOut=\"toolTip()\"; href=\"#\">");
1570 out.println(text.toString());
1574 out.println("</map></body></html>");
1577 } catch (Exception ex)
1579 ex.printStackTrace();
1581 } // /////////END OF IMAGE MAP
1585 int getWrappedHeight()
1587 int seqPanelWidth = getSeqPanel().seqCanvas.getWidth();
1589 if (System.getProperty("java.awt.headless") != null
1590 && System.getProperty("java.awt.headless").equals("true"))
1592 seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth()
1593 - vscroll.getPreferredSize().width
1594 - alignFrame.getInsets().left - alignFrame.getInsets().right;
1597 int chunkWidth = getSeqPanel().seqCanvas
1598 .getWrappedCanvasWidth(seqPanelWidth);
1600 int hgap = av.getCharHeight();
1601 if (av.getScaleAboveWrapped())
1603 hgap += av.getCharHeight();
1606 int annotationHeight = 0;
1607 if (av.isShowAnnotation())
1609 annotationHeight = getAnnotationPanel().adjustPanelHeight();
1612 int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
1615 int maxwidth = av.getAlignment().getWidth();
1616 if (av.hasHiddenColumns())
1618 maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
1621 int height = ((maxwidth / chunkWidth) + 1) * cHeight;
1627 * close the panel - deregisters all listeners and nulls any references to
1630 public void closePanel()
1632 PaintRefresher.RemoveComponent(getSeqPanel().seqCanvas);
1633 PaintRefresher.RemoveComponent(getIdPanel().getIdCanvas());
1634 PaintRefresher.RemoveComponent(this);
1637 * try to ensure references are nulled
1639 if (annotationPanel != null)
1641 annotationPanel.dispose();
1646 av.removePropertyChangeListener(propertyChangeListener);
1647 jalview.structure.StructureSelectionManager ssm = av
1648 .getStructureSelectionManager();
1649 ssm.removeStructureViewerListener(getSeqPanel(), null);
1650 ssm.removeSelectionListener(getSeqPanel());
1651 ssm.removeCommandListener(av);
1652 ssm.removeStructureViewerListener(getSeqPanel(), null);
1653 ssm.removeSelectionListener(getSeqPanel());
1659 if (Cache.log.isDebugEnabled())
1661 Cache.log.warn("Closing alignment panel which is already closed.");
1667 * hides or shows dynamic annotation rows based on groups and av state flags
1669 public void updateAnnotation()
1671 updateAnnotation(false, false);
1674 public void updateAnnotation(boolean applyGlobalSettings)
1676 updateAnnotation(applyGlobalSettings, false);
1679 public void updateAnnotation(boolean applyGlobalSettings,
1680 boolean preserveNewGroupSettings)
1682 av.updateGroupAnnotationSettings(applyGlobalSettings,
1683 preserveNewGroupSettings);
1684 adjustAnnotationHeight();
1688 public AlignmentI getAlignment()
1690 return av == null ? null : av.getAlignment();
1694 public String getViewName()
1700 * Make/Unmake this alignment panel the current input focus
1704 public void setSelected(boolean b)
1708 if (alignFrame.getSplitViewContainer() != null)
1711 * bring enclosing SplitFrame to front first if there is one
1713 ((SplitFrame) alignFrame.getSplitViewContainer()).setSelected(b);
1715 alignFrame.setSelected(b);
1716 } catch (Exception ex)
1722 alignFrame.setDisplayedView(this);
1727 public StructureSelectionManager getStructureSelectionManager()
1729 return av.getStructureSelectionManager();
1733 public void raiseOOMWarning(String string, OutOfMemoryError error)
1735 new OOMWarning(string, error, this);
1739 public jalview.api.FeatureRenderer cloneFeatureRenderer()
1742 return new FeatureRenderer(this);
1746 public jalview.api.FeatureRenderer getFeatureRenderer()
1748 return seqPanel.seqCanvas.getFeatureRenderer();
1751 public void updateFeatureRenderer(
1752 jalview.renderer.seqfeatures.FeatureRenderer fr)
1754 fr.transferSettings(getSeqPanel().seqCanvas.getFeatureRenderer());
1757 public void updateFeatureRendererFrom(jalview.api.FeatureRenderer fr)
1759 if (getSeqPanel().seqCanvas.getFeatureRenderer() != null)
1761 getSeqPanel().seqCanvas.getFeatureRenderer().transferSettings(fr);
1765 public ScalePanel getScalePanel()
1770 public void setScalePanel(ScalePanel scalePanel)
1772 this.scalePanel = scalePanel;
1775 public SeqPanel getSeqPanel()
1780 public void setSeqPanel(SeqPanel seqPanel)
1782 this.seqPanel = seqPanel;
1785 public AnnotationPanel getAnnotationPanel()
1787 return annotationPanel;
1790 public void setAnnotationPanel(AnnotationPanel annotationPanel)
1792 this.annotationPanel = annotationPanel;
1795 public AnnotationLabels getAlabels()
1800 public void setAlabels(AnnotationLabels alabels)
1802 this.alabels = alabels;
1805 public IdPanel getIdPanel()
1810 public void setIdPanel(IdPanel idPanel)
1812 this.idPanel = idPanel;
1816 * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
1817 * The aim is to keep the two alignments 'lined up' on their centre columns.
1820 * holds mapped region(s) of this alignment that we are scrolling
1821 * 'to'; may be modified for sequence offset by this method
1822 * @param verticalOffset
1823 * the number of visible sequences to show above the mapped region
1825 public void scrollToCentre(SearchResults sr, int verticalOffset)
1828 * To avoid jumpy vertical scrolling (if some sequences are gapped or not
1829 * mapped), we can make the scroll-to location a sequence above the one
1832 SequenceI mappedTo = sr.getResultSequence(0);
1833 List<SequenceI> seqs = av.getAlignment().getSequences();
1836 * This is like AlignmentI.findIndex(seq) but here we are matching the
1837 * dataset sequence not the aligned sequence
1839 boolean matched = false;
1840 for (SequenceI seq : seqs)
1842 if (mappedTo == seq.getDatasetSequence())
1850 return; // failsafe, shouldn't happen
1854 * Scroll to position but centring the target residue.
1856 scrollToPosition(sr, verticalOffset, true, true);
1860 * Set a flag to say do not scroll any (cDNA/protein) complement.
1864 protected void setDontScrollComplement(boolean b)
1866 this.dontScrollComplement = b;
1869 protected boolean isDontScrollComplement()
1871 return this.dontScrollComplement;