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;
32 import jalview.viewmodel.ViewportRanges;
34 import java.awt.Color;
35 import java.awt.FontMetrics;
36 import java.awt.Graphics;
37 import java.awt.Graphics2D;
38 import java.awt.Point;
39 import java.awt.RenderingHints;
40 import java.awt.event.ActionEvent;
41 import java.awt.event.ActionListener;
42 import java.awt.event.MouseEvent;
43 import java.awt.event.MouseListener;
44 import java.awt.event.MouseMotionListener;
45 import java.beans.PropertyChangeEvent;
46 import java.util.Iterator;
47 import java.util.List;
49 import javax.swing.JMenuItem;
50 import javax.swing.JPanel;
51 import javax.swing.JPopupMenu;
52 import javax.swing.SwingUtilities;
53 import javax.swing.ToolTipManager;
56 * The panel containing the sequence ruler (when not in wrapped mode), and
57 * supports a range of mouse operations to select, hide or reveal columns.
59 public class ScalePanel extends JPanel
60 implements MouseMotionListener, MouseListener, ViewportListenerI
62 protected int offy = 4;
66 protected AlignViewport av;
70 boolean stretchingGroup = false;
73 * min, max hold the extent of a mouse drag action
79 boolean mouseDragging = false;
82 * holds a hidden column range when the mouse is over an adjacent column
92 public ScalePanel(AlignViewport av, AlignmentPanel ap)
97 addMouseListener(this);
98 addMouseMotionListener(this);
100 av.getRanges().addPropertyChangeListener(this);
110 public void mousePressed(MouseEvent evt)
112 int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
115 if (av.hasHiddenColumns())
117 x = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(x);
120 if (x >= av.getAlignment().getWidth())
122 res = av.getAlignment().getWidth() - 1;
132 if (evt.isPopupTrigger()) // Mac: mousePressed
134 rightMouseButtonPressed(evt, res);
137 if (Platform.isWinRightButton(evt))
140 * defer right-mouse click handling to mouse up on Windows
141 * (where isPopupTrigger() will answer true)
142 * but accept Cmd-click on Mac which passes isRightMouseButton
146 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();
240 // try to be as quick as possible
241 SequenceI[] iVec = av.getAlignment().getSequencesArray();
242 for (int i = 0; i < iVec.length; i++)
244 sg.addSequence(iVec[i], false);
251 if (evt.isShiftDown())
253 int min = Math.min(av.getColumnSelection().getMin(), res);
254 int max = Math.max(av.getColumnSelection().getMax(), res);
255 for (int i = min; i < max; i++)
257 av.getColumnSelection().addElement(i);
262 av.setSelectionGroup(sg);
263 ap.paintAlignment(false, false);
268 * Action on mouseUp is to set the limit of the current selection group (if
269 * there is one) and broadcast the selection
274 public void mouseReleased(MouseEvent evt)
276 mouseDragging = false;
277 ap.getSeqPanel().stopScrolling();
279 // todo res calculation should be a method on AlignViewport
280 int xCords = Math.max(0, evt.getX()); // prevent negative X coordinates
282 int res = (xCords / av.getCharWidth())
283 + av.getRanges().getStartRes();
285 if (av.hasHiddenColumns())
287 res = av.getAlignment().getHiddenColumns()
288 .visibleToAbsoluteColumn(res);
290 res = Math.min(res, av.getAlignment().getWidth() - 1);
292 if (!stretchingGroup)
294 if (evt.isPopupTrigger()) // Windows: mouseReleased
296 rightMouseButtonPressed(evt, res);
300 ap.paintAlignment(false, false);
305 SequenceGroup sg = av.getSelectionGroup();
309 if (res > sg.getStartRes())
313 else if (res < sg.getStartRes())
318 stretchingGroup = false;
319 ap.paintAlignment(false, false);
324 * Action on dragging the mouse in the scale panel is to expand or shrink the
325 * selection group range (including any hidden columns that it spans)
330 public void mouseDragged(MouseEvent evt)
332 mouseDragging = true;
333 ColumnSelection cs = av.getColumnSelection();
334 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
336 int res = (evt.getX() / av.getCharWidth())
337 + av.getRanges().getStartRes();
338 res = Math.max(0, res);
339 res = hidden.visibleToAbsoluteColumn(res);
340 res = Math.min(res, av.getAlignment().getWidth() - 1);
341 min = Math.min(res, min);
342 max = Math.max(res, max);
344 SequenceGroup sg = av.getSelectionGroup();
347 stretchingGroup = true;
348 cs.stretchGroup(res, sg, min, max);
349 ap.paintAlignment(false, false);
354 public void mouseEntered(MouseEvent evt)
358 mouseDragging = false;
359 ap.getSeqPanel().stopScrolling();
364 * Action on leaving the panel bounds with mouse drag in progress is to start
365 * scrolling the alignment in the direction of the mouse. To restrict
366 * scrolling to left-right (not up-down), the y-value of the mouse position is
367 * replaced with zero.
370 public void mouseExited(MouseEvent evt)
374 ap.getSeqPanel().startScrolling(new Point(evt.getX(), 0));
379 public void mouseClicked(MouseEvent evt)
384 * Creates a tooltip when the mouse is over a hidden columns marker
387 public void mouseMoved(MouseEvent evt)
389 this.setToolTipText(null);
391 if (!av.hasHiddenColumns())
396 int res = (evt.getX() / av.getCharWidth())
397 + av.getRanges().getStartRes();
399 reveal = av.getAlignment().getHiddenColumns()
400 .getRegionWithEdgeAtRes(res);
402 res = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(res);
404 ToolTipManager.sharedInstance().registerComponent(this);
406 MessageManager.getString("label.reveal_hidden_columns"));
417 public void paintComponent(Graphics g)
419 //super.paintComponent(g); // BH 2019
422 * shouldn't get called in wrapped mode as the scale above is
423 * drawn instead by SeqCanvas.drawNorthScale
425 if (!av.getWrapAlignment())
427 drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
428 getWidth(), getHeight());
432 // scalewidth will normally be screenwidth,
433 public void drawScale(Graphics g, int startx, int endx, int width,
436 Graphics2D gg = (Graphics2D) g;
437 gg.setFont(av.getFont());
441 gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
442 RenderingHints.VALUE_ANTIALIAS_ON);
445 // Fill in the background
446 gg.setColor(Color.white);
447 gg.fillRect(0, 0, width, height);
448 gg.setColor(Color.black);
450 // Fill the selected columns
451 ColumnSelection cs = av.getColumnSelection();
452 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
453 int avCharWidth = av.getCharWidth();
454 int avCharHeight = av.getCharHeight();
458 gg.setColor(new Color(220, 0, 0));
460 for (int sel : cs.getSelected())
462 // TODO: JAL-2001 - provide a fast method to list visible selected in a
465 if (av.hasHiddenColumns())
467 if (hidden.isVisible(sel))
469 sel = hidden.absoluteToVisibleColumn(sel);
477 if ((sel >= startx) && (sel <= endx))
479 gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
485 int widthx = 1 + endx - startx;
487 FontMetrics fm = gg.getFontMetrics(av.getFont());
488 int y = avCharHeight;
489 int yOf = fm.getDescent();
491 if (av.hasHiddenColumns())
493 // draw any hidden column markers
494 gg.setColor(Color.blue);
497 if (av.getShowHiddenMarkers())
499 Iterator<Integer> it = hidden.getStartRegionIterator(startx,
500 startx + widthx + 1);
503 res = it.next() - startx;
507 { -1 + res * avCharWidth - avCharHeight / 4,
508 -1 + res * avCharWidth + avCharHeight / 4,
509 -1 + res * avCharWidth }, new int[]
510 { y, y, y + 2 * yOf }, 3);
514 // Draw the scale numbers
515 gg.setColor(Color.black);
518 List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
521 for (ScaleMark mark : marks)
523 boolean major = mark.major;
524 int mpos = mark.column; // (i - startx - 1)
525 String mstring = mark.text;
528 if (mpos * avCharWidth > maxX)
530 gg.drawString(mstring, mpos * avCharWidth, y);
531 maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
536 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
537 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
541 gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
542 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
548 public void propertyChange(PropertyChangeEvent evt)
550 // Respond to viewport change events (e.g. alignment panel was scrolled)
551 // Both scrolling and resizing change viewport ranges: scrolling changes
552 // both start and end points, but resize only changes end values.
553 // Here we only want to fastpaint on a scroll, with resize using a normal
554 // paint, so scroll events are identified as changes to the horizontal or
555 // vertical start value.
556 if (evt.getPropertyName().equals(ViewportRanges.STARTRES)
557 || evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ)
558 || evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
560 // scroll event, repaint panel
562 // Call repaint on alignment panel so that repaints from other alignment
563 // panel components can be aggregated. Otherwise performance of the overview
564 // window and others may be adversely affected.
565 av.getAlignPanel().repaint();