/*
- * 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-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
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.gui;
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.image.*;
-import javax.swing.*;
-
-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;
/**
- * AnnotationPanel displays visible portion of annotation rows below unwrapped alignment
+ * 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();
public final AnnotationRenderer renderer;
+ private MouseWheelListener[] _mwl;
+
/**
* Creates a new AnnotationPanel object.
- *
+ *
* @param ap
* DOCUMENT ME!
*/
public AnnotationPanel(AlignmentPanel ap)
{
- MAC = new jalview.util.Platform().isAMac();
+ MAC = jalview.util.Platform.isAMac();
ToolTipManager.sharedInstance().registerComponent(this);
ToolTipManager.sharedInstance().setInitialDelay(0);
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();
}
renderer = new AnnotationRenderer();
}
- /**
- * DOCUMENT ME!
- *
- * @param evt
- * 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)
+ *
+ * @see
+ * java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event
+ * .AdjustmentEvent)
*/
@Override
public void adjustmentValueChanged(AdjustmentEvent evt)
{
- ap.alabels.setScrollOffset(-evt.getValue());
+ // update annotation label display
+ ap.getAlabels().setScrollOffset(-evt.getValue());
}
/**
* Calculates the height of the annotation displayed in the annotation panel.
* Callers should normally call the ap.adjustAnnotationHeight method to ensure
* all annotation associated components are updated correctly.
- *
+ *
*/
public int adjustPanelHeight()
{
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
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)
{
int index = av.getColumnSelection().columnAt(i);
if (!av.getColumnSelection().isVisible(index))
+ {
continue;
+ }
if (anot[index] == null)
{
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.getColumnSelection().isVisible(index))
+ {
continue;
+ }
if (anot[index] == null)
{
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)
{
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.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;
+
}
}
- aa[activeRow].validateRangeAndDisplay();
+ av.getAlignment().validateAnnotation(aa[activeRow]);
+ ap.alignmentChanged();
adjustPanelHeight();
- ap.alignmentChanged();
repaint();
return;
{
String collatedInput = "";
String last = "";
- ColumnSelection viscols=av.getColumnSelection();
+ 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 (!viscols.isVisible(index))
+ {
continue;
+ }
String tlabel = null;
if (anot[index] != null)
{ // LML added stem code
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
return;
}
- JPopupMenu pop = new JPopupMenu("Structure type");
+ JPopupMenu pop = new JPopupMenu(
+ MessageManager.getString("label.structure_type"));
JMenuItem item;
/*
* Just display the needed structure options
return;
}
- ap.scalePanel.mousePressed(evt);
+ ap.getScalePanel().mousePressed(evt);
}
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
graphStretch = -1;
graphStretchY = -1;
mouseDragging = false;
- ap.scalePanel.mouseReleased(evt);
+ ap.getScalePanel().mouseReleased(evt);
}
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
@Override
public void mouseEntered(MouseEvent evt)
{
- ap.scalePanel.mouseEntered(evt);
+ ap.getScalePanel().mouseEntered(evt);
}
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
@Override
public void mouseExited(MouseEvent evt)
{
- ap.scalePanel.mouseExited(evt);
+ ap.getScalePanel().mouseExited(evt);
}
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
}
else
{
- ap.scalePanel.mouseDragged(evt);
+ ap.getScalePanel().mouseDragged(evt);
}
}
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
&& 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
{
/**
* DOCUMENT ME!
- *
+ *
* @param evt
* DOCUMENT ME!
*/
@Override
public void mouseClicked(MouseEvent evt)
{
- if (activeRow != -1)
- {
- AlignmentAnnotation[] aa = av.getAlignment().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!
public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
int y1)
{
- int pady = av.charHeight / 5;
+ int pady = av.getCharHeight() / 5;
int charOffset = 0;
graphics.setColor(Color.black);
- graphics.fillRect(x1, y1, av.charWidth, av.charHeight);
+ graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
if (av.validCharWidth)
{
char s = seq.getCharAt(res);
- charOffset = (av.charWidth - fm.charWidth(s)) / 2;
+ charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
graphics.drawString(String.valueOf(s), charOffset + x1,
- (y1 + av.charHeight) - pady);
+ (y1 + av.getCharHeight()) - pady);
}
}
- private volatile boolean imageFresh=false;
+
+ private volatile boolean imageFresh = false;
+
/**
* DOCUMENT ME!
- *
+ *
* @param g
* DOCUMENT ME!
*/
return;
}
}
- imgWidth = (av.endRes - av.startRes + 1) * av.charWidth;
+ imgWidth = (av.endRes - av.startRes + 1) * av.getCharWidth();
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.getAnnotationPanel().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)
fm = gg.getFontMetrics();
gg.setColor(Color.white);
gg.fillRect(0, 0, imgWidth, image.getHeight());
- imageFresh=true;
+ imageFresh = true;
}
drawComponent(gg, av.startRes, av.endRes + 1);
- imageFresh=false;
+ 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
* repaint with horizontal shift in alignment
*/
public void fastPaint(int horizontal)
{
-
if ((horizontal == 0) || gg == null
|| av.getAlignment().getAlignmentAnnotation() == null
|| av.getAlignment().getAlignmentAnnotation().length < 1
repaint();
return;
}
- gg.copyArea(0, 0, imgWidth, getHeight(), -horizontal * av.charWidth, 0);
-
+ long stime = System.currentTimeMillis();
+ gg.copyArea(0, 0, imgWidth, getHeight(),
+ -horizontal * av.getCharWidth(), 0);
+ long mtime = System.currentTimeMillis();
int sr = av.startRes;
int er = av.endRes + 1;
int transX = 0;
if (horizontal > 0) // scrollbar pulled right, image to the left
{
- transX = (er - sr - horizontal) * av.charWidth;
+ transX = (er - sr - horizontal) * av.getCharWidth();
sr = er - horizontal;
}
else if (horizontal < 0)
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;
+
+ private volatile boolean lastImageGood = false;
+
/**
* DOCUMENT ME!
- *
+ *
* @param g
* DOCUMENT ME!
* @param startRes
*/
public void drawComponent(Graphics g, int startRes, int endRes)
{
- BufferedImage oldFaded=fadedImage;
+ BufferedImage oldFaded = fadedImage;
if (av.isCalcInProgress())
{
if (image == null)
{
- lastImageGood=false;
+ lastImageGood = false;
return;
}
// We'll keep a record of the old image,
// and draw a faded image until the calculation
// has completed
- if (lastImageGood && (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+")");
+ // System.err.println("redraw faded image ("+(fadedImage==null ?
+ // "null image" : "") + " lastGood="+lastImageGood+")");
fadedImage = new BufferedImage(imgWidth, image.getHeight(),
BufferedImage.TYPE_INT_RGB);
fadedG.drawImage(image, 0, 0, this);
}
- // make sure we don't overwrite the last good faded image until all calculations have finished
- lastImageGood=false;
+ // make sure we don't overwrite the last good faded image until all
+ // calculations have finished
+ lastImageGood = false;
}
else
{
- if (fadedImage!=null)
+ if (fadedImage != null)
{
- oldFaded=fadedImage;
+ oldFaded = fadedImage;
}
fadedImage = null;
}
g.setColor(Color.white);
- g.fillRect(0, 0, (endRes - startRes) * av.charWidth, getHeight());
+ g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
g.setFont(av.getFont());
if (fm == null)
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;
}
- lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes, endRes);
- if (!lastImageGood && fadedImage==null)
+ lastImageGood = renderer.drawComponent(this, av, g, activeRow,
+ startRes, endRes);
+ if (!lastImageGood && fadedImage == null)
{
- fadedImage=oldFaded;
+ fadedImage = oldFaded;
}
}
{
return imgWidth;
}
+
+ private int[] bounds = new int[2];
+
+ @Override
+ public int[] getVisibleVRange()
+ {
+ if (ap != null && ap.getAlabels() != null)
+ {
+ int sOffset = -ap.getAlabels().getScrollOffset();
+ int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
+ bounds[0] = sOffset;
+ bounds[1] = visHeight;
+ return bounds;
+ }
+ else
+ {
+ return null;
+ }
+ }
}