X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FAnnotationPanel.java;h=e020701f5d281e36086babc1770120b7231143c4;hb=ab43013b7e357b84b4abade0dba949668dfb2a0e;hp=eb0189eee5b29fb84c19818ef1cbfe0c59b129e9;hpb=298c2b85845dbaabda7e3304751cc856e7b0ad30;p=jalview.git diff --git a/src/jalview/gui/AnnotationPanel.java b/src/jalview/gui/AnnotationPanel.java index eb0189e..e020701 100755 --- a/src/jalview/gui/AnnotationPanel.java +++ b/src/jalview/gui/AnnotationPanel.java @@ -1,59 +1,87 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) - * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1) + * Copyright (C) 2014 The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - * + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.gui; -import java.awt.*; -import java.awt.event.*; -import java.awt.image.*; -import java.util.Hashtable; - -import javax.swing.*; - -import jalview.analysis.AAFrequency; -import jalview.analysis.StructureFrequency; -import jalview.datamodel.*; +import jalview.datamodel.AlignmentAnnotation; +import jalview.datamodel.Annotation; +import jalview.datamodel.ColumnSelection; +import jalview.datamodel.SequenceI; import jalview.renderer.AnnotationRenderer; import jalview.renderer.AwtRenderPanelI; +import jalview.util.MessageManager; + +import java.awt.AlphaComposite; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.FontMetrics; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.Image; +import java.awt.Rectangle; +import java.awt.RenderingHints; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.AdjustmentEvent; +import java.awt.event.AdjustmentListener; +import java.awt.event.MouseEvent; +import java.awt.event.MouseListener; +import java.awt.event.MouseMotionListener; +import java.awt.event.MouseWheelEvent; +import java.awt.event.MouseWheelListener; +import java.awt.image.BufferedImage; + +import javax.swing.JColorChooser; +import javax.swing.JMenuItem; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JPopupMenu; +import javax.swing.Scrollable; +import javax.swing.SwingUtilities; +import javax.swing.ToolTipManager; /** - * DOCUMENT ME! + * AnnotationPanel displays visible portion of annotation rows below unwrapped + * alignment * * @author $author$ * @version $Revision$ */ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, - MouseListener, MouseMotionListener, ActionListener, - AdjustmentListener + MouseListener, MouseWheelListener, MouseMotionListener, + ActionListener, AdjustmentListener, Scrollable { - final String HELIX = "Helix"; + String HELIX = MessageManager.getString("label.helix"); - final String SHEET = "Sheet"; + String SHEET = MessageManager.getString("label.sheet"); /** * For RNA secondary structure "stems" aka helices */ - final String STEM = "RNA Helix"; + String STEM = MessageManager.getString("label.rna_helix"); - final String LABEL = "Label"; + String LABEL = MessageManager.getString("label.label"); - final String REMOVE = "Remove Annotation"; + String REMOVE = MessageManager.getString("label.remove_annotation"); - final String COLOUR = "Colour"; + String COLOUR = MessageManager.getString("action.colour"); public final Color HELIX_COLOUR = Color.red.darker(); @@ -70,7 +98,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, public BufferedImage image; - public BufferedImage fadedImage; + public volatile BufferedImage fadedImage; Graphics2D gg; @@ -100,6 +128,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, public final AnnotationRenderer renderer; + private MouseWheelListener[] _mwl; + /** * Creates a new AnnotationPanel object. * @@ -121,6 +151,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, addMouseMotionListener(this); ap.annotationScroller.getVerticalScrollBar() .addAdjustmentListener(this); + // save any wheel listeners on the scroller, so we can propagate scroll + // events to them. + _mwl = ap.annotationScroller.getMouseWheelListeners(); + // and then set our own listener to consume all mousewheel events + ap.annotationScroller.addMouseWheelListener(this); renderer = new AnnotationRenderer(); } @@ -130,14 +165,82 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, renderer = new AnnotationRenderer(); } - /** - * DOCUMENT ME! + @Override + public void mouseWheelMoved(MouseWheelEvent e) + { + if (e.isShiftDown()) + { + e.consume(); + if (e.getWheelRotation() > 0) + { + ap.scrollRight(true); + } + else + { + ap.scrollRight(false); + } + } + else + { + // TODO: find the correct way to let the event bubble up to + // ap.annotationScroller + for (MouseWheelListener mwl : _mwl) + { + if (mwl != null) + { + mwl.mouseWheelMoved(e); + } + if (e.isConsumed()) + { + break; + } + } + } + } + + @Override + public Dimension getPreferredScrollableViewportSize() + { + return getPreferredSize(); + } + + @Override + public int getScrollableBlockIncrement(Rectangle visibleRect, + int orientation, int direction) + { + return 30; + } + + @Override + public boolean getScrollableTracksViewportHeight() + { + return false; + } + + @Override + public boolean getScrollableTracksViewportWidth() + { + return true; + } + + @Override + public int getScrollableUnitIncrement(Rectangle visibleRect, + int orientation, int direction) + { + return 30; + } + + /* + * (non-Javadoc) * - * @param evt - * DOCUMENT ME! + * @see + * java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event + * .AdjustmentEvent) */ + @Override public void adjustmentValueChanged(AdjustmentEvent evt) { + // update annotation label display ap.alabels.setScrollOffset(-evt.getValue()); } @@ -149,7 +252,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, */ public int adjustPanelHeight() { - int height = calcPanelHeight(); + int height = av.calcPanelHeight(); this.setPreferredSize(new Dimension(1, height)); if (ap != null) { @@ -161,73 +264,15 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, } /** - * calculate the height for visible annotation, revalidating bounds where - * necessary ABSTRACT GUI METHOD - * - * @return total height of annotation - */ - public int calcPanelHeight() - { - // setHeight of panels - AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation(); - int height = 0; - - if (aa != null) - { - for (int i = 0; i < aa.length; i++) - { - if (aa[i] == null) - { - System.err.println("Null annotation row: ignoring."); - continue; - } - if (!aa[i].visible) - { - continue; - } - - aa[i].height = 0; - - if (aa[i].hasText) - { - aa[i].height += av.charHeight; - } - - if (aa[i].hasIcons) - { - aa[i].height += 16; - } - - if (aa[i].graph > 0) - { - aa[i].height += aa[i].graphHeight; - } - - if (aa[i].height == 0) - { - aa[i].height = 20; - } - - height += aa[i].height; - } - } - if (height == 0) - { - // set minimum - height = 20; - } - return height; - } - - /** * DOCUMENT ME! * * @param evt * DOCUMENT ME! */ + @Override public void actionPerformed(ActionEvent evt) { - AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation(); + AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation(); if (aa == null) { return; @@ -252,8 +297,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, else if (evt.getActionCommand().equals(LABEL)) { String exMesg = collectAnnotVals(anot, av.getColumnSelection(), LABEL); - String label = JOptionPane.showInputDialog(this, "Enter label", - exMesg); + String label = JOptionPane.showInputDialog(this, + MessageManager.getString("label.enter_label"), exMesg); if (label == null) { @@ -269,8 +314,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, { int index = av.getColumnSelection().columnAt(i); - if (!av.colSel.isVisible(index)) + if (!av.getColumnSelection().isVisible(index)) + { continue; + } if (anot[index] == null) { @@ -288,14 +335,16 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, else if (evt.getActionCommand().equals(COLOUR)) { Color col = JColorChooser.showDialog(this, - "Choose foreground colour", Color.black); + MessageManager.getString("label.select_foreground_colour"), Color.black); for (int i = 0; i < av.getColumnSelection().size(); i++) { int index = av.getColumnSelection().columnAt(i); - if (!av.colSel.isVisible(index)) + if (!av.getColumnSelection().isVisible(index)) + { continue; + } if (anot[index] == null) { @@ -333,8 +382,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, aa[activeRow].hasIcons = true; } - String label = JOptionPane.showInputDialog( - "Enter a label for the structure?", symbol); + String label = JOptionPane.showInputDialog(MessageManager + .getString("label.enter_label_for_the_structure"), symbol); if (label == null) { @@ -344,24 +393,34 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, if ((label.length() > 0) && !aa[activeRow].hasText) { aa[activeRow].hasText = true; + if (evt.getActionCommand().equals(STEM)) + { + aa[activeRow].showAllColLabels = true; + } } - for (int i = 0; i < av.getColumnSelection().size(); i++) { int index = av.getColumnSelection().columnAt(i); - if (!av.colSel.isVisible(index)) + if (!av.getColumnSelection().isVisible(index)) + { continue; + } if (anot[index] == null) { anot[index] = new Annotation(label, "", type, 0); } - anot[index].secondaryStructure = type; + + anot[index].secondaryStructure = type != 'S' ? type : label + .length() == 0 ? ' ' : label.charAt(0); anot[index].displayCharacter = label; + } } + av.getAlignment().validateAnnotation(aa[activeRow]); + ap.alignmentChanged(); adjustPanelHeight(); repaint(); @@ -374,12 +433,16 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, { String collatedInput = ""; String last = ""; + ColumnSelection viscols = av.getColumnSelection(); + // TODO: refactor and save av.getColumnSelection for efficiency for (int i = 0; i < columnSelection.size(); i++) { int index = columnSelection.columnAt(i); // always check for current display state - just in case - if (!av.colSel.isVisible(index)) + if (!viscols.isVisible(index)) + { continue; + } String tlabel = null; if (anot[index] != null) { // LML added stem code @@ -419,10 +482,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mousePressed(MouseEvent evt) { - AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation(); + AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation(); if (aa == null) { return; @@ -462,12 +526,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, return; } - JPopupMenu pop = new JPopupMenu("Structure type"); + JPopupMenu pop = new JPopupMenu( + MessageManager.getString("label.structure_type")); JMenuItem item; /* * Just display the needed structure options */ - if (av.alignment.isNucleotide() == true) + if (av.getAlignment().isNucleotide() == true) { item = new JMenuItem(STEM); item.addActionListener(this); @@ -511,6 +576,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseReleased(MouseEvent evt) { graphStretch = -1; @@ -525,6 +591,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseEntered(MouseEvent evt) { ap.scalePanel.mouseEntered(evt); @@ -536,6 +603,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseExited(MouseEvent evt) { ap.scalePanel.mouseExited(evt); @@ -547,15 +615,16 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseDragged(MouseEvent evt) { if (graphStretch > -1) { - av.alignment.getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY + av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY - evt.getY(); - if (av.alignment.getAlignmentAnnotation()[graphStretch].graphHeight < 0) + if (av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight < 0) { - av.alignment.getAlignmentAnnotation()[graphStretch].graphHeight = 0; + av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight = 0; } graphStretchY = evt.getY(); adjustPanelHeight(); @@ -573,9 +642,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseMoved(MouseEvent evt) { - AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation(); + AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation(); if (aa == null) { @@ -609,13 +679,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, int res = (evt.getX() / av.getCharWidth()) + av.getStartRes(); - if (av.hasHiddenColumns) + if (av.hasHiddenColumns()) { res = av.getColumnSelection().adjustForHiddenColumns(res); } if (row > -1 && aa[row].annotations != null - && res < (int) aa[row].annotations.length) + && res < aa[row].annotations.length) { if (aa[row].graphGroup > -1) { @@ -639,7 +709,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, && aa[row].annotations[res].description != null && aa[row].annotations[res].description.length() > 0) { - this.setToolTipText(aa[row].annotations[res].description); + this.setToolTipText(JvSwingUtils + .wrapTooltip(true, aa[row].annotations[res].description)); } else { @@ -672,18 +743,14 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, * @param evt * DOCUMENT ME! */ + @Override public void mouseClicked(MouseEvent evt) { - if (activeRow != -1) - { - AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation(); - AlignmentAnnotation anot = aa[activeRow]; - - if (anot.description.equals("secondary structure")) - { - // System.out.println(anot.description+" "+anot.getRNAStruc()); - } - } + // if (activeRow != -1) + // { + // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation(); + // AlignmentAnnotation anot = aa[activeRow]; + // } } // TODO mouseClicked-content and drawCursor are quite experimental! @@ -708,12 +775,15 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, } + private volatile boolean imageFresh = false; + /** * DOCUMENT ME! * * @param g * DOCUMENT ME! */ + @Override public void paintComponent(Graphics g) { g.setColor(Color.white); @@ -731,12 +801,30 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, } imgWidth = (av.endRes - av.startRes + 1) * av.charWidth; if (imgWidth < 1) + { return; - if (image == null || imgWidth != image.getWidth() + } + if (image == null || imgWidth != image.getWidth(this) || image.getHeight(this) != getHeight()) { - image = new BufferedImage(imgWidth, ap.annotationPanel.getHeight(), - BufferedImage.TYPE_INT_RGB); + try + { + image = new BufferedImage(imgWidth, ap.annotationPanel.getHeight(), + BufferedImage.TYPE_INT_RGB); + } catch (OutOfMemoryError oom) + { + try + { + System.gc(); + } catch (Exception x) + { + } + ; + new OOMWarning( + "Couldn't allocate memory to redraw screen. Please restart Jalview", + oom); + return; + } gg = (Graphics2D) image.getGraphics(); if (av.antiAlias) @@ -749,13 +837,20 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, fm = gg.getFontMetrics(); gg.setColor(Color.white); gg.fillRect(0, 0, imgWidth, image.getHeight()); + imageFresh = true; } drawComponent(gg, av.startRes, av.endRes + 1); + imageFresh = false; g.drawImage(image, 0, 0, this); } /** + * set true to enable redraw timing debug output on stderr + */ + private final boolean debugRedraw = false; + + /** * non-Thread safe repaint * * @param horizontal @@ -763,17 +858,17 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, */ public void fastPaint(int horizontal) { - if ((horizontal == 0) || gg == null - || av.alignment.getAlignmentAnnotation() == null - || av.alignment.getAlignmentAnnotation().length < 1 - || av.updatingConsensus || av.updatingConservation) + || av.getAlignment().getAlignmentAnnotation() == null + || av.getAlignment().getAlignmentAnnotation().length < 1 + || av.isCalcInProgress()) { repaint(); return; } + long stime = System.currentTimeMillis(); gg.copyArea(0, 0, imgWidth, getHeight(), -horizontal * av.charWidth, 0); - + long mtime = System.currentTimeMillis(); int sr = av.startRes; int er = av.endRes + 1; int transX = 0; @@ -793,12 +888,21 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, drawComponent(gg, sr, er); gg.translate(-transX, 0); - + long dtime = System.currentTimeMillis(); fastPaint = true; repaint(); + long rtime = System.currentTimeMillis(); + if (debugRedraw) + { + System.err.println("Scroll:\t" + horizontal + "\tCopyArea:\t" + + (mtime - stime) + "\tDraw component:\t" + (dtime - mtime) + + "\tRepaint call:\t" + (rtime - dtime)); + } } + private volatile boolean lastImageGood = false; + /** * DOCUMENT ME! * @@ -811,18 +915,23 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, */ public void drawComponent(Graphics g, int startRes, int endRes) { - if (av.updatingConsensus || av.updatingConservation) + BufferedImage oldFaded = fadedImage; + if (av.isCalcInProgress()) { if (image == null) { + lastImageGood = false; return; } // We'll keep a record of the old image, // and draw a faded image until the calculation // has completed - if (fadedImage == null || fadedImage.getWidth() != imgWidth - || fadedImage.getHeight() != image.getHeight()) + if (lastImageGood + && (fadedImage == null || fadedImage.getWidth() != imgWidth || fadedImage + .getHeight() != image.getHeight())) { + // System.err.println("redraw faded image ("+(fadedImage==null ? + // "null image" : "") + " lastGood="+lastImageGood+")"); fadedImage = new BufferedImage(imgWidth, image.getHeight(), BufferedImage.TYPE_INT_RGB); @@ -836,10 +945,17 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, fadedG.drawImage(image, 0, 0, this); } + // make sure we don't overwrite the last good faded image until all + // calculations have finished + lastImageGood = false; } else { + if (fadedImage != null) + { + oldFaded = fadedImage; + } fadedImage = null; } @@ -852,20 +968,26 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, fm = g.getFontMetrics(); } - if ((av.alignment.getAlignmentAnnotation() == null) - || (av.alignment.getAlignmentAnnotation().length < 1)) + if ((av.getAlignment().getAlignmentAnnotation() == null) + || (av.getAlignment().getAlignmentAnnotation().length < 1)) { g.setColor(Color.white); g.fillRect(0, 0, getWidth(), getHeight()); g.setColor(Color.black); if (av.validCharWidth) { - g.drawString("Alignment has no annotations", 20, 15); + g.drawString(MessageManager + .getString("label.alignment_has_no_annotations"), 20, 15); } return; } - renderer.drawComponent(this, av, g, activeRow, startRes, endRes); + lastImageGood = renderer.drawComponent(this, av, g, activeRow, + startRes, endRes); + if (!lastImageGood && fadedImage == null) + { + fadedImage = oldFaded; + } } @Override @@ -885,4 +1007,23 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI, { return imgWidth; } + + private int[] bounds = new int[2]; + + @Override + public int[] getVisibleVRange() + { + if (ap != null && ap.alabels != null) + { + int sOffset = -ap.alabels.scrollOffset; + int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight(); + bounds[0] = sOffset; + bounds[1] = visHeight; + return bounds; + } + else + { + return null; + } + } }