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