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.ToolTipManager;
  52
  53 /**
  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.
  56  */
  57 public class ScalePanel extends JPanel
  58         implements MouseMotionListener, MouseListener, ViewportListenerI
  59 {
  60   protected int offy = 4;
  61
  62   public int width;
  63
  64   protected AlignViewport av;
  65
  66   AlignmentPanel ap;
  67
  68   boolean stretchingGroup = false;
  69
  70   /*
  71    * min, max hold the extent of a mouse drag action
  72    */
  73   int min;
  74
  75   int max;
  76
  77   boolean mouseDragging = false;
  78
  79   /*
  80    * holds a hidden column range when the mouse is over an adjacent column
  81    */
  82   int[] reveal;
  83
  84   /**
  85    * Constructor
  86    *
  87    * @param av
  88    * @param ap
  89    */
  90   public ScalePanel(AlignViewport av, AlignmentPanel ap)
  91   {
  92     this.av = av;
  93     this.ap = ap;
  94
  95     addMouseListener(this);
  96     addMouseMotionListener(this);
  97
  98     av.getRanges().addPropertyChangeListener(this);
  99   }
 100
 101   /**
 102    * DOCUMENT ME!
 103    *
 104    * @param evt
 105    *          DOCUMENT ME!
 106    */
 107   @Override
 108   public void mousePressed(MouseEvent evt)
 109   {
 110     int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
 111     final int res;
 112
 113     if (av.hasHiddenColumns())
 114     {
 115       x = av.getAlignment().getHiddenColumns().visibleToAbsoluteColumn(x);
 116     }
 117
 118     if (x >= av.getAlignment().getWidth())
 119     {
 120       res = av.getAlignment().getWidth() - 1;
 121     }
 122     else
 123     {
 124       res = x;
 125     }
 126
 127     min = res;
 128     max = res;
 129
 130     if (evt.isPopupTrigger()) // Mac: mousePressed
 131     {
 132       rightMouseButtonPressed(evt, res);
 133       return;
 134     }
 135     if (Platform.isWinRightButton(evt))
 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     leftMouseButtonPressed(evt, res);
 145   }
 146
 147   /**
 148    * Handles right mouse button press. If pressed in a selected column, opens
 149    * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
 150    * opens context menu for 'Reveal / Reveal All'. Else does nothing.
 151    *
 152    * @param evt
 153    * @param res
 154    */
 155   protected void rightMouseButtonPressed(MouseEvent evt, final int res)
 156   {
 157     JPopupMenu pop = new JPopupMenu();
 158
 159     /*
 160      * grab the hidden range in case mouseMoved nulls it
 161      */
 162     final int[] hiddenRange = reveal;
 163     if (hiddenRange != null)
 164     {
 165       JMenuItem item = new JMenuItem(
 166               MessageManager.getString("label.reveal"));
 167       item.addActionListener(new ActionListener()
 168       {
 169         @Override
 170         public void actionPerformed(ActionEvent e)
 171         {
 172           av.showColumn(hiddenRange[0]);
 173           reveal = null;
 174           ap.updateLayout();
 175           ap.paintAlignment(true, true);
 176           av.sendSelection();
 177         }
 178       });
 179       pop.add(item);
 180
 181       if (av.getAlignment().getHiddenColumns().hasMultiHiddenColumnRegions())
 182       {
 183         item = new JMenuItem(MessageManager.getString("action.reveal_all"));
 184         item.addActionListener(new ActionListener()
 185         {
 186           @Override
 187           public void actionPerformed(ActionEvent e)
 188           {
 189             av.showAllHiddenColumns();
 190             reveal = null;
 191             ap.updateLayout();
 192             ap.paintAlignment(true, true);
 193             av.sendSelection();
 194           }
 195         });
 196         pop.add(item);
 197       }
 198       pop.show(this, evt.getX(), evt.getY());
 199     }
 200     else if (av.getColumnSelection().contains(res))
 201     {
 202       JMenuItem item = new JMenuItem(
 203               MessageManager.getString("label.hide_columns"));
 204       item.addActionListener(new ActionListener()
 205       {
 206         @Override
 207         public void actionPerformed(ActionEvent e)
 208         {
 209           av.hideColumns(res, res);
 210           if (av.getSelectionGroup() != null && av.getSelectionGroup()
 211                   .getSize() == av.getAlignment().getHeight())
 212           {
 213             av.setSelectionGroup(null);
 214           }
 215
 216           ap.updateLayout();
 217           ap.paintAlignment(true, true);
 218           av.sendSelection();
 219         }
 220       });
 221       pop.add(item);
 222       pop.show(this, evt.getX(), evt.getY());
 223     }
 224   }
 225
 226   /**
 227    * Handles left mouse button press
 228    *
 229    * @param evt
 230    * @param res
 231    */
 232   protected void leftMouseButtonPressed(MouseEvent evt, final int res)
 233   {
 234     /*
 235      * Ctrl-click/Cmd-click adds to the selection
 236      * Shift-click extends the selection
 237      */
 238     // TODO Problem: right-click on Windows not reported until mouseReleased?!?
 239     if (!Platform.isControlDown(evt) && !evt.isShiftDown())
 240     {
 241       av.getColumnSelection().clear();
 242     }
 243
 244     av.getColumnSelection().addElement(res);
 245     SequenceGroup sg = new SequenceGroup(av.getAlignment().getSequences());
 246     sg.setStartRes(res);
 247     sg.setEndRes(res);
 248
 249     if (evt.isShiftDown())
 250     {
 251       int min = Math.min(av.getColumnSelection().getMin(), res);
 252       int max = Math.max(av.getColumnSelection().getMax(), res);
 253       for (int i = min; i < max; i++)
 254       {
 255         av.getColumnSelection().addElement(i);
 256       }
 257       sg.setStartRes(min);
 258       sg.setEndRes(max);
 259     }
 260     av.setSelectionGroup(sg);
 261     ap.paintAlignment(false, false);
 262     av.sendSelection();
 263   }
 264
 265   /**
 266    * Action on mouseUp is to set the limit of the current selection group (if
 267    * there is one) and broadcast the selection
 268    *
 269    * @param evt
 270    */
 271   @Override
 272   public void mouseReleased(MouseEvent evt)
 273   {
 274     boolean wasDragging = mouseDragging;
 275     mouseDragging = false;
 276     ap.getSeqPanel().stopScrolling();
 277
 278     // todo res calculation should be a method on AlignViewport
 279     int xCords = Math.max(0, evt.getX()); // prevent negative X coordinates
 280     ViewportRanges ranges = av.getRanges();
 281     int res = (xCords / av.getCharWidth())
 282             + ranges.getStartRes();
 283     res = Math.min(res, ranges.getEndRes());
 284     if (av.hasHiddenColumns())
 285     {
 286       res = av.getAlignment().getHiddenColumns()
 287               .visibleToAbsoluteColumn(res);
 288     }
 289     res = Math.max(0, res);
 290
 291     if (!stretchingGroup)
 292     {
 293       if (evt.isPopupTrigger()) // Windows: mouseReleased
 294       {
 295         rightMouseButtonPressed(evt, res);
 296       }
 297       else
 298       {
 299         ap.paintAlignment(false, false);
 300       }
 301       return;
 302     }
 303
 304     SequenceGroup sg = av.getSelectionGroup();
 305
 306     if (sg != null)
 307     {
 308       if (res > sg.getStartRes())
 309       {
 310         sg.setEndRes(res);
 311       }
 312       else if (res < sg.getStartRes())
 313       {
 314         sg.setStartRes(res);
 315       }
 316       if (wasDragging)
 317       {
 318         min = Math.min(res, min);
 319         max = Math.max(res, max);
 320         av.getColumnSelection().stretchGroup(res, sg, min, max);
 321       }
 322     }
 323     stretchingGroup = false;
 324     ap.paintAlignment(false, false);
 325     av.isSelectionGroupChanged(true);
 326     av.isColSelChanged(true);
 327     av.sendSelection();
 328   }
 329
 330   /**
 331    * Action on dragging the mouse in the scale panel is to expand or shrink the
 332    * selection group range (including any hidden columns that it spans). Note
 333    * that the selection is only broadcast at the start of the drag (on
 334    * mousePressed) and at the end (on mouseReleased), to avoid overload
 335    * redrawing of other views.
 336    *
 337    * @param evt
 338    */
 339   @Override
 340   public void mouseDragged(MouseEvent evt)
 341   {
 342     mouseDragging = true;
 343     ColumnSelection cs = av.getColumnSelection();
 344     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 345
 346     int res = (evt.getX() / av.getCharWidth())
 347             + av.getRanges().getStartRes();
 348     res = Math.max(0, res);
 349     res = hidden.visibleToAbsoluteColumn(res);
 350     res = Math.min(res, av.getAlignment().getWidth() - 1);
 351     min = Math.min(res, min);
 352     max = Math.max(res, max);
 353
 354     SequenceGroup sg = av.getSelectionGroup();
 355     if (sg != null)
 356     {
 357       stretchingGroup = true;
 358       cs.stretchGroup(res, sg, min, max);
 359       ap.paintAlignment(false, false);
 360     }
 361   }
 362
 363   @Override
 364   public void mouseEntered(MouseEvent evt)
 365   {
 366     if (mouseDragging)
 367     {
 368       mouseDragging = false;
 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);  // BH 2019
 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 }