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