JAL-2647 Added iterators and associated tests and benchmarks
[jalview.git] / src / jalview / appletgui / ScalePanel.java
index 8688486..bbbb92b 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-\r
-package jalview.appletgui;\r
-\r
-import java.awt.*;\r
-import java.awt.event.*;\r
-\r
-import jalview.datamodel.*;\r
-\r
-public class ScalePanel\r
-    extends Panel\r
-{\r
-\r
-  protected int offy = 4;\r
-  public int width;\r
-\r
-  protected AlignViewport av;\r
-  AlignmentPanel ap;\r
-\r
-  boolean stretchingGroup = false;\r
-\r
-  public ScalePanel(AlignViewport av, AlignmentPanel ap)\r
-  {\r
-    setLayout(null);\r
-    this.av = av;\r
-    this.ap = ap;\r
-\r
-    addMouseListener(new MouseAdapter()\r
-    {\r
-      public void mousePressed(MouseEvent evt)\r
-      {\r
-        doMousePressed(evt);\r
-      }\r
-\r
-      public void mouseReleased(MouseEvent evt)\r
-      {\r
-        doMouseReleased(evt);\r
-      }\r
-\r
-    });\r
-    addMouseMotionListener(new MouseMotionAdapter()\r
-    {\r
-      public void mouseDragged(MouseEvent evt)\r
-      {\r
-        doMouseDragged(evt);\r
-      }\r
-    });\r
-\r
-  }\r
-\r
-  public void doMousePressed(MouseEvent evt)\r
-  {\r
-    int x = evt.getX();\r
-    int res = x / av.getCharWidth() + av.getStartRes();\r
-    SequenceGroup sg = null;\r
-\r
-\r
-    if (av.getColumnSelection().contains(res))\r
-    {\r
-      av.getColumnSelection().removeElement(res);\r
-    }\r
-    else\r
-    {\r
-      av.getColumnSelection().addElement(res);\r
-\r
-      sg = new SequenceGroup();\r
-      for (int i = 0; i < av.alignment.getSequences().size(); i++)\r
-      {\r
-        sg.addSequence(av.alignment.getSequenceAt(i), false);\r
-      }\r
-\r
-      sg.setStartRes(res);\r
-      sg.setEndRes(res);\r
-\r
-      ap.annotationPanel.addEditableColumn(res);\r
-    }\r
-    av.setSelectionGroup(sg);\r
-    ap.repaint();\r
-  }\r
-\r
-  public void doMouseReleased(MouseEvent evt)\r
-  {\r
-    if (!stretchingGroup)\r
-    {\r
-      return;\r
-    }\r
-\r
-    int x = evt.getX();\r
-    int res = x / av.getCharWidth() + av.getStartRes();\r
-\r
-    if(res> av.alignment.getWidth())\r
-    {\r
-      res = av.alignment.getWidth()-1;\r
-    }\r
-\r
-    if (!av.getColumnSelection().contains(res))\r
-    {\r
-      av.getColumnSelection().addElement(res);\r
-    }\r
-\r
-    SequenceGroup sg = av.getSelectionGroup();\r
-\r
-    if (res > sg.getStartRes())\r
-    {\r
-      sg.setEndRes(res);\r
-    }\r
-    else if (res < sg.getStartRes())\r
-    {\r
-      sg.setStartRes(res);\r
-    }\r
-\r
-    stretchingGroup = false;\r
-    ap.repaint();\r
-  }\r
-\r
-  public void doMouseDragged(MouseEvent evt)\r
-  {\r
-    int x = evt.getX();\r
-    int res = x / av.getCharWidth() + av.getStartRes();\r
-\r
-    if(res> av.alignment.getWidth())\r
-    {\r
-      res = av.alignment.getWidth()-1;\r
-    }\r
-\r
-    SequenceGroup sg = av.getSelectionGroup();\r
-    if (sg != null)\r
-    {\r
-      stretchingGroup = true;\r
-      if (res > sg.getStartRes())\r
-      {\r
-        sg.setEndRes(res);\r
-      }\r
-      else if (res < sg.getStartRes())\r
-      {\r
-        sg.setStartRes(res);\r
-      }\r
-\r
-      ap.annotationPanel.addEditableColumn(res);\r
-      ap.repaint();\r
-    }\r
-  }\r
-\r
-  public void update(Graphics g)\r
-  {\r
-    paint(g);\r
-  }\r
-\r
-  public void paint(Graphics g)\r
-  {\r
-    drawScale(g, av.getStartRes(), av.getEndRes(), getSize().width,\r
-              getSize().height);\r
-  }\r
-\r
-// scalewidth will normally be screenwidth,\r
-  public void drawScale(Graphics gg, int startx, int endx, int width,\r
-                        int height)\r
-  {\r
-    gg.setFont(av.getFont());\r
-\r
-    //Fill in the background\r
-    gg.setColor(Color.white);\r
-    gg.fillRect(0, 0, width, height);\r
-    gg.setColor(Color.black);\r
-\r
-    //Fill the selected columns\r
-    ColumnSelection cs = av.getColumnSelection();\r
-    gg.setColor(new Color(220, 0, 0));\r
-    for (int i = 0; i < cs.size(); i++)\r
-    {\r
-      int sel = cs.columnAt(i);\r
-      if (sel >= startx && sel <= endx)\r
-      {\r
-        gg.fillRect( (sel - startx) * av.charWidth, 0, av.charWidth,\r
-                    getSize().height);\r
-      }\r
-    }\r
-\r
-    // Draw the scale numbers\r
-    gg.setColor(Color.black);\r
-    int scalestartx = (startx / 10) * 10;\r
-\r
-    FontMetrics fm = gg.getFontMetrics(av.getFont());\r
-    int y = av.charHeight - fm.getDescent();\r
-\r
-    if (scalestartx % 10 == 0)\r
-    {\r
-      scalestartx += 5;\r
-    }\r
-\r
-    String string;\r
-    int maxX=0;\r
-\r
-    for (int i = scalestartx; i < endx; i += 5)\r
-    {\r
-      if (i % 10 == 0)\r
-      {\r
-        string = String.valueOf(i);\r
-        if ( (i - startx - 1) * av.charWidth > maxX)\r
-        {\r
-          gg.drawString(string,\r
-                        (i - startx - 1) * av.charWidth, y);\r
-          maxX = (i - startx + 1) * av.charWidth + fm.stringWidth(string);\r
-        }\r
-\r
-        gg.drawLine( (int) ( (i - startx - 1) * av.charWidth + av.charWidth / 2),\r
-                    y + 2,\r
-                    (int) ( (i - startx - 1) * av.charWidth + av.charWidth / 2),\r
-                    y + fm.getDescent() * 2);\r
-      }\r
-      else\r
-      {\r
-        gg.drawLine( (int) ( (i - startx - 1) * av.charWidth + av.charWidth / 2),\r
-                    y + fm.getDescent(),\r
-                    (int) ( (i - startx - 1) * av.charWidth + av.charWidth / 2),\r
-                    y + fm.getDescent() * 2);\r
-      }\r
-\r
-    }\r
-  }\r
-\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.appletgui;
+
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.SequenceGroup;
+import jalview.renderer.ScaleRenderer;
+import jalview.renderer.ScaleRenderer.ScaleMark;
+import jalview.util.MessageManager;
+import jalview.viewmodel.ViewportListenerI;
+import jalview.viewmodel.ViewportRanges;
+
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.MenuItem;
+import java.awt.Panel;
+import java.awt.PopupMenu;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.InputEvent;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.beans.PropertyChangeEvent;
+import java.util.Iterator;
+import java.util.List;
+
+public class ScalePanel extends Panel
+        implements MouseMotionListener, MouseListener, ViewportListenerI
+{
+
+  protected int offy = 4;
+
+  public int width;
+
+  protected AlignViewport av;
+
+  AlignmentPanel ap;
+
+  boolean stretchingGroup = false;
+
+  int min; // used by mouseDragged to see if user
+
+  int max; // used by mouseDragged to see if user
+
+  boolean mouseDragging = false;
+
+  int[] reveal;
+
+  public ScalePanel(AlignViewport av, AlignmentPanel ap)
+  {
+    setLayout(null);
+    this.av = av;
+    this.ap = ap;
+
+    addMouseListener(this);
+    addMouseMotionListener(this);
+
+    av.getRanges().addPropertyChangeListener(this);
+  }
+
+  @Override
+  public void mousePressed(MouseEvent evt)
+  {
+    int x = (evt.getX() / av.getCharWidth()) + av.getRanges().getStartRes();
+    final int res;
+
+    if (av.hasHiddenColumns())
+    {
+      res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(x);
+    }
+    else
+    {
+      res = x;
+    }
+
+    min = res;
+    max = res;
+    if ((evt.getModifiers()
+            & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
+    {
+      rightMouseButtonPressed(evt, res);
+    }
+    else
+    {
+      leftMouseButtonPressed(evt, res);
+    }
+  }
+
+  /**
+   * Handles left mouse button pressed (selection / clear selections)
+   * 
+   * @param evt
+   * @param res
+   */
+  protected void leftMouseButtonPressed(MouseEvent evt, final int res)
+  {
+    if (!evt.isControlDown() && !evt.isShiftDown())
+    {
+      av.getColumnSelection().clear();
+    }
+
+    av.getColumnSelection().addElement(res);
+    SequenceGroup sg = new SequenceGroup();
+    for (int i = 0; i < av.getAlignment().getSequences().size(); i++)
+    {
+      sg.addSequence(av.getAlignment().getSequenceAt(i), false);
+    }
+
+    sg.setStartRes(res);
+    sg.setEndRes(res);
+    av.setSelectionGroup(sg);
+
+    if (evt.isShiftDown())
+    {
+      int min = Math.min(av.getColumnSelection().getMin(), res);
+      int max = Math.max(av.getColumnSelection().getMax(), res);
+      for (int i = min; i < max; i++)
+      {
+        av.getColumnSelection().addElement(i);
+      }
+      sg.setStartRes(min);
+      sg.setEndRes(max);
+    }
+    ap.paintAlignment(false);
+    av.sendSelection();
+  }
+
+  /**
+   * Handles right mouse button press. If pressed in a selected column, opens
+   * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
+   * opens context menu for 'Reveal / Reveal All'. Else does nothing.
+   * 
+   * @param evt
+   * @param res
+   */
+  protected void rightMouseButtonPressed(MouseEvent evt, final int res)
+  {
+    PopupMenu pop = new PopupMenu();
+    if (reveal != null)
+    {
+      MenuItem item = new MenuItem(
+              MessageManager.getString("label.reveal"));
+      item.addActionListener(new ActionListener()
+      {
+        @Override
+        public void actionPerformed(ActionEvent e)
+        {
+          av.showColumn(reveal[0]);
+          reveal = null;
+          ap.paintAlignment(true);
+          av.sendSelection();
+        }
+      });
+      pop.add(item);
+
+      if (av.getAlignment().getHiddenColumns().hasManyHiddenColumns())
+      {
+        item = new MenuItem(MessageManager.getString("action.reveal_all"));
+        item.addActionListener(new ActionListener()
+        {
+          @Override
+          public void actionPerformed(ActionEvent e)
+          {
+            av.showAllHiddenColumns();
+            reveal = null;
+            ap.paintAlignment(true);
+            av.sendSelection();
+          }
+        });
+        pop.add(item);
+      }
+      this.add(pop);
+      pop.show(this, evt.getX(), evt.getY());
+    }
+    else if (av.getColumnSelection().contains(res))
+    {
+      MenuItem item = new MenuItem(
+              MessageManager.getString("label.hide_columns"));
+      item.addActionListener(new ActionListener()
+      {
+        @Override
+        public void actionPerformed(ActionEvent e)
+        {
+          av.hideColumns(res, res);
+          if (av.getSelectionGroup() != null && av.getSelectionGroup()
+                  .getSize() == av.getAlignment().getHeight())
+          {
+            av.setSelectionGroup(null);
+          }
+
+          ap.paintAlignment(true);
+          av.sendSelection();
+        }
+      });
+      pop.add(item);
+      this.add(pop);
+      pop.show(this, evt.getX(), evt.getY());
+    }
+  }
+
+  @Override
+  public void mouseReleased(MouseEvent evt)
+  {
+    mouseDragging = false;
+
+    int res = (evt.getX() / av.getCharWidth())
+            + av.getRanges().getStartRes();
+
+    if (res > av.getAlignment().getWidth())
+    {
+      res = av.getAlignment().getWidth() - 1;
+    }
+
+    if (av.hasHiddenColumns())
+    {
+      res = av.getAlignment().getHiddenColumns()
+              .adjustForHiddenColumns(res);
+    }
+
+    if (!stretchingGroup)
+    {
+      ap.paintAlignment(false);
+
+      return;
+    }
+
+    SequenceGroup sg = av.getSelectionGroup();
+
+    if (res > sg.getStartRes())
+    {
+      sg.setEndRes(res);
+    }
+    else if (res < sg.getStartRes())
+    {
+      sg.setStartRes(res);
+    }
+
+    stretchingGroup = false;
+    ap.paintAlignment(false);
+    av.sendSelection();
+  }
+
+  /**
+   * Action on dragging the mouse in the scale panel is to expand or shrink the
+   * selection group range (including any hidden columns that it spans)
+   * 
+   * @param evt
+   */
+  @Override
+  public void mouseDragged(MouseEvent evt)
+  {
+    mouseDragging = true;
+    ColumnSelection cs = av.getColumnSelection();
+
+    int res = (evt.getX() / av.getCharWidth())
+            + av.getRanges().getStartRes();
+    res = Math.max(0, res);
+    res = av.getAlignment().getHiddenColumns().adjustForHiddenColumns(res);
+    res = Math.min(res, av.getAlignment().getWidth() - 1);
+    min = Math.min(res, min);
+    max = Math.max(res, max);
+
+    SequenceGroup sg = av.getSelectionGroup();
+    if (sg != null)
+    {
+      stretchingGroup = true;
+      cs.stretchGroup(res, sg, min, max);
+      ap.paintAlignment(false);
+    }
+  }
+
+  @Override
+  public void mouseEntered(MouseEvent evt)
+  {
+    if (mouseDragging)
+    {
+      ap.seqPanel.scrollCanvas(null);
+    }
+  }
+
+  @Override
+  public void mouseExited(MouseEvent evt)
+  {
+    if (mouseDragging)
+    {
+      ap.seqPanel.scrollCanvas(evt);
+    }
+  }
+
+  @Override
+  public void mouseClicked(MouseEvent evt)
+  {
+
+  }
+
+  @Override
+  public void mouseMoved(MouseEvent evt)
+  {
+    if (!av.hasHiddenColumns())
+    {
+      return;
+    }
+
+    int res = (evt.getX() / av.getCharWidth())
+            + av.getRanges().getStartRes();
+
+    reveal = av.getAlignment().getHiddenColumns()
+            .getRegionWithEdgeAtRes(res);
+
+    repaint();
+  }
+
+  @Override
+  public void update(Graphics g)
+  {
+    paint(g);
+  }
+
+  @Override
+  public void paint(Graphics g)
+  {
+    /*
+     * shouldn't get called in wrapped mode as the scale above is
+     * drawn instead by SeqCanvas.drawNorthScale
+     */
+    if (!av.getWrapAlignment())
+    {
+      drawScale(g, av.getRanges().getStartRes(), av.getRanges().getEndRes(),
+              getSize().width, getSize().height);
+    }
+  }
+
+  // scalewidth will normally be screenwidth,
+  public void drawScale(Graphics gg, int startx, int endx, int width,
+          int height)
+  {
+    gg.setFont(av.getFont());
+    // Fill in the background
+    gg.setColor(Color.white);
+    gg.fillRect(0, 0, width, height);
+    gg.setColor(Color.black);
+
+    // Fill the selected columns
+    ColumnSelection cs = av.getColumnSelection();
+    HiddenColumns hidden = av.getAlignment().getHiddenColumns();
+    int avCharWidth = av.getCharWidth();
+    int avcharHeight = av.getCharHeight();
+    if (cs != null)
+    {
+      gg.setColor(new Color(220, 0, 0));
+      boolean hasHiddenColumns = hidden.hasHiddenColumns();
+      for (int sel : cs.getSelected())
+      {
+        // TODO: JAL-2001 - provide a fast method to list visible selected in a
+        // given range
+        if (hasHiddenColumns)
+        {
+          if (hidden.isVisible(sel))
+          {
+            sel = hidden.findColumnPosition(sel);
+          }
+          else
+          {
+            continue;
+          }
+        }
+
+        if ((sel >= startx) && (sel <= endx))
+        {
+          gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
+                  getSize().height);
+        }
+      }
+    }
+
+    // Draw the scale numbers
+    gg.setColor(Color.black);
+
+    int maxX = 0;
+    List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
+            endx);
+
+    FontMetrics fm = gg.getFontMetrics(av.getFont());
+    int y = avcharHeight;
+    int yOf = fm.getDescent();
+    y -= yOf;
+    for (ScaleMark mark : marks)
+    {
+      boolean major = mark.major;
+      int mpos = mark.column; // (i - startx - 1)
+      String mstring = mark.text;
+      if (mstring != null)
+      {
+        if (mpos * avCharWidth > maxX)
+        {
+          gg.drawString(mstring, mpos * avCharWidth, y);
+          maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
+        }
+      }
+      if (major)
+      {
+        gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
+                (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
+      }
+      else
+      {
+        gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
+                (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
+      }
+    }
+
+    if (av.hasHiddenColumns())
+    {
+      gg.setColor(Color.blue);
+      int res;
+      if (av.getShowHiddenMarkers())
+      {
+        int widthx = 1 + endx - startx;
+        Iterator<Integer> it = hidden.getBoundedStartIterator(startx,
+                startx + widthx + 1, true);
+        while (it.hasNext())
+        {
+          res = it.next() - startx;
+
+          gg.fillPolygon(
+                  new int[]
+                  { -1 + res * avCharWidth - avcharHeight / 4, -1 + res * avCharWidth + avcharHeight / 4,
+              -1 + res * avCharWidth }, new int[]
+          { y, y, y + 2 * yOf }, 3);
+        }
+      }
+    }
+  }
+
+  @Override
+  public void propertyChange(PropertyChangeEvent evt)
+  {
+    // Respond to viewport change events (e.g. alignment panel was scrolled)
+    // Both scrolling and resizing change viewport ranges: scrolling changes
+    // both start and end points, but resize only changes end values.
+    // Here we only want to fastpaint on a scroll, with resize using a normal
+    // paint, so scroll events are identified as changes to the horizontal or
+    // vertical start value.
+    if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
+    {
+      // scroll event, repaint panel
+      repaint();
+    }
+  }
+
+}