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