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