2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import jalview.datamodel.ColumnSelection;
24 import jalview.datamodel.HiddenColumns;
25 import jalview.datamodel.SequenceGroup;
26 import jalview.datamodel.SequenceI;
27 import jalview.renderer.ScaleRenderer;
28 import jalview.renderer.ScaleRenderer.ScaleMark;
29 import jalview.util.MessageManager;
30 import jalview.util.Platform;
31 import jalview.viewmodel.ViewportListenerI;
33 import java.awt.Color;
34 import java.awt.FontMetrics;
35 import java.awt.Graphics;
36 import java.awt.Graphics2D;
37 import java.awt.RenderingHints;
38 import java.awt.event.ActionEvent;
39 import java.awt.event.ActionListener;
40 import java.awt.event.MouseEvent;
41 import java.awt.event.MouseListener;
42 import java.awt.event.MouseMotionListener;
43 import java.beans.PropertyChangeEvent;
44 import java.util.List;
46 import javax.swing.JMenuItem;
47 import javax.swing.JPanel;
48 import javax.swing.JPopupMenu;
49 import javax.swing.SwingUtilities;
50 import javax.swing.ToolTipManager;
53 * The panel containing the sequence ruler (when not in wrapped mode), and
54 * supports a range of mouse operations to select, hide or reveal columns.
56 public class ScalePanel extends JPanel implements MouseMotionListener,
57 MouseListener, ViewportListenerI
59 protected int offy = 4;
63 protected AlignViewport av;
67 boolean stretchingGroup = false;
70 * min, max hold the extent of a mouse drag action
76 boolean mouseDragging = false;
79 * holds a hidden column range when the mouse is over an adjacent column
89 public ScalePanel(AlignViewport av, AlignmentPanel ap)
94 addMouseListener(this);
95 addMouseMotionListener(this);
97 av.getRanges().addPropertyChangeListener(this);
107 public void mousePressed(MouseEvent evt)
109 int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
112 if (av.hasHiddenColumns())
114 x = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(x);
117 if (x >= av.getAlignment().getWidth())
119 res = av.getAlignment().getWidth() - 1;
129 if (evt.isPopupTrigger()) // Mac: mousePressed
131 rightMouseButtonPressed(evt, res);
133 else if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
136 * defer right-mouse click handling to mouse up on Windows
137 * (where isPopupTrigger() will answer true)
138 * but accept Cmd-click on Mac which passes isRightMouseButton
144 leftMouseButtonPressed(evt, res);
149 * Handles right mouse button press. If pressed in a selected column, opens
150 * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
151 * opens context menu for 'Reveal / Reveal All'. Else does nothing.
156 protected void rightMouseButtonPressed(MouseEvent evt, final int res)
158 JPopupMenu pop = new JPopupMenu();
161 JMenuItem item = new JMenuItem(
162 MessageManager.getString("label.reveal"));
163 item.addActionListener(new ActionListener()
166 public void actionPerformed(ActionEvent e)
168 av.showColumn(reveal[0]);
170 ap.paintAlignment(true);
171 if (ap.overviewPanel != null)
173 ap.overviewPanel.updateOverviewImage();
180 if (av.getAlignment().getHiddenColumns().hasHiddenColumns())
182 item = new JMenuItem(MessageManager.getString("action.reveal_all"));
183 item.addActionListener(new ActionListener()
186 public void actionPerformed(ActionEvent e)
188 av.showAllHiddenColumns();
190 ap.paintAlignment(true);
191 if (ap.overviewPanel != null)
193 ap.overviewPanel.updateOverviewImage();
200 pop.show(this, evt.getX(), evt.getY());
202 else if (av.getColumnSelection().contains(res))
204 JMenuItem item = new JMenuItem(
205 MessageManager.getString("label.hide_columns"));
206 item.addActionListener(new ActionListener()
209 public void actionPerformed(ActionEvent e)
211 av.hideColumns(res, res);
212 if (av.getSelectionGroup() != null
213 && av.getSelectionGroup().getSize() == av.getAlignment()
216 av.setSelectionGroup(null);
219 ap.paintAlignment(true);
220 if (ap.overviewPanel != null)
222 ap.overviewPanel.updateOverviewImage();
228 pop.show(this, evt.getX(), evt.getY());
233 * Handles left mouse button press
238 protected void leftMouseButtonPressed(MouseEvent evt, final int res)
241 * Ctrl-click/Cmd-click adds to the selection
242 * Shift-click extends the selection
244 // TODO Problem: right-click on Windows not reported until mouseReleased?!?
245 if (!Platform.isControlDown(evt) && !evt.isShiftDown())
247 av.getColumnSelection().clear();
250 av.getColumnSelection().addElement(res);
251 SequenceGroup sg = new SequenceGroup();
252 // try to be as quick as possible
253 SequenceI[] iVec = av.getAlignment().getSequencesArray();
254 for (int i = 0; i < iVec.length; i++)
256 sg.addSequence(iVec[i], false);
263 if (evt.isShiftDown())
265 int min = Math.min(av.getColumnSelection().getMin(), res);
266 int max = Math.max(av.getColumnSelection().getMax(), res);
267 for (int i = min; i < max; i++)
269 av.getColumnSelection().addElement(i);
274 av.setSelectionGroup(sg);
275 ap.paintAlignment(false);
286 public void mouseReleased(MouseEvent evt)
288 mouseDragging = false;
290 int res = (evt.getX() / av.getCharWidth())
291 + av.getRanges().getStartRes();
293 if (av.hasHiddenColumns())
295 res = av.getAlignment().getHiddenColumns()
296 .adjustForHiddenColumns(res);
299 if (res >= av.getAlignment().getWidth())
301 res = av.getAlignment().getWidth() - 1;
304 if (!stretchingGroup)
306 if (evt.isPopupTrigger()) // Windows: mouseReleased
308 rightMouseButtonPressed(evt, res);
312 ap.paintAlignment(false);
317 SequenceGroup sg = av.getSelectionGroup();
321 if (res > sg.getStartRes())
325 else if (res < sg.getStartRes())
330 stretchingGroup = false;
331 ap.paintAlignment(false);
336 * Action on dragging the mouse in the scale panel is to expand or shrink the
337 * selection group range (including any hidden columns that it spans)
342 public void mouseDragged(MouseEvent evt)
344 mouseDragging = true;
345 ColumnSelection cs = av.getColumnSelection();
346 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
348 int res = (evt.getX() / av.getCharWidth())
349 + av.getRanges().getStartRes();
350 res = Math.max(0, res);
351 res = hidden.adjustForHiddenColumns(res);
352 res = Math.min(res, av.getAlignment().getWidth() - 1);
353 min = Math.min(res, min);
354 max = Math.max(res, max);
356 SequenceGroup sg = av.getSelectionGroup();
359 stretchingGroup = true;
360 cs.stretchGroup(res, sg, min, max);
361 ap.paintAlignment(false);
366 public void mouseEntered(MouseEvent evt)
370 ap.getSeqPanel().scrollCanvas(null);
375 public void mouseExited(MouseEvent evt)
379 ap.getSeqPanel().scrollCanvas(evt);
384 public void mouseClicked(MouseEvent evt)
389 * Creates a tooltip when the mouse is over a hidden columns marker
392 public void mouseMoved(MouseEvent evt)
394 this.setToolTipText(null);
396 if (!av.hasHiddenColumns())
401 int res = (evt.getX() / av.getCharWidth())
402 + av.getRanges().getStartRes();
404 res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(res);
406 if (av.getAlignment().getHiddenColumns().getHiddenRegions() != null)
408 for (int[] region : av.getAlignment().getHiddenColumns()
411 if (res + 1 == region[0] || res - 1 == region[1])
414 ToolTipManager.sharedInstance().registerComponent(this);
415 this.setToolTipText(MessageManager
416 .getString("label.reveal_hidden_columns"));
431 public void paintComponent(Graphics g)
433 drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
434 getWidth(), getHeight());
437 // scalewidth will normally be screenwidth,
438 public void drawScale(Graphics g, int startx, int endx, int width,
441 Graphics2D gg = (Graphics2D) g;
442 gg.setFont(av.getFont());
446 gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
447 RenderingHints.VALUE_ANTIALIAS_ON);
450 // Fill in the background
451 gg.setColor(Color.white);
452 gg.fillRect(0, 0, width, height);
453 gg.setColor(Color.black);
455 // Fill the selected columns
456 ColumnSelection cs = av.getColumnSelection();
457 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
458 int avCharWidth = av.getCharWidth();
459 int avCharHeight = av.getCharHeight();
463 gg.setColor(new Color(220, 0, 0));
465 for (int sel : cs.getSelected())
467 // TODO: JAL-2001 - provide a fast method to list visible selected in a
470 if (av.hasHiddenColumns())
472 if (hidden.isVisible(sel))
474 sel = hidden.findColumnPosition(sel);
482 if ((sel >= startx) && (sel <= endx))
484 gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
490 int widthx = 1 + endx - startx;
492 FontMetrics fm = gg.getFontMetrics(av.getFont());
493 int y = avCharHeight;
494 int yOf = fm.getDescent();
496 if (av.hasHiddenColumns())
498 // draw any hidden column markers
499 gg.setColor(Color.blue);
502 if (av.getShowHiddenMarkers() && hidden.getHiddenRegions() != null)
504 for (int i = 0; i < hidden.getHiddenRegions()
507 res = hidden.findHiddenRegionPosition(i)
510 if (res < 0 || res > widthx)
515 gg.fillPolygon(new int[] {
516 -1 + res * avCharWidth - avCharHeight / 4,
517 -1 + res * avCharWidth + avCharHeight / 4,
518 -1 + res * avCharWidth }, new int[] { y, y, y + 2 * yOf }, 3);
522 // Draw the scale numbers
523 gg.setColor(Color.black);
526 List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
529 for (ScaleMark mark : marks)
531 boolean major = mark.major;
532 int mpos = mark.column; // (i - startx - 1)
533 String mstring = mark.text;
536 if (mpos * avCharWidth > maxX)
538 gg.drawString(mstring, mpos * avCharWidth, y);
539 maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
544 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
545 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
549 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
550 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
556 public void propertyChange(PropertyChangeEvent evt)
558 // Respond to viewport change events (e.g. alignment panel was scrolled)