/*
- * 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 <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 javax.swing.*;
-
-import jalview.datamodel.*;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.renderer.ScaleRenderer;
+import jalview.renderer.ScaleRenderer.ScaleMark;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.ViewportListenerI;
+import jalview.viewmodel.ViewportRanges;
+
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.beans.PropertyChangeEvent;
+import java.util.List;
+
+import javax.swing.JMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+import javax.swing.ToolTipManager;
/**
- * DOCUMENT ME!
- *
- * @author $author$
- * @version $Revision$
+ * The panel containing the sequence ruler (when not in wrapped mode), and
+ * supports a range of mouse operations to select, hide or reveal columns.
*/
-public class ScalePanel
- extends JPanel implements MouseMotionListener, MouseListener
+public class ScalePanel extends JPanel
+ implements MouseMotionListener, MouseListener, ViewportListenerI
{
protected int offy = 4;
- /** DOCUMENT ME!! */
public int width;
+
protected AlignViewport av;
+
AlignmentPanel ap;
+
boolean stretchingGroup = false;
- int min; //used by mouseDragged to see if user
- int max; //used by mouseDragged to see if user
+
+ /*
+ * min, max hold the extent of a mouse drag action
+ */
+ int min;
+
+ int max;
+
boolean mouseDragging = false;
- // wants to delete columns
+ /*
+ * holds a hidden column range when the mouse is over an adjacent column
+ */
+ int[] reveal;
+
+ /**
+ * Constructor
+ *
+ * @param av
+ * @param ap
+ */
public ScalePanel(AlignViewport av, AlignmentPanel ap)
{
this.av = av;
addMouseListener(this);
addMouseMotionListener(this);
+
+ av.getRanges().addPropertyChangeListener(this);
}
/**
* DOCUMENT ME!
- *
- * @param evt DOCUMENT ME!
+ *
+ * @param evt
+ * DOCUMENT ME!
*/
+ @Override
public void mousePressed(MouseEvent evt)
{
- int x = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+ int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
final int res;
- if (av.hasHiddenColumns)
+ if (av.hasHiddenColumns())
+ {
+ x = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(x);
+ }
+
+ if (x >= av.getAlignment().getWidth())
{
- res = av.getColumnSelection().adjustForHiddenColumns(x);
+ res = av.getAlignment().getWidth() - 1;
}
else
{
min = res;
max = res;
- if (SwingUtilities.isRightMouseButton(evt))
+ if (evt.isPopupTrigger()) // Mac: mousePressed
+ {
+ rightMouseButtonPressed(evt, res);
+ }
+ else if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
+ {
+ /*
+ * defer right-mouse click handling to mouse up on Windows
+ * (where isPopupTrigger() will answer true)
+ * but accept Cmd-click on Mac which passes isRightMouseButton
+ */
+ return;
+ }
+ else
{
- JPopupMenu pop = new JPopupMenu();
- if (reveal != null)
+ leftMouseButtonPressed(evt, res);
+ }
+ }
+
+ /**
+ * Handles right mouse button press. If pressed in a selected column, opens
+ * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
+ * opens context menu for 'Reveal / Reveal All'. Else does nothing.
+ *
+ * @param evt
+ * @param res
+ */
+ protected void rightMouseButtonPressed(MouseEvent evt, final int res)
+ {
+ JPopupMenu pop = new JPopupMenu();
+ if (reveal != null)
+ {
+ JMenuItem item = new JMenuItem(
+ MessageManager.getString("label.reveal"));
+ item.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent e)
+ {
+ av.showColumn(reveal[0]);
+ reveal = null;
+ ap.paintAlignment(true);
+ av.sendSelection();
+ }
+ });
+ pop.add(item);
+
+ if (av.getAlignment().getHiddenColumns().hasHiddenColumns())
{
- JMenuItem item = new JMenuItem("Reveal");
+ item = new JMenuItem(MessageManager.getString("action.reveal_all"));
item.addActionListener(new ActionListener()
{
+ @Override
public void actionPerformed(ActionEvent e)
{
- av.showColumn(reveal[0]);
+ av.showAllHiddenColumns();
reveal = null;
ap.paintAlignment(true);
- if (ap.overviewPanel != null)
- {
- ap.overviewPanel.updateOverviewImage();
- }
+ av.sendSelection();
}
});
pop.add(item);
-
- if (av.getColumnSelection().getHiddenColumns().size() > 1)
- {
- item = new JMenuItem("Reveal All");
- item.addActionListener(new ActionListener()
- {
- public void actionPerformed(ActionEvent e)
- {
- av.showAllHiddenColumns();
- reveal = null;
- ap.paintAlignment(true);
- if (ap.overviewPanel != null)
- {
- ap.overviewPanel.updateOverviewImage();
- }
- }
- });
- pop.add(item);
- }
- pop.show(this, evt.getX(), evt.getY());
}
- else if (av.getColumnSelection().contains(res))
+ pop.show(this, evt.getX(), evt.getY());
+ }
+ else if (av.getColumnSelection().contains(res))
+ {
+ JMenuItem item = new JMenuItem(
+ MessageManager.getString("label.hide_columns"));
+ item.addActionListener(new ActionListener()
{
- JMenuItem item = new JMenuItem("Hide Columns");
- item.addActionListener(new ActionListener()
+ @Override
+ public void actionPerformed(ActionEvent e)
{
- public void actionPerformed(ActionEvent e)
+ av.hideColumns(res, res);
+ if (av.getSelectionGroup() != null && av.getSelectionGroup()
+ .getSize() == av.getAlignment().getHeight())
{
- av.hideColumns(res, res);
- if (av.getSelectionGroup() != null
- && av.getSelectionGroup().getSize() == av.alignment.getHeight())
- {
- av.setSelectionGroup(null);
- }
-
- ap.paintAlignment(true);
- if (ap.overviewPanel != null)
- {
- ap.overviewPanel.updateOverviewImage();
- }
+ av.setSelectionGroup(null);
}
- });
- pop.add(item);
- pop.show(this, evt.getX(), evt.getY());
- }
+
+ ap.paintAlignment(true);
+ av.sendSelection();
+ }
+ });
+ pop.add(item);
+ pop.show(this, evt.getX(), evt.getY());
}
- else // LEFT MOUSE TO SELECT
+ }
+
+ /**
+ * Handles left mouse button press
+ *
+ * @param evt
+ * @param res
+ */
+ protected void leftMouseButtonPressed(MouseEvent evt, final int res)
+ {
+ /*
+ * Ctrl-click/Cmd-click adds to the selection
+ * Shift-click extends the selection
+ */
+ // TODO Problem: right-click on Windows not reported until mouseReleased?!?
+ if (!Platform.isControlDown(evt) && !evt.isShiftDown())
{
- if (!evt.isControlDown() && !evt.isShiftDown())
- {
- av.getColumnSelection().clear();
- }
+ av.getColumnSelection().clear();
+ }
- av.getColumnSelection().addElement(res);
- SequenceGroup sg = new SequenceGroup();
- // try to be as quick as possible
- SequenceI[] iVec = av.alignment.getSequencesArray();
- for (int i = 0; i < iVec.length; i++)
- {
- sg.addSequence(iVec[i], false);
- iVec[i] = null;
- }
- iVec=null;
- sg.setStartRes(res);
- sg.setEndRes(res);
- av.setSelectionGroup(sg);
+ av.getColumnSelection().addElement(res);
+ SequenceGroup sg = new SequenceGroup();
+ // try to be as quick as possible
+ SequenceI[] iVec = av.getAlignment().getSequencesArray();
+ for (int i = 0; i < iVec.length; i++)
+ {
+ sg.addSequence(iVec[i], false);
+ iVec[i] = null;
+ }
+ iVec = null;
+ sg.setStartRes(res);
+ sg.setEndRes(res);
- if (evt.isShiftDown())
+ if (evt.isShiftDown())
+ {
+ int min = Math.min(av.getColumnSelection().getMin(), res);
+ int max = Math.max(av.getColumnSelection().getMax(), res);
+ for (int i = min; i < max; i++)
{
- int min = Math.min(av.getColumnSelection().getMin(), res);
- int max = Math.max(av.getColumnSelection().getMax(), res);
- for (int i = min; i < max; i++)
- {
- av.getColumnSelection().addElement(i);
- }
- sg.setStartRes(min);
- sg.setEndRes(max);
+ av.getColumnSelection().addElement(i);
}
-
+ sg.setStartRes(min);
+ sg.setEndRes(max);
}
-
+ av.setSelectionGroup(sg);
ap.paintAlignment(false);
+ av.sendSelection();
}
/**
* DOCUMENT ME!
- *
- * @param evt DOCUMENT ME!
+ *
+ * @param evt
+ * DOCUMENT ME!
*/
+ @Override
public void mouseReleased(MouseEvent evt)
{
mouseDragging = false;
- int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+ int res = (evt.getX() / av.getCharWidth())
+ + av.getRanges().getStartRes();
- if (res > av.alignment.getWidth())
+ if (av.hasHiddenColumns())
{
- res = av.alignment.getWidth() - 1;
+ res = av.getAlignment().getHiddenColumns()
+ .adjustForHiddenColumns(res);
}
- if (av.hasHiddenColumns)
+ if (res >= av.getAlignment().getWidth())
{
- res = av.getColumnSelection().adjustForHiddenColumns(res);
+ res = av.getAlignment().getWidth() - 1;
}
if (!stretchingGroup)
{
- ap.paintAlignment(false);
-
+ if (evt.isPopupTrigger()) // Windows: mouseReleased
+ {
+ rightMouseButtonPressed(evt, res);
+ }
+ else
+ {
+ ap.paintAlignment(false);
+ }
return;
}
}
stretchingGroup = false;
ap.paintAlignment(false);
+ av.sendSelection();
}
/**
- * DOCUMENT ME!
- *
- * @param evt DOCUMENT ME!
+ * Action on dragging the mouse in the scale panel is to expand or shrink the
+ * selection group range (including any hidden columns that it spans)
+ *
+ * @param evt
*/
+ @Override
public void mouseDragged(MouseEvent evt)
{
mouseDragging = true;
+ ColumnSelection cs = av.getColumnSelection();
+ HiddenColumns hidden = av.getAlignment().getHiddenColumns();
- int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
- if (res < 0)
- {
- res = 0;
- }
-
- if (av.hasHiddenColumns)
- {
- res = av.getColumnSelection().adjustForHiddenColumns(res);
- }
-
- if (res > av.alignment.getWidth())
- {
- res = av.alignment.getWidth() - 1;
- }
-
- if (res < min)
- {
- min = res;
- }
-
- if (res > max)
- {
- max = res;
- }
+ int res = (evt.getX() / av.getCharWidth())
+ + av.getRanges().getStartRes();
+ res = Math.max(0, res);
+ res = hidden.adjustForHiddenColumns(res);
+ res = Math.min(res, av.getAlignment().getWidth() - 1);
+ min = Math.min(res, min);
+ max = Math.max(res, max);
SequenceGroup sg = av.getSelectionGroup();
-
if (sg != null)
{
stretchingGroup = true;
-
- if (!av.getColumnSelection().contains(res))
- {
- av.getColumnSelection().addElement(res);
- }
-
- if (res > sg.getStartRes())
- {
- sg.setEndRes(res);
- }
- if (res < sg.getStartRes())
- {
- sg.setStartRes(res);
- }
-
- int col;
- for (int i = min; i <= max; i++)
- {
- col = av.getColumnSelection().adjustForHiddenColumns(i);
-
- if ( (col < sg.getStartRes()) || (col > sg.getEndRes()))
- {
- av.getColumnSelection().removeElement(col);
- }
- else
- {
- av.getColumnSelection().addElement(col);
- }
- }
-
+ cs.stretchGroup(res, sg, min, max);
ap.paintAlignment(false);
}
}
+ @Override
public void mouseEntered(MouseEvent evt)
{
if (mouseDragging)
{
- ap.seqPanel.scrollCanvas(null);
+ ap.getSeqPanel().scrollCanvas(null);
}
}
+ @Override
public void mouseExited(MouseEvent evt)
{
if (mouseDragging)
{
- ap.seqPanel.scrollCanvas(evt);
+ ap.getSeqPanel().scrollCanvas(evt);
}
}
+ @Override
public void mouseClicked(MouseEvent evt)
- {}
+ {
+ }
+ /**
+ * Creates a tooltip when the mouse is over a hidden columns marker
+ */
+ @Override
public void mouseMoved(MouseEvent evt)
{
- if (!av.hasHiddenColumns)
+ this.setToolTipText(null);
+ reveal = null;
+ if (!av.hasHiddenColumns())
{
return;
}
- int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+ int res = (evt.getX() / av.getCharWidth())
+ + av.getRanges().getStartRes();
- res = av.getColumnSelection().adjustForHiddenColumns(res);
+ reveal = av.getAlignment().getHiddenColumns()
+ .getRegionWithEdgeAtRes(res);
- reveal = null;
- for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
- {
- int[] region = (int[]) av.getColumnSelection().getHiddenColumns().
- elementAt(i);
- if (res + 1 == region[0] || res - 1 == region[1])
- {
- reveal = region;
- ToolTipManager.sharedInstance().registerComponent(this);
- this.setToolTipText("Reveal Hidden Columns with Right Mouse Button");
- break;
- }
- else
- {
- this.setToolTipText(null);
- }
-
- }
+ res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(res);
+ ToolTipManager.sharedInstance().registerComponent(this);
+ this.setToolTipText(
+ MessageManager.getString("label.reveal_hidden_columns"));
repaint();
}
- int[] reveal;
-
/**
* DOCUMENT ME!
- *
- * @param g DOCUMENT ME!
+ *
+ * @param g
+ * DOCUMENT ME!
*/
+ @Override
public void paintComponent(Graphics g)
{
- drawScale(g, av.getStartRes(), av.getEndRes(), getWidth(), getHeight());
+ /*
+ * shouldn't get called in wrapped mode as the scale above is
+ * drawn instead by SeqCanvas.drawNorthScale
+ */
+ if (!av.getWrapAlignment())
+ {
+ drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
+ getWidth(), getHeight());
+ }
}
// scalewidth will normally be screenwidth,
public void drawScale(Graphics g, int startx, int endx, int width,
- int height)
+ int height)
{
Graphics2D gg = (Graphics2D) g;
gg.setFont(av.getFont());
if (av.antiAlias)
{
gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
- RenderingHints.VALUE_ANTIALIAS_ON);
+ RenderingHints.VALUE_ANTIALIAS_ON);
}
- //Fill in the background
+ // Fill in the background
gg.setColor(Color.white);
gg.fillRect(0, 0, width, height);
gg.setColor(Color.black);
- //Fill the selected columns
+ // Fill the selected columns
ColumnSelection cs = av.getColumnSelection();
- gg.setColor(new Color(220, 0, 0));
+ HiddenColumns hidden = av.getAlignment().getHiddenColumns();
+ int avCharWidth = av.getCharWidth();
+ int avCharHeight = av.getCharHeight();
- for (int i = 0; i < cs.size(); i++)
+ if (cs != null)
{
- int sel = cs.columnAt(i);
- if (av.hasHiddenColumns)
- {
- sel = av.getColumnSelection().findColumnPosition(sel);
- }
+ gg.setColor(new Color(220, 0, 0));
- if ( (sel >= startx) && (sel <= endx))
+ for (int sel : cs.getSelected())
{
- gg.fillRect( (sel - startx) * av.charWidth, 0, av.charWidth,
- getHeight());
- }
- }
-
- // Draw the scale numbers
- gg.setColor(Color.black);
+ // TODO: JAL-2001 - provide a fast method to list visible selected in a
+ // given range
- int scalestartx = (startx / 10) * 10;
-
- FontMetrics fm = gg.getFontMetrics(av.getFont());
- int y = av.charHeight - fm.getDescent();
-
- if ( (scalestartx % 10) == 0)
- {
- scalestartx += 5;
- }
-
- String string;
- int maxX = 0;
-
- for (int i = scalestartx; i < endx; i += 5)
- {
- if ( (i % 10) == 0)
- {
- string = String.valueOf(av.getColumnSelection().adjustForHiddenColumns(
- i));
- if ( (i - startx - 1) * av.charWidth > maxX)
+ if (av.hasHiddenColumns())
{
- gg.drawString(string,
- (i - startx - 1) * av.charWidth, y);
- maxX = (i - startx + 1) * av.charWidth + fm.stringWidth(string);
+ if (hidden.isVisible(sel))
+ {
+ sel = hidden.findColumnPosition(sel);
+ }
+ else
+ {
+ continue;
+ }
}
- gg.drawLine( (int) ( ( (i - startx - 1) * av.charWidth) +
- (av.charWidth / 2)), y + 2,
- (int) ( ( (i - startx - 1) * av.charWidth) +
- (av.charWidth / 2)),
- y + (fm.getDescent() * 2));
-
- }
- else
- {
- gg.drawLine( (int) ( ( (i - startx - 1) * av.charWidth) +
- (av.charWidth / 2)), y + fm.getDescent(),
- (int) ( ( (i - startx - 1) * av.charWidth) +
- (av.charWidth / 2)), y + (fm.getDescent() * 2));
+ if ((sel >= startx) && (sel <= endx))
+ {
+ gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
+ getHeight());
+ }
}
}
- if (av.hasHiddenColumns)
+ int widthx = 1 + endx - startx;
+
+ FontMetrics fm = gg.getFontMetrics(av.getFont());
+ int y = avCharHeight;
+ int yOf = fm.getDescent();
+ y -= yOf;
+ if (av.hasHiddenColumns())
{
+ // draw any hidden column markers
gg.setColor(Color.blue);
int res;
+
if (av.getShowHiddenMarkers())
{
- for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size();
- i++)
+ List<Integer> positions = hidden.findHiddenRegionPositions();
+ for (int pos : positions)
{
+ res = pos - startx;
- res = av.getColumnSelection().findHiddenRegionPosition(i) -
- startx;
-
- if (res < 0 || res > endx - scalestartx)
+ if (res < 0 || res > widthx)
{
continue;
}
- gg.fillPolygon(new int[]
- {res * av.charWidth - av.charHeight / 4,
- res * av.charWidth + av.charHeight / 4,
- res * av.charWidth},
- new int[]
- {
- y - av.charHeight / 2, y - av.charHeight / 2,
- y + 8
- }, 3);
-
+ gg.fillPolygon(
+ new int[]
+ { -1 + res * avCharWidth - avCharHeight / 4,
+ -1 + res * avCharWidth + avCharHeight / 4,
+ -1 + res * avCharWidth },
+ new int[]
+ { y, y, y + 2 * yOf }, 3);
}
}
+ }
+ // Draw the scale numbers
+ gg.setColor(Color.black);
+
+ int maxX = 0;
+ List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
+ endx);
- if (reveal != null && reveal[0] > startx && reveal[0] < endx)
+ for (ScaleMark mark : marks)
+ {
+ boolean major = mark.major;
+ int mpos = mark.column; // (i - startx - 1)
+ String mstring = mark.text;
+ if (mstring != null)
+ {
+ if (mpos * avCharWidth > maxX)
+ {
+ gg.drawString(mstring, mpos * avCharWidth, y);
+ maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
+ }
+ }
+ if (major)
+ {
+ gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
+ (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
+ }
+ else
{
- gg.drawString("Reveal Columns", reveal[0] * av.charWidth, 0);
+ gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
+ (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
}
}
+ }
+ @Override
+ public void propertyChange(PropertyChangeEvent evt)
+ {
+ // Respond to viewport change events (e.g. alignment panel was scrolled)
+ // 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 (evt.getPropertyName().equals(ViewportRanges.STARTRES))
+ {
+ // scroll event, repaint panel
+ repaint();
+ }
}
+
}
git://source.jalview.org / jalview.git / blobdiff