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