src/jalview/appletgui/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.appletgui;
  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.viewmodel.ViewportListenerI;
  30 import jalview.viewmodel.ViewportRanges;
  31
  32 import java.awt.Color;
  33 import java.awt.FontMetrics;
  34 import java.awt.Graphics;
  35 import java.awt.MenuItem;
  36 import java.awt.Panel;
  37 import java.awt.PopupMenu;
  38 import java.awt.event.ActionEvent;
  39 import java.awt.event.ActionListener;
  40 import java.awt.event.InputEvent;
  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 public class ScalePanel extends Panel implements MouseMotionListener,
  48         MouseListener, ViewportListenerI
  49 {
  50
  51   protected int offy = 4;
  52
  53   public int width;
  54
  55   protected AlignViewport av;
  56
  57   AlignmentPanel ap;
  58
  59   boolean stretchingGroup = false;
  60
  61   int min; // used by mouseDragged to see if user
  62
  63   int max; // used by mouseDragged to see if user
  64
  65   boolean mouseDragging = false;
  66
  67   int[] reveal;
  68
  69   public ScalePanel(AlignViewport av, AlignmentPanel ap)
  70   {
  71     setLayout(null);
  72     this.av = av;
  73     this.ap = ap;
  74
  75     addMouseListener(this);
  76     addMouseMotionListener(this);
  77
  78     av.getRanges().addPropertyChangeListener(this);
  79   }
  80
  81   @Override
  82   public void mousePressed(MouseEvent evt)
  83   {
  84     int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
  85     final int res;
  86
  87     if (av.hasHiddenColumns())
  88     {
  89       res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(x);
  90     }
  91     else
  92     {
  93       res = x;
  94     }
  95
  96     min = res;
  97     max = res;
  98     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
  99     {
 100       rightMouseButtonPressed(evt, res);
 101     }
 102     else
 103     {
 104       leftMouseButtonPressed(evt, res);
 105     }
 106   }
 107
 108   /**
 109    * Handles left mouse button pressed (selection / clear selections)
 110    *
 111    * @param evt
 112    * @param res
 113    */
 114   protected void leftMouseButtonPressed(MouseEvent evt, final int res)
 115   {
 116     if (!evt.isControlDown() && !evt.isShiftDown())
 117     {
 118       av.getColumnSelection().clear();
 119     }
 120
 121     av.getColumnSelection().addElement(res);
 122     SequenceGroup sg = new SequenceGroup();
 123     for (int i = 0; i < av.getAlignment().getSequences().size(); i++)
 124     {
 125       sg.addSequence(av.getAlignment().getSequenceAt(i), false);
 126     }
 127
 128     sg.setStartRes(res);
 129     sg.setEndRes(res);
 130     av.setSelectionGroup(sg);
 131
 132     if (evt.isShiftDown())
 133     {
 134       int min = Math.min(av.getColumnSelection().getMin(), res);
 135       int max = Math.max(av.getColumnSelection().getMax(), res);
 136       for (int i = min; i < max; i++)
 137       {
 138         av.getColumnSelection().addElement(i);
 139       }
 140       sg.setStartRes(min);
 141       sg.setEndRes(max);
 142     }
 143     ap.paintAlignment(true);
 144     av.sendSelection();
 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     PopupMenu pop = new PopupMenu();
 158     if (reveal != null)
 159     {
 160       MenuItem item = new MenuItem(MessageManager.getString("label.reveal"));
 161       item.addActionListener(new ActionListener()
 162       {
 163         @Override
 164         public void actionPerformed(ActionEvent e)
 165         {
 166           av.showColumn(reveal[0]);
 167           reveal = null;
 168           ap.paintAlignment(true);
 169           if (ap.overviewPanel != null)
 170           {
 171             ap.overviewPanel.updateOverviewImage();
 172           }
 173           av.sendSelection();
 174         }
 175       });
 176       pop.add(item);
 177
 178       if (av.getAlignment().getHiddenColumns().hasManyHiddenColumns())
 179       {
 180         item = new MenuItem(MessageManager.getString("action.reveal_all"));
 181         item.addActionListener(new ActionListener()
 182         {
 183           @Override
 184           public void actionPerformed(ActionEvent e)
 185           {
 186             av.showAllHiddenColumns();
 187             reveal = null;
 188             ap.paintAlignment(true);
 189             if (ap.overviewPanel != null)
 190             {
 191               ap.overviewPanel.updateOverviewImage();
 192             }
 193             av.sendSelection();
 194           }
 195         });
 196         pop.add(item);
 197       }
 198       this.add(pop);
 199       pop.show(this, evt.getX(), evt.getY());
 200     }
 201     else if (av.getColumnSelection().contains(res))
 202     {
 203       MenuItem item = new MenuItem(
 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       this.add(pop);
 228       pop.show(this, evt.getX(), evt.getY());
 229     }
 230   }
 231
 232   @Override
 233   public void mouseReleased(MouseEvent evt)
 234   {
 235     mouseDragging = false;
 236
 237     int res = (evt.getX() / av.getCharWidth())
 238             + av.getRanges().getStartRes();
 239
 240     if (res > av.getAlignment().getWidth())
 241     {
 242       res = av.getAlignment().getWidth() - 1;
 243     }
 244
 245     if (av.hasHiddenColumns())
 246     {
 247       res = av.getAlignment().getHiddenColumns()
 248               .adjustForHiddenColumns(res);
 249     }
 250
 251     if (!stretchingGroup)
 252     {
 253       ap.paintAlignment(false);
 254
 255       return;
 256     }
 257
 258     SequenceGroup sg = av.getSelectionGroup();
 259
 260     if (res > sg.getStartRes())
 261     {
 262       sg.setEndRes(res);
 263     }
 264     else if (res < sg.getStartRes())
 265     {
 266       sg.setStartRes(res);
 267     }
 268
 269     stretchingGroup = false;
 270     ap.paintAlignment(false);
 271     av.sendSelection();
 272   }
 273
 274   /**
 275    * Action on dragging the mouse in the scale panel is to expand or shrink the
 276    * selection group range (including any hidden columns that it spans)
 277    *
 278    * @param evt
 279    */
 280   @Override
 281   public void mouseDragged(MouseEvent evt)
 282   {
 283     mouseDragging = true;
 284     ColumnSelection cs = av.getColumnSelection();
 285
 286     int res = (evt.getX() / av.getCharWidth())
 287             + av.getRanges().getStartRes();
 288     res = Math.max(0, res);
 289     res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(res);
 290     res = Math.min(res, av.getAlignment().getWidth() - 1);
 291     min = Math.min(res, min);
 292     max = Math.max(res, max);
 293
 294     SequenceGroup sg = av.getSelectionGroup();
 295     if (sg != null)
 296     {
 297       stretchingGroup = true;
 298       cs.stretchGroup(res, sg, min, max);
 299       ap.paintAlignment(false);
 300     }
 301   }
 302
 303   @Override
 304   public void mouseEntered(MouseEvent evt)
 305   {
 306     if (mouseDragging)
 307     {
 308       ap.seqPanel.scrollCanvas(null);
 309     }
 310   }
 311
 312   @Override
 313   public void mouseExited(MouseEvent evt)
 314   {
 315     if (mouseDragging)
 316     {
 317       ap.seqPanel.scrollCanvas(evt);
 318     }
 319   }
 320
 321   @Override
 322   public void mouseClicked(MouseEvent evt)
 323   {
 324
 325   }
 326
 327   @Override
 328   public void mouseMoved(MouseEvent evt)
 329   {
 330     if (!av.hasHiddenColumns())
 331     {
 332       return;
 333     }
 334
 335     int res = (evt.getX() / av.getCharWidth())
 336             + av.getRanges().getStartRes();
 337
 338     reveal = av.getAlignment().getHiddenColumns()
 339             .getRegionWithEdgeAtRes(res);
 340
 341     repaint();
 342   }
 343
 344   @Override
 345   public void update(Graphics g)
 346   {
 347     paint(g);
 348   }
 349
 350   @Override
 351   public void paint(Graphics g)
 352   {
 353     /*
 354      * shouldn't get called in wrapped mode as the scale above is
 355      * drawn instead by SeqCanvas.drawNorthScale
 356      */
 357     if (!av.getWrapAlignment())
 358     {
 359       drawScale(g, av.getRanges().getStartRes(),
 360               av.getRanges().getEndRes(), getSize().width, getSize().height);
 361     }
 362   }
 363
 364   // scalewidth will normally be screenwidth,
 365   public void drawScale(Graphics gg, int startx, int endx, int width,
 366           int height)
 367   {
 368     gg.setFont(av.getFont());
 369     // Fill in the background
 370     gg.setColor(Color.white);
 371     gg.fillRect(0, 0, width, height);
 372     gg.setColor(Color.black);
 373
 374     // Fill the selected columns
 375     ColumnSelection cs = av.getColumnSelection();
 376     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 377     int avCharWidth = av.getCharWidth();
 378     int avcharHeight = av.getCharHeight();
 379     if (cs != null)
 380     {
 381       gg.setColor(new Color(220, 0, 0));
 382       boolean hasHiddenColumns = hidden.hasHiddenColumns();
 383       for (int sel : cs.getSelected())
 384       {
 385         // TODO: JAL-2001 - provide a fast method to list visible selected in a
 386         // given range
 387         if (hasHiddenColumns)
 388         {
 389           if (hidden.isVisible(sel))
 390           {
 391             sel = hidden.findColumnPosition(sel);
 392           }
 393           else
 394           {
 395             continue;
 396           }
 397         }
 398
 399         if ((sel >= startx) && (sel <= endx))
 400         {
 401           gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
 402                   getSize().height);
 403         }
 404       }
 405     }
 406
 407     // Draw the scale numbers
 408     gg.setColor(Color.black);
 409
 410     int maxX = 0;
 411     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
 412             endx);
 413
 414     FontMetrics fm = gg.getFontMetrics(av.getFont());
 415     int y = avcharHeight;
 416     int yOf = fm.getDescent();
 417     y -= yOf;
 418     for (ScaleMark mark : marks)
 419     {
 420       boolean major = mark.major;
 421       int mpos = mark.column; // (i - startx - 1)
 422       String mstring = mark.text;
 423       if (mstring != null)
 424       {
 425         if (mpos * avCharWidth > maxX)
 426         {
 427           gg.drawString(mstring, mpos * avCharWidth, y);
 428           maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
 429         }
 430       }
 431       if (major)
 432       {
 433         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
 434                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 435       }
 436       else
 437       {
 438         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
 439                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 440       }
 441     }
 442
 443     if (av.hasHiddenColumns())
 444     {
 445       gg.setColor(Color.blue);
 446       int res;
 447       if (av.getShowHiddenMarkers())
 448       {
 449         int widthx = 1 + endx - startx;
 450         List<Integer> positions = hidden.findHiddenRegionPositions();
 451         for (int pos : positions)
 452         {
 453
 454           res = pos - startx;
 455
 456           if (res < 0 || res > widthx)
 457           {
 458             continue;
 459           }
 460
 461           gg.fillPolygon(new int[] {
 462               -1 + res * avCharWidth - avcharHeight / 4,
 463               -1 + res * avCharWidth + avcharHeight / 4,
 464               -1 + res * avCharWidth }, new int[] { y, y, y + 2 * yOf }, 3);
 465         }
 466       }
 467     }
 468   }
 469
 470   @Override
 471   public void propertyChange(PropertyChangeEvent evt)
 472   {
 473     // Respond to viewport change events (e.g. alignment panel was scrolled)
 474     // Both scrolling and resizing change viewport ranges: scrolling changes
 475     // both start and end points, but resize only changes end values.
 476     // Here we only want to fastpaint on a scroll, with resize using a normal
 477     // paint, so scroll events are identified as changes to the horizontal or
 478     // vertical start value.
 479     if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
 480     {
 481       // scroll event, repaint panel
 482       repaint();
 483     }
 484   }
 485
 486 }