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.renderer.ScaleRenderer;
27 import jalview.renderer.ScaleRenderer.ScaleMark;
28 import jalview.util.MessageManager;
29 import jalview.util.Platform;
30 import jalview.viewmodel.ViewportListenerI;
31 import jalview.viewmodel.ViewportRanges;
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.Iterator;
45 import java.util.List;
47 import javax.swing.JMenuItem;
48 import javax.swing.JPanel;
49 import javax.swing.JPopupMenu;
50 import javax.swing.SwingUtilities;
51 import javax.swing.ToolTipManager;
54 * The panel containing the sequence ruler (when not in wrapped mode), and
55 * supports a range of mouse operations to select, hide or reveal columns.
57 public class ScalePanel extends JPanel
58 implements MouseMotionListener, MouseListener, ViewportListenerI
60 protected int offy = 4;
64 protected AlignViewport av;
68 boolean stretchingGroup = false;
71 * min, max hold the extent of a mouse drag action
77 boolean mouseDragging = false;
80 * holds a hidden column range when the mouse is over an adjacent column
90 public ScalePanel(AlignViewport av, AlignmentPanel ap)
95 addMouseListener(this);
96 addMouseMotionListener(this);
98 av.getRanges().addPropertyChangeListener(this);
108 public void mousePressed(MouseEvent evt)
110 int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
113 if (av.hasHiddenColumns())
115 x = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(x);
118 if (x >= av.getAlignment().getWidth())
120 res = av.getAlignment().getWidth() - 1;
130 if (evt.isPopupTrigger()) // Mac: mousePressed
132 rightMouseButtonPressed(evt, res);
134 else if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
137 * defer right-mouse click handling to mouse up on Windows
138 * (where isPopupTrigger() will answer true)
139 * but accept Cmd-click on Mac which passes isRightMouseButton
145 leftMouseButtonPressed(evt, res);
150 * Handles right mouse button press. If pressed in a selected column, opens
151 * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
152 * opens context menu for 'Reveal / Reveal All'. Else does nothing.
157 protected void rightMouseButtonPressed(MouseEvent evt, final int res)
159 JPopupMenu pop = new JPopupMenu();
162 JMenuItem item = new JMenuItem(
163 MessageManager.getString("label.reveal"));
164 item.addActionListener(new ActionListener()
167 public void actionPerformed(ActionEvent e)
169 av.showColumn(reveal[0]);
171 ap.paintAlignment(true, true);
177 if (av.getAlignment().getHiddenColumns().hasMultiHiddenColumnRegions())
179 item = new JMenuItem(MessageManager.getString("action.reveal_all"));
180 item.addActionListener(new ActionListener()
183 public void actionPerformed(ActionEvent e)
185 av.showAllHiddenColumns();
187 ap.paintAlignment(true, true);
193 pop.show(this, evt.getX(), evt.getY());
195 else if (av.getColumnSelection().contains(res))
197 JMenuItem item = new JMenuItem(
198 MessageManager.getString("label.hide_columns"));
199 item.addActionListener(new ActionListener()
202 public void actionPerformed(ActionEvent e)
204 av.hideColumns(res, res);
205 if (av.getSelectionGroup() != null && av.getSelectionGroup()
206 .getSize() == av.getAlignment().getHeight())
208 av.setSelectionGroup(null);
211 ap.paintAlignment(true, true);
216 pop.show(this, evt.getX(), evt.getY());
221 * Handles left mouse button press
226 protected void leftMouseButtonPressed(MouseEvent evt, final int res)
229 * Ctrl-click/Cmd-click adds to the selection
230 * Shift-click extends the selection
232 // TODO Problem: right-click on Windows not reported until mouseReleased?!?
233 if (!Platform.isControlDown(evt) && !evt.isShiftDown())
235 av.getColumnSelection().clear();
238 av.getColumnSelection().addElement(res);
239 SequenceGroup sg = new SequenceGroup(av.getAlignment().getSequences());
243 if (evt.isShiftDown())
245 int min = Math.min(av.getColumnSelection().getMin(), res);
246 int max = Math.max(av.getColumnSelection().getMax(), res);
247 for (int i = min; i < max; i++)
249 av.getColumnSelection().addElement(i);
254 av.setSelectionGroup(sg);
255 ap.paintAlignment(false, false);
266 public void mouseReleased(MouseEvent evt)
268 mouseDragging = false;
270 int xCords = Math.max(0, evt.getX()); // prevent negative X coordinates
272 int res = (xCords / av.getCharWidth())
273 + av.getRanges().getStartRes();
275 if (av.hasHiddenColumns())
277 res = av.getAlignment().getHiddenColumns()
278 .visibleToAbsoluteColumn(res);
281 if (res >= av.getAlignment().getWidth())
283 res = av.getAlignment().getWidth() - 1;
286 if (!stretchingGroup)
288 if (evt.isPopupTrigger()) // Windows: mouseReleased
290 rightMouseButtonPressed(evt, res);
294 ap.paintAlignment(false, false);
299 SequenceGroup sg = av.getSelectionGroup();
303 if (res > sg.getStartRes())
307 else if (res < sg.getStartRes())
312 stretchingGroup = false;
313 ap.paintAlignment(false, false);
318 * Action on dragging the mouse in the scale panel is to expand or shrink the
319 * selection group range (including any hidden columns that it spans)
324 public void mouseDragged(MouseEvent evt)
326 mouseDragging = true;
327 ColumnSelection cs = av.getColumnSelection();
328 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
330 int res = (evt.getX() / av.getCharWidth())
331 + av.getRanges().getStartRes();
332 res = Math.max(0, res);
333 res = hidden.visibleToAbsoluteColumn(res);
334 res = Math.min(res, av.getAlignment().getWidth() - 1);
335 min = Math.min(res, min);
336 max = Math.max(res, max);
338 SequenceGroup sg = av.getSelectionGroup();
341 stretchingGroup = true;
342 cs.stretchGroup(res, sg, min, max);
343 ap.paintAlignment(false, false);
348 public void mouseEntered(MouseEvent evt)
352 ap.getSeqPanel().scrollCanvas(null);
357 public void mouseExited(MouseEvent evt)
361 ap.getSeqPanel().scrollCanvas(evt);
366 public void mouseClicked(MouseEvent evt)
371 * Creates a tooltip when the mouse is over a hidden columns marker
374 public void mouseMoved(MouseEvent evt)
376 this.setToolTipText(null);
378 if (!av.hasHiddenColumns())
383 int res = (evt.getX() / av.getCharWidth())
384 + av.getRanges().getStartRes();
386 reveal = av.getAlignment().getHiddenColumns()
387 .getRegionWithEdgeAtRes(res);
389 res = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(res);
391 ToolTipManager.sharedInstance().registerComponent(this);
393 MessageManager.getString("label.reveal_hidden_columns"));
404 public void paintComponent(Graphics g)
406 super.paintComponent(g);
409 * shouldn't get called in wrapped mode as the scale above is
410 * drawn instead by SeqCanvas.drawNorthScale
412 if (!av.getWrapAlignment())
414 drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
415 getWidth(), getHeight());
419 // scalewidth will normally be screenwidth,
420 public void drawScale(Graphics g, int startx, int endx, int width,
423 Graphics2D gg = (Graphics2D) g;
424 gg.setFont(av.getFont());
428 gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
429 RenderingHints.VALUE_ANTIALIAS_ON);
432 // Fill in the background
433 gg.setColor(Color.white);
434 gg.fillRect(0, 0, width, height);
435 gg.setColor(Color.black);
437 // Fill the selected columns
438 ColumnSelection cs = av.getColumnSelection();
439 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
440 int avCharWidth = av.getCharWidth();
441 int avCharHeight = av.getCharHeight();
445 gg.setColor(new Color(220, 0, 0));
447 for (int sel : cs.getSelected())
449 // TODO: JAL-2001 - provide a fast method to list visible selected in a
452 if (av.hasHiddenColumns())
454 if (hidden.isVisible(sel))
456 sel = hidden.absoluteToVisibleColumn(sel);
464 if ((sel >= startx) && (sel <= endx))
466 gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
472 int widthx = 1 + endx - startx;
474 FontMetrics fm = gg.getFontMetrics(av.getFont());
475 int y = avCharHeight;
476 int yOf = fm.getDescent();
478 if (av.hasHiddenColumns())
480 // draw any hidden column markers
481 gg.setColor(Color.blue);
484 if (av.getShowHiddenMarkers())
486 Iterator<Integer> it = hidden.getStartRegionIterator(startx,
487 startx + widthx + 1);
490 res = it.next() - startx;
494 { -1 + res * avCharWidth - avCharHeight / 4,
495 -1 + res * avCharWidth + avCharHeight / 4,
496 -1 + res * avCharWidth }, new int[]
497 { y, y, y + 2 * yOf }, 3);
501 // Draw the scale numbers
502 gg.setColor(Color.black);
505 List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
508 for (ScaleMark mark : marks)
510 boolean major = mark.major;
511 int mpos = mark.column; // (i - startx - 1)
512 String mstring = mark.text;
515 if (mpos * avCharWidth > maxX)
517 gg.drawString(mstring, mpos * avCharWidth, y);
518 maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
523 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
524 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
528 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
529 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
535 public void propertyChange(PropertyChangeEvent evt)
537 // Respond to viewport change events (e.g. alignment panel was scrolled)
538 // Both scrolling and resizing change viewport ranges: scrolling changes
539 // both start and end points, but resize only changes end values.
540 // Here we only want to fastpaint on a scroll, with resize using a normal
541 // paint, so scroll events are identified as changes to the horizontal or
542 // vertical start value.
543 if (evt.getPropertyName().equals(ViewportRanges.STARTRES)
544 || evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ)
545 || evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
547 // scroll event, repaint panel
549 // Call repaint on alignment panel so that repaints from other alignment
550 // panel components can be aggregated. Otherwise performance of the overview
551 // window and others may be adversely affected.
552 av.getAlignPanel().repaint();