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.getRanges().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())
 233             + av.getRanges().getStartRes();
 234
 235     if (res > av.getAlignment().getWidth())
 236     {
 237       res = av.getAlignment().getWidth() - 1;
 238     }
 239
 240     if (av.hasHiddenColumns())
 241     {
 242       res = av.getColumnSelection().adjustForHiddenColumns(res);
 243     }
 244
 245     if (!stretchingGroup)
 246     {
 247       ap.paintAlignment(false);
 248
 249       return;
 250     }
 251
 252     SequenceGroup sg = av.getSelectionGroup();
 253
 254     if (res > sg.getStartRes())
 255     {
 256       sg.setEndRes(res);
 257     }
 258     else if (res < sg.getStartRes())
 259     {
 260       sg.setStartRes(res);
 261     }
 262
 263     stretchingGroup = false;
 264     ap.paintAlignment(false);
 265     av.sendSelection();
 266   }
 267
 268   /**
 269    * Action on dragging the mouse in the scale panel is to expand or shrink the
 270    * selection group range (including any hidden columns that it spans)
 271    *
 272    * @param evt
 273    */
 274   @Override
 275   public void mouseDragged(MouseEvent evt)
 276   {
 277     mouseDragging = true;
 278     ColumnSelection cs = av.getColumnSelection();
 279
 280     int res = (evt.getX() / av.getCharWidth())
 281             + av.getRanges().getStartRes();
 282     res = Math.max(0, res);
 283     res = cs.adjustForHiddenColumns(res);
 284     res = Math.min(res, av.getAlignment().getWidth() - 1);
 285     min = Math.min(res, min);
 286     max = Math.max(res, max);
 287
 288     SequenceGroup sg = av.getSelectionGroup();
 289     if (sg != null)
 290     {
 291       stretchingGroup = true;
 292       cs.stretchGroup(res, sg, min, max);
 293       ap.paintAlignment(false);
 294     }
 295   }
 296
 297   @Override
 298   public void mouseEntered(MouseEvent evt)
 299   {
 300     if (mouseDragging)
 301     {
 302       ap.seqPanel.scrollCanvas(null);
 303     }
 304   }
 305
 306   @Override
 307   public void mouseExited(MouseEvent evt)
 308   {
 309     if (mouseDragging)
 310     {
 311       ap.seqPanel.scrollCanvas(evt);
 312     }
 313   }
 314
 315   @Override
 316   public void mouseClicked(MouseEvent evt)
 317   {
 318
 319   }
 320
 321   @Override
 322   public void mouseMoved(MouseEvent evt)
 323   {
 324     if (!av.hasHiddenColumns())
 325     {
 326       return;
 327     }
 328
 329     int res = (evt.getX() / av.getCharWidth())
 330             + av.getRanges().getStartRes();
 331
 332     res = av.getColumnSelection().adjustForHiddenColumns(res);
 333
 334     reveal = null;
 335     for (int[] region : av.getColumnSelection().getHiddenColumns())
 336     {
 337       if (res + 1 == region[0] || res - 1 == region[1])
 338       {
 339         reveal = region;
 340         break;
 341       }
 342     }
 343
 344     repaint();
 345   }
 346
 347   @Override
 348   public void update(Graphics g)
 349   {
 350     paint(g);
 351   }
 352
 353   @Override
 354   public void paint(Graphics g)
 355   {
 356     drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
 357             getSize().width,
 358             getSize().height);
 359   }
 360
 361   // scalewidth will normally be screenwidth,
 362   public void drawScale(Graphics gg, int startx, int endx, int width,
 363           int height)
 364   {
 365     gg.setFont(av.getFont());
 366     // Fill in the background
 367     gg.setColor(Color.white);
 368     gg.fillRect(0, 0, width, height);
 369     gg.setColor(Color.black);
 370
 371     // Fill the selected columns
 372     ColumnSelection cs = av.getColumnSelection();
 373     int avCharWidth = av.getCharWidth();
 374     int avcharHeight = av.getCharHeight();
 375     if (cs != null)
 376     {
 377       gg.setColor(new Color(220, 0, 0));
 378       boolean hasHiddenColumns = cs.hasHiddenColumns();
 379       for (int sel : cs.getSelected())
 380       {
 381         // TODO: JAL-2001 - provide a fast method to list visible selected in a
 382         // given range
 383         if (hasHiddenColumns)
 384         {
 385           if (cs.isVisible(sel))
 386           {
 387             sel = cs.findColumnPosition(sel);
 388           }
 389           else
 390           {
 391             continue;
 392           }
 393         }
 394
 395         if ((sel >= startx) && (sel <= endx))
 396         {
 397           gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
 398                   getSize().height);
 399         }
 400       }
 401     }
 402
 403     // Draw the scale numbers
 404     gg.setColor(Color.black);
 405
 406     int maxX = 0;
 407     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
 408             endx);
 409
 410     FontMetrics fm = gg.getFontMetrics(av.getFont());
 411     int y = avcharHeight;
 412     int yOf = fm.getDescent();
 413     y -= yOf;
 414     for (ScaleMark mark : marks)
 415     {
 416       boolean major = mark.major;
 417       int mpos = mark.column; // (i - startx - 1)
 418       String mstring = mark.text;
 419       if (mstring != null)
 420       {
 421         if (mpos * avCharWidth > maxX)
 422         {
 423           gg.drawString(mstring, mpos * avCharWidth, y);
 424           maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
 425         }
 426       }
 427       if (major)
 428       {
 429         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
 430                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 431       }
 432       else
 433       {
 434         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
 435                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
 436       }
 437     }
 438
 439     if (av.hasHiddenColumns())
 440     {
 441       gg.setColor(Color.blue);
 442       int res;
 443       if (av.getShowHiddenMarkers())
 444       {
 445         int widthx = 1 + endx - startx;
 446         for (int i = 0; i < cs.getHiddenColumns().size(); i++)
 447         {
 448
 449           res = cs.findHiddenRegionPosition(i) - startx;
 450
 451           if (res < 0 || res > widthx)
 452           {
 453             continue;
 454           }
 455
 456           gg.fillPolygon(new int[] {
 457               -1 + res * avCharWidth - avcharHeight / 4,
 458               -1 + res * avCharWidth + avcharHeight / 4,
 459               -1 + res * avCharWidth }, new int[] { y, y, y + 2 * yOf }, 3);
 460         }
 461       }
 462     }
 463   }
 464
 465 }