X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSeqCanvas.java;h=c2a2ccbdab4bbf429c20c7c78e8720db4daa0e09;hb=e510f5ac2ae4530767c92cbe99e871c7f21eb36a;hp=789fb3f5b48d74c72947183755a55bf0aaf6e425;hpb=6e71f42b0a3713ddbc3054e7ea9d8f5088130ec9;p=jalview.git diff --git a/src/jalview/gui/SeqCanvas.java b/src/jalview/gui/SeqCanvas.java index 789fb3f..6919f8a 100755 --- a/src/jalview/gui/SeqCanvas.java +++ b/src/jalview/gui/SeqCanvas.java @@ -1,590 +1,2111 @@ -/* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program 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 2 - * of the License, or (at your option) any later version. - * - * This program 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - */ -package jalview.gui; - -import java.awt.*; -import java.awt.image.*; -import javax.swing.*; - -import jalview.analysis.*; -import jalview.datamodel.*; - -public class SeqCanvas - extends JComponent -{ - FeatureRenderer fr; - SequenceRenderer sr; - BufferedImage img; - Graphics2D gg; - int imgWidth; - int imgHeight; - AlignViewport av; - boolean showScores = false; - boolean displaySearch = false; - int[] searchResults = null; - int chunkHeight; - int chunkWidth; - boolean fastPaint = false; - int LABEL_WEST; - int LABEL_EAST; - - - public SeqCanvas(AlignViewport av) - { - this.av = av; - fr = new FeatureRenderer(av); - sr = new SequenceRenderer(av); - setLayout(new BorderLayout()); - PaintRefresher.Register(this, av.alignment); - setBackground(Color.white); - } - - void drawNorthScale(Graphics g, int startx, int endx, int ypos) - { - int scalestartx = startx - (startx % 10) + 10; - - g.setColor(Color.black); - - // NORTH SCALE - for (int i = scalestartx; i < endx; i += 10) - { - String string = String.valueOf(i); - g.drawString(string, (i - startx - 1) * av.charWidth, - ypos - (av.charHeight / 2)); - - g.drawLine( ( (i - startx - 1) * av.charWidth) + (av.charWidth / 2), - (ypos + 2) - (av.charHeight / 2), - ( (i - startx - 1) * av.charWidth) + (av.charWidth / 2), ypos - - 2); - } - } - - void drawWestScale(Graphics g, int startx, int endx, int ypos) - { - FontMetrics fm = getFontMetrics(av.getFont()); - ypos += av.charHeight; - - // EAST SCALE - for (int i = 0; i < av.alignment.getHeight(); i++) - { - SequenceI seq = av.alignment.getSequenceAt(i); - int index = startx; - int value = -1; - - while (index < endx) - { - if (jalview.util.Comparison.isGap(seq.getCharAt(index))) - { - index++; - - continue; - } - - value = av.alignment.getSequenceAt(i).findPosition(index); - - break; - } - - if (value != -1) - { - int x = LABEL_WEST - fm.stringWidth(value + ""); - g.drawString(value + "", x, - (ypos + (i * av.charHeight)) - (av.charHeight / 5)); - } - } - } - - void drawEastScale(Graphics g, int startx, int endx, int ypos) - { - ypos += av.charHeight; - - // EAST SCALE - for (int i = 0; i < av.alignment.getHeight(); i++) - { - SequenceI seq = av.alignment.getSequenceAt(i); - int index = endx; - int value = -1; - - while (index > startx) - { - if (jalview.util.Comparison.isGap(seq.getCharAt(index))) - { - index--; - - continue; - } - - value = av.alignment.getSequenceAt(i).findPosition(index); - - break; - } - - if (value != -1) - { - g.drawString(value + "", 0, - (ypos + (i * av.charHeight)) - (av.charHeight / 5)); - } - } - } - - public void fastPaint(int horizontal, int vertical) - { - if ( ( (horizontal == 0) && (vertical == 0)) || (gg == null)) - { - return; - } - - gg.copyArea(0, 0, imgWidth, imgHeight, -horizontal * av.charWidth, - -vertical * av.charHeight); - - int sr = av.startRes; - int er = av.endRes; - int ss = av.startSeq; - int es = av.endSeq; - int transX = 0; - int transY = 0; - - if (horizontal > 0) // scrollbar pulled right, image to the left - { - transX = (er - sr - horizontal) * av.charWidth; - sr = er - horizontal; - } - else if (horizontal < 0) - { - er = sr - horizontal; - } - else if (vertical > 0) // scroll down - { - ss = es - vertical; - - if (ss < av.startSeq) - { // ie scrolling too fast, more than a page at a time - ss = av.startSeq; - } - else - { - transY = imgHeight - (vertical * av.charHeight); - } - } - else if (vertical < 0) - { - es = ss - vertical; - - if (es > av.endSeq) - { - es = av.endSeq; - } - } - - gg.translate(transX, transY); - - gg.setColor(Color.white); - gg.fillRect(0, 0, (er - sr + 1) * av.charWidth, - (es - ss) * av.charHeight); - drawPanel(gg, sr, er, ss, es, sr, ss, 0); - gg.translate( -transX, -transY); - - fastPaint = true; - repaint(); - } - - /** - * Definitions of startx and endx (hopefully): - * SMJS This is what I'm working towards! - * startx is the first residue (starting at 0) to display. - * endx is the last residue to display (starting at 0). - * starty is the first sequence to display (starting at 0). - * endy is the last sequence to display (starting at 0). - * NOTE 1: The av limits are set in setFont in this class and - * in the adjustment listener in SeqPanel when the scrollbars move. - */ - - - // Set this to false to force a full panel paint - public void paintComponent(Graphics g) - { - if (fastPaint || getWidth() != g.getClipBounds().width - || getHeight() != g.getClipBounds().height) - { - g.drawImage(img, 0, 0, this); - fastPaint = false; - return; - } - - // this draws the whole of the alignment - imgWidth = getWidth(); - imgHeight = getHeight(); - - imgWidth -= (imgWidth % av.charWidth); - imgHeight -= (imgHeight % av.charHeight); - - if ( (imgWidth < 1) || (imgHeight < 1)) - { - return; - } - - img = new BufferedImage(imgWidth, imgHeight, BufferedImage.TYPE_INT_RGB); - gg = (Graphics2D) img.getGraphics(); - gg.setFont(av.getFont()); - gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING, - RenderingHints.VALUE_ANTIALIAS_ON); - - gg.setColor(Color.white); - gg.fillRect(0, 0, imgWidth, imgHeight); - - chunkWidth = getWrappedCanvasWidth(getWidth()); - chunkHeight = (av.getAlignment().getHeight() + 2) * av.charHeight; - - av.setChunkHeight(chunkHeight); - av.setChunkWidth(chunkWidth); - - if (av.getWrapAlignment()) - { - drawWrappedPanel(gg, getWidth(), getHeight(), av.startRes); - } - else - { - drawPanel(gg, av.startRes, av.endRes, av.startSeq, av.endSeq, - av.startRes, av.startSeq, 0); - } - - g.drawImage(img, 0, 0, this); - } - - public int getWrappedCanvasWidth(int cwidth) - { - FontMetrics fm = getFontMetrics(av.getFont()); - - LABEL_EAST = 0; - LABEL_WEST = 0; - - if (av.scaleRightWrapped) - { - LABEL_EAST = fm.stringWidth(av.alignment.getWidth() + "000"); - } - - if (av.scaleLeftWrapped) - { - LABEL_WEST = fm.stringWidth(av.alignment.getWidth() + ""); - } - - return (cwidth - LABEL_EAST - LABEL_WEST) / av.charWidth; - } - - public void drawWrappedPanel(Graphics g, int canvasWidth, int canvasHeight, - int startRes) - { - AlignmentI al = av.getAlignment(); - - FontMetrics fm = getFontMetrics(av.getFont()); - - int LABEL_EAST = 0; - - if (av.scaleRightWrapped) - { - LABEL_EAST = fm.stringWidth(al.getWidth() + "000"); - } - - int LABEL_WEST = 0; - - if (av.scaleLeftWrapped) - { - LABEL_WEST = fm.stringWidth(al.getWidth() + "0"); - } - - int cWidth = (canvasWidth - LABEL_EAST - LABEL_WEST) / av.charWidth; - int cHeight = (av.getAlignment().getHeight() + 2) * av.charHeight; - - av.endRes = av.startRes + cWidth; - - int endx = (startRes + cWidth) - 1; - int ypos = 2 * av.charHeight; - - while ( (ypos <= canvasHeight) && (startRes < av.alignment.getWidth())) - { - g.setColor(Color.black); - - if (av.scaleLeftWrapped) - { - drawWestScale(g, startRes, endx, ypos); - } - - if (av.scaleRightWrapped) - { - g.translate(canvasWidth - LABEL_EAST + av.charWidth, 0); - drawEastScale(g, startRes, endx, ypos); - g.translate( - (canvasWidth - LABEL_EAST + av.charWidth), 0); - } - - g.translate(LABEL_WEST, 0); - - if (av.scaleAboveWrapped) - { - drawNorthScale(g, startRes, endx, ypos); - } - - // When printing we have an extra clipped region, - // the Printable page which we need to account for here - Shape clip = g.getClip(); - - if (clip == null) - { - g.setClip(0, 0, cWidth * av.charWidth, canvasHeight); - } - else - { - g.setClip(0, (int) clip.getBounds().getY(), - cWidth * av.charWidth, (int) clip.getBounds().getHeight()); - } - - drawPanel(g, startRes, endx, 0, al.getHeight(), startRes, 0, ypos); - g.setClip(clip); - g.translate( -LABEL_WEST, 0); - - ypos += cHeight; - startRes += cWidth; - endx = (startRes + cWidth) - 1; - - if (endx > al.getWidth()) - { - endx = al.getWidth(); - } - } - } - - synchronized public void drawPanel(Graphics g1, int x1, int x2, int y1, - int y2, int startx, int starty, int offset) - { - Graphics2D g = (Graphics2D) g1; - g.setFont(av.getFont()); - sr.renderGaps(av.renderGaps); - - SequenceI nextSeq; - - /// First draw the sequences - ///////////////////////////// - for (int i = y1; i < y2; i++) - { - nextSeq = av.alignment.getSequenceAt(i); - - sr.drawSequence(g, nextSeq, av.alignment.findAllGroups(nextSeq), - x1, x2, (x1 - startx) * av.charWidth, - offset + - AlignmentUtil.getPixelHeight(starty, i, av.charHeight), - av.charWidth, av.charHeight); - - if (av.showSequenceFeatures) - { - fr.drawSequence(g, nextSeq, - av.alignment.findAllGroups(nextSeq), x1, x2, - (x1 - startx) * av.charWidth, - offset + - AlignmentUtil.getPixelHeight(starty, i, av.charHeight), - av.charWidth, av.charHeight); - } - } - - // - ///////////////////////////////////// - // Now outline any areas if necessary - ///////////////////////////////////// - SequenceGroup group = av.getSelectionGroup(); - java.util.Vector groups = av.alignment.getGroups(); - - int sx = -1; - int sy = -1; - int ex = -1; - int groupIndex = -1; - - if ( (group == null) && (groups.size() > 0)) - { - group = (SequenceGroup) groups.elementAt(0); - groupIndex = 0; - } - - if (group != null) - { - do - { - int oldY = -1; - int i = 0; - boolean inGroup = false; - int top = -1; - int bottom = -1; - - for (i = y1; i < y2; i++) - { - sx = (group.getStartRes() - startx) * av.charWidth; - sy = offset + - AlignmentUtil.getPixelHeight(starty, i, av.charHeight); - ex = ( ( (group.getEndRes() + 1) - group.getStartRes()) * - av.charWidth) - - 1; - - if ( (sx < getWidth()) && (ex > 0) && - group.sequences.contains(av.alignment.getSequenceAt( - i))) - { - if ( (bottom == -1) && - !group.sequences.contains( - av.alignment.getSequenceAt(i + 1))) - { - bottom = sy + av.charHeight; - } - - if (!inGroup) - { - if ( ( (top == -1) && (i == 0)) || - !group.sequences.contains( - av.alignment.getSequenceAt(i - 1))) - { - top = sy; - } - - oldY = sy; - inGroup = true; - - if (group == av.getSelectionGroup()) - { - g.setStroke(new BasicStroke(1, - BasicStroke.CAP_BUTT, - BasicStroke.JOIN_ROUND, 3f, - new float[] - {5f, 3f}, 0f)); - g.setColor(Color.RED); - } - else - { - g.setStroke(new BasicStroke()); - g.setColor(group.getOutlineColour()); - } - } - } - else - { - if (inGroup) - { - g.drawLine(sx, oldY, sx, sy); - g.drawLine(sx + ex, oldY, sx + ex, sy); - - if (top != -1) - { - g.drawLine(sx, top, sx + ex, top); - top = -1; - } - - if (bottom != -1) - { - g.drawLine(sx, bottom, sx + ex, bottom); - bottom = -1; - } - - inGroup = false; - } - } - } - - if (inGroup) - { - if (top != -1) - { - g.drawLine(sx, top, sx + ex, top); - top = -1; - } - - if (bottom != -1) - { - g.drawLine(sx, bottom - 1, sx + ex, bottom - 1); - bottom = -1; - } - - sy = offset + - AlignmentUtil.getPixelHeight(starty, i, av.charHeight); - g.drawLine(sx, oldY, sx, sy); - g.drawLine(sx + ex, oldY, sx + ex, sy); - inGroup = false; - } - - groupIndex++; - - if (groupIndex >= groups.size()) - { - break; - } - - group = (SequenceGroup) groups.elementAt(groupIndex); - } - while (groupIndex < groups.size()); - } - - /// Highlight search Results once all sequences have been drawn - ////////////////////////////////////////////////////////// - if (displaySearch) - { - for (int r = 0; r < searchResults.length; r += 3) - { - int searchSeq = searchResults[r]; - - if ( (searchSeq >= y1) && (searchSeq < y2)) - { - SequenceI seq = av.getAlignment().getSequenceAt(searchSeq); - - int searchStart = seq.findIndex(searchResults[r + 1]) - 1; - int searchEnd = seq.findIndex(searchResults[r + 2]) - 1; - - SequenceRenderer ssr = (SequenceRenderer) sr; - - if (searchStart < x1) - { - searchStart = x1; - } - - if (searchEnd > x2) - { - searchEnd = x2; - } - - ssr.drawHighlightedText(seq, searchStart, searchEnd, - (searchStart - startx) * av.charWidth, - offset + - AlignmentUtil.getPixelHeight(starty, - searchSeq, - av.charHeight), av.charWidth, av.charHeight); - } - } - } - } - - public void highlightSearchResults(int[] results) - { - // results are in the order sequence, startRes, endRes - if (results == null) - { - displaySearch = false; - } - else - { - displaySearch = true; - } - - searchResults = results; - - repaint(); - } -} +/* + * 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. + * + * 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 . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ +package jalview.gui; + +import jalview.datamodel.AlignmentI; +import jalview.datamodel.HiddenColumns; +import jalview.datamodel.SearchResultsI; +import jalview.datamodel.SequenceGroup; +import jalview.datamodel.SequenceI; +import jalview.renderer.ScaleRenderer; +import jalview.renderer.ScaleRenderer.ScaleMark; +import jalview.util.Comparison; +import jalview.viewmodel.ViewportListenerI; +import jalview.viewmodel.ViewportRanges; + +import java.awt.AlphaComposite; +import java.awt.BasicStroke; +import java.awt.BorderLayout; +import java.awt.Color; +import java.awt.FontMetrics; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.RenderingHints; +import java.awt.Shape; +import java.awt.image.BufferedImage; +import java.beans.PropertyChangeEvent; +import java.util.List; + +import javax.swing.JComponent; + +/** + * 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. + * + */ +public class SeqCanvas extends JComponent implements ViewportListenerI +{ + private static final String ZEROS = "0000000000"; + + final FeatureRenderer fr; + + BufferedImage img; + + AlignViewport av; + + 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 + */ + 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 ap + */ + public SeqCanvas(AlignmentPanel ap) + { + this.av = ap.av; + fr = new FeatureRenderer(ap); + seqRdr = new SequenceRenderer(av); + setLayout(new BorderLayout()); + PaintRefresher.Register(this, av.getSequenceSetId()); + setBackground(Color.white); + + av.getRanges().addPropertyChangeListener(this); + } + + public SequenceRenderer getSequenceRenderer() + { + return seqRdr; + } + + public FeatureRenderer getFeatureRenderer() + { + return fr; + } + + /** + * Draws the scale above a region of a wrapped alignment, consisting of a + * column number every major interval (10 columns). + * + * @param g + * the graphics context to draw on, positioned at the start (bottom + * left) of the line on which to draw any scale marks + * @param startx + * start alignment column (0..) + * @param endx + * end alignment column (0..) + * @param ypos + * y offset to draw at + */ + private void drawNorthScale(Graphics g, int startx, int endx, int ypos) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + /* + * white fill the scale space (for the fastPaint case) + */ + g.setColor(Color.white); + g.fillRect(0, ypos - charHeight - charHeight / 2, getWidth(), + charHeight * 3 / 2 + 2); + g.setColor(Color.black); + + List marks = new ScaleRenderer().calculateMarks(av, startx, + endx); + for (ScaleMark mark : marks) + { + int mpos = mark.column; // (i - startx - 1) + if (mpos < 0) + { + continue; + } + String mstring = mark.text; + + if (mark.major) + { + if (mstring != null) + { + g.drawString(mstring, mpos * charWidth, ypos - (charHeight / 2)); + } + + /* + * draw a tick mark below the column number, centred on the column; + * height of tick mark is 4 pixels less than half a character + */ + int xpos = (mpos * charWidth) + (charWidth / 2); + g.drawLine(xpos, (ypos + 2) - (charHeight / 2), xpos, ypos - 2); + } + } + } + + /** + * Draw the scale to the left or right of a wrapped alignment + * + * @param g + * graphics context, positioned at the start of the scale to be drawn + * @param startx + * first column of wrapped width (0.. excluding any hidden columns) + * @param endx + * last column of wrapped width (0.. excluding any hidden columns) + * @param ypos + * vertical offset at which to begin the scale + * @param left + * if true, scale is left of residues, if false, scale is right + */ + void drawVerticalScale(Graphics g, final int startx, final int endx, + final int ypos, final boolean left) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + 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); + } + FontMetrics fm = getFontMetrics(av.getFont()); + + for (int i = 0; i < av.getAlignment().getHeight(); i++) + { + SequenceI seq = av.getAlignment().getSequenceAt(i); + + /* + * 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 value = -1; + while (index >= startX && index <= endX) + { + if (!Comparison.isGap(seq.getCharAt(index))) + { + value = seq.findPosition(index); + break; + } + if (left) + { + index++; + } + else + { + index--; + } + } + + /* + * white fill the space for the scale + */ + g.setColor(Color.white); + 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 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 labelLength = fm.stringWidth(valueAsString); + int xOffset = labelSpace - labelLength; + g.setColor(Color.black); + g.drawString(valueAsString, xOffset, y); + } + } + } + + /** + * Does a fast paint of an alignment in response to a scroll. Most of the + * visible region is simply copied and shifted, and then any newly visible + * columns or rows are drawn. The scroll may be horizontal or vertical, but + * not both at once. Scrolling may be the result of + * + * + * @param horizontal + * columns to shift right (positive) or left (negative) + * @param vertical + * rows to shift down (positive) or up (negative) + */ + public void fastPaint(int horizontal, int vertical) + { + if (fastpainting || gg == null || img == null) + { + return; + } + fastpainting = true; + fastPaint = true; + + try + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + ViewportRanges ranges = av.getRanges(); + int startRes = ranges.getStartRes(); + int endRes = ranges.getEndRes(); + int startSeq = ranges.getStartSeq(); + int endSeq = ranges.getEndSeq(); + int transX = 0; + int transY = 0; + + gg.copyArea(horizontal * charWidth, vertical * charHeight, + img.getWidth(), img.getHeight(), -horizontal * charWidth, + -vertical * charHeight); + + if (horizontal > 0) // scrollbar pulled right, image to the left + { + transX = (endRes - startRes - horizontal) * charWidth; + startRes = endRes - horizontal; + } + else if (horizontal < 0) + { + endRes = startRes - horizontal; + } + + if (vertical > 0) // scroll down + { + startSeq = endSeq - vertical; + + if (startSeq < ranges.getStartSeq()) + { // ie scrolling too fast, more than a page at a time + startSeq = ranges.getStartSeq(); + } + else + { + transY = img.getHeight() - ((vertical + 1) * charHeight); + } + } + else if (vertical < 0) + { + endSeq = startSeq - vertical; + + if (endSeq > ranges.getEndSeq()) + { + endSeq = ranges.getEndSeq(); + } + } + + gg.translate(transX, transY); + drawPanel(gg, startRes, endRes, startSeq, endSeq, 0); + gg.translate(-transX, -transY); + + repaint(); + } finally + { + fastpainting = false; + } + } + + @Override + public void paintComponent(Graphics g) + { + super.paintComponent(g); + + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + ViewportRanges ranges = av.getRanges(); + + int width = getWidth(); + int height = getHeight(); + + width -= (width % charWidth); + height -= (height % charHeight); + + // selectImage is the selection group outline image + BufferedImage selectImage = drawSelectionGroup( + ranges.getStartRes(), ranges.getEndRes(), + ranges.getStartSeq(), ranges.getEndSeq()); + + if ((img != null) && (fastPaint + || (getVisibleRect().width != g.getClipBounds().width) + || (getVisibleRect().height != g.getClipBounds().height))) + { + BufferedImage lcimg = buildLocalImage(selectImage); + g.drawImage(lcimg, 0, 0, this); + fastPaint = false; + } + else if ((width > 0) && (height > 0)) + { + // img is a cached version of the last view we drew, if any + // if we have no img or the size has changed, make a new one + if (img == null || width != img.getWidth() + || height != img.getHeight()) + { + img = setupImage(); + if (img == null) + { + return; + } + gg = (Graphics2D) img.getGraphics(); + gg.setFont(av.getFont()); + } + + if (av.antiAlias) + { + gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING, + RenderingHints.VALUE_ANTIALIAS_ON); + } + + gg.setColor(Color.white); + gg.fillRect(0, 0, img.getWidth(), img.getHeight()); + + if (av.getWrapAlignment()) + { + drawWrappedPanel(gg, getWidth(), getHeight(), ranges.getStartRes()); + } + else + { + drawPanel(gg, ranges.getStartRes(), ranges.getEndRes(), + ranges.getStartSeq(), ranges.getEndSeq(), 0); + } + + // lcimg is a local *copy* of img which we'll draw selectImage on top of + BufferedImage lcimg = buildLocalImage(selectImage); + g.drawImage(lcimg, 0, 0, this); + } + } + + /** + * Draw an alignment panel for printing + * + * @param g1 + * Graphics object to draw with + * @param startRes + * start residue of print area + * @param endRes + * end residue of print area + * @param startSeq + * start sequence of print area + * @param endSeq + * end sequence of print area + */ + public void drawPanelForPrinting(Graphics g1, int startRes, int endRes, + int startSeq, int endSeq) + { + drawPanel(g1, startRes, endRes, startSeq, endSeq, 0); + + BufferedImage selectImage = drawSelectionGroup(startRes, endRes, + startSeq, endSeq); + if (selectImage != null) + { + ((Graphics2D) g1).setComposite(AlphaComposite + .getInstance(AlphaComposite.SRC_OVER)); + g1.drawImage(selectImage, 0, 0, this); + } + } + + /** + * Draw a wrapped alignment panel for printing + * + * @param g + * Graphics object to draw with + * @param canvasWidth + * width of drawing area + * @param canvasHeight + * height of drawing area + * @param startRes + * start residue of print area + */ + public void drawWrappedPanelForPrinting(Graphics g, int canvasWidth, + int canvasHeight, int startRes) + { + SequenceGroup group = av.getSelectionGroup(); + + drawWrappedPanel(g, canvasWidth, canvasHeight, startRes); + + if (group != null) + { + BufferedImage selectImage = null; + try + { + selectImage = new BufferedImage(canvasWidth, canvasHeight, + BufferedImage.TYPE_INT_ARGB); // ARGB so alpha compositing works + } catch (OutOfMemoryError er) + { + System.gc(); + System.err.println("Print image OutOfMemory Error.\n" + er); + new OOMWarning("Creating wrapped alignment image for printing", er); + } + if (selectImage != null) + { + Graphics2D g2 = selectImage.createGraphics(); + setupSelectionGroup(g2, selectImage); + drawWrappedSelection(g2, group, canvasWidth, canvasHeight, + startRes); + + g2.setComposite( + AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + g.drawImage(selectImage, 0, 0, this); + g2.dispose(); + } + } + } + + /* + * Make a local image by combining the cached image img + * with any selection + */ + private BufferedImage buildLocalImage(BufferedImage selectImage) + { + // clone the cached image + BufferedImage lcimg = new BufferedImage(img.getWidth(), img.getHeight(), + img.getType()); + Graphics2D g2d = lcimg.createGraphics(); + g2d.drawImage(img, 0, 0, null); + + // overlay selection group on lcimg + if (selectImage != null) + { + g2d.setComposite( + AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + g2d.drawImage(selectImage, 0, 0, this); + } + g2d.dispose(); + + return lcimg; + } + + /* + * Set up a buffered image of the correct height and size for the sequence canvas + */ + private BufferedImage setupImage() + { + BufferedImage lcimg = null; + + int charWidth = av.getCharWidth(); + int charHeight = av.getCharHeight(); + + int width = getWidth(); + int height = getHeight(); + + width -= (width % charWidth); + height -= (height % charHeight); + + if ((width < 1) || (height < 1)) + { + return null; + } + + try + { + lcimg = new BufferedImage(width, height, + BufferedImage.TYPE_INT_ARGB); // ARGB so alpha compositing works + } catch (OutOfMemoryError er) + { + System.gc(); + System.err.println( + "Group image OutOfMemory Redraw Error.\n" + er); + new OOMWarning("Creating alignment image for display", er); + + return null; + } + + return lcimg; + } + + /** + * Returns the visible width of the canvas in residues, after allowing for + * East or West scales (if shown) + * + * @param canvasWidth + * the width in pixels (possibly including scales) + * + * @return + */ + public int getWrappedCanvasWidth(int canvasWidth) + { + int charWidth = av.getCharWidth(); + + FontMetrics fm = getFontMetrics(av.getFont()); + + int labelWidth = 0; + + if (av.getScaleRightWrapped() || av.getScaleLeftWrapped()) + { + labelWidth = getLabelWidth(fm); + } + + labelWidthEast = av.getScaleRightWrapped() ? labelWidth : 0; + + labelWidthWest = av.getScaleLeftWrapped() ? labelWidth : 0; + + return (canvasWidth - labelWidthEast - labelWidthWest) / charWidth; + } + + /** + * 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 + */ + protected int getLabelWidth(FontMetrics fm) + { + /* + * find the biggest sequence end position we need to show + * (note this is not necessarily the sequence length) + */ + int maxWidth = 0; + AlignmentI alignment = av.getAlignment(); + for (int i = 0; i < alignment.getHeight(); i++) + { + maxWidth = Math.max(maxWidth, alignment.getSequenceAt(i).getEnd()); + } + + int length = 0; + for (int i = maxWidth; i > 0; i /= 10) + { + length++; + } + + return fm.stringWidth(ZEROS.substring(0, length)) + av.getCharWidth(); + } + + /** + * Draws as many widths of a wrapped alignment as can fit in the visible + * window + * + * @param g + * @param canvasWidth + * available width in pixels + * @param canvasHeight + * available height in pixels + * @param startColumn + * the first column (0...) of the alignment to draw + */ + public void drawWrappedPanel(Graphics g, int canvasWidth, + int canvasHeight, final int startColumn) + { + int wrappedWidthInResidues = calculateWrappedGeometry(canvasWidth, + canvasHeight); + + av.setWrappedWidth(wrappedWidthInResidues); + + ViewportRanges ranges = av.getRanges(); + ranges.setViewportStartAndWidth(startColumn, wrappedWidthInResidues); + + /* + * draw one width at a time (including any scales or annotation shown), + * until we have run out of either alignment or vertical space available + */ + int ypos = wrappedSpaceAboveAlignment; + int maxWidth = ranges.getVisibleAlignmentWidth(); + + int start = startColumn; + int currentWidth = 0; + while ((currentWidth < wrappedVisibleWidths) && (start < maxWidth)) + { + int endColumn = Math + .min(maxWidth, start + wrappedWidthInResidues - 1); + drawWrappedWidth(g, ypos, start, endColumn, canvasHeight); + ypos += wrappedRepeatHeightPx; + start += wrappedWidthInResidues; + currentWidth++; + } + + drawWrappedDecorators(g, startColumn); + } + + /** + * Calculates and saves values needed when rendering a wrapped alignment. + * These depend on many factors, including + * + * + * @param canvasWidth + * @param canvasHeight + * @return the number of residue columns in each width + */ + protected int calculateWrappedGeometry(int canvasWidth, int canvasHeight) + { + int charHeight = av.getCharHeight(); + + /* + * vertical space in pixels between wrapped widths of alignment + * - one character height, or two if scale above is drawn + */ + wrappedSpaceAboveAlignment = charHeight + * (av.getScaleAboveWrapped() ? 2 : 1); + + /* + * height in pixels of the wrapped widths + */ + wrappedRepeatHeightPx = wrappedSpaceAboveAlignment; + // add sequences + wrappedRepeatHeightPx += av.getRanges().getViewportHeight() + * charHeight; + // add annotations panel height if shown + wrappedRepeatHeightPx += getAnnotationHeight(); + + /* + * number of visible widths (the last one may be part height), + * ensuring a part height includes at least one sequence + */ + ViewportRanges ranges = av.getRanges(); + wrappedVisibleWidths = canvasHeight / wrappedRepeatHeightPx; + int remainder = canvasHeight % wrappedRepeatHeightPx; + if (remainder >= (wrappedSpaceAboveAlignment + charHeight)) + { + wrappedVisibleWidths++; + } + + /* + * 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 xMax = ranges.getVisibleAlignmentWidth(); + int startToEnd = xMax - ranges.getStartRes(); + int maxWidths = startToEnd / wrappedWidthInResidues; + if (startToEnd % wrappedWidthInResidues > 0) + { + maxWidths++; + } + wrappedVisibleWidths = Math.min(wrappedVisibleWidths, maxWidths); + + return wrappedWidthInResidues; + } + + /** + * Draws one width of a wrapped alignment, including sequences and + * annnotations, if shown, but not scales or hidden column markers + * + * @param g + * @param ypos + * @param startColumn + * @param endColumn + * @param canvasHeight + */ + protected void drawWrappedWidth(Graphics g, int ypos, int startColumn, + int endColumn, int canvasHeight) + { + ViewportRanges ranges = av.getRanges(); + int viewportWidth = ranges.getViewportWidth(); + + int endx = Math.min(startColumn + viewportWidth - 1, endColumn); + + /* + * move right before drawing by the width of the scale left (if any) + * 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; + g.translate(xOffset, 0); + + // When printing we have an extra clipped region, + // the Printable page which we need to account for here + Shape clip = g.getClip(); + + if (clip == null) + { + g.setClip(0, 0, viewportWidth * charWidth, canvasHeight); + } + else + { + g.setClip(0, (int) clip.getBounds().getY(), + viewportWidth * charWidth, (int) clip.getBounds().getHeight()); + } + + /* + * white fill the region to be drawn (so incremental fast paint doesn't + * scribble over an existing image) + */ + gg.setColor(Color.white); + gg.fillRect(0, ypos, (endx - startColumn + 1) * charWidth, + wrappedRepeatHeightPx); + + drawPanel(g, startColumn, endx, 0, av.getAlignment().getHeight() - 1, + ypos); + + int cHeight = av.getAlignment().getHeight() * av.getCharHeight(); + + if (av.isShowAnnotation()) + { + g.translate(0, cHeight + ypos + 3); + if (annotations == null) + { + annotations = new AnnotationPanel(av); + } + + annotations.renderer.drawComponent(annotations, av, g, -1, + startColumn, endx + 1); + g.translate(0, -cHeight - ypos - 3); + } + g.setClip(clip); + g.translate(-xOffset, 0); + } + + /** + * Draws scales left, right and above (if shown), and any hidden column + * markers, on all widths of the wrapped alignment + * + * @param g + * @param startColumn + */ + protected void drawWrappedDecorators(Graphics g, final int startColumn) + { + int charWidth = av.getCharWidth(); + + g.setFont(av.getFont()); + g.setColor(Color.black); + + int ypos = wrappedSpaceAboveAlignment; + ViewportRanges ranges = av.getRanges(); + int viewportWidth = ranges.getViewportWidth(); + int maxWidth = ranges.getVisibleAlignmentWidth(); + int widthsDrawn = 0; + int startCol = startColumn; + + while (widthsDrawn < wrappedVisibleWidths) + { + int endColumn = Math.min(maxWidth, startCol + viewportWidth - 1); + + if (av.getScaleLeftWrapped()) + { + drawVerticalScale(g, startCol, endColumn - 1, ypos, true); + } + + if (av.getScaleRightWrapped()) + { + int x = labelWidthWest + viewportWidth * charWidth; + g.translate(x, 0); + drawVerticalScale(g, startCol, endColumn, ypos, false); + g.translate(-x, 0); + } + + /* + * white fill region of scale above and hidden column markers + * (to support incremental fast paint of image) + */ + g.translate(labelWidthWest, 0); + g.setColor(Color.white); + g.fillRect(0, ypos - wrappedSpaceAboveAlignment, viewportWidth + * charWidth + labelWidthWest, wrappedSpaceAboveAlignment); + g.setColor(Color.black); + g.translate(-labelWidthWest, 0); + + g.translate(labelWidthWest, 0); + + if (av.getScaleAboveWrapped()) + { + drawNorthScale(g, startCol, endColumn, ypos); + } + + if (av.hasHiddenColumns() && av.getShowHiddenMarkers()) + { + drawHiddenColumnMarkers(g, ypos, startCol, endColumn); + } + + g.translate(-labelWidthWest, 0); + + ypos += wrappedRepeatHeightPx; + startCol += viewportWidth; + widthsDrawn++; + } + } + + /** + * Draws markers (triangles) above hidden column positions between startColumn + * and endColumn. + * + * @param g + * @param ypos + * @param startColumn + * @param endColumn + */ + protected void drawHiddenColumnMarkers(Graphics g, int ypos, + int startColumn, int endColumn) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + g.setColor(Color.blue); + HiddenColumns hidden = av.getAlignment().getHiddenColumns(); + List positions = hidden.findHiddenRegionPositions(); + for (int pos : positions) + { + int res = pos - startColumn; + + if (res < 0 || res > endColumn - startColumn + 1) + { + continue; + } + + /* + * draw a downward-pointing triangle at the hidden columns location + * (before the following visible column) + */ + int xMiddle = res * charWidth; + int[] xPoints = new int[] { xMiddle - charHeight / 4, + xMiddle + charHeight / 4, xMiddle }; + int yTop = ypos - (charHeight / 2); + int[] yPoints = new int[] { yTop, yTop, yTop + 8 }; + g.fillPolygon(xPoints, yPoints, 3); + } + } + + /* + * Draw a selection group over a wrapped alignment + */ + private void drawWrappedSelection(Graphics2D g, SequenceGroup group, + int canvasWidth, + int canvasHeight, int startRes) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + // height gap above each panel + int hgap = charHeight; + if (av.getScaleAboveWrapped()) + { + hgap += charHeight; + } + + int cWidth = (canvasWidth - labelWidthEast - labelWidthWest) + / charWidth; + int cHeight = av.getAlignment().getHeight() * charHeight; + + int startx = startRes; + int endx; + int ypos = hgap; // vertical offset + int maxwidth = av.getAlignment().getWidth(); + + if (av.hasHiddenColumns()) + { + maxwidth = av.getAlignment().getHiddenColumns() + .findColumnPosition(maxwidth); + } + + // chop the wrapped alignment extent up into panel-sized blocks and treat + // each block as if it were a block from an unwrapped alignment + while ((ypos <= canvasHeight) && (startx < maxwidth)) + { + // set end value to be start + width, or maxwidth, whichever is smaller + endx = startx + cWidth - 1; + + if (endx > maxwidth) + { + endx = maxwidth; + } + + g.translate(labelWidthWest, 0); + + drawUnwrappedSelection(g, group, startx, endx, 0, + av.getAlignment().getHeight() - 1, + ypos); + + g.translate(-labelWidthWest, 0); + + // update vertical offset + ypos += cHeight + getAnnotationHeight() + hgap; + + // update horizontal offset + startx += cWidth; + } + } + + int getAnnotationHeight() + { + if (!av.isShowAnnotation()) + { + return 0; + } + + if (annotations == null) + { + annotations = new AnnotationPanel(av); + } + + return annotations.adjustPanelHeight(); + } + + /** + * Draws the visible region of the alignment on the graphics context. If there + * are hidden column markers in the visible region, then each sub-region + * between the markers is drawn separately, followed by the hidden column + * marker. + * + * @param g1 + * the graphics context, positioned at the first residue to be drawn + * @param startRes + * offset of the first column to draw (0..) + * @param endRes + * offset of the last column to draw (0..) + * @param startSeq + * offset of the first sequence to draw (0..) + * @param endSeq + * offset of the last sequence to draw (0..) + * @param yOffset + * vertical offset at which to draw (for wrapped alignments) + */ + public void drawPanel(Graphics g1, final int startRes, final int endRes, + final int startSeq, final int endSeq, final int yOffset) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + if (!av.hasHiddenColumns()) + { + draw(g1, startRes, endRes, startSeq, endSeq, yOffset); + } + else + { + int screenY = 0; + final int screenYMax = endRes - startRes; + int blockStart = startRes; + int blockEnd = endRes; + + for (int[] region : av.getAlignment().getHiddenColumns() + .getHiddenColumnsCopy()) + { + int hideStart = region[0]; + int hideEnd = region[1]; + + if (hideStart <= blockStart) + { + blockStart += (hideEnd - hideStart) + 1; + continue; + } + + /* + * draw up to just before the next hidden region, or the end of + * the visible region, whichever comes first + */ + blockEnd = Math.min(hideStart - 1, blockStart + screenYMax + - screenY); + + g1.translate(screenY * charWidth, 0); + + draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset); + + /* + * draw the downline of the hidden column marker (ScalePanel draws the + * triangle on top) if we reached it + */ + if (av.getShowHiddenMarkers() && blockEnd == hideStart - 1) + { + g1.setColor(Color.blue); + + g1.drawLine((blockEnd - blockStart + 1) * charWidth - 1, + 0 + yOffset, (blockEnd - blockStart + 1) * charWidth - 1, + (endSeq - startSeq + 1) * charHeight + yOffset); + } + + g1.translate(-screenY * charWidth, 0); + screenY += blockEnd - blockStart + 1; + blockStart = hideEnd + 1; + + if (screenY > screenYMax) + { + // already rendered last block + return; + } + } + + if (screenY <= screenYMax) + { + // remaining visible region to render + blockEnd = blockStart + screenYMax - screenY; + g1.translate(screenY * charWidth, 0); + draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset); + + g1.translate(-screenY * charWidth, 0); + } + } + + } + + /** + * Draws a region of the visible alignment + * + * @param g1 + * @param startRes + * offset of the first column in the visible region (0..) + * @param endRes + * offset of the last column in the visible region (0..) + * @param startSeq + * offset of the first sequence in the visible region (0..) + * @param endSeq + * offset of the last sequence in the visible region (0..) + * @param yOffset + * vertical offset at which to draw (for wrapped alignments) + */ + private void draw(Graphics g, int startRes, int endRes, int startSeq, + int endSeq, int offset) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + g.setFont(av.getFont()); + seqRdr.prepare(g, av.isRenderGaps()); + + SequenceI nextSeq; + + // / First draw the sequences + // /////////////////////////// + for (int i = startSeq; i <= endSeq; i++) + { + nextSeq = av.getAlignment().getSequenceAt(i); + if (nextSeq == null) + { + // occasionally, a race condition occurs such that the alignment row is + // empty + continue; + } + seqRdr.drawSequence(nextSeq, av.getAlignment().findAllGroups(nextSeq), + startRes, endRes, offset + ((i - startSeq) * charHeight)); + + if (av.isShowSequenceFeatures()) + { + fr.drawSequence(g, nextSeq, startRes, endRes, + offset + ((i - startSeq) * charHeight), false); + } + + /* + * highlight search Results once sequence has been drawn + */ + if (av.hasSearchResults()) + { + SearchResultsI searchResults = av.getSearchResults(); + int[] visibleResults = searchResults.getResults(nextSeq, + startRes, endRes); + if (visibleResults != null) + { + for (int r = 0; r < visibleResults.length; r += 2) + { + seqRdr.drawHighlightedText(nextSeq, visibleResults[r], + visibleResults[r + 1], (visibleResults[r] - startRes) + * charWidth, offset + + ((i - startSeq) * charHeight)); + } + } + } + + if (av.cursorMode && cursorY == i && cursorX >= startRes + && cursorX <= endRes) + { + seqRdr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * charWidth, + offset + ((i - startSeq) * charHeight)); + } + } + + if (av.getSelectionGroup() != null + || av.getAlignment().getGroups().size() > 0) + { + drawGroupsBoundaries(g, startRes, endRes, startSeq, endSeq, offset); + } + + } + + void drawGroupsBoundaries(Graphics g1, int startRes, int endRes, + int startSeq, int endSeq, int offset) + { + Graphics2D g = (Graphics2D) g1; + // + // /////////////////////////////////// + // Now outline any areas if necessary + // /////////////////////////////////// + + SequenceGroup group = null; + int groupIndex = -1; + + if (av.getAlignment().getGroups().size() > 0) + { + group = av.getAlignment().getGroups().get(0); + groupIndex = 0; + } + + if (group != null) + { + g.setStroke(new BasicStroke()); + g.setColor(group.getOutlineColour()); + + do + { + drawPartialGroupOutline(g, group, startRes, endRes, startSeq, + endSeq, offset); + + groupIndex++; + + g.setStroke(new BasicStroke()); + + if (groupIndex >= av.getAlignment().getGroups().size()) + { + break; + } + + group = av.getAlignment().getGroups().get(groupIndex); + + } while (groupIndex < av.getAlignment().getGroups().size()); + + } + + } + + + /* + * Draw the selection group as a separate image and overlay + */ + private BufferedImage drawSelectionGroup(int startRes, int endRes, + int startSeq, int endSeq) + { + // get a new image of the correct size + BufferedImage selectionImage = setupImage(); + + if (selectionImage == null) + { + return null; + } + + SequenceGroup group = av.getSelectionGroup(); + if (group == null) + { + // nothing to draw + return null; + } + + // set up drawing colour + Graphics2D g = (Graphics2D) selectionImage.getGraphics(); + + setupSelectionGroup(g, selectionImage); + + if (!av.getWrapAlignment()) + { + drawUnwrappedSelection(g, group, startRes, endRes, startSeq, endSeq, + 0); + } + else + { + drawWrappedSelection(g, group, getWidth(), getHeight(), + av.getRanges().getStartRes()); + } + + g.dispose(); + return selectionImage; + } + + /* + * Set up graphics for selection group + */ + private void setupSelectionGroup(Graphics2D g, + BufferedImage selectionImage) + { + // set background to transparent + g.setComposite(AlphaComposite.getInstance(AlphaComposite.CLEAR, 0.0f)); + g.fillRect(0, 0, selectionImage.getWidth(), selectionImage.getHeight()); + + // set up foreground to draw red dashed line + g.setComposite(AlphaComposite.Src); + g.setStroke(new BasicStroke(1, BasicStroke.CAP_BUTT, + BasicStroke.JOIN_ROUND, 3f, new float[] + { 5f, 3f }, 0f)); + g.setColor(Color.RED); + } + + /* + * Draw a selection group over an unwrapped alignment + * @param g graphics object to draw with + * @param group selection group + * @param startRes start residue of area to draw + * @param endRes end residue of area to draw + * @param startSeq start sequence of area to draw + * @param endSeq end sequence of area to draw + * @param offset vertical offset (used when called from wrapped alignment code) + */ + private void drawUnwrappedSelection(Graphics2D g, SequenceGroup group, + int startRes, int endRes, int startSeq, int endSeq, int offset) + { + int charWidth = av.getCharWidth(); + + if (!av.hasHiddenColumns()) + { + drawPartialGroupOutline(g, group, startRes, endRes, startSeq, endSeq, + offset); + } + else + { + // package into blocks of visible columns + int screenY = 0; + int blockStart = startRes; + int blockEnd = endRes; + + for (int[] region : av.getAlignment().getHiddenColumns() + .getHiddenColumnsCopy()) + { + int hideStart = region[0]; + int hideEnd = region[1]; + + if (hideStart <= blockStart) + { + blockStart += (hideEnd - hideStart) + 1; + continue; + } + + blockEnd = hideStart - 1; + + g.translate(screenY * charWidth, 0); + drawPartialGroupOutline(g, group, + blockStart, blockEnd, startSeq, endSeq, offset); + + g.translate(-screenY * charWidth, 0); + screenY += blockEnd - blockStart + 1; + blockStart = hideEnd + 1; + + if (screenY > (endRes - startRes)) + { + // already rendered last block + break; + } + } + + if (screenY <= (endRes - startRes)) + { + // remaining visible region to render + blockEnd = blockStart + (endRes - startRes) - screenY; + g.translate(screenY * charWidth, 0); + drawPartialGroupOutline(g, group, + blockStart, blockEnd, startSeq, endSeq, offset); + + g.translate(-screenY * charWidth, 0); + } + } + } + + /* + * Draw the selection group as a separate image and overlay + */ + private void drawPartialGroupOutline(Graphics2D g, SequenceGroup group, + int startRes, int endRes, int startSeq, int endSeq, + int verticalOffset) + { + int charHeight = av.getCharHeight(); + int charWidth = av.getCharWidth(); + + int visWidth = (endRes - startRes + 1) * charWidth; + + int oldY = -1; + int i = 0; + boolean inGroup = false; + int top = -1; + int bottom = -1; + + int sx = -1; + int sy = -1; + int xwidth = -1; + + for (i = startSeq; i <= endSeq; i++) + { + // position of start residue of group relative to startRes, in pixels + sx = (group.getStartRes() - startRes) * charWidth; + + // width of group in pixels + xwidth = (((group.getEndRes() + 1) - group.getStartRes()) * charWidth) + - 1; + + sy = verticalOffset + (i - startSeq) * charHeight; + + if (sx + xwidth < 0 || sx > visWidth) + { + continue; + } + + if ((sx <= (endRes - startRes) * charWidth) + && group.getSequences(null) + .contains(av.getAlignment().getSequenceAt(i))) + { + if ((bottom == -1) && !group.getSequences(null) + .contains(av.getAlignment().getSequenceAt(i + 1))) + { + bottom = sy + charHeight; + } + + if (!inGroup) + { + if (((top == -1) && (i == 0)) || !group.getSequences(null) + .contains(av.getAlignment().getSequenceAt(i - 1))) + { + top = sy; + } + + oldY = sy; + inGroup = true; + } + } + else + { + if (inGroup) + { + // if start position is visible, draw vertical line to left of + // group + if (sx >= 0 && sx < visWidth) + { + g.drawLine(sx, oldY, sx, sy); + } + + // if end position is visible, draw vertical line to right of + // group + if (sx + xwidth < visWidth) + { + g.drawLine(sx + xwidth, oldY, sx + xwidth, sy); + } + + if (sx < 0) + { + xwidth += sx; + sx = 0; + } + + // don't let width extend beyond current block, or group extent + // fixes JAL-2672 + if (sx + xwidth >= (endRes - startRes + 1) * charWidth) + { + xwidth = (endRes - startRes + 1) * charWidth - sx; + } + + // draw horizontal line at top of group + if (top != -1) + { + g.drawLine(sx, top, sx + xwidth, top); + top = -1; + } + + // draw horizontal line at bottom of group + if (bottom != -1) + { + g.drawLine(sx, bottom, sx + xwidth, bottom); + bottom = -1; + } + + inGroup = false; + } + } + } + + if (inGroup) + { + sy = verticalOffset + ((i - startSeq) * charHeight); + if (sx >= 0 && sx < visWidth) + { + g.drawLine(sx, oldY, sx, sy); + } + + if (sx + xwidth < visWidth) + { + g.drawLine(sx + xwidth, oldY, sx + xwidth, sy); + } + + if (sx < 0) + { + xwidth += sx; + sx = 0; + } + + if (sx + xwidth > visWidth) + { + xwidth = visWidth; + } + else if (sx + xwidth >= (endRes - startRes + 1) * charWidth) + { + xwidth = (endRes - startRes + 1) * charWidth; + } + + if (top != -1) + { + g.drawLine(sx, top, sx + xwidth, top); + top = -1; + } + + if (bottom != -1) + { + g.drawLine(sx, bottom - 1, sx + xwidth, bottom - 1); + bottom = -1; + } + + inGroup = false; + } + } + + /** + * Highlights search results in the visible region by rendering as white text + * on a black background. Any previous highlighting is removed. Answers true + * if any highlight was left on the visible alignment (so status bar should be + * set to match), else false. + *

+ * Currently fastPaint is not implemented for wrapped alignments. If a wrapped + * alignment had to be scrolled to show the highlighted region, then it should + * be fully redrawn, otherwise a fast paint can be performed. This argument + * could be removed if fast paint of scrolled wrapped alignment is coded in + * future (JAL-2609). + * + * @param results + * @param noFastPaint + * @return + */ + public boolean highlightSearchResults(SearchResultsI results, + boolean noFastPaint) + { + if (fastpainting) + { + return false; + } + boolean wrapped = av.getWrapAlignment(); + try + { + fastPaint = !noFastPaint; + fastpainting = fastPaint; + + /* + * to avoid redrawing the whole visible region, we instead + * redraw just the minimal regions to remove previous highlights + * and add new ones + */ + SearchResultsI previous = av.getSearchResults(); + av.setSearchResults(results); + boolean redrawn = false; + boolean drawn = false; + if (wrapped) + { + redrawn = drawMappedPositionsWrapped(previous); + drawn = drawMappedPositionsWrapped(results); + redrawn |= drawn; + } + else + { + redrawn = drawMappedPositions(previous); + drawn = drawMappedPositions(results); + redrawn |= drawn; + } + + /* + * if highlights were either removed or added, repaint + */ + if (redrawn) + { + repaint(); + } + + /* + * return true only if highlights were added + */ + return drawn; + + } finally + { + fastpainting = false; + } + } + + /** + * Redraws the minimal rectangle in the visible region (if any) that includes + * mapped positions of the given search results. Whether or not positions are + * highlighted depends on the SearchResults set on the Viewport. This allows + * this method to be called to either clear or set highlighting. Answers true + * if any positions were drawn (in which case a repaint is still required), + * else false. + * + * @param results + * @return + */ + protected boolean drawMappedPositions(SearchResultsI results) + { + if (results == null) + { + return false; + } + + /* + * calculate the minimal rectangle to redraw that + * includes both new and existing search results + */ + int firstSeq = Integer.MAX_VALUE; + int lastSeq = -1; + int firstCol = Integer.MAX_VALUE; + int lastCol = -1; + boolean matchFound = false; + + ViewportRanges ranges = av.getRanges(); + int firstVisibleColumn = ranges.getStartRes(); + int lastVisibleColumn = ranges.getEndRes(); + AlignmentI alignment = av.getAlignment(); + if (av.hasHiddenColumns()) + { + firstVisibleColumn = alignment.getHiddenColumns() + .adjustForHiddenColumns(firstVisibleColumn); + lastVisibleColumn = alignment.getHiddenColumns() + .adjustForHiddenColumns(lastVisibleColumn); + } + + for (int seqNo = ranges.getStartSeq(); seqNo <= ranges + .getEndSeq(); seqNo++) + { + SequenceI seq = alignment.getSequenceAt(seqNo); + + int[] visibleResults = results.getResults(seq, firstVisibleColumn, + lastVisibleColumn); + if (visibleResults != null) + { + for (int i = 0; i < visibleResults.length - 1; i += 2) + { + int firstMatchedColumn = visibleResults[i]; + int lastMatchedColumn = visibleResults[i + 1]; + if (firstMatchedColumn <= lastVisibleColumn + && lastMatchedColumn >= firstVisibleColumn) + { + /* + * found a search results match in the visible region - + * remember the first and last sequence matched, and the first + * and last visible columns in the matched positions + */ + matchFound = true; + firstSeq = Math.min(firstSeq, seqNo); + lastSeq = Math.max(lastSeq, seqNo); + firstMatchedColumn = Math.max(firstMatchedColumn, + firstVisibleColumn); + lastMatchedColumn = Math.min(lastMatchedColumn, + lastVisibleColumn); + firstCol = Math.min(firstCol, firstMatchedColumn); + lastCol = Math.max(lastCol, lastMatchedColumn); + } + } + } + } + + if (matchFound) + { + if (av.hasHiddenColumns()) + { + firstCol = alignment.getHiddenColumns() + .findColumnPosition(firstCol); + lastCol = alignment.getHiddenColumns().findColumnPosition(lastCol); + } + int transX = (firstCol - ranges.getStartRes()) * av.getCharWidth(); + int transY = (firstSeq - ranges.getStartSeq()) * av.getCharHeight(); + gg.translate(transX, transY); + drawPanel(gg, firstCol, lastCol, firstSeq, lastSeq, 0); + gg.translate(-transX, -transY); + } + + return matchFound; + } + + @Override + public void propertyChange(PropertyChangeEvent evt) + { + String eventName = evt.getPropertyName(); + + if (eventName.equals(SequenceGroup.SEQ_GROUP_CHANGED)) + { + fastPaint = true; + repaint(); + return; + } + + int scrollX = 0; + if (eventName.equals(ViewportRanges.STARTRES) + || eventName.equals(ViewportRanges.STARTRESANDSEQ)) + { + // Make sure we're not trying to draw a panel + // larger than the visible window + if (eventName.equals(ViewportRanges.STARTRES)) + { + scrollX = (int) evt.getNewValue() - (int) evt.getOldValue(); + } + else + { + scrollX = ((int[]) evt.getNewValue())[0] + - ((int[]) evt.getOldValue())[0]; + } + ViewportRanges vpRanges = av.getRanges(); + + int range = vpRanges.getEndRes() - vpRanges.getStartRes(); + if (scrollX > range) + { + scrollX = range; + } + else if (scrollX < -range) + { + scrollX = -range; + } + + // Both scrolling and resizing change viewport ranges: scrolling changes + // both start and end points, but resize only changes end values. + // Here we only want to fastpaint on a scroll, with resize using a normal + // paint, so scroll events are identified as changes to the horizontal or + // vertical start value. + if (eventName.equals(ViewportRanges.STARTRES)) + { + if (av.getWrapAlignment()) + { + fastPaintWrapped(scrollX); + } + else + { + fastPaint(scrollX, 0); + } + } + else if (eventName.equals(ViewportRanges.STARTSEQ)) + { + // scroll + fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue()); + } + else if (eventName.equals(ViewportRanges.STARTRESANDSEQ)) + { + if (av.getWrapAlignment()) + { + fastPaintWrapped(scrollX); + } + else + { + fastPaint(scrollX, 0); + } + // bizarrely, we only need to scroll on the x value here as fastpaint + // copies the full height of the image anyway. Passing in the y value + // causes nasty repaint artefacts, which only disappear on a full + // repaint. + } + } + } + + /** + * Does a minimal update of the image for a scroll movement. This method + * handles scroll movements of up to one width of the wrapped alignment (one + * click in the vertical scrollbar). Larger movements (for example after a + * scroll to highlight a mapped position) trigger a full redraw instead. + * + * @param scrollX + * number of positions scrolled (right if positive, left if negative) + */ + protected void fastPaintWrapped(int scrollX) + { + ViewportRanges ranges = av.getRanges(); + + if (Math.abs(scrollX) > ranges.getViewportWidth()) + { + /* + * shift of more than one view width is + * overcomplicated to handle in this method + */ + fastPaint = false; + repaint(); + return; + } + + if (fastpainting || gg == null) + { + return; + } + + fastPaint = true; + fastpainting = true; + + try + { + calculateWrappedGeometry(getWidth(), getHeight()); + + /* + * relocate the regions of the alignment that are still visible + */ + shiftWrappedAlignment(-scrollX); + + /* + * add new columns (sequence, annotation) + * - at top left if scrollX < 0 + * - at right of last two widths if scrollX > 0 + */ + if (scrollX < 0) + { + int startRes = ranges.getStartRes(); + drawWrappedWidth(gg, wrappedSpaceAboveAlignment, startRes, startRes + - scrollX - 1, getHeight()); + } + else + { + fastPaintWrappedAddRight(scrollX); + } + + /* + * draw all scales (if shown) and hidden column markers + */ + drawWrappedDecorators(gg, ranges.getStartRes()); + + repaint(); + } finally + { + fastpainting = false; + } + } + + /** + * Draws the specified number of columns at the 'end' (bottom right) of a + * wrapped alignment view, including sequences and annotations if shown, but + * not scales. Also draws the same number of columns at the right hand end of + * the second last width shown, if the last width is not full height (so + * cannot simply be copied from the graphics image). + * + * @param columns + */ + protected void fastPaintWrappedAddRight(int columns) + { + if (columns == 0) + { + return; + } + + ViewportRanges ranges = av.getRanges(); + int viewportWidth = ranges.getViewportWidth(); + int charWidth = av.getCharWidth(); + + /** + * draw full height alignment in the second last row, last columns, if the + * last row was not full height + */ + int visibleWidths = wrappedVisibleWidths; + int canvasHeight = getHeight(); + boolean lastWidthPartHeight = (wrappedVisibleWidths * wrappedRepeatHeightPx) > canvasHeight; + + if (lastWidthPartHeight) + { + int widthsAbove = Math.max(0, visibleWidths - 2); + int ypos = wrappedRepeatHeightPx * widthsAbove + + wrappedSpaceAboveAlignment; + int endRes = ranges.getEndRes(); + endRes += widthsAbove * viewportWidth; + int startRes = endRes - columns; + int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth) + * charWidth; + + /* + * white fill first to erase annotations + */ + gg.translate(xOffset, 0); + gg.setColor(Color.white); + gg.fillRect(labelWidthWest, ypos, + (endRes - startRes + 1) * charWidth, wrappedRepeatHeightPx); + gg.translate(-xOffset, 0); + + drawWrappedWidth(gg, ypos, startRes, endRes, canvasHeight); + } + + /* + * draw newly visible columns in last wrapped width (none if we + * have reached the end of the alignment) + * y-offset for drawing last width is height of widths above, + * plus one gap row + */ + int widthsAbove = visibleWidths - 1; + int ypos = wrappedRepeatHeightPx * widthsAbove + + wrappedSpaceAboveAlignment; + int endRes = ranges.getEndRes(); + endRes += widthsAbove * viewportWidth; + int startRes = endRes - columns + 1; + + /* + * white fill first to erase annotations + */ + int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth) + * charWidth; + gg.translate(xOffset, 0); + gg.setColor(Color.white); + int width = viewportWidth * charWidth - xOffset; + gg.fillRect(labelWidthWest, ypos, width, wrappedRepeatHeightPx); + gg.translate(-xOffset, 0); + + gg.setFont(av.getFont()); + gg.setColor(Color.black); + + if (startRes < ranges.getVisibleAlignmentWidth()) + { + drawWrappedWidth(gg, ypos, startRes, endRes, canvasHeight); + } + + /* + * and finally, white fill any space below the visible alignment + */ + int heightBelow = canvasHeight - visibleWidths * wrappedRepeatHeightPx; + if (heightBelow > 0) + { + gg.setColor(Color.white); + gg.fillRect(0, canvasHeight - heightBelow, getWidth(), heightBelow); + } + } + + /** + * Shifts the visible alignment by the specified number of columns - left if + * negative, right if positive. Copies and moves sequences and annotations (if + * shown). Scales, hidden column markers and any newly visible columns must be + * drawn separately. + * + * @param positions + */ + protected void shiftWrappedAlignment(int positions) + { + if (positions == 0) + { + return; + } + int charWidth = av.getCharWidth(); + + int canvasHeight = getHeight(); + ViewportRanges ranges = av.getRanges(); + int viewportWidth = ranges.getViewportWidth(); + int widthToCopy = (ranges.getViewportWidth() - Math.abs(positions)) + * charWidth; + int heightToCopy = wrappedRepeatHeightPx - wrappedSpaceAboveAlignment; + int xMax = ranges.getVisibleAlignmentWidth(); + + if (positions > 0) + { + /* + * shift right (after scroll left) + * for each wrapped width (starting with the last), copy (width-positions) + * columns from the left margin to the right margin, and copy positions + * columns from the right margin of the row above (if any) to the + * left margin of the current row + */ + + /* + * get y-offset of last wrapped width, first row of sequences + */ + int y = canvasHeight / wrappedRepeatHeightPx * wrappedRepeatHeightPx; + y += wrappedSpaceAboveAlignment; + int copyFromLeftStart = labelWidthWest; + int copyFromRightStart = copyFromLeftStart + widthToCopy; + + while (y >= 0) + { + gg.copyArea(copyFromLeftStart, y, widthToCopy, heightToCopy, + positions * charWidth, 0); + if (y > 0) + { + gg.copyArea(copyFromRightStart, y - wrappedRepeatHeightPx, + positions * charWidth, heightToCopy, -widthToCopy, + wrappedRepeatHeightPx); + } + + y -= wrappedRepeatHeightPx; + } + } + else + { + /* + * shift left (after scroll right) + * for each wrapped width (starting with the first), copy (width-positions) + * columns from the right margin to the left margin, and copy positions + * columns from the left margin of the row below (if any) to the + * right margin of the current row + */ + int xpos = av.getRanges().getStartRes(); + int y = wrappedSpaceAboveAlignment; + int copyFromRightStart = labelWidthWest - positions * charWidth; + + while (y < canvasHeight) + { + gg.copyArea(copyFromRightStart, y, widthToCopy, heightToCopy, + positions * charWidth, 0); + if (y + wrappedRepeatHeightPx < canvasHeight - wrappedRepeatHeightPx + && (xpos + viewportWidth <= xMax)) + { + gg.copyArea(labelWidthWest, y + wrappedRepeatHeightPx, -positions + * charWidth, heightToCopy, widthToCopy, + -wrappedRepeatHeightPx); + } + + y += wrappedRepeatHeightPx; + xpos += viewportWidth; + } + } + } + + + /** + * Redraws any positions in the search results in the visible region of a + * wrapped alignment. Any highlights are drawn depending on the search results + * set on the Viewport, not the results argument. This allows + * this method to be called either to clear highlights (passing the previous + * search results), or to draw new highlights. + * + * @param results + * @return + */ + protected boolean drawMappedPositionsWrapped(SearchResultsI results) + { + if (results == null) + { + return false; + } + int charHeight = av.getCharHeight(); + + boolean matchFound = false; + + calculateWrappedGeometry(getWidth(), getHeight()); + int wrappedWidth = av.getWrappedWidth(); + int wrappedHeight = wrappedRepeatHeightPx; + + ViewportRanges ranges = av.getRanges(); + int canvasHeight = getHeight(); + int repeats = canvasHeight / wrappedHeight; + if (canvasHeight / wrappedHeight > 0) + { + repeats++; + } + + int firstVisibleColumn = ranges.getStartRes(); + int lastVisibleColumn = ranges.getStartRes() + repeats + * ranges.getViewportWidth() - 1; + + AlignmentI alignment = av.getAlignment(); + if (av.hasHiddenColumns()) + { + firstVisibleColumn = alignment.getHiddenColumns() + .adjustForHiddenColumns(firstVisibleColumn); + lastVisibleColumn = alignment.getHiddenColumns() + .adjustForHiddenColumns(lastVisibleColumn); + } + + int gapHeight = charHeight * (av.getScaleAboveWrapped() ? 2 : 1); + + for (int seqNo = ranges.getStartSeq(); seqNo <= ranges + .getEndSeq(); seqNo++) + { + SequenceI seq = alignment.getSequenceAt(seqNo); + + int[] visibleResults = results.getResults(seq, firstVisibleColumn, + lastVisibleColumn); + if (visibleResults != null) + { + for (int i = 0; i < visibleResults.length - 1; i += 2) + { + int firstMatchedColumn = visibleResults[i]; + int lastMatchedColumn = visibleResults[i + 1]; + if (firstMatchedColumn <= lastVisibleColumn + && lastMatchedColumn >= firstVisibleColumn) + { + /* + * found a search results match in the visible region + */ + firstMatchedColumn = Math.max(firstMatchedColumn, + firstVisibleColumn); + lastMatchedColumn = Math.min(lastMatchedColumn, + lastVisibleColumn); + + /* + * draw each mapped position separately (as contiguous positions may + * wrap across lines) + */ + for (int mappedPos = firstMatchedColumn; mappedPos <= lastMatchedColumn; mappedPos++) + { + int displayColumn = mappedPos; + if (av.hasHiddenColumns()) + { + displayColumn = alignment.getHiddenColumns() + .findColumnPosition(displayColumn); + } + + /* + * transX: offset from left edge of canvas to residue position + */ + int transX = labelWidthWest + + ((displayColumn - ranges.getStartRes()) % wrappedWidth) + * av.getCharWidth(); + + /* + * transY: offset from top edge of canvas to residue position + */ + int transY = gapHeight; + transY += (displayColumn - ranges.getStartRes()) + / wrappedWidth * wrappedHeight; + transY += (seqNo - ranges.getStartSeq()) * av.getCharHeight(); + + /* + * yOffset is from graphics origin to start of visible region + */ + int yOffset = 0;// (displayColumn / wrappedWidth) * wrappedHeight; + if (transY < getHeight()) + { + matchFound = true; + gg.translate(transX, transY); + drawPanel(gg, displayColumn, displayColumn, seqNo, seqNo, + yOffset); + gg.translate(-transX, -transY); + } + } + } + } + } + } + + return matchFound; + } + + /** + * Answers the width in pixels of the left scale labels (0 if not shown) + * + * @return + */ + int getLabelWidthWest() + { + return labelWidthWest; + } +}