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