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