X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fgui%2FAlignmentPanel.java;h=d3f80ce2b21ccb37e4d09038277f8f6588d09805;hb=e57f77dc13f5a295cf49a403da05770a68a6e22b;hp=e50b522ed00e820d21d02e65ee651bcffa16b0b1;hpb=655911bbe41713fd320da9afd5461c75eebe8db8;p=jalview.git
diff --git a/src/jalview/gui/AlignmentPanel.java b/src/jalview/gui/AlignmentPanel.java
old mode 100755
new mode 100644
index e50b522..d3f80ce
--- a/src/jalview/gui/AlignmentPanel.java
+++ b/src/jalview/gui/AlignmentPanel.java
@@ -1,114 +1,190 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
* Jalview is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- *
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
* Jalview is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License along with Jalview. If not, see .
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.gui;
-import java.beans.*;
-import java.io.*;
-import java.util.Hashtable;
-import java.util.Vector;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.print.*;
-import javax.swing.*;
-
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Container;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.event.AdjustmentEvent;
+import java.awt.event.AdjustmentListener;
+import java.awt.event.ComponentAdapter;
+import java.awt.event.ComponentEvent;
+import java.awt.print.PageFormat;
+import java.awt.print.Printable;
+import java.awt.print.PrinterException;
+import java.beans.PropertyChangeEvent;
+import java.beans.PropertyChangeListener;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.PrintWriter;
+import java.util.List;
+
+import javax.swing.SwingUtilities;
+
+import jalview.analysis.AnnotationSorter;
+import jalview.api.AlignViewportI;
import jalview.api.AlignmentViewPanel;
import jalview.bin.Cache;
-import jalview.datamodel.*;
-import jalview.jbgui.*;
-import jalview.schemes.*;
-import jalview.structure.SelectionSource;
+import jalview.bin.Console;
+import jalview.bin.Jalview;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.SearchResultsI;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.gui.ImageExporter.ImageWriterI;
+import jalview.io.HTMLOutput;
+import jalview.io.exceptions.ImageOutputException;
+import jalview.jbgui.GAlignmentPanel;
+import jalview.math.AlignmentDimension;
+import jalview.schemes.ResidueProperties;
+import jalview.structure.StructureSelectionManager;
+import jalview.util.Comparison;
+import jalview.util.ImageMaker;
+import jalview.util.MessageManager;
+import jalview.util.imagemaker.BitmapImageSizing;
+import jalview.viewmodel.ViewportListenerI;
+import jalview.viewmodel.ViewportRanges;
/**
* DOCUMENT ME!
*
* @author $author$
- * @version $Revision$
+ * @version $Revision: 1.161 $
*/
+@SuppressWarnings("serial")
public class AlignmentPanel extends GAlignmentPanel implements
- AdjustmentListener, Printable, AlignmentViewPanel
+ AdjustmentListener, Printable, AlignmentViewPanel, ViewportListenerI
{
+ /*
+ * spare space in pixels between sequence id and alignment panel
+ */
+ private static final int ID_WIDTH_PADDING = 4;
+
public AlignViewport av;
OverviewPanel overviewPanel;
- SeqPanel seqPanel;
+ private SeqPanel seqPanel;
- IdPanel idPanel;
+ private IdPanel idPanel;
IdwidthAdjuster idwidthAdjuster;
- /** DOCUMENT ME!! */
public AlignFrame alignFrame;
- ScalePanel scalePanel;
+ private ScalePanel scalePanel;
+
+ private AnnotationPanel annotationPanel;
- AnnotationPanel annotationPanel;
+ private AnnotationLabels alabels;
- AnnotationLabels alabels;
+ private int hextent = 0;
- // this value is set false when selection area being dragged
- boolean fastPaint = true;
+ private int vextent = 0;
+
+ /*
+ * Flag set while scrolling to follow complementary cDNA/protein scroll. When
+ * false, suppresses invoking the same method recursively.
+ */
+ private boolean scrollComplementaryPanel = true;
- int hextent = 0;
+ private PropertyChangeListener propertyChangeListener;
- int vextent = 0;
+ private CalculationChooser calculationDialog;
/**
* Creates a new AlignmentPanel object.
*
* @param af
- * DOCUMENT ME!
* @param av
- * DOCUMENT ME!
*/
public AlignmentPanel(AlignFrame af, final AlignViewport av)
{
+ // setBackground(Color.white); // BH 2019
alignFrame = af;
this.av = av;
- seqPanel = new SeqPanel(av, this);
- idPanel = new IdPanel(av, this);
+ setSeqPanel(new SeqPanel(av, this));
+ setIdPanel(new IdPanel(av, this));
- scalePanel = new ScalePanel(av, this);
+ setScalePanel(new ScalePanel(av, this));
- idPanelHolder.add(idPanel, BorderLayout.CENTER);
+ idPanelHolder.add(getIdPanel(), BorderLayout.CENTER);
idwidthAdjuster = new IdwidthAdjuster(this);
idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
- annotationPanel = new AnnotationPanel(this);
- alabels = new AnnotationLabels(this);
+ setAnnotationPanel(new AnnotationPanel(this));
+ setAlabels(new AnnotationLabels(this));
- annotationScroller.setViewportView(annotationPanel);
- annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);
+ annotationScroller.setViewportView(getAnnotationPanel());
+ annotationSpaceFillerHolder.add(getAlabels(), BorderLayout.CENTER);
- scalePanelHolder.add(scalePanel, BorderLayout.CENTER);
- seqPanelHolder.add(seqPanel, BorderLayout.CENTER);
+ scalePanelHolder.add(getScalePanel(), BorderLayout.CENTER);
+ seqPanelHolder.add(getSeqPanel(), BorderLayout.CENTER);
setScrollValues(0, 0);
- setAnnotationVisible(av.getShowAnnotation());
-
hscroll.addAdjustmentListener(this);
vscroll.addAdjustmentListener(this);
+ addComponentListener(new ComponentAdapter()
+ {
+ @Override
+ public void componentResized(ComponentEvent evt)
+ {
+ // reset the viewport ranges when the alignment panel is resized
+ // in particular, this initialises the end residue value when Jalview
+ // is initialised
+ ViewportRanges ranges = av.getRanges();
+ if (av.getWrapAlignment())
+ {
+ int widthInRes = getSeqPanel().seqCanvas.getWrappedCanvasWidth(
+ getSeqPanel().seqCanvas.getWidth());
+ ranges.setViewportWidth(widthInRes);
+ }
+ else
+ {
+ int widthInRes = getSeqPanel().seqCanvas.getWidth()
+ / av.getCharWidth();
+ int heightInSeq = getSeqPanel().seqCanvas.getHeight()
+ / av.getCharHeight();
+
+ ranges.setViewportWidth(widthInRes);
+ ranges.setViewportHeight(heightInSeq);
+ }
+ }
+
+ });
+
final AlignmentPanel ap = this;
- av.addPropertyChangeListener(new PropertyChangeListener()
+ propertyChangeListener = new PropertyChangeListener()
{
+ @Override
public void propertyChange(PropertyChangeEvent evt)
{
if (evt.getPropertyName().equals("alignment"))
@@ -117,19 +193,34 @@ public class AlignmentPanel extends GAlignmentPanel implements
alignmentChanged();
}
}
- });
+ };
+ av.addPropertyChangeListener(propertyChangeListener);
+
+ av.getRanges().addPropertyChangeListener(this);
fontChanged();
adjustAnnotationHeight();
+ updateLayout();
+ }
+ @Override
+ public AlignViewportI getAlignViewport()
+ {
+ return av;
}
public void alignmentChanged()
{
av.alignmentChanged(this);
+ if (getCalculationDialog() != null)
+ {
+ getCalculationDialog().validateCalcTypes();
+ }
+
alignFrame.updateEditMenuBar();
- paintAlignment(true);
+ // no idea if we need to update structure
+ paintAlignment(true, true);
}
@@ -142,207 +233,339 @@ public class AlignmentPanel extends GAlignmentPanel implements
// to prevent drawing old image
FontMetrics fm = getFontMetrics(av.getFont());
- scalePanelHolder.setPreferredSize(new Dimension(10, av.charHeight
- + fm.getDescent()));
- idSpaceFillerPanel1.setPreferredSize(new Dimension(10, av.charHeight
- + fm.getDescent()));
+ // update the flag controlling whether the grid is too small to render the
+ // font
+ av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
- idPanel.idCanvas.gg = null;
- seqPanel.seqCanvas.img = null;
- annotationPanel.adjustPanelHeight();
+ scalePanelHolder.setPreferredSize(
+ new Dimension(10, av.getCharHeight() + fm.getDescent()));
+ idSpaceFillerPanel1.setPreferredSize(
+ new Dimension(10, av.getCharHeight() + fm.getDescent()));
+ idwidthAdjuster.invalidate();
+ scalePanelHolder.invalidate();
+ // BH 2018 getIdPanel().getIdCanvas().gg = null;
+ getSeqPanel().seqCanvas.img = null;
+ getAnnotationPanel().adjustPanelHeight();
Dimension d = calculateIdWidth();
- d.setSize(d.width + 4, d.height);
- idPanel.idCanvas.setPreferredSize(d);
+ getIdPanel().getIdCanvas().setPreferredSize(d);
hscrollFillerPanel.setPreferredSize(d);
- if (overviewPanel != null)
+ repaint();
+ }
+
+ /**
+ * Calculates the width of the alignment labels based on the displayed names
+ * and any bounds on label width set in preferences.
+ *
+ * The calculated width is set as a property of the viewport and the layout is
+ * updated.
+ *
+ * @return Dimension giving the maximum width of the alignment label panel
+ * that should be used.
+ */
+ public Dimension calculateIdWidth()
+ {
+ int oldWidth = av.getIdWidth();
+
+ // calculate sensible default width when no preference is available
+ Dimension r = null;
+ if (av.getIdWidth() < 0)
+ {
+ r = calculateDefaultAlignmentIdWidth();
+ av.setIdWidth(r.width);
+ }
+ else
{
- overviewPanel.setBoxPosition();
+ r = new Dimension();
+ r.width = av.getIdWidth();
+ r.height = 0;
}
- repaint();
+ /*
+ * fudge: if desired width has changed, update layout
+ * (see also paintComponent - updates layout on a repaint)
+ */
+ if (r.width != oldWidth)
+ {
+ idPanelHolder.setPreferredSize(r);
+ validate();
+ }
+ return r;
+ }
+
+ public Dimension calculateDefaultAlignmentIdWidth()
+ {
+ return calculateIdWidth(-1, false, false);
+ }
+
+ /**
+ * pre 2.11.3 Id width calculation - used when importing old projects only
+ *
+ * @return
+ */
+ public int getLegacyIdWidth()
+ {
+ int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
+ int idWidth = Math.min(afwidth - 200, 2 * afwidth / 3);
+ int maxwidth = Math.max(IdwidthAdjuster.MIN_ID_WIDTH, idWidth);
+ Dimension w = calculateIdWidthOrLegacy(true, maxwidth, false, false);
+ return w.width;
+ }
+
+ /**
+ * Calculate the width of the alignment labels based on the displayed names
+ * and any bounds on label width set in preferences. Also includes annotations
+ * not actually visible.
+ *
+ * FIXME JAL-244 JAL-4091 - doesn't include sequence associated annotation
+ * label decorators and only called during tests
+ *
+ * @param maxwidth
+ * -1 or maximum width allowed for IdWidth
+ * @return Dimension giving the maximum width of the alignment label panel
+ * that should be used.
+ */
+ protected Dimension calculateIdWidth(int maxwidth)
+ {
+ return calculateIdWidth(maxwidth, true, false);
}
/**
* Calculate the width of the alignment labels based on the displayed names
* and any bounds on label width set in preferences.
*
+ * @param maxwidth
+ * -1 or maximum width allowed for IdWidth
+ * @param includeAnnotations
+ * - when true includes width of any additional marks in annotation
+ * id panel
+ * @param visibleOnly
+ * - when true, ignore label widths for hidden annotation rows
* @return Dimension giving the maximum width of the alignment label panel
* that should be used.
*/
- public Dimension calculateIdWidth()
+ public Dimension calculateIdWidth(int maxwidth,
+ boolean includeAnnotations, boolean visibleOnly)
+ {
+ return calculateIdWidthOrLegacy(false, maxwidth, includeAnnotations,
+ visibleOnly);
+ }
+
+ /**
+ * legacy mode or post 2.11.3 ID width calculation
+ *
+ * @param legacy
+ * - uses annotation labels, not rendered label width (excludes
+ * additional decorators)
+ * @param maxwidth
+ * @param includeAnnotations
+ * @param visibleOnly
+ * @return
+ */
+ private Dimension calculateIdWidthOrLegacy(boolean legacy, int maxwidth,
+ boolean includeAnnotations, boolean visibleOnly)
{
Container c = new Container();
- FontMetrics fm = c.getFontMetrics(new Font(av.font.getName(),
- Font.ITALIC, av.font.getSize()));
+ FontMetrics fm = c.getFontMetrics(
+ new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));
AlignmentI al = av.getAlignment();
- int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
- int maxwidth = Math.max(20,
- Math.min(afwidth - 200, (int) 2 * afwidth / 3));
int i = 0;
int idWidth = 0;
- String id;
while ((i < al.getHeight()) && (al.getSequenceAt(i) != null))
{
SequenceI s = al.getSequenceAt(i);
-
- id = s.getDisplayId(av.getShowJVSuffix());
-
- if (fm.stringWidth(id) > idWidth)
- {
- idWidth = fm.stringWidth(id);
- }
-
+ String id = s.getDisplayId(av.getShowJVSuffix());
+ int stringWidth = fm.stringWidth(id);
+ idWidth = Math.max(idWidth, stringWidth);
i++;
}
// Also check annotation label widths
- i = 0;
-
- if (al.getAlignmentAnnotation() != null)
+ if (includeAnnotations && al.getAlignmentAnnotation() != null)
{
- fm = c.getFontMetrics(alabels.getFont());
+ fm = c.getFontMetrics(getAlabels().getFont());
- while (i < al.getAlignmentAnnotation().length)
+ if (!legacy || Jalview.isHeadlessMode())
{
- String label = al.getAlignmentAnnotation()[i].label;
-
- if (fm.stringWidth(label) > idWidth)
+ AnnotationLabels aal = getAlabels();
+ int stringWidth = aal.drawLabels(null, false, idWidth, false, false,
+ fm, !visibleOnly);
+ idWidth = Math.max(idWidth, stringWidth);
+ }
+ else
+ {
+ for (i = 0; i < al.getAlignmentAnnotation().length; i++)
{
- idWidth = fm.stringWidth(label);
+ AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
+ if (visibleOnly && !aa.visible)
+ {
+ continue;
+ }
+ String label = aa.label;
+ int stringWidth = fm.stringWidth(label);
+ idWidth = Math.max(idWidth, stringWidth);
}
-
- i++;
}
}
- return new Dimension(Math.min(maxwidth, idWidth), 12);
+ int w = maxwidth < 0 ? idWidth : Math.min(maxwidth, idWidth);
+ w += ID_WIDTH_PADDING;
+
+ return new Dimension(w, 12);
}
/**
- * Highlight the given results on the alignment.
+ * Highlight the given results on the alignment
*
*/
- public void highlightSearchResults(SearchResults results)
+ public void highlightSearchResults(SearchResultsI results)
{
- scrollToPosition(results);
- seqPanel.seqCanvas.highlightSearchResults(results);
+ boolean scrolled = scrollToPosition(results, 0, false);
+
+ boolean fastPaint = !(scrolled && av.getWrapAlignment());
+
+ getSeqPanel().seqCanvas.highlightSearchResults(results, fastPaint);
}
/**
- * scroll the view to show the position of the highlighted region in results
- * (if any) and redraw the overview
+ * Scroll the view to show the position of the highlighted region in results
+ * (if any)
*
- * @param results
+ * @param searchResults
+ * @return
*/
- public boolean scrollToPosition(SearchResults results)
+ public boolean scrollToPosition(SearchResultsI searchResults)
{
- return scrollToPosition(results, true);
+ return scrollToPosition(searchResults, 0, false);
}
/**
- * scroll the view to show the position of the highlighted region in results
- * (if any)
+ * Scrolls the view (if necessary) to show the position of the first
+ * highlighted region in results (if any). Answers true if the view was
+ * scrolled, or false if no matched region was found, or it is already
+ * visible.
*
* @param results
- * @param redrawOverview
- * - when set, the overview will be recalculated (takes longer)
- * @return false if results were not found
+ * @param verticalOffset
+ * if greater than zero, allows scrolling to a position below the
+ * first displayed sequence
+ * @param centre
+ * if true, try to centre the search results horizontally in the view
+ * @return
*/
- public boolean scrollToPosition(SearchResults results,
- boolean redrawOverview)
- {
- int startv, endv, starts, ends, width;
- // TODO: properly locate search results in view when large numbers of hidden
- // columns exist before highlighted region
- // do we need to scroll the panel?
- // TODO: tons of nullpointereexceptions raised here.
- if (results != null && results.getSize() > 0 && av != null
- && av.alignment != null)
- {
- int seqIndex = av.alignment.findIndex(results);
- if (seqIndex == -1)
- {
- return false;
- }
- SequenceI seq = av.alignment.getSequenceAt(seqIndex);
-
- int[] r=results.getResults(seq, 0, av.alignment.getWidth());
- if (r == null)
- {
- return false;
- }
- int start = r[0];
- int end = r[1];
- // System.err.println("Seq : "+seqIndex+" Scroll to "+start+","+end); //
- // DEBUG
- if (start < 0)
+ protected boolean scrollToPosition(SearchResultsI results,
+ int verticalOffset, boolean centre)
+ {
+ int startv, endv, starts, ends;
+ ViewportRanges ranges = av.getRanges();
+
+ if (results == null || results.isEmpty() || av == null
+ || av.getAlignment() == null)
+ {
+ return false;
+ }
+ int seqIndex = av.getAlignment().findIndex(results);
+ if (seqIndex == -1)
+ {
+ return false;
+ }
+ SequenceI seq = av.getAlignment().getSequenceAt(seqIndex);
+
+ int[] r = results.getResults(seq, 0, av.getAlignment().getWidth());
+ if (r == null)
+ {
+ return false;
+ }
+ int start = r[0];
+ int end = r[1];
+
+ /*
+ * To centre results, scroll to positions half the visible width
+ * left/right of the start/end positions
+ */
+ if (centre)
+ {
+ int offset = (ranges.getEndRes() - ranges.getStartRes() + 1) / 2 - 1;
+ start = Math.max(start - offset, 0);
+ end = end + offset - 1;
+ }
+ if (start < 0)
+ {
+ return false;
+ }
+ if (end == seq.getEnd())
+ {
+ return false;
+ }
+
+ if (av.hasHiddenColumns())
+ {
+ HiddenColumns hidden = av.getAlignment().getHiddenColumns();
+ start = hidden.absoluteToVisibleColumn(start);
+ end = hidden.absoluteToVisibleColumn(end);
+ if (start == end)
{
- return false;
+ if (!hidden.isVisible(r[0]))
+ {
+ // don't scroll - position isn't visible
+ return false;
+ }
}
- if (end == seq.getEnd())
+ }
+
+ /*
+ * allow for offset of target sequence (actually scroll to one above it)
+ */
+ seqIndex = Math.max(0, seqIndex - verticalOffset);
+ boolean scrollNeeded = true;
+
+ if (!av.getWrapAlignment())
+ {
+ if ((startv = ranges.getStartRes()) >= start)
{
- return false;
+ /*
+ * Scroll left to make start of search results visible
+ */
+ setScrollValues(start, seqIndex);
}
- if (av.hasHiddenColumns)
+ else if ((endv = ranges.getEndRes()) <= end)
{
- start = av.getColumnSelection().findColumnPosition(start);
- end = av.getColumnSelection().findColumnPosition(end);
- if (start==end)
- {
- if (!av.colSel.isVisible(r[0]))
- {
- // don't scroll - position isn't visible
- return false;
- }
- }
+ /*
+ * Scroll right to make end of search results visible
+ */
+ setScrollValues(startv + end - endv, seqIndex);
}
- if (!av.wrapAlignment)
+ else if ((starts = ranges.getStartSeq()) > seqIndex)
{
- if ((startv = av.getStartRes()) >= start)
- {
- setScrollValues(start - 1, seqIndex);
- }
- else if ((endv = av.getEndRes()) <= end)
- {
- setScrollValues(startv + 1 + end - endv, seqIndex);
- }
- else if ((starts = av.getStartSeq()) > seqIndex)
- {
- setScrollValues(av.getStartRes(), seqIndex);
- }
- else if ((ends = av.getEndSeq()) <= seqIndex)
- {
- setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1);
- }
+ /*
+ * Scroll up to make start of search results visible
+ */
+ setScrollValues(ranges.getStartRes(), seqIndex);
}
- else
+ else if ((ends = ranges.getEndSeq()) <= seqIndex)
{
- scrollToWrappedVisible(start);
+ /*
+ * Scroll down to make end of search results visible
+ */
+ setScrollValues(ranges.getStartRes(), starts + seqIndex - ends + 1);
}
+ /*
+ * Else results are already visible - no need to scroll
+ */
+ scrollNeeded = false;
}
- if (redrawOverview && overviewPanel != null)
+ else
{
- overviewPanel.setBoxPosition();
+ scrollNeeded = ranges.scrollToWrappedVisible(start);
}
- paintAlignment(redrawOverview);
- return true;
- }
- void scrollToWrappedVisible(int res)
- {
- int cwidth = seqPanel.seqCanvas
- .getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());
- if (res < av.getStartRes() || res >= (av.getStartRes() + cwidth))
- {
- vscroll.setValue((res / cwidth));
- av.startRes = vscroll.getValue() * cwidth;
- }
+ paintAlignment(false, false);
+ return scrollNeeded;
}
/**
@@ -368,12 +591,13 @@ public class AlignmentPanel extends GAlignmentPanel implements
/**
*
- * @param b Hide or show annotation panel
- *
+ * @param b
+ * Hide or show annotation panel
+ *
*/
public void setAnnotationVisible(boolean b)
{
- if (!av.wrapAlignment)
+ if (!av.getWrapAlignment())
{
annotationSpaceFillerHolder.setVisible(b);
annotationScroller.setVisible(b);
@@ -382,298 +606,325 @@ public class AlignmentPanel extends GAlignmentPanel implements
}
/**
- * automatically adjust annotation panel height for new annotation
- * whilst ensuring the alignment is still visible.
+ * automatically adjust annotation panel height for new annotation whilst
+ * ensuring the alignment is still visible.
*/
+ @Override
public void adjustAnnotationHeight()
{
// TODO: display vertical annotation scrollbar if necessary
// this is called after loading new annotation onto alignment
if (alignFrame.getHeight() == 0)
{
- System.out.println("NEEDS FIXING");
+ jalview.bin.Console.error(
+ "adjustAnnotationHeight called with zero height alignment window");
}
+ validateAnnotationDimensions(true);
+ addNotify();
+ // TODO: many places call this method and also paintAlignment with various
+ // different settings. this means multiple redraws are triggered...
+ paintAlignment(true, av.needToUpdateStructureViews());
+ }
- int height = annotationPanel.adjustPanelHeight();
-
- if (hscroll.isVisible())
- {
- height += hscroll.getPreferredSize().height;
- }
- if (height > alignFrame.getHeight() / 2)
- {
- height = alignFrame.getHeight() / 2;
- }
+ /**
+ * calculate the annotation dimensions and refresh slider values accordingly.
+ * need to do repaints/notifys afterwards.
+ */
+ protected void validateAnnotationDimensions(boolean adjustPanelHeight)
+ {
+ // BH 2018.04.18 comment: addNotify() is not appropriate here. We
+ // are not changing ancestors, and keyboard action listeners do
+ // not need to be reset. addNotify() is a very expensive operation,
+ // requiring a full re-layout of all parents and children.
+ // Note in JComponent:
+ // This method is called by the toolkit internally and should
+ // not be called directly by programs.
+ // I note that addNotify() is called in several areas of Jalview.
+
+ AnnotationPanel ap = getAnnotationPanel();
+ int annotationHeight = ap.adjustPanelHeight();
+ annotationHeight = ap.adjustForAlignFrame(adjustPanelHeight,
+ annotationHeight);
hscroll.addNotify();
+ Dimension e = idPanel.getSize();
+ int idWidth = e.width;
+ boolean manuallyAdjusted = this.getIdPanel().getIdCanvas()
+ .isManuallyAdjusted();
+ annotationScroller.setPreferredSize(new Dimension(
+ manuallyAdjusted ? idWidth : annotationScroller.getWidth(),
+ annotationHeight));
- annotationScroller.setPreferredSize(new Dimension(annotationScroller
- .getWidth(), height));
+ alabels.setPreferredSize(new Dimension(idWidth, annotationHeight));
annotationSpaceFillerHolder.setPreferredSize(new Dimension(
- annotationSpaceFillerHolder.getWidth(), height));
- annotationScroller.validate();// repaint();
- addNotify();
- repaint();
+ manuallyAdjusted ? idWidth
+ : annotationSpaceFillerHolder.getWidth(),
+ annotationHeight));
+ annotationScroller.validate();
+ annotationScroller.addNotify();
+ ap.validate();
}
/**
- * DOCUMENT ME!
+ * update alignment layout for viewport settings
*
* @param wrap
* DOCUMENT ME!
*/
- public void setWrapAlignment(boolean wrap)
+ public void updateLayout()
{
- av.startSeq = 0;
- scalePanelHolder.setVisible(!wrap);
+ fontChanged();
+ setAnnotationVisible(av.isShowAnnotation());
+ boolean wrap = av.getWrapAlignment();
+ ViewportRanges ranges = av.getRanges();
+ ranges.setStartSeq(0);
+ // scalePanelHolder.setVisible(!wrap);
hscroll.setVisible(!wrap);
- idwidthAdjuster.setVisible(!wrap);
+ // Allow idPanel width adjustment in wrap mode
+ idwidthAdjuster.setVisible(true);
if (wrap)
{
annotationScroller.setVisible(false);
annotationSpaceFillerHolder.setVisible(false);
}
- else if (av.showAnnotation)
+ else if (av.isShowAnnotation())
{
annotationScroller.setVisible(true);
annotationSpaceFillerHolder.setVisible(true);
+ validateAnnotationDimensions(false);
}
- idSpaceFillerPanel1.setVisible(!wrap);
-
- repaint();
- }
-
- // return value is true if the scroll is valid
- public boolean scrollUp(boolean up)
- {
- if (up)
- {
- if (vscroll.getValue() < 1)
+ int canvasWidth = getSeqPanel().seqCanvas.getWidth();
+ if (canvasWidth > 0)
+ { // may not yet be laid out
+ if (wrap)
{
- return false;
+ int widthInRes = getSeqPanel().seqCanvas
+ .getWrappedCanvasWidth(canvasWidth);
+ ranges.setViewportWidth(widthInRes);
}
-
- fastPaint = false;
- vscroll.setValue(vscroll.getValue() - 1);
- }
- else
- {
- if ((vextent + vscroll.getValue()) >= av.getAlignment().getHeight())
+ else
{
- return false;
- }
+ int widthInRes = (canvasWidth / av.getCharWidth());
+ int heightInSeq = (getSeqPanel().seqCanvas.getHeight()
+ / av.getCharHeight());
- fastPaint = false;
- vscroll.setValue(vscroll.getValue() + 1);
+ ranges.setViewportWidth(widthInRes);
+ ranges.setViewportHeight(heightInSeq);
+ }
}
- fastPaint = true;
+ // idSpaceFillerPanel1.setVisible(!wrap);
- return true;
+ repaint();
}
/**
- * DOCUMENT ME!
+ * Adjust row/column scrollers to show a visible position in the alignment.
*
- * @param right
- * DOCUMENT ME!
+ * @param x
+ * visible column to scroll to
+ * @param y
+ * visible row to scroll to
*
- * @return DOCUMENT ME!
*/
- public boolean scrollRight(boolean right)
+ public void setScrollValues(int xpos, int ypos)
{
- if (!right)
+ int x = xpos;
+ int y = ypos;
+
+ if (av == null || av.getAlignment() == null)
{
- if (hscroll.getValue() < 1)
- {
- return false;
- }
+ return;
+ }
- fastPaint = false;
- hscroll.setValue(hscroll.getValue() - 1);
+ if (av.getWrapAlignment())
+ {
+ setScrollingForWrappedPanel(x);
}
else
{
- if ((hextent + hscroll.getValue()) >= av.getAlignment().getWidth())
+ int width = av.getAlignment().getVisibleWidth();
+ int height = av.getAlignment().getHeight();
+
+ hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
+ vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
+
+ if (hextent > width)
{
- return false;
+ hextent = width;
}
- fastPaint = false;
- hscroll.setValue(hscroll.getValue() + 1);
- }
+ if (vextent > height)
+ {
+ vextent = height;
+ }
+
+ if ((hextent + x) > width)
+ {
+ x = width - hextent;
+ }
+
+ if ((vextent + y) > height)
+ {
+ y = height - vextent;
+ }
- fastPaint = true;
+ if (y < 0)
+ {
+ y = 0;
+ }
+
+ if (x < 0)
+ {
+ x = 0;
+ }
- return true;
+ // update the scroll values
+ hscroll.setValues(x, hextent, 0, width);
+ vscroll.setValues(y, vextent, 0, height);
+ }
}
/**
- * Adjust row/column scrollers to show a visible position in the alignment.
+ * Respond to adjustment event when horizontal or vertical scrollbar is
+ * changed
*
- * @param x visible column to scroll to
- * DOCUMENT ME!
- * @param y visible row to scroll to
- *
+ * @param evt
+ * adjustment event encoding whether hscroll or vscroll changed
*/
- public void setScrollValues(int x, int y)
+ @Override
+ public void adjustmentValueChanged(AdjustmentEvent evt)
{
- // System.err.println("Scroll to "+x+","+y);
- if (av == null || av.alignment == null)
+ if (av.getWrapAlignment())
{
+ adjustScrollingWrapped(evt);
return;
}
- int width = av.alignment.getWidth();
- int height = av.alignment.getHeight();
- if (av.hasHiddenColumns)
- {
- width = av.getColumnSelection().findColumnPosition(width);
- }
-
- av.setEndRes((x + (seqPanel.seqCanvas.getWidth() / av.charWidth)) - 1);
-
- hextent = seqPanel.seqCanvas.getWidth() / av.charWidth;
- vextent = seqPanel.seqCanvas.getHeight() / av.charHeight;
-
- if (hextent > width)
- {
- hextent = width;
- }
-
- if (vextent > height)
- {
- vextent = height;
- }
-
- if ((hextent + x) > width)
- {
- x = width - hextent;
- }
+ ViewportRanges ranges = av.getRanges();
- if ((vextent + y) > height)
+ if (evt.getSource() == hscroll)
{
- y = height - vextent;
- }
+ int oldX = ranges.getStartRes();
+ int oldwidth = ranges.getViewportWidth();
+ int x = hscroll.getValue();
+ int width = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
- if (y < 0)
- {
- y = 0;
+ // if we're scrolling to the position we're already at, stop
+ // this prevents infinite recursion of events when the scroll/viewport
+ // ranges values are the same
+ if ((x == oldX) && (width == oldwidth))
+ {
+ return;
+ }
+ ranges.setViewportStartAndWidth(x, width);
}
-
- if (x < 0)
+ else if (evt.getSource() == vscroll)
{
- x = 0;
+ int oldY = ranges.getStartSeq();
+ int oldheight = ranges.getViewportHeight();
+ int y = vscroll.getValue();
+ int height = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
+
+ // if we're scrolling to the position we're already at, stop
+ // this prevents infinite recursion of events when the scroll/viewport
+ // ranges values are the same
+ if ((y == oldY) && (height == oldheight))
+ {
+ return;
+ }
+ ranges.setViewportStartAndHeight(y, height);
}
-
- hscroll.setValues(x, hextent, 0, width);
- vscroll.setValues(y, vextent, 0, height);
+ repaint();
}
/**
- * DOCUMENT ME!
+ * Responds to a scroll change by setting the start position of the viewport.
+ * Does
*
* @param evt
- * DOCUMENT ME!
*/
- public void adjustmentValueChanged(AdjustmentEvent evt)
+ protected void adjustScrollingWrapped(AdjustmentEvent evt)
{
-
- int oldX = av.getStartRes();
- int oldY = av.getStartSeq();
-
if (evt.getSource() == hscroll)
{
- int x = hscroll.getValue();
- av.setStartRes(x);
- av.setEndRes((x + (seqPanel.seqCanvas.getWidth() / av.getCharWidth())) - 1);
+ return; // no horizontal scroll when wrapped
}
+ final ViewportRanges ranges = av.getRanges();
if (evt.getSource() == vscroll)
{
- int offy = vscroll.getValue();
-
- if (av.getWrapAlignment())
+ int newY = vscroll.getValue();
+
+ /*
+ * if we're scrolling to the position we're already at, stop
+ * this prevents infinite recursion of events when the scroll/viewport
+ * ranges values are the same
+ */
+ int oldX = ranges.getStartRes();
+ int oldY = ranges.getWrappedScrollPosition(oldX);
+ if (oldY == newY)
{
- if (offy > -1)
- {
- int rowSize = seqPanel.seqCanvas
- .getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());
- av.setStartRes(offy * rowSize);
- av.setEndRes((offy + 1) * rowSize);
- }
- else
- {
- // This is only called if file loaded is a jar file that
- // was wrapped when saved and user has wrap alignment true
- // as preference setting
- SwingUtilities.invokeLater(new Runnable()
- {
- public void run()
- {
- setScrollValues(av.getStartRes(), av.getStartSeq());
- }
- });
- }
+ return;
}
- else
+ if (newY > -1)
{
- av.setStartSeq(offy);
- av.setEndSeq(offy
- + (seqPanel.seqCanvas.getHeight() / av.getCharHeight()));
+ /*
+ * limit page up/down to one width's worth of positions
+ */
+ int rowSize = ranges.getViewportWidth();
+ int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
+ ranges.setViewportStartAndWidth(Math.max(0, newX), rowSize);
}
}
-
- if (overviewPanel != null)
+ else
{
- overviewPanel.setBoxPosition();
+ // This is only called if file loaded is a jar file that
+ // was wrapped when saved and user has wrap alignment true
+ // as preference setting
+ SwingUtilities.invokeLater(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ // When updating scrolling to use ViewportChange events, this code
+ // could not be validated and it is not clear if it is now being
+ // called. Log warning here in case it is called and unforeseen
+ // problems occur
+ Console.warn(
+ "Unexpected path through code: Wrapped jar file opened with wrap alignment set in preferences");
+
+ // scroll to start of panel
+ ranges.setStartRes(0);
+ ranges.setStartSeq(0);
+ }
+ });
}
+ repaint();
+ }
- int scrollX = av.startRes - oldX;
- int scrollY = av.startSeq - oldY;
-
- if (av.getWrapAlignment() || !fastPaint)
- {
- repaint();
- }
- else
- {
- // Make sure we're not trying to draw a panel
- // larger than the visible window
- if (scrollX > av.endRes - av.startRes)
- {
- scrollX = av.endRes - av.startRes;
- }
- else if (scrollX < av.startRes - av.endRes)
- {
- scrollX = av.startRes - av.endRes;
- }
-
- if (scrollX != 0 || scrollY != 0)
- {
- idPanel.idCanvas.fastPaint(scrollY);
- seqPanel.seqCanvas.fastPaint(scrollX, scrollY);
- scalePanel.repaint();
-
- if (av.getShowAnnotation())
- {
- annotationPanel.fastPaint(scrollX);
- }
- }
- }
- }
-
- public void paintAlignment(boolean updateOverview)
+ /* (non-Javadoc)
+ * @see jalview.api.AlignmentViewPanel#paintAlignment(boolean)
+ */
+ @Override
+ public void paintAlignment(boolean updateOverview,
+ boolean updateStructures)
{
+ final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
+ av.isShowAutocalculatedAbove());
+ sorter.sort(getAlignment().getAlignmentAnnotation(),
+ av.getSortAnnotationsBy());
repaint();
+ if (updateStructures)
+ {
+ av.getStructureSelectionManager().sequenceColoursChanged(this);
+ }
if (updateOverview)
{
- jalview.structure.StructureSelectionManager
- .getStructureSelectionManager().sequenceColoursChanged(this);
if (overviewPanel != null)
{
@@ -682,47 +933,62 @@ public class AlignmentPanel extends GAlignmentPanel implements
}
}
- /**
- * DOCUMENT ME!
- *
- * @param g
- * DOCUMENT ME!
- */
+ @Override
public void paintComponent(Graphics g)
{
- invalidate();
-
- Dimension d = idPanel.idCanvas.getPreferredSize();
- idPanelHolder.setPreferredSize(d);
- hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));
- validate();
+ invalidate(); // needed so that the id width adjuster works correctly
+ Dimension d = getIdPanel().getIdCanvas().getPreferredSize();
+ int idWidth = d.width;
+ // check wrapped alignment as at least 1 residue width
if (av.getWrapAlignment())
{
- int maxwidth = av.alignment.getWidth();
-
- if (av.hasHiddenColumns)
+ SeqCanvas sc = this.getSeqPanel().seqCanvas;
+ if (sc != null && sc.getWidth() < sc.getMinimumWrappedCanvasWidth())
{
- maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
- }
+ // need to make some adjustments
+ idWidth -= (sc.getMinimumWrappedCanvasWidth() - sc.getWidth());
+ av.setIdWidth(idWidth);
+ av.getAlignPanel().getIdPanel().getIdCanvas()
+ .setManuallyAdjusted(true);
- int canvasWidth = seqPanel.seqCanvas
- .getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());
- if (canvasWidth > 0)
- {
- int max = maxwidth
- / seqPanel.seqCanvas
- .getWrappedCanvasWidth(seqPanel.seqCanvas
- .getWidth()) + 1;
- vscroll.setMaximum(max);
- vscroll.setUnitIncrement(1);
- vscroll.setVisibleAmount(1);
+ validateAnnotationDimensions(false);
}
}
- else
- {
- setScrollValues(av.getStartRes(), av.getStartSeq());
- }
+
+ idPanelHolder.setPreferredSize(new Dimension(idWidth, d.height));
+ hscrollFillerPanel.setPreferredSize(new Dimension(idWidth, 12));
+
+ validate(); // needed so that the id width adjuster works correctly
+
+ /*
+ * set scroll bar positions - tried to remove but necessary for split panel to resize correctly
+ * though I still think this call should be elsewhere.
+ */
+ ViewportRanges ranges = av.getRanges();
+ setScrollValues(ranges.getStartRes(), ranges.getStartSeq());
+ super.paintComponent(g);
+ }
+
+ /**
+ * Set vertical scroll bar position, and number of increments, for wrapped
+ * panel
+ *
+ * @param topLeftColumn
+ * the column position at top left (0..)
+ */
+ private void setScrollingForWrappedPanel(int topLeftColumn)
+ {
+ ViewportRanges ranges = av.getRanges();
+ int scrollPosition = ranges.getWrappedScrollPosition(topLeftColumn);
+ int maxScroll = ranges.getWrappedMaxScroll(topLeftColumn);
+
+ /*
+ * a scrollbar's value can be set to at most (maximum-extent)
+ * so we add extent (1) to the maxScroll value
+ */
+ vscroll.setUnitIncrement(1);
+ vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
}
/**
@@ -740,6 +1006,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
* @throws PrinterException
* DOCUMENT ME!
*/
+ @Override
public int print(Graphics pg, PageFormat pf, int pi)
throws PrinterException
{
@@ -750,268 +1017,231 @@ public class AlignmentPanel extends GAlignmentPanel implements
if (av.getWrapAlignment())
{
- return printWrappedAlignment(pg, pwidth, pheight, pi);
+ return printWrappedAlignment(pwidth, pheight, pi, pg);
}
else
{
- return printUnwrapped(pg, pwidth, pheight, pi);
+ return printUnwrapped(pwidth, pheight, pi, pg, pg);
}
}
/**
- * DOCUMENT ME!
- *
- * @param pg
- * DOCUMENT ME!
- * @param pwidth
- * DOCUMENT ME!
- * @param pheight
- * DOCUMENT ME!
- * @param pi
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Draws the alignment image, including sequence ids, sequences, and
+ * annotation labels and annotations if shown, on either one or two Graphics
+ * contexts.
*
+ * @param pageWidth
+ * in pixels
+ * @param pageHeight
+ * in pixels
+ * @param pageIndex
+ * (0, 1, ...)
+ * @param idGraphics
+ * the graphics context for sequence ids and annotation labels
+ * @param alignmentGraphics
+ * the graphics context for sequences and annotations (may or may not
+ * be the same context as idGraphics)
+ * @return
* @throws PrinterException
- * DOCUMENT ME!
*/
- public int printUnwrapped(Graphics pg, int pwidth, int pheight, int pi)
+ public int printUnwrapped(int pageWidth, int pageHeight, int pageIndex,
+ Graphics idGraphics, Graphics alignmentGraphics)
throws PrinterException
{
- int idWidth = getVisibleIdWidth();
- FontMetrics fm = getFontMetrics(av.getFont());
- int scaleHeight = av.charHeight + fm.getDescent();
-
- pg.setColor(Color.white);
- pg.fillRect(0, 0, pwidth, pheight);
- pg.setFont(av.getFont());
-
- // //////////////////////////////////
- // / How many sequences and residues can we fit on a printable page?
- int totalRes = (pwidth - idWidth) / av.getCharWidth();
+ final int idWidth, idWidthForGui;
+ // otherwise calculate it
+ idWidth = getVisibleIdWidth(false);
+ // if (getIdPanel()!=null && getIdPanel().getWidth()>0)
+ // {
+ // // use the current IdPanel's width, if its set and non-zero
+ // idWidthForGui = getIdPanel().getWidth();
+ // } else {
+ // idWidthForGui=0;
+ // }
+ /*
+ * Get the horizontal offset to where we draw the sequences.
+ * This is idWidth if using a single Graphics context, else zero.
+ */
+ final int alignmentGraphicsOffset = idGraphics != alignmentGraphics ? 0
+ : idWidth;
- int totalSeq = (int) ((pheight - scaleHeight) / av.getCharHeight()) - 1;
+ FontMetrics fm = getFontMetrics(av.getFont());
+ final int charHeight = av.getCharHeight();
+ final int scaleHeight = charHeight + fm.getDescent();
- int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;
+ idGraphics.setColor(Color.white);
+ idGraphics.fillRect(0, 0, pageWidth, pageHeight);
+ idGraphics.setFont(av.getFont());
- // ///////////////////////////
- // / Only print these sequences and residues on this page
- int startRes;
+ /*
+ * How many sequences and residues can we fit on a printable page?
+ */
+ final int totalRes = (pageWidth - idWidth) / av.getCharWidth();
- // ///////////////////////////
- // / Only print these sequences and residues on this page
- int endRes;
+ final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
- // ///////////////////////////
- // / Only print these sequences and residues on this page
- int startSeq;
+ final int alignmentWidth = av.getAlignment().getVisibleWidth();
+ int pagesWide = (alignmentWidth / totalRes) + 1;
- // ///////////////////////////
- // / Only print these sequences and residues on this page
- int endSeq;
- startRes = (pi % pagesWide) * totalRes;
- endRes = (startRes + totalRes) - 1;
+ final int startRes = (pageIndex % pagesWide) * totalRes;
+ final int endRes = Math.min(startRes + totalRes - 1,
+ alignmentWidth - 1);
- if (endRes > (av.getAlignment().getWidth() - 1))
- {
- endRes = av.getAlignment().getWidth() - 1;
- }
+ final int startSeq = (pageIndex / pagesWide) * totalSeq;
+ final int alignmentHeight = av.getAlignment().getHeight();
+ final int endSeq = Math.min(startSeq + totalSeq, alignmentHeight);
- startSeq = (pi / pagesWide) * totalSeq;
- endSeq = startSeq + totalSeq;
+ int pagesHigh = ((alignmentHeight / totalSeq) + 1) * pageHeight;
- if (endSeq > av.getAlignment().getHeight())
+ if (av.isShowAnnotation())
{
- endSeq = av.getAlignment().getHeight();
+ pagesHigh += getAnnotationPanel().adjustPanelHeight() + 3;
}
- int pagesHigh = ((av.alignment.getHeight() / totalSeq) + 1) * pheight;
+ pagesHigh /= pageHeight;
- if (av.showAnnotation)
- {
- pagesHigh += annotationPanel.adjustPanelHeight() + 3;
- }
-
- pagesHigh /= pheight;
-
- if (pi >= (pagesWide * pagesHigh))
+ if (pageIndex >= (pagesWide * pagesHigh))
{
return Printable.NO_SUCH_PAGE;
}
-
- // draw Scale
- pg.translate(idWidth, 0);
- scalePanel.drawScale(pg, startRes, endRes, pwidth - idWidth,
- scaleHeight);
- pg.translate(-idWidth, scaleHeight);
-
- // //////////////
- // Draw the ids
- Color currentColor = null;
- Color currentTextColor = null;
-
- pg.setFont(idPanel.idCanvas.idfont);
-
- SequenceI seq;
- for (int i = startSeq; i < endSeq; i++)
- {
- seq = av.getAlignment().getSequenceAt(i);
- if ((av.getSelectionGroup() != null)
- && av.getSelectionGroup().getSequences(null).contains(seq))
- {
- currentColor = Color.gray;
- currentTextColor = Color.black;
- }
- else
- {
- currentColor = av.getSequenceColour(seq);
- currentTextColor = Color.black;
- }
-
- pg.setColor(currentColor);
- pg.fillRect(0, (i - startSeq) * av.charHeight, idWidth,
- av.getCharHeight());
-
- pg.setColor(currentTextColor);
-
- int xPos = 0;
- if (av.rightAlignIds)
- {
- fm = pg.getFontMetrics();
- xPos = idWidth
- - fm.stringWidth(seq.getDisplayId(av.getShowJVSuffix()))
- - 4;
- }
-
- pg.drawString(
- seq.getDisplayId(av.getShowJVSuffix()),
- xPos,
- (((i - startSeq) * av.charHeight) + av.getCharHeight())
- - (av.getCharHeight() / 5));
- }
-
- pg.setFont(av.getFont());
-
- // draw main sequence panel
- pg.translate(idWidth, 0);
- seqPanel.seqCanvas.drawPanel(pg, startRes, endRes, startSeq, endSeq, 0);
-
- if (av.showAnnotation && (endSeq == av.alignment.getHeight()))
+ final int alignmentDrawnHeight = (endSeq - startSeq) * charHeight + 3;
+
+ alignmentGraphics.setColor(Color.white);
+ alignmentGraphics.fillRect(0, 0, pageWidth, pageHeight + scaleHeight);
+
+ /*
+ * draw the Scale at horizontal offset, then reset to top left (0, 0)
+ */
+ alignmentGraphics.translate(alignmentGraphicsOffset, 0);
+ getScalePanel().drawScale(alignmentGraphics, startRes, endRes,
+ pageWidth - idWidth, scaleHeight);
+ alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
+
+ /*
+ * Draw the sequence ids, offset for scale height,
+ * then reset to top left (0, 0)
+ */
+ idGraphics.translate(0, scaleHeight);
+ IdCanvas idCanvas = getIdPanel().getIdCanvas();
+ List selection = av.getSelectionGroup() == null ? null
+ : av.getSelectionGroup().getSequences(null);
+
+ idCanvas.drawIds((Graphics2D) idGraphics, av, startSeq, endSeq - 1,
+ selection, false, idWidth);
+
+ idGraphics.setFont(av.getFont());
+ idGraphics.translate(0, -scaleHeight);
+
+ /*
+ * draw the sequences, offset for scale height, and id width (if using a
+ * single graphics context), then reset to (0, scale height)
+ */
+ alignmentGraphics.translate(alignmentGraphicsOffset, scaleHeight);
+ getSeqPanel().seqCanvas.drawPanelForPrinting(alignmentGraphics,
+ startRes, endRes, startSeq, endSeq - 1);
+ alignmentGraphics.translate(-alignmentGraphicsOffset, 0);
+
+ if (av.isShowAnnotation() && (endSeq == alignmentHeight))
{
- pg.translate(-idWidth - 3, (endSeq - startSeq) * av.charHeight + 3);
- alabels.drawComponent((Graphics2D) pg, idWidth);
- pg.translate(idWidth + 3, 0);
- annotationPanel.drawComponent((Graphics2D) pg, startRes, endRes + 1);
+ /*
+ * draw annotation labels; drawComponent() translates by
+ * getScrollOffset(), so compensate for that first;
+ * then reset to (0, scale height)
+ */
+ int offset = getAlabels().getScrollOffset();
+ idGraphics.translate(0, -offset);
+ idGraphics.translate(0, alignmentDrawnHeight);
+ getAlabels().drawComponentNotGUI(idGraphics, idWidth);
+ idGraphics.translate(0, -alignmentDrawnHeight);
+
+ /*
+ * draw the annotations starting at
+ * (idOffset, alignmentHeight) from (0, scaleHeight)
+ */
+ alignmentGraphics.translate(alignmentGraphicsOffset,
+ alignmentDrawnHeight);
+ updateLayout();
+ getAnnotationPanel().renderer.drawComponent(getAnnotationPanel(), av,
+ alignmentGraphics, -1, startRes, endRes + 1);
}
return Printable.PAGE_EXISTS;
}
/**
- * DOCUMENT ME!
+ * Prints one page of an alignment in wrapped mode. Returns
+ * Printable.PAGE_EXISTS (0) if a page was drawn, or Printable.NO_SUCH_PAGE if
+ * no page could be drawn (page number out of range).
*
- * @param pg
- * DOCUMENT ME!
- * @param pwidth
- * DOCUMENT ME!
- * @param pheight
- * DOCUMENT ME!
- * @param pi
- * DOCUMENT ME!
+ * @param pageWidth
+ * @param pageHeight
+ * @param pageNumber
+ * (0, 1, ...)
+ * @param g
*
- * @return DOCUMENT ME!
+ * @return
*
* @throws PrinterException
- * DOCUMENT ME!
*/
- public int printWrappedAlignment(Graphics pg, int pwidth, int pheight,
- int pi) throws PrinterException
+ public int printWrappedAlignment(int pageWidth, int pageHeight,
+ int pageNumber, Graphics g) throws PrinterException
{
-
+ getSeqPanel().seqCanvas.calculateWrappedGeometry(getWidth(),
+ getHeight());
int annotationHeight = 0;
- AnnotationLabels labels = null;
- if (av.showAnnotation)
+ if (av.isShowAnnotation())
{
- annotationHeight = annotationPanel.adjustPanelHeight();
- labels = new AnnotationLabels(av);
+ annotationHeight = getAnnotationPanel().adjustPanelHeight();
}
- int hgap = av.charHeight;
- if (av.scaleAboveWrapped)
+ int hgap = av.getCharHeight();
+ if (av.getScaleAboveWrapped())
{
- hgap += av.charHeight;
+ hgap += av.getCharHeight();
}
- int cHeight = av.getAlignment().getHeight() * av.charHeight + hgap
+ int cHeight = av.getAlignment().getHeight() * av.getCharHeight() + hgap
+ annotationHeight;
- int idWidth = getVisibleIdWidth();
+ int idWidth = getVisibleIdWidth(false);
- int maxwidth = av.alignment.getWidth();
- if (av.hasHiddenColumns)
- {
- maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
- }
+ int maxwidth = av.getAlignment().getVisibleWidth();
- int resWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(pwidth
- - idWidth);
+ int resWidth = getSeqPanel().seqCanvas
+ .getWrappedCanvasWidth(pageWidth - idWidth);
+ av.getRanges().setViewportStartAndWidth(0, resWidth);
int totalHeight = cHeight * (maxwidth / resWidth + 1);
- pg.setColor(Color.white);
- pg.fillRect(0, 0, pwidth, pheight);
- pg.setFont(av.getFont());
+ g.setColor(Color.white);
+ g.fillRect(0, 0, pageWidth, pageHeight);
+ g.setFont(av.getFont());
+ g.setColor(Color.black);
- // //////////////
- // Draw the ids
- pg.setColor(Color.black);
+ /*
+ * method: print the whole wrapped alignment, but with a clip region that
+ * is restricted to the requested page; this supports selective print of
+ * single pages or ranges, (at the cost of repeated processing in the
+ * 'normal' case, when all pages are printed)
+ */
+ g.translate(0, -pageNumber * pageHeight);
- pg.translate(0, -pi * pheight);
+ g.setClip(0, pageNumber * pageHeight, pageWidth, pageHeight);
- pg.setClip(0, pi * pheight, pwidth, pheight);
+ /*
+ * draw sequence ids and annotation labels (if shown)
+ */
+ IdCanvas idCanvas = getIdPanel().getIdCanvas();
+ idCanvas.drawIdsWrappedNoGUI((Graphics2D) g, av, 0, totalHeight);
- int ypos = hgap;
+ g.translate(idWidth, 0);
- do
- {
- for (int i = 0; i < av.alignment.getHeight(); i++)
- {
- pg.setFont(idPanel.idCanvas.idfont);
- SequenceI s = av.alignment.getSequenceAt(i);
- String string = s.getDisplayId(av.getShowJVSuffix());
- int xPos = 0;
- if (av.rightAlignIds)
- {
- FontMetrics fm = pg.getFontMetrics();
- xPos = idWidth - fm.stringWidth(string) - 4;
- }
- pg.drawString(string, xPos,
- ((i * av.charHeight) + ypos + av.charHeight)
- - (av.charHeight / 5));
- }
- if (labels != null)
- {
- pg.translate(-3, ypos
- + (av.getAlignment().getHeight() * av.charHeight));
-
- pg.setFont(av.getFont());
- labels.drawComponent(pg, idWidth);
- pg.translate(+3, -ypos
- - (av.getAlignment().getHeight() * av.charHeight));
- }
-
- ypos += cHeight;
- } while (ypos < totalHeight);
+ getSeqPanel().seqCanvas.drawWrappedPanelForPrinting(g,
+ pageWidth - idWidth, totalHeight, 0);
- pg.translate(idWidth, 0);
-
- seqPanel.seqCanvas.drawWrappedPanel(pg, pwidth - idWidth, totalHeight,
- 0);
-
- if ((pi * pheight) < totalHeight)
+ if ((pageNumber * pageHeight) < totalHeight)
{
return Printable.PAGE_EXISTS;
-
}
else
{
@@ -1019,115 +1249,146 @@ public class AlignmentPanel extends GAlignmentPanel implements
}
}
- int getVisibleIdWidth()
+ /**
+ * get current sequence ID panel width, or nominal value if panel were to be
+ * displayed using default settings
+ *
+ * @return
+ */
+ public int getVisibleIdWidth()
{
- return idPanel.getWidth() > 0 ? idPanel.getWidth()
- : calculateIdWidth().width + 4;
+ return getVisibleIdWidth(true);
}
- void makeAlignmentImage(int type, File file)
+ /**
+ * get current sequence ID panel width, or nominal value if panel were to be
+ * displayed using default settings
+ *
+ * @param onscreen
+ * indicate if the Id width for onscreen or offscreen display should
+ * be returned
+ * @return
+ */
+ protected int getVisibleIdWidth(boolean onscreen)
{
- int maxwidth = av.alignment.getWidth();
- if (av.hasHiddenColumns)
+ // see if rendering offscreen - check preferences and calc width accordingly
+ if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
{
- maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);
+ return calculateIdWidth(-1, true, true).width;
}
-
- int height = ((av.alignment.getHeight() + 1) * av.charHeight)
- + scalePanel.getHeight();
- int width = getVisibleIdWidth() + (maxwidth * av.charWidth);
-
- if (av.getWrapAlignment())
+ Integer idwidth = onscreen ? null
+ : Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH");
+ if (idwidth != null)
{
- height = getWrappedHeight();
- if (System.getProperty("java.awt.headless") != null
- && System.getProperty("java.awt.headless").equals("true"))
- {
- // TODO: JAL-244
- width = alignFrame.getWidth() - vscroll.getPreferredSize().width
- - alignFrame.getInsets().left
- - alignFrame.getInsets().right;
- }
- else
- {
- width = seqPanel.getWidth() + getVisibleIdWidth();
- }
-
- }
- else if (av.getShowAnnotation())
- {
- height += annotationPanel.adjustPanelHeight() + 3;
+ return idwidth.intValue() + ID_WIDTH_PADDING;
}
- try
- {
+ int w = getIdPanel().getWidth();
+ w = calculateIdWidth(-1, true, true).width;
+ return (w > 0 ? w : calculateIdWidth().width);
+ }
- jalview.util.ImageMaker im;
- if (type == jalview.util.ImageMaker.PNG)
- {
- im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.PNG,
- "Create PNG image from alignment", width, height, file,
- null);
- }
- else
- {
- im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.EPS,
- "Create EPS file from alignment", width, height, file,
- alignFrame.getTitle());
- }
+ void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer)
+ throws ImageOutputException
+ {
+ makeAlignmentImage(type, file, renderer,
+ BitmapImageSizing.defaultBitmapImageSizing());
+ }
+
+ /**
+ * Builds an image of the alignment of the specified type (EPS/PNG/SVG) and
+ * writes it to the specified file
+ *
+ * @param type
+ * @param file
+ * @param textrenderer
+ * @param bitmapscale
+ */
+ void makeAlignmentImage(ImageMaker.TYPE type, File file, String renderer,
+ BitmapImageSizing userBis) throws ImageOutputException
+ {
+ final int borderBottomOffset = 5;
- if (av.getWrapAlignment())
+ AlignmentDimension aDimension = getAlignmentDimension();
+
+ // todo use a lambda function in place of callback here?
+ ImageWriterI writer = new ImageWriterI()
+ {
+ @Override
+ public void exportImage(Graphics graphics) throws Exception
{
- if (im.getGraphics() != null)
+ if (av.getWrapAlignment())
{
- printWrappedAlignment(im.getGraphics(), width, height, 0);
- im.writeImage();
+ printWrappedAlignment(aDimension.getWidth(),
+ aDimension.getHeight() + borderBottomOffset, 0, graphics);
}
- }
- else
- {
- if (im.getGraphics() != null)
+ else
{
- printUnwrapped(im.getGraphics(), width, height, 0);
- im.writeImage();
+ printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
+ graphics, graphics);
}
}
- } catch (OutOfMemoryError err)
- {
- // Be noisy here.
- System.out.println("########################\n" + "OUT OF MEMORY "
- + file + "\n" + "########################");
- new OOMWarning("Creating Image for " + file, err);
- // System.out.println("Create IMAGE: " + err);
- } catch (Exception ex)
- {
- ex.printStackTrace();
- }
+ };
+
+ String fileTitle = alignFrame.getTitle();
+ ImageExporter exporter = new ImageExporter(writer, alignFrame, type,
+ fileTitle);
+ int imageWidth = aDimension.getWidth();
+ int imageHeight = aDimension.getHeight() + borderBottomOffset;
+ String of = MessageManager.getString("label.alignment");
+ exporter.doExport(file, this, imageWidth, imageHeight, of, renderer,
+ userBis);
}
/**
- * DOCUMENT ME!
+ * Calculates and returns a suitable width and height (in pixels) for an
+ * exported image
+ *
+ * @return
*/
- public void makeEPS(File epsFile)
+ public AlignmentDimension getAlignmentDimension()
{
- makeAlignmentImage(jalview.util.ImageMaker.EPS, epsFile);
- }
+ int maxwidth = av.getAlignment().getVisibleWidth();
+
+ int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
+ + getScalePanel().getHeight();
+ int width = getVisibleIdWidth(false) + (maxwidth * av.getCharWidth());
+
+ if (av.getWrapAlignment())
+ {
+ height = getWrappedHeight();
+ if (Jalview.isHeadlessMode())
+ {
+ // need to obtain default alignment width and then add in any
+ // additional allowance for id margin
+ // this duplicates the calculation in getWrappedHeight but adjusts for
+ // offscreen idWith
+ width = alignFrame.getWidth() - vscroll.getPreferredSize().width
+ - alignFrame.getInsets().left - alignFrame.getInsets().right
+ - getVisibleIdWidth() + getVisibleIdWidth(false);
+ }
+ else
+ {
+ width = getSeqPanel().getWidth() + getVisibleIdWidth(false);
+ }
+
+ }
+ else if (av.isShowAnnotation())
+ {
+ height += getAnnotationPanel().adjustPanelHeight() + 3;
+ }
+ return new AlignmentDimension(width, height);
- /**
- * DOCUMENT ME!
- */
- public void makePNG(File pngFile)
- {
- makeAlignmentImage(jalview.util.ImageMaker.PNG, pngFile);
}
public void makePNGImageMap(File imgMapFile, String imageName)
+ throws ImageOutputException
{
- // /////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS
+ // /////ONLY WORKS WITH NON WRAPPED ALIGNMENTS
// ////////////////////////////////////////////
- int idWidth = getVisibleIdWidth();
+ int idWidth = getVisibleIdWidth(false);
FontMetrics fm = getFontMetrics(av.getFont());
- int scaleHeight = av.charHeight + fm.getDescent();
+ int scaleHeight = av.getCharHeight() + fm.getDescent();
// Gen image map
// ////////////////////////////////
@@ -1135,119 +1396,109 @@ public class AlignmentPanel extends GAlignmentPanel implements
{
try
{
- int s, sSize = av.alignment.getHeight(), res, alwidth = av.alignment
- .getWidth(), g, gSize, f, fSize, sy;
- StringBuffer text = new StringBuffer();
+ int sSize = av.getAlignment().getHeight();
+ int alwidth = av.getAlignment().getWidth();
PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));
- out.println(jalview.io.HTMLOutput.getImageMapHTML());
+ out.println(HTMLOutput.getImageMapHTML());
out.println("
"
+ "