X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSeqCanvas.java;h=0e312461ab54154139e2a931e9a77578048136c9;hb=c4b90e7ff57436d6bb96d316eed24c887b241f4d;hp=389da75fc527406441d524c4abdaf2a73d9c6ad3;hpb=69933be26034fbebe01d573a9290f0baa2b468b4;p=jalview.git diff --git a/src/jalview/gui/SeqCanvas.java b/src/jalview/gui/SeqCanvas.java index 389da75..0e31246 100755 --- a/src/jalview/gui/SeqCanvas.java +++ b/src/jalview/gui/SeqCanvas.java @@ -1,66 +1,100 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2007 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 + * 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. - * - * 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. - * + * + * 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.gui; -import java.awt.*; -import java.awt.image.*; -import javax.swing.*; - -import jalview.datamodel.*; +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.viewmodel.ViewportListenerI; +import jalview.viewmodel.ViewportRanges; + +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; /** * DOCUMENT ME! - * + * * @author $author$ * @version $Revision$ */ -public class SeqCanvas - extends JComponent +public class SeqCanvas extends JComponent implements ViewportListenerI { + private static String ZEROS = "0000000000"; + final FeatureRenderer fr; + final SequenceRenderer sr; + BufferedImage img; + Graphics2D gg; + int imgWidth; + int imgHeight; + AlignViewport av; - SearchResults searchResults = null; + boolean fastPaint = false; - int LABEL_WEST; - int LABEL_EAST; + + int labelWidthWest; + + int labelWidthEast; int cursorX = 0; + int cursorY = 0; /** * Creates a new SeqCanvas object. - * - * @param av DOCUMENT ME! + * + * @param av + * DOCUMENT ME! */ public SeqCanvas(AlignmentPanel ap) { this.av = ap.av; + updateViewport(); fr = new FeatureRenderer(ap); sr = new SequenceRenderer(av); setLayout(new BorderLayout()); PaintRefresher.Register(this, av.getSequenceSetId()); setBackground(Color.white); + + av.getRanges().addPropertyChangeListener(this); } public SequenceRenderer getSequenceRenderer() @@ -73,69 +107,88 @@ public class SeqCanvas return fr; } + int charHeight = 0, charWidth = 0; + + private void updateViewport() + { + charHeight = av.getCharHeight(); + charWidth = av.getCharWidth(); + } /** * DOCUMENT ME! - * - * @param g DOCUMENT ME! - * @param startx DOCUMENT ME! - * @param endx DOCUMENT ME! - * @param ypos DOCUMENT ME! + * + * @param g + * DOCUMENT ME! + * @param startx + * DOCUMENT ME! + * @param endx + * DOCUMENT ME! + * @param ypos + * DOCUMENT ME! */ - void drawNorthScale(Graphics g, int startx, int endx, int ypos) + private 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) + updateViewport(); + for (ScaleMark mark : new ScaleRenderer().calculateMarks(av, startx, + endx)) { - int value = i; - if (av.hasHiddenColumns) + int mpos = mark.column; // (i - startx - 1) + if (mpos < 0) { - value = av.getColumnSelection().adjustForHiddenColumns(value); + continue; } + String mstring = mark.text; - g.drawString(String.valueOf(value), (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); + if (mark.major) + { + if (mstring != null) + { + g.drawString(mstring, mpos * charWidth, ypos - (charHeight / 2)); + } + g.drawLine((mpos * charWidth) + (charWidth / 2), (ypos + 2) + - (charHeight / 2), (mpos * charWidth) + (charWidth / 2), + ypos - 2); + } } } /** * DOCUMENT ME! - * - * @param g DOCUMENT ME! - * @param startx DOCUMENT ME! - * @param endx DOCUMENT ME! - * @param ypos DOCUMENT ME! + * + * @param g + * DOCUMENT ME! + * @param startx + * DOCUMENT ME! + * @param endx + * DOCUMENT ME! + * @param ypos + * DOCUMENT ME! */ void drawWestScale(Graphics g, int startx, int endx, int ypos) { FontMetrics fm = getFontMetrics(av.getFont()); - ypos += av.charHeight; + ypos += charHeight; - if (av.hasHiddenColumns) + if (av.hasHiddenColumns()) { - startx = av.getColumnSelection().adjustForHiddenColumns(startx); - endx = av.getColumnSelection().adjustForHiddenColumns(endx); + startx = av.getAlignment().getHiddenColumns() + .adjustForHiddenColumns(startx); + endx = av.getAlignment().getHiddenColumns() + .adjustForHiddenColumns(endx); } - int maxwidth = av.alignment.getWidth(); - if (av.hasHiddenColumns) + int maxwidth = av.getAlignment().getWidth(); + if (av.hasHiddenColumns()) { - maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1; + maxwidth = av.getAlignment().getHiddenColumns() + .findColumnPosition(maxwidth) - 1; } // WEST SCALE - for (int i = 0; i < av.alignment.getHeight(); i++) + for (int i = 0; i < av.getAlignment().getHeight(); i++) { - SequenceI seq = av.alignment.getSequenceAt(i); + SequenceI seq = av.getAlignment().getSequenceAt(i); int index = startx; int value = -1; @@ -148,43 +201,48 @@ public class SeqCanvas continue; } - value = av.alignment.getSequenceAt(i).findPosition(index); + value = av.getAlignment().getSequenceAt(i).findPosition(index); break; } if (value != -1) { - int x = LABEL_WEST - fm.stringWidth(String.valueOf(value)) - - av.charWidth / 2; - g.drawString(value + "", x, - (ypos + (i * av.charHeight)) - (av.charHeight / 5)); + int x = labelWidthWest - fm.stringWidth(String.valueOf(value)) + - charWidth / 2; + g.drawString(value + "", x, (ypos + (i * charHeight)) + - (charHeight / 5)); } } } /** * DOCUMENT ME! - * - * @param g DOCUMENT ME! - * @param startx DOCUMENT ME! - * @param endx DOCUMENT ME! - * @param ypos DOCUMENT ME! + * + * @param g + * DOCUMENT ME! + * @param startx + * DOCUMENT ME! + * @param endx + * DOCUMENT ME! + * @param ypos + * DOCUMENT ME! */ void drawEastScale(Graphics g, int startx, int endx, int ypos) { - ypos += av.charHeight; + ypos += charHeight; - if (av.hasHiddenColumns) + if (av.hasHiddenColumns()) { - endx = av.getColumnSelection().adjustForHiddenColumns(endx); + endx = av.getAlignment().getHiddenColumns() + .adjustForHiddenColumns(endx); } SequenceI seq; // EAST SCALE - for (int i = 0; i < av.alignment.getHeight(); i++) + for (int i = 0; i < av.getAlignment().getHeight(); i++) { - seq = av.alignment.getSequenceAt(i); + seq = av.getAlignment().getSequenceAt(i); int index = endx; int value = -1; @@ -204,101 +262,96 @@ public class SeqCanvas if (value != -1) { - g.drawString(String.valueOf(value), 0, - (ypos + (i * av.charHeight)) - (av.charHeight / 5)); + g.drawString(String.valueOf(value), 0, (ypos + (i * charHeight)) + - (charHeight / 5)); } } } + boolean fastpainting = false; + /** - * DOCUMENT ME! - * - * @param horizontal DOCUMENT ME! - * @param vertical DOCUMENT ME! + * need to make this thread safe move alignment rendering in response to + * slider adjustment + * + * @param horizontal + * shift along + * @param vertical + * shift up or down in repaint */ public void fastPaint(int horizontal, int vertical) { - if (gg == null) + if (fastpainting || gg == null) { return; } - + fastpainting = true; fastPaint = true; + updateViewport(); - gg.copyArea(horizontal * av.charWidth, - vertical * av.charHeight, - imgWidth, - imgHeight, - -horizontal * av.charWidth, - -vertical * av.charHeight); - - int sr = av.startRes; - int er = av.endRes; - int ss = av.startSeq; - int es = av.endSeq; + 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, imgWidth, + imgHeight, -horizontal * charWidth, -vertical * charHeight); + if (horizontal > 0) // scrollbar pulled right, image to the left { - er++; - transX = (er - sr - horizontal) * av.charWidth; - sr = er - horizontal; + transX = (endRes - startRes - horizontal) * charWidth; + startRes = endRes - horizontal; } else if (horizontal < 0) { - er = sr - horizontal - 1; + endRes = startRes - horizontal; } else if (vertical > 0) // scroll down { - ss = es - vertical; + startSeq = endSeq - vertical; - if (ss < av.startSeq) + if (startSeq < ranges.getStartSeq()) { // ie scrolling too fast, more than a page at a time - ss = av.startSeq; + startSeq = ranges.getStartSeq(); } else { - transY = imgHeight - (vertical * av.charHeight); + transY = imgHeight - ((vertical + 1) * charHeight); } } else if (vertical < 0) { - es = ss - vertical; + endSeq = startSeq - vertical; - if (es > av.endSeq) + if (endSeq > ranges.getEndSeq()) { - es = av.endSeq; + endSeq = ranges.getEndSeq(); } } gg.translate(transX, transY); - drawPanel(gg, sr, er, ss, es, 0); - gg.translate( -transX, -transY); + drawPanel(gg, startRes, endRes, startSeq, endSeq, 0); + gg.translate(-transX, -transY); repaint(); + fastpainting = false; } - /** - * 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 + @Override public void paintComponent(Graphics g) { - BufferedImage lcimg = img; // take reference since other threads may null img and call later. + updateViewport(); + BufferedImage lcimg = img; // take reference since other threads may null + // img and call later. super.paintComponent(g); - if (lcimg != null && (fastPaint - || (getVisibleRect().width != g.getClipBounds().width) - || (getVisibleRect().height != g.getClipBounds().height))) + if (lcimg != null + && (fastPaint + || (getVisibleRect().width != g.getClipBounds().width) || (getVisibleRect().height != g + .getClipBounds().height))) { g.drawImage(lcimg, 0, 0, this); fastPaint = false; @@ -309,40 +362,28 @@ public class SeqCanvas imgWidth = getWidth(); imgHeight = getHeight(); - imgWidth -= (imgWidth % av.charWidth); - imgHeight -= (imgHeight % av.charHeight); + imgWidth -= (imgWidth % charWidth); + imgHeight -= (imgHeight % charHeight); - if ( (imgWidth < 1) || (imgHeight < 1)) + if ((imgWidth < 1) || (imgHeight < 1)) { return; } - if (lcimg == null || imgWidth != lcimg.getWidth() || imgHeight != lcimg.getHeight()) + if (lcimg == null || imgWidth != lcimg.getWidth() + || imgHeight != lcimg.getHeight()) { try { lcimg = img = new BufferedImage(imgWidth, imgHeight, - BufferedImage.TYPE_INT_RGB); + BufferedImage.TYPE_INT_RGB); gg = (Graphics2D) img.getGraphics(); gg.setFont(av.getFont()); - } - catch (OutOfMemoryError er) + } catch (OutOfMemoryError er) { System.gc(); - System.out.println(er + " making image, SeqCanvas"); - javax.swing.SwingUtilities.invokeLater(new Runnable() - { - public void run() - { - javax.swing.JOptionPane.showInternalMessageDialog(Desktop. - desktop, - "Out of memory creating alignment image!!" - + - "\nSee help files for increasing Java Virtual Machine memory." - , "Out of memory", - javax.swing.JOptionPane.WARNING_MESSAGE); - } - }); + System.err.println("SeqCanvas OutOfMemory Redraw Error.\n" + er); + new OOMWarning("Creating alignment image for display", er); return; } @@ -351,126 +392,141 @@ public class SeqCanvas if (av.antiAlias) { gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING, - RenderingHints.VALUE_ANTIALIAS_ON); + RenderingHints.VALUE_ANTIALIAS_ON); } gg.setColor(Color.white); gg.fillRect(0, 0, imgWidth, imgHeight); + ViewportRanges ranges = av.getRanges(); if (av.getWrapAlignment()) { - drawWrappedPanel(gg, getWidth(), getHeight(), av.startRes); + drawWrappedPanel(gg, getWidth(), getHeight(), ranges.getStartRes()); } else { - drawPanel(gg, av.startRes, av.endRes, av.startSeq, av.endSeq, 0); + drawPanel(gg, ranges.getStartRes(), ranges.getEndRes(), + ranges.getStartSeq(), ranges.getEndSeq(), 0); } g.drawImage(lcimg, 0, 0, this); - } /** - * DOCUMENT ME! - * - * @param cwidth DOCUMENT ME! - * - * @return DOCUMENT ME! + * 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 cwidth) + public int getWrappedCanvasWidth(int canvasWidth) { FontMetrics fm = getFontMetrics(av.getFont()); - LABEL_EAST = 0; - LABEL_WEST = 0; + labelWidthEast = 0; + labelWidthWest = 0; - if (av.scaleRightWrapped) + if (av.getScaleRightWrapped()) { - LABEL_EAST = fm.stringWidth(getMask()); + labelWidthEast = getLabelWidth(fm); } - if (av.scaleLeftWrapped) + if (av.getScaleLeftWrapped()) { - LABEL_WEST = fm.stringWidth(getMask()); + labelWidthWest = labelWidthEast > 0 ? labelWidthEast + : getLabelWidth(fm); } - return (cwidth - LABEL_EAST - LABEL_WEST) / av.charWidth; + return (canvasWidth - labelWidthEast - labelWidthWest) / charWidth; } /** - * Generates a string of zeroes. - * @return String + * 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). + * + * @param fm + * @return */ - String getMask() + protected int getLabelWidth(FontMetrics fm) { - String mask = "00"; + /* + * find the biggest sequence end position we need to show + * (note this is not necessarily the sequence length) + */ int maxWidth = 0; - int tmp; - for (int i = 0; i < av.alignment.getHeight(); i++) + AlignmentI alignment = av.getAlignment(); + for (int i = 0; i < alignment.getHeight(); i++) { - tmp = av.alignment.getSequenceAt(i).getEnd(); - if (tmp > maxWidth) - { - maxWidth = tmp; - } + maxWidth = Math.max(maxWidth, alignment.getSequenceAt(i).getEnd()); } + int length = 2; for (int i = maxWidth; i > 0; i /= 10) { - mask += "0"; + length++; } - return mask; + + return fm.stringWidth(ZEROS.substring(0, length)); } /** * DOCUMENT ME! - * - * @param g DOCUMENT ME! - * @param canvasWidth DOCUMENT ME! - * @param canvasHeight DOCUMENT ME! - * @param startRes DOCUMENT ME! + * + * @param g + * DOCUMENT ME! + * @param canvasWidth + * DOCUMENT ME! + * @param canvasHeight + * DOCUMENT ME! + * @param startRes + * DOCUMENT ME! */ - public void drawWrappedPanel(Graphics g, int canvasWidth, int canvasHeight, - int startRes) + public void drawWrappedPanel(Graphics g, int canvasWidth, + int canvasHeight, int startRes) { + updateViewport(); AlignmentI al = av.getAlignment(); - FontMetrics fm = getFontMetrics(av.getFont()); - - if (av.scaleRightWrapped) + int labelWidth = 0; + if (av.getScaleRightWrapped() || av.getScaleLeftWrapped()) { - LABEL_EAST = fm.stringWidth(getMask()); + FontMetrics fm = getFontMetrics(av.getFont()); + labelWidth = getLabelWidth(fm); } - if (av.scaleLeftWrapped) - { - LABEL_WEST = fm.stringWidth(getMask()); - } + labelWidthEast = av.getScaleRightWrapped() ? labelWidth : 0; + labelWidthWest = av.getScaleLeftWrapped() ? labelWidth : 0; - int hgap = av.charHeight; - if (av.scaleAboveWrapped) + int hgap = charHeight; + if (av.getScaleAboveWrapped()) { - hgap += av.charHeight; + hgap += charHeight; } - int cWidth = (canvasWidth - LABEL_EAST - LABEL_WEST) / av.charWidth; - int cHeight = av.getAlignment().getHeight() * av.charHeight; + int cWidth = (canvasWidth - labelWidthEast - labelWidthWest) / charWidth; + int cHeight = av.getAlignment().getHeight() * charHeight; av.setWrappedWidth(cWidth); - av.endRes = av.startRes + cWidth; + av.getRanges().setViewportStartAndWidth(startRes, cWidth); int endx; int ypos = hgap; - int maxwidth = av.alignment.getWidth() - 1; + int maxwidth = av.getAlignment().getWidth(); - if (av.hasHiddenColumns) + if (av.hasHiddenColumns()) { - maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1; + maxwidth = av.getAlignment().getHiddenColumns() + .findColumnPosition(maxwidth); } - while ( (ypos <= canvasHeight) && (startRes < maxwidth)) + int annotationHeight = getAnnotationHeight(); + + while ((ypos <= canvasHeight) && (startRes < maxwidth)) { endx = startRes + cWidth - 1; @@ -482,50 +538,46 @@ public class SeqCanvas g.setFont(av.getFont()); g.setColor(Color.black); - if (av.scaleLeftWrapped) + if (av.getScaleLeftWrapped()) { drawWestScale(g, startRes, endx, ypos); } - if (av.scaleRightWrapped) + if (av.getScaleRightWrapped()) { - g.translate(canvasWidth - LABEL_EAST, 0); + g.translate(canvasWidth - labelWidthEast, 0); drawEastScale(g, startRes, endx, ypos); - g.translate( - (canvasWidth - LABEL_EAST), 0); + g.translate(-(canvasWidth - labelWidthEast), 0); } - g.translate(LABEL_WEST, 0); + g.translate(labelWidthWest, 0); - if (av.scaleAboveWrapped) + if (av.getScaleAboveWrapped()) { drawNorthScale(g, startRes, endx, ypos); } - if (av.hasHiddenColumns && av.showHiddenMarkers) + if (av.hasHiddenColumns() && av.getShowHiddenMarkers()) { g.setColor(Color.blue); int res; - for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); - i++) + HiddenColumns hidden = av.getAlignment().getHiddenColumns(); + List positions = hidden.findHiddenRegionPositions(); + for (int pos : positions) { - res = av.getColumnSelection().findHiddenRegionPosition(i) - - startRes; + res = pos - startRes; if (res < 0 || res > endx - startRes) { continue; } - gg.fillPolygon(new int[] - {res * av.charWidth - av.charHeight / 4, - res * av.charWidth + av.charHeight / 4, - res * av.charWidth}, - new int[] - { - ypos - (av.charHeight / 2), - ypos - (av.charHeight / 2), - ypos - (av.charHeight / 2) + 8 - }, 3); + gg.fillPolygon( + new int[] { res * charWidth - charHeight / 4, + res * charWidth + charHeight / 4, res * charWidth }, + new int[] { ypos - (charHeight / 2), + ypos - (charHeight / 2), ypos - (charHeight / 2) + 8 }, + 3); } } @@ -536,17 +588,17 @@ public class SeqCanvas if (clip == null) { - g.setClip(0, 0, cWidth * av.charWidth, canvasHeight); + g.setClip(0, 0, cWidth * charWidth, canvasHeight); } else { - g.setClip(0, (int) clip.getBounds().getY(), - cWidth * av.charWidth, (int) clip.getBounds().getHeight()); + g.setClip(0, (int) clip.getBounds().getY(), cWidth * charWidth, + (int) clip.getBounds().getHeight()); } - drawPanel(g, startRes, endx, 0, al.getHeight(), ypos); + drawPanel(g, startRes, endx, 0, al.getHeight() - 1, ypos); - if (av.showAnnotation) + if (av.isShowAnnotation()) { g.translate(0, cHeight + ypos + 3); if (annotations == null) @@ -554,22 +606,24 @@ public class SeqCanvas annotations = new AnnotationPanel(av); } - annotations.drawComponent( (Graphics2D) g, startRes, endx + 1); + annotations.renderer.drawComponent(annotations, av, g, -1, + startRes, endx + 1); g.translate(0, -cHeight - ypos - 3); } g.setClip(clip); - g.translate( -LABEL_WEST, 0); + g.translate(-labelWidthWest, 0); - ypos += cHeight + getAnnotationHeight() + hgap; + ypos += cHeight + annotationHeight + hgap; startRes += cWidth; } } AnnotationPanel annotations; + int getAnnotationHeight() { - if (!av.showAnnotation) + if (!av.isShowAnnotation()) { return 0; } @@ -583,33 +637,41 @@ public class SeqCanvas } /** - * DOCUMENT ME! - * - * @param g1 DOCUMENT ME! - * @param startRes DOCUMENT ME! - * @param endRes DOCUMENT ME! - * @param startSeq DOCUMENT ME! - * @param endSeq DOCUMENT ME! - * @param offset DOCUMENT ME! + * 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 + * @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) */ - void drawPanel(Graphics g1, int startRes, int endRes, - int startSeq, int endSeq, int offset) + public void drawPanel(Graphics g1, final int startRes, final int endRes, + final int startSeq, final int endSeq, final int yOffset) { - if (!av.hasHiddenColumns) + updateViewport(); + if (!av.hasHiddenColumns()) { - draw(g1, startRes, endRes, startSeq, endSeq, offset); + draw(g1, startRes, endRes, startSeq, endSeq, yOffset); } else { - java.util.Vector regions = av.getColumnSelection().getHiddenColumns(); - int screenY = 0; + final int screenYMax = endRes - startRes; int blockStart = startRes; int blockEnd = endRes; - for (int i = 0; i < regions.size(); i++) + for (int[] region : av.getAlignment().getHiddenColumns() + .getHiddenColumnsCopy()) { - int[] region = (int[]) regions.elementAt(i); int hideStart = region[0]; int hideEnd = region[1]; @@ -619,122 +681,152 @@ public class SeqCanvas continue; } - blockEnd = hideStart - 1; + /* + * 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 * av.charWidth, 0); + g1.translate(screenY * charWidth, 0); - draw(g1, blockStart, blockEnd, startSeq, endSeq, offset); + draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset); - if (av.getShowHiddenMarkers()) + /* + * 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) * av.charWidth - 1, - 0 + offset, - (blockEnd - blockStart + 1) * av.charWidth - 1, - (endSeq - startSeq) * av.charHeight + offset); + g1.drawLine((blockEnd - blockStart + 1) * charWidth - 1, + 0 + yOffset, (blockEnd - blockStart + 1) * charWidth - 1, + (endSeq - startSeq + 1) * charHeight + yOffset); } - g1.translate( -screenY * av.charWidth, 0); + g1.translate(-screenY * charWidth, 0); screenY += blockEnd - blockStart + 1; blockStart = hideEnd + 1; + + if (screenY > screenYMax) + { + // already rendered last block + return; + } } - if (screenY <= (endRes - startRes)) + if (screenY <= screenYMax) { - blockEnd = blockStart + (endRes - startRes) - screenY; - g1.translate(screenY * av.charWidth, 0); - draw(g1, blockStart, blockEnd, startSeq, endSeq, offset); + // remaining visible region to render + blockEnd = blockStart + screenYMax - screenY; + g1.translate(screenY * charWidth, 0); + draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset); - g1.translate( -screenY * av.charWidth, 0); + g1.translate(-screenY * charWidth, 0); } } } - //int startRes, int endRes, int startSeq, int endSeq, int x, int y, - // int x1, int x2, int y1, int y2, int startx, int starty, - void draw(Graphics g, - int startRes, int endRes, - int startSeq, int endSeq, - int offset) + /** + * 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) { g.setFont(av.getFont()); - sr.prepare(g, av.renderGaps); + sr.prepare(g, av.isRenderGaps()); SequenceI nextSeq; - /// First draw the sequences - ///////////////////////////// - for (int i = startSeq; i < endSeq; i++) + // / First draw the sequences + // /////////////////////////// + for (int i = startSeq; i <= endSeq; i++) { - nextSeq = av.alignment.getSequenceAt(i); - - sr.drawSequence(nextSeq, av.alignment.findAllGroups(nextSeq), - startRes, endRes, - offset + ( (i - startSeq) * av.charHeight)); + nextSeq = av.getAlignment().getSequenceAt(i); + if (nextSeq == null) + { + // occasionally, a race condition occurs such that the alignment row is + // empty + continue; + } + sr.drawSequence(nextSeq, av.getAlignment().findAllGroups(nextSeq), + startRes, endRes, offset + ((i - startSeq) * charHeight)); - if (av.showSequenceFeatures) + if (av.isShowSequenceFeatures()) { - fr.drawSequence(g, nextSeq, startRes, endRes, - offset + ( (i - startSeq) * av.charHeight)); + fr.drawSequence(g, nextSeq, startRes, endRes, offset + + ((i - startSeq) * charHeight), false); } - /// Highlight search Results once all sequences have been drawn - ////////////////////////////////////////////////////////// - if (searchResults != null) + /* + * highlight search Results once sequence has been drawn + */ + if (av.hasSearchResults()) { - int[] visibleResults = searchResults.getResults(nextSeq, startRes, - endRes); + SearchResultsI searchResults = av.getSearchResults(); + int[] visibleResults = searchResults.getResults(nextSeq, + startRes, endRes); if (visibleResults != null) { for (int r = 0; r < visibleResults.length; r += 2) { sr.drawHighlightedText(nextSeq, visibleResults[r], - visibleResults[r + 1], - (visibleResults[r] - startRes) * - av.charWidth, - offset + ( (i - startSeq) * av.charHeight)); + visibleResults[r + 1], (visibleResults[r] - startRes) + * charWidth, offset + + ((i - startSeq) * charHeight)); } } } - if (av.cursorMode && cursorY == i - && cursorX >= startRes && cursorX <= endRes) + if (av.cursorMode && cursorY == i && cursorX >= startRes + && cursorX <= endRes) { - sr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * av.charWidth, - offset + ( (i - startSeq) * av.charHeight)); + sr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * charWidth, + offset + ((i - startSeq) * charHeight)); } } - if (av.getSelectionGroup() != null || av.alignment.getGroups().size() > 0) + 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) + 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 = av.getSelectionGroup(); int sx = -1; int sy = -1; int ex = -1; int groupIndex = -1; - int visWidth = (endRes - startRes + 1) * av.charWidth; + int visWidth = (endRes - startRes + 1) * charWidth; - if ( (group == null) && (av.alignment.getGroups().size() > 0)) + if ((group == null) && (av.getAlignment().getGroups().size() > 0)) { - group = (SequenceGroup) av.alignment.getGroups().elementAt(0); + group = av.getAlignment().getGroups().get(0); groupIndex = 0; } @@ -748,35 +840,33 @@ public class SeqCanvas int top = -1; int bottom = -1; - for (i = startSeq; i < endSeq; i++) + for (i = startSeq; i <= endSeq; i++) { - sx = (group.getStartRes() - startRes) * av.charWidth; - sy = offset + ( (i - startSeq) * av.charHeight); - ex = ( ( (group.getEndRes() + 1) - group.getStartRes()) * - av.charWidth) - - 1; + sx = (group.getStartRes() - startRes) * charWidth; + sy = offset + ((i - startSeq) * charHeight); + ex = (((group.getEndRes() + 1) - group.getStartRes()) * charWidth) - 1; if (sx + ex < 0 || sx > visWidth) { continue; } - if ( (sx <= (endRes - startRes) * av.charWidth) && - group.getSequences(null). - contains(av.alignment.getSequenceAt(i))) + if ((sx <= (endRes - startRes) * charWidth) + && group.getSequences(null).contains( + av.getAlignment().getSequenceAt(i))) { - if ( (bottom == -1) && - !group.getSequences(null).contains( - av.alignment.getSequenceAt(i + 1))) + if ((bottom == -1) + && !group.getSequences(null).contains( + av.getAlignment().getSequenceAt(i + 1))) { - bottom = sy + av.charHeight; + bottom = sy + charHeight; } if (!inGroup) { - if ( ( (top == -1) && (i == 0)) || - !group.getSequences(null).contains( - av.alignment.getSequenceAt(i - 1))) + if (((top == -1) && (i == 0)) + || !group.getSequences(null).contains( + av.getAlignment().getSequenceAt(i - 1))) { top = sy; } @@ -786,11 +876,9 @@ public class SeqCanvas if (group == av.getSelectionGroup()) { - g.setStroke(new BasicStroke(1, - BasicStroke.CAP_BUTT, - BasicStroke.JOIN_ROUND, 3f, - new float[] - {5f, 3f}, 0f)); + g.setStroke(new BasicStroke(1, BasicStroke.CAP_BUTT, + BasicStroke.JOIN_ROUND, 3f, new float[] { 5f, 3f }, + 0f)); g.setColor(Color.RED); } else @@ -825,9 +913,9 @@ public class SeqCanvas ex = visWidth; } - else if (sx + ex >= (endRes - startRes + 1) * av.charWidth) + else if (sx + ex >= (endRes - startRes + 1) * charWidth) { - ex = (endRes - startRes + 1) * av.charWidth; + ex = (endRes - startRes + 1) * charWidth; } if (top != -1) @@ -849,7 +937,7 @@ public class SeqCanvas if (inGroup) { - sy = offset + ( (i - startSeq) * av.charHeight); + sy = offset + ((i - startSeq) * charHeight); if (sx >= 0 && sx < visWidth) { g.drawLine(sx, oldY, sx, sy); @@ -870,9 +958,9 @@ public class SeqCanvas { ex = visWidth; } - else if (sx + ex >= (endRes - startRes + 1) * av.charWidth) + else if (sx + ex >= (endRes - startRes + 1) * charWidth) { - ex = (endRes - startRes + 1) * av.charWidth; + ex = (endRes - startRes + 1) * charWidth; } if (top != -1) @@ -894,31 +982,371 @@ public class SeqCanvas g.setStroke(new BasicStroke()); - if (groupIndex >= av.alignment.getGroups().size()) + if (groupIndex >= av.getAlignment().getGroups().size()) { break; } - group = (SequenceGroup) av.alignment.getGroups().elementAt(groupIndex); + group = av.getAlignment().getGroups().get(groupIndex); + + } while (groupIndex < av.getAlignment().getGroups().size()); + + } + + } + + /** + * 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; + + updateViewport(); + + /* + * 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 (av.getWrapAlignment()) + { + if (eventName.equals(ViewportRanges.STARTRES)) + { + repaint(); + } + } + else + { + int scrollX = 0; + if (eventName.equals(ViewportRanges.STARTRES)) + { + // Make sure we're not trying to draw a panel + // larger than the visible window + ViewportRanges vpRanges = av.getRanges(); + scrollX = (int) evt.getNewValue() - (int) evt.getOldValue(); + 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)) + { + // scroll - startres and endres both change + fastPaint(scrollX, 0); + } + else if (eventName.equals(ViewportRanges.STARTSEQ)) + { + // scroll + fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue()); } - while (groupIndex < av.alignment.getGroups().size()); + } + } + + /** + * 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; + } + + boolean matchFound = false; + + int wrappedWidth = av.getWrappedWidth(); + int wrappedHeight = getRepeatHeightWrapped(); + 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; } /** - * DOCUMENT ME! - * - * @param results DOCUMENT ME! + * Answers the height in pixels of a repeating section of the wrapped + * alignment, including space above, scale above if shown, sequences, and + * annotation panel if shown + * + * @return */ - public void highlightSearchResults(SearchResults results) + protected int getRepeatHeightWrapped() { - img = null; + // gap (and maybe scale) above + int repeatHeight = charHeight * (av.getScaleAboveWrapped() ? 2 : 1); - searchResults = results; + // add sequences + repeatHeight += av.getRanges().getViewportHeight() * charHeight; - repaint(); + // add annotations panel height if shown + repeatHeight += getAnnotationHeight(); + + return repeatHeight; } }