src/jalview/gui/ScalePanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.gui;
  22
  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;
  32
  33 import java.awt.Color;
  34 import java.awt.FontMetrics;
  35 import java.awt.Graphics;
  36 import java.awt.Graphics2D;
  37 import java.awt.Point;
  38 import java.awt.RenderingHints;
  39 import java.awt.event.ActionEvent;
  40 import java.awt.event.ActionListener;
  41 import java.awt.event.MouseEvent;
  42 import java.awt.event.MouseListener;
  43 import java.awt.event.MouseMotionListener;
  44 import java.beans.PropertyChangeEvent;
  45 import java.util.Iterator;
  46 import java.util.List;
  47
  48 import javax.swing.JMenuItem;
  49 import javax.swing.JPanel;
  50 import javax.swing.JPopupMenu;
  51 import javax.swing.SwingUtilities;
  52 import javax.swing.ToolTipManager;
  53
  54 /**
  55  * The panel containing the sequence ruler (when not in wrapped mode), and
  56  * supports a range of mouse operations to select, hide or reveal columns.
  57  */
  58 public class ScalePanel extends JPanel
  59         implements MouseMotionListener, MouseListener, ViewportListenerI
  60 {
  61   protected int offy = 4;
  62
  63   public int width;
  64
  65   protected AlignViewport av;
  66
  67   AlignmentPanel ap;
  68
  69   boolean stretchingGroup = false;
  70
  71   /*
  72    * min, max hold the extent of a mouse drag action
  73    */
  74   int min;
  75
  76   int max;
  77
  78   boolean mouseDragging = false;
  79
  80   /*
  81    * holds a hidden column range when the mouse is over an adjacent column
  82    */
  83   int[] reveal;
  84
  85   /**
  86    * Constructor
  87    *
  88    * @param av
  89    * @param ap
  90    */
  91   public ScalePanel(AlignViewport av, AlignmentPanel ap)
  92   {
  93     this.av = av;
  94     this.ap = ap;
  95
  96     addMouseListener(this);
  97     addMouseMotionListener(this);
  98
  99     av.getRanges().addPropertyChangeListener(this);
 100   }
 101
 102   /**
 103    * DOCUMENT ME!
 104    *
 105    * @param evt
 106    *          DOCUMENT ME!
 107    */
 108   @Override
 109   public void mousePressed(MouseEvent evt)
 110   {
 111     int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
 112     final int res;
 113
 114     if (av.hasHiddenColumns())
 115     {
 116       x = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(x);
 117     }
 118
 119     if (x >= av.getAlignment().getWidth())
 120     {
 121       res = av.getAlignment().getWidth() - 1;
 122     }
 123     else
 124     {
 125       res = x;
 126     }
 127
 128     min = res;
 129     max = res;
 130
 131     if (evt.isPopupTrigger()) // Mac: mousePressed
 132     {
 133       rightMouseButtonPressed(evt, res);
 134     }
 135     else if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
 136     {
 137       /*
 138        * defer right-mouse click handling to mouse up on Windows
 139        * (where isPopupTrigger() will answer true)
 140        * but accept Cmd-click on Mac which passes isRightMouseButton
 141        */
 142       return;
 143     }
 144     else
 145     {
 146       leftMouseButtonPressed(evt, res);
 147     }
 148   }
 149
 150   /**
 151    * Handles right mouse button press. If pressed in a selected column, opens
 152    * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
 153    * opens context menu for 'Reveal / Reveal All'. Else does nothing.
 154    *
 155    * @param evt
 156    * @param res
 157    */
 158   protected void rightMouseButtonPressed(MouseEvent evt, final int res)
 159   {
 160     JPopupMenu pop = new JPopupMenu();
 161
 162     /*
 163      * grab the hidden range in case mouseMoved nulls it
 164      */
 165     final int[] hiddenRange = reveal;
 166     if (hiddenRange != null)
 167     {
 168       JMenuItem item = new JMenuItem(
 169               MessageManager.getString("label.reveal"));
 170       item.addActionListener(new ActionListener()
 171       {
 172         @Override
 173         public void actionPerformed(ActionEvent e)
 174         {
 175           av.showColumn(hiddenRange[0]);
 176           reveal = null;
 177           ap.updateLayout();
 178           ap.paintAlignment(true, true);
 179           av.sendSelection();
 180         }
 181       });
 182       pop.add(item);
 183
 184       if (av.getAlignment().getHiddenColumns().hasMultiHiddenColumnRegions())
 185       {
 186         item = new JMenuItem(MessageManager.getString("action.reveal_all"));
 187         item.addActionListener(new ActionListener()
 188         {
 189           @Override
 190           public void actionPerformed(ActionEvent e)
 191           {
 192             av.showAllHiddenColumns();
 193             reveal = null;
 194             ap.updateLayout();
 195             ap.paintAlignment(true, true);
 196             av.sendSelection();
 197           }
 198         });
 199         pop.add(item);
 200       }
 201       pop.show(this, evt.getX(), evt.getY());
 202     }
 203     else if (av.getColumnSelection().contains(res))
 204     {
 205       JMenuItem item = new JMenuItem(
 206               MessageManager.getString("label.hide_columns"));
 207       item.addActionListener(new ActionListener()
 208       {
 209         @Override
 210         public void actionPerformed(ActionEvent e)
 211         {
 212           av.hideColumns(res, res);
 213           if (av.getSelectionGroup() != null && av.getSelectionGroup()
 214                   .getSize() == av.getAlignment().getHeight())
 215           {
 216             av.setSelectionGroup(null);
 217           }
 218
 219           ap.updateLayout();
 220           ap.paintAlignment(true, true);
 221           av.sendSelection();
 222         }
 223       });
 224       pop.add(item);
 225       pop.show(this, evt.getX(), evt.getY());
 226     }
 227   }
 228
 229   /**
 230    * Handles left mouse button press
 231    *
 232    * @param evt
 233    * @param res
 234    */
 235   protected void leftMouseButtonPressed(MouseEvent evt, final int res)
 236   {
 237     /*
 238      * Ctrl-click/Cmd-click adds to the selection
 239      * Shift-click extends the selection
 240      */
 241     // TODO Problem: right-click on Windows not reported until mouseReleased?!?
 242     if (!Platform.isControlDown(evt) && !evt.isShiftDown())
 243     {
 244       av.getColumnSelection().clear();
 245     }
 246
 247     av.getColumnSelection().addElement(res);
 248     SequenceGroup sg = new SequenceGroup(av.getAlignment().getSequences());
 249     sg.setStartRes(res);
 250     sg.setEndRes(res);
 251
 252     if (evt.isShiftDown())
 253     {
 254       int min = Math.min(av.getColumnSelection().getMin(), res);
 255       int max = Math.max(av.getColumnSelection().getMax(), res);
 256       for (int i = min; i < max; i++)
 257       {
 258         av.getColumnSelection().addElement(i);
 259       }
 260       sg.setStartRes(min);
 261       sg.setEndRes(max);
 262     }
 263     av.setSelectionGroup(sg);
 264     ap.paintAlignment(false, false);
 265     av.sendSelection();
 266   }
 267
 268   /**
 269    * Action on mouseUp is to set the limit of the current selection group (if
 270    * there is one) and broadcast the selection
 271    *
 272    * @param evt
 273    */
 274   @Override
 275   public void mouseReleased(MouseEvent evt)
 276   {
 277     boolean wasDragging = mouseDragging;
 278     mouseDragging = false;
 279     ap.getSeqPanel().stopScrolling();
 280
 281     int xCords = Math.max(0, evt.getX()); // prevent negative X coordinates
 282     int res = (xCords / av.getCharWidth())
 283             + av.getRanges().getStartRes();
 284     if (av.hasHiddenColumns())
 285     {
 286       res = av.getAlignment().getHiddenColumns()
 287               .visibleToAbsoluteColumn(res);
 288     }
 289     res = Math.min(res, av.getRanges().getEndRes());
 290     res = Math.max(0, res);
 291
 292     if (!stretchingGroup)
 293     {
 294       if (evt.isPopupTrigger()) // Windows: mouseReleased
 295       {
 296         rightMouseButtonPressed(evt, res);
 297       }
 298       else
 299       {
 300         ap.paintAlignment(false, false);
 301       }
 302       return;
 303     }
 304
 305     SequenceGroup sg = av.getSelectionGroup();
 306
 307     if (sg != null)
 308     {
 309       if (res > sg.getStartRes())
 310       {
 311         sg.setEndRes(res);
 312       }
 313       else if (res < sg.getStartRes())
 314       {
 315         sg.setStartRes(res);
 316       }
 317       if (wasDragging)
 318       {
 319         min = Math.min(res, min);
 320         max = Math.max(res, max);
 321         av.getColumnSelection().stretchGroup(res, sg, min, max);
 322       }
 323     }
 324     stretchingGroup = false;
 325     ap.paintAlignment(false, false);
 326     av.isSelectionGroupChanged(true);
 327     av.isColSelChanged(true);
 328     av.sendSelection();
 329   }
 330
 331   /**
 332    * Action on dragging the mouse in the scale panel is to expand or shrink the
 333    * selection group range (including any hidden columns that it spans). Note
 334    * that the selection is only broadcast at the start of the drag (on
 335    * mousePressed) and at the end (on mouseReleased), to avoid overload
 336    * redrawing of other views.
 337    *
 338    * @param evt
 339    */
 340   @Override
 341   public void mouseDragged(MouseEvent evt)
 342   {
 343     mouseDragging = true;
 344     ColumnSelection cs = av.getColumnSelection();
 345     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 346
 347     int res = (evt.getX() / av.getCharWidth())
 348             + av.getRanges().getStartRes();
 349     res = Math.max(0, res);
 350     res = hidden.visibleToAbsoluteColumn(res);
 351     res = Math.min(res, av.getAlignment().getWidth() - 1);
 352     min = Math.min(res, min);
 353     max = Math.max(res, max);
 354
 355     SequenceGroup sg = av.getSelectionGroup();
 356     if (sg != null)
 357     {
 358       stretchingGroup = true;
 359       cs.stretchGroup(res, sg, min, max);
 360       ap.paintAlignment(false, false);
 361     }
 362   }
 363
 364   @Override
 365   public void mouseEntered(MouseEvent evt)
 366   {
 367     if (mouseDragging)
 368     {
 369       ap.getSeqPanel().stopScrolling();
 370     }
 371   }
 372
 373   /**
 374    * Action on leaving the panel bounds with mouse drag in progress is to start
 375    * scrolling the alignment in the direction of the mouse. To restrict
 376    * scrolling to left-right (not up-down), the y-value of the mouse position is
 377    * replaced with zero.
 378    */
 379   @Override
 380   public void mouseExited(MouseEvent evt)
 381   {
 382     if (mouseDragging)
 383     {
 384       ap.getSeqPanel().startScrolling(new Point(evt.getX(), 0));
 385     }
 386   }
 387
 388   @Override
 389   public void mouseClicked(MouseEvent evt)
 390   {
 391   }
 392
 393   /**
 394    * Creates a tooltip when the mouse is over a hidden columns marker
 395    */
 396   @Override
 397   public void mouseMoved(MouseEvent evt)
 398   {
 399     this.setToolTipText(null);
 400     reveal = null;
 401     if (!av.hasHiddenColumns())
 402     {
 403       return;
 404     }
 405
 406     int res = (evt.getX() / av.getCharWidth())
 407             + av.getRanges().getStartRes();
 408
 409     reveal = av.getAlignment().getHiddenColumns()
 410             .getRegionWithEdgeAtRes(res);
 411
 412     res = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(res);
 413
 414     ToolTipManager.sharedInstance().registerComponent(this);
 415     this.setToolTipText(
 416             MessageManager.getString("label.reveal_hidden_columns"));
 417     repaint();
 418   }
 419
 420   /**
 421    * DOCUMENT ME!
 422    *
 423    * @param g
 424    *          DOCUMENT ME!
 425    */
 426   @Override
 427   public void paintComponent(Graphics g)
 428   {
 429     super.paintComponent(g);
 430
 431     /*
 432      * shouldn't get called in wrapped mode as the scale above is
 433      * drawn instead by SeqCanvas.drawNorthScale
 434      */
 435     if (!av.getWrapAlignment())
 436     {
 437       drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
 438               getWidth(), getHeight());
 439     }
 440   }
 441
 442   // scalewidth will normally be screenwidth,
 443   public void drawScale(Graphics g, int startx, int endx, int width,
 444           int height)
 445   {
 446     Graphics2D gg = (Graphics2D) g;
 447     gg.setFont(av.getFont());
 448
 449     if (av.antiAlias)
 450     {
 451       gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 452               RenderingHints.VALUE_ANTIALIAS_ON);
 453     }
 454
 455     // Fill in the background
 456     gg.setColor(Color.white);
 457     gg.fillRect(0, 0, width, height);
 458     gg.setColor(Color.black);
 459
 460     // Fill the selected columns
 461     ColumnSelection cs = av.getColumnSelection();
 462     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 463     int avCharWidth = av.getCharWidth();
 464     int avCharHeight = av.getCharHeight();
 465
 466     if (cs != null)
 467     {
 468       gg.setColor(new Color(220, 0, 0));
 469
 470       for (int sel : cs.getSelected())
 471       {
 472         // TODO: JAL-2001 - provide a fast method to list visible selected in a
 473         // given range
 474
 475         if (av.hasHiddenColumns())
 476         {
 477           if (hidden.isVisible(sel))
 478           {
 479             sel = hidden.absoluteToVisibleColumn(sel);
 480           }
 481           else
 482           {
 483             continue;
 484           }
 485         }
 486
 487         if ((sel >= startx) && (sel <= endx))
 488         {
 489           gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
 490                   getHeight());
 491         }
 492       }
 493     }
 494
 495     int widthx = 1 + endx - startx;
 496
 497     FontMetrics fm = gg.getFontMetrics(av.getFont());
 498     int y = avCharHeight;
 499     int yOf = fm.getDescent();
 500     y -= yOf;
 501     if (av.hasHiddenColumns())
 502     {
 503       // draw any hidden column markers
 504       gg.setColor(Color.blue);
 505       int res;
 506
 507       if (av.getShowHiddenMarkers())
 508       {
 509         Iterator<Integer> it = hidden.getStartRegionIterator(startx,
 510                 startx + widthx + 1);
 511         while (it.hasNext())
 512         {
 513           res = it.next() - startx;
 514
 515           gg.fillPolygon(
 516                   new int[]
 517           { -1 + res * avCharWidth - avCharHeight / 4,
 518               -1 + res * avCharWidth + avCharHeight / 4,
 519               -1 + res * avCharWidth }, new int[]
 520           { y, y, y + 2 * yOf }, 3);
 521         }
 522       }
 523     }
 524     // Draw the scale numbers
 525     gg.setColor(Color.black);
 526
 527     int maxX = 0;
 528     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
 529             endx);
 530
 531     for (ScaleMark mark : marks)
 532     {
 533       boolean major = mark.major;
 534       int mpos = mark.column; // (i - startx - 1)
 535       String mstring = mark.text;
 536       if (mstring != null)
 537       {
 538         if (mpos * avCharWidth > maxX)
 539         {
 540           gg.drawString(mstring, mpos * avCharWidth, y);
 541           maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
 542         }
 543       }
 544       if (major)
 545       {
 546         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
 547                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 548       }
 549       else
 550       {
 551         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
 552                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 553       }
 554     }
 555   }
 556
 557   @Override
 558   public void propertyChange(PropertyChangeEvent evt)
 559   {
 560     // Respond to viewport change events (e.g. alignment panel was scrolled)
 561     // Both scrolling and resizing change viewport ranges: scrolling changes
 562     // both start and end points, but resize only changes end values.
 563     // Here we only want to fastpaint on a scroll, with resize using a normal
 564     // paint, so scroll events are identified as changes to the horizontal or
 565     // vertical start value.
 566     if (evt.getPropertyName().equals(ViewportRanges.STARTRES)
 567             || evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ)
 568             || evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
 569     {
 570       // scroll event, repaint panel
 571
 572         // Call repaint on alignment panel so that repaints from other alignment
 573     // panel components can be aggregated. Otherwise performance of the overview
 574     // window and others may be adversely affected.
 575       av.getAlignPanel().repaint();
 576     }
 577   }
 578
 579 }