From 71a8851cfb5ce8cadd2af91e517234be3677a6e1 Mon Sep 17 00:00:00 2001 From: gmungoc Date: Wed, 11 Oct 2017 15:01:16 +0100 Subject: [PATCH] JAL-2609 tidy label width code, some checkstyle warnings --- src/jalview/gui/SeqCanvas.java | 154 +++++++++++++++++++--------------------- src/jalview/gui/SeqPanel.java | 2 +- 2 files changed, 73 insertions(+), 83 deletions(-) diff --git a/src/jalview/gui/SeqCanvas.java b/src/jalview/gui/SeqCanvas.java index 36da5fe..adc36f9 100755 --- a/src/jalview/gui/SeqCanvas.java +++ b/src/jalview/gui/SeqCanvas.java @@ -47,57 +47,52 @@ import java.util.List; import javax.swing.JComponent; /** - * DOCUMENT ME! + * The Swing component on which the alignment sequences, and annotations (if + * shown), are drawn. This includes scales above, left and right (if shown) in + * Wrapped mode, but not the scale above in Unwrapped mode. * - * @author $author$ - * @version $Revision$ */ public class SeqCanvas extends JComponent implements ViewportListenerI { - private static String ZEROS = "0000000000"; + private static final String ZEROS = "0000000000"; final FeatureRenderer fr; - final SequenceRenderer seqRdr; - BufferedImage img; - Graphics2D gg; - - int imgWidth; - - int imgHeight; - AlignViewport av; - boolean fastPaint = false; - - boolean fastpainting = false; - int cursorX = 0; int cursorY = 0; + private final SequenceRenderer seqRdr; + + private boolean fastPaint = false; + + private boolean fastpainting = false; + private AnnotationPanel annotations; /* * measurements for drawing a wrapped alignment */ - int labelWidthWest; // label left width in pixels if shown - private int labelWidthEast; // label right width in pixels if shown + private int labelWidthWest; // label left width in pixels if shown + private int wrappedSpaceAboveAlignment; // gap between widths private int wrappedRepeatHeightPx; // height in pixels of wrapped width private int wrappedVisibleWidths; // number of wrapped widths displayed + private Graphics2D gg; + /** * Creates a new SeqCanvas object. * - * @param av - * DOCUMENT ME! + * @param ap */ public SeqCanvas(AlignmentPanel ap) { @@ -190,19 +185,21 @@ public class SeqCanvas extends JComponent implements ViewportListenerI * @param left * if true, scale is left of residues, if false, scale is right */ - void drawVerticalScale(Graphics g, int startx, int endx, int ypos, - boolean left) + void drawVerticalScale(Graphics g, final int startx, final int endx, + final int ypos, final boolean left) { int charHeight = av.getCharHeight(); int charWidth = av.getCharWidth(); - ypos += charHeight; + int yPos = ypos + charHeight; + int startX = startx; + int endX = endx; if (av.hasHiddenColumns()) { HiddenColumns hiddenColumns = av.getAlignment().getHiddenColumns(); - startx = hiddenColumns.adjustForHiddenColumns(startx); - endx = hiddenColumns.adjustForHiddenColumns(endx); + startX = hiddenColumns.adjustForHiddenColumns(startx); + endX = hiddenColumns.adjustForHiddenColumns(endx); } FontMetrics fm = getFontMetrics(av.getFont()); @@ -214,9 +211,9 @@ public class SeqCanvas extends JComponent implements ViewportListenerI * find sequence position of first non-gapped position - * to the right if scale left, to the left if scale right */ - int index = left ? startx : endx; + int index = left ? startX : endX; int value = -1; - while (index >= startx && index <= endx) + while (index >= startX && index <= endX) { if (!Comparison.isGap(seq.getCharAt(index))) { @@ -237,24 +234,24 @@ public class SeqCanvas extends JComponent implements ViewportListenerI * white fill the space for the scale */ g.setColor(Color.white); - int y = (ypos + (i * charHeight)) - (charHeight / 5); + int y = (yPos + (i * charHeight)) - (charHeight / 5); // fillRect origin is top left of rectangle g.fillRect(0, y - charHeight, left ? labelWidthWest : labelWidthEast, charHeight + 1); if (value != -1) { - /* - * draw scale value, right justified, with half a character width - * separation from the sequence data + * draw scale value, right justified within its width less half a + * character width padding on the right */ + int labelSpace = left ? labelWidthWest : labelWidthEast; + labelSpace -= charWidth / 2; // leave space to the right String valueAsString = String.valueOf(value); - int justify = fm.stringWidth(valueAsString) + charWidth; - int xpos = left ? labelWidthWest - justify + charWidth / 2 - : labelWidthEast - justify + charWidth / 2; + int labelLength = fm.stringWidth(valueAsString); + int xOffset = labelSpace - labelLength; g.setColor(Color.black); - g.drawString(valueAsString, xpos, y); + g.drawString(valueAsString, xOffset, y); } } } @@ -569,27 +566,26 @@ public class SeqCanvas extends JComponent implements ViewportListenerI FontMetrics fm = getFontMetrics(av.getFont()); - labelWidthEast = 0; - labelWidthWest = 0; - - if (av.getScaleRightWrapped()) + int labelWidth = 0; + + if (av.getScaleRightWrapped() || av.getScaleLeftWrapped()) { - labelWidthEast = getLabelWidth(fm); + labelWidth = getLabelWidth(fm); } - if (av.getScaleLeftWrapped()) - { - labelWidthWest = labelWidthEast > 0 ? labelWidthEast - : getLabelWidth(fm); - } + labelWidthEast = av.getScaleRightWrapped() ? labelWidth : 0; + + labelWidthWest = av.getScaleLeftWrapped() ? labelWidth : 0; return (canvasWidth - labelWidthEast - labelWidthWest) / charWidth; } /** - * Returns a pixel width suitable for showing the largest sequence coordinate - * (end position) in the alignment. Returns 2 plus the number of decimal - * digits to be shown (3 for 1-10, 4 for 11-99 etc). + * Returns a pixel width sufficient to show the largest sequence coordinate + * (end position) in the alignment, calculated as the FontMetrics width of + * zeroes "0000000" limited to the number of decimal digits to be shown (3 for + * 1-10, 4 for 11-99 etc). One character width is added to this, to allow for + * half a character width space on either side. * * @param fm * @return @@ -607,13 +603,13 @@ public class SeqCanvas extends JComponent implements ViewportListenerI maxWidth = Math.max(maxWidth, alignment.getSequenceAt(i).getEnd()); } - int length = 2; + int length = 0; for (int i = maxWidth; i > 0; i /= 10) { length++; } - return fm.stringWidth(ZEROS.substring(0, length)); + return fm.stringWidth(ZEROS.substring(0, length)) + av.getCharWidth(); } /** @@ -678,19 +674,6 @@ public class SeqCanvas extends JComponent implements ViewportListenerI protected int calculateWrappedGeometry(int canvasWidth, int canvasHeight) { int charHeight = av.getCharHeight(); - int charWidth = av.getCharWidth(); - - /* - * width of labels in pixels left and right (if shown) - */ - int labelWidth = 0; - if (av.getScaleRightWrapped() || av.getScaleLeftWrapped()) - { - FontMetrics fm = getFontMetrics(av.getFont()); - labelWidth = getLabelWidth(fm); - } - labelWidthEast = av.getScaleRightWrapped() ? labelWidth : 0; - labelWidthWest = av.getScaleLeftWrapped() ? labelWidth : 0; /* * vertical space in pixels between wrapped widths of alignment @@ -710,14 +693,6 @@ public class SeqCanvas extends JComponent implements ViewportListenerI wrappedRepeatHeightPx += getAnnotationHeight(); /* - * number of residue columns we can show in each row; - * this is just canvas width less scale left and right (if shown), - * as a whole multiple of character widths - */ - int wrappedWidthInResidues = (canvasWidth - labelWidthEast - - labelWidthWest) / charWidth; - - /* * number of visible widths (the last one may be part height), * ensuring a part height includes at least one sequence */ @@ -731,6 +706,11 @@ public class SeqCanvas extends JComponent implements ViewportListenerI } /* + * compute width in residues; this also sets East and West label widths + */ + int wrappedWidthInResidues = getWrappedCanvasWidth(canvasWidth); + + /* * limit visibleWidths to not exceed width of alignment */ int maxWidths = (xMax - ranges.getStartRes()) / wrappedWidthInResidues; @@ -756,9 +736,6 @@ public class SeqCanvas extends JComponent implements ViewportListenerI protected void drawWrappedWidth(Graphics g, int ypos, int startColumn, int endColumn, int canvasHeight) { - int charHeight = av.getCharHeight(); - int charWidth = av.getCharWidth(); - ViewportRanges ranges = av.getRanges(); int viewportWidth = ranges.getViewportWidth(); @@ -769,6 +746,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI * plus column offset from left margin (usually zero, but may be non-zero * when fast painting is drawing just a few columns) */ + int charWidth = av.getCharWidth(); int xOffset = labelWidthWest + ((startColumn - ranges.getStartRes()) % viewportWidth) * charWidth; @@ -799,7 +777,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI drawPanel(g, startColumn, endx, 0, av.getAlignment().getHeight() - 1, ypos); - int cHeight = av.getAlignment().getHeight() * charHeight; + int cHeight = av.getAlignment().getHeight() * av.getCharHeight(); if (av.isShowAnnotation()) { @@ -824,7 +802,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI * @param g * @param startColumn */ - protected void drawWrappedDecorators(Graphics g, int startColumn) + protected void drawWrappedDecorators(Graphics g, final int startColumn) { int charWidth = av.getCharWidth(); @@ -836,20 +814,22 @@ public class SeqCanvas extends JComponent implements ViewportListenerI int viewportWidth = ranges.getViewportWidth(); int maxWidth = ranges.getVisibleAlignmentWidth(); int widthsDrawn = 0; + int startCol = startColumn; + while (widthsDrawn < wrappedVisibleWidths) { - int endColumn = Math.min(maxWidth, startColumn + viewportWidth - 1); + int endColumn = Math.min(maxWidth, startCol + viewportWidth - 1); if (av.getScaleLeftWrapped()) { - drawVerticalScale(g, startColumn, endColumn - 1, ypos, true); + drawVerticalScale(g, startCol, endColumn - 1, ypos, true); } if (av.getScaleRightWrapped()) { int x = labelWidthWest + viewportWidth * charWidth; g.translate(x, 0); - drawVerticalScale(g, startColumn, endColumn, ypos, false); + drawVerticalScale(g, startCol, endColumn, ypos, false); g.translate(-x, 0); } @@ -866,18 +846,18 @@ public class SeqCanvas extends JComponent implements ViewportListenerI if (av.getScaleAboveWrapped()) { - drawNorthScale(g, startColumn, endColumn, ypos); + drawNorthScale(g, startCol, endColumn, ypos); } if (av.hasHiddenColumns() && av.getShowHiddenMarkers()) { - drawHiddenColumnMarkers(g, ypos, startColumn, endColumn); + drawHiddenColumnMarkers(g, ypos, startCol, endColumn); } g.translate(-labelWidthWest, 0); ypos += wrappedRepeatHeightPx; - startColumn += viewportWidth; + startCol += viewportWidth; widthsDrawn++; } } @@ -2086,4 +2066,14 @@ public class SeqCanvas extends JComponent implements ViewportListenerI return matchFound; } + + /** + * Answers the width in pixels of the left scale labels (0 if not shown) + * + * @return + */ + int getLabelWidthWest() + { + return labelWidthWest; + } } diff --git a/src/jalview/gui/SeqPanel.java b/src/jalview/gui/SeqPanel.java index 2d30c90..8cb5e07 100644 --- a/src/jalview/gui/SeqPanel.java +++ b/src/jalview/gui/SeqPanel.java @@ -216,7 +216,7 @@ public class SeqPanel extends JPanel int y = evt.getY(); y = Math.max(0, y - hgap); - x = Math.max(0, x - seqCanvas.labelWidthWest); + x = Math.max(0, x - seqCanvas.getLabelWidthWest()); int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth()); if (cwidth < 1) -- 1.7.10.2