update author list in license for (JAL-826)
[jalview.git] / src / jalview / gui / ScalePanel.java
index 37cfcaf..b5a19b2 100755 (executable)
-package jalview.gui;\r
-\r
-import jalview.datamodel.*;\r
-import java.awt.*;\r
-import java.awt.event.*;\r
-import javax.swing.*;\r
-\r
-public class ScalePanel extends JPanel\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
-    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
-      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
-\r
-  public void doMousePressed(MouseEvent evt) {\r
-    int x = evt.getX();\r
-    int res = x/av.getCharWidth() + av.getStartRes();\r
-    SequenceGroup sg = null;\r
-\r
-    if (av.getColumnSelection().contains(res))\r
-      av.getColumnSelection().removeElement(res);\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
-        sg.addSequence(av.alignment.getSequenceAt(i));\r
-\r
-      sg.setStartRes(res);\r
-      sg.setEndRes(res);\r
-    }\r
-    av.setSelectionGroup(sg);\r
-    ap.RefreshPanels();\r
-  }\r
-\r
-  public void doMouseReleased(MouseEvent evt)\r
-  {\r
-    if(!stretchingGroup)\r
-      return;\r
-\r
-    int x = evt.getX();\r
-    int res = x/av.getCharWidth() + av.getStartRes();\r
-\r
-   if (! av.getColumnSelection().contains(res))\r
-     av.getColumnSelection().addElement(res);\r
-\r
-   SequenceGroup sg = av.getSelectionGroup();\r
-\r
-   if(res>sg.getStartRes())\r
-     sg.setEndRes(res);\r
-   else if(res<sg.getStartRes())\r
-     sg.setStartRes(res);\r
-\r
-   stretchingGroup = false;\r
-   ap.RefreshPanels();\r
-  }\r
-\r
-  public void doMouseDragged(MouseEvent evt)\r
-  {\r
-    int x = evt.getX();\r
-    int res = x/av.getCharWidth() + av.getStartRes();\r
-\r
-    SequenceGroup sg = av.getSelectionGroup();\r
-    if(sg!=null)\r
-    {\r
-      stretchingGroup = true;\r
-      if (res > sg.getStartRes())\r
-        sg.setEndRes(res);\r
-      else if (res < sg.getStartRes())\r
-        sg.setStartRes(res);\r
-\r
-      ap.RefreshPanels();\r
-    }\r
-  }\r
-\r
-  public void paintComponent(Graphics g)\r
-  {\r
-    drawScale(g, av.getStartRes(), av.getEndRes(), getWidth());\r
-  }\r
-\r
-// scalewidth will normally be screenwidth,\r
-  public void drawScale(Graphics gg, int startx, int endx, int scaleWidth)\r
-  {\r
-    int charWidth  = av.getCharWidth();\r
-\r
-    gg.setFont(av.getFont());\r
-\r
-    //Fill in the background\r
-\r
-    gg.setColor(Color.white);\r
-    gg.fillRect(0,0,scaleWidth, getHeight());\r
-\r
-    int resWidth = endx - startx + 1;\r
-\r
-    // We want roughly one tick every 50 pixels\r
-\r
-    double rough = scaleWidth/50.0;\r
-\r
-    double roughtick = resWidth/rough;\r
-\r
-    int   digits  = (int)(Math.log(roughtick)/Math.log(10));\r
-    int   num     = (int)(roughtick/Math.pow(10,digits));\r
-\r
-    if (roughtick>5)\r
-        num = 10;\r
-    else\r
-        num = 5;\r
-\r
-  //   else\r
-  //  num = 2;\r
-\r
-  //  System.out.println("Dig " + digits + " " + rough + " " + roughtick + " " + getWidth() + " " + num);\r
-\r
-    int space = (int)(num * Math.pow(10,digits));\r
-\r
-    //Set the text font\r
-\r
-    gg.setColor(Color.black);\r
-\r
-\r
-    int scalestartx = 0;\r
-    if(space>0)\r
-      scalestartx = startx - startx%space + space;\r
-\r
-\r
-    //Fill the selected columns\r
-    ColumnSelection cs = av.getColumnSelection();\r
-    int width = charWidth;\r
-    if (width == 0)\r
-      width = 1;\r
-\r
-    gg.setColor(new Color(220,0,0));\r
-    for (int i=0; i<cs.size(); i++) {\r
-      int sel  = cs.columnAt(i);\r
-      //      System.out.println("Selection = " + sel);\r
-      if ( sel >= startx  && sel <= endx) {\r
-\r
-        gg.fillRect((sel-startx)*charWidth,0,width,getHeight());\r
-      }\r
-    }\r
-\r
-    // Draw the scale numbers\r
-    gg.setColor(Color.black);\r
-\r
-\r
-    for (int i=scalestartx;i < endx;i+= space) {\r
-\r
-      String string = String.valueOf(i);\r
-\r
-      gg.drawString(string,(i-startx-1)*charWidth,  av.charHeight / 2 +offy);\r
-      gg.drawLine( (int)((i-startx-1)*charWidth +charWidth/2), av.charHeight/2 +offy +2, (int)((i-startx-1)*charWidth +charWidth/2),av.charHeight/2 +offy+7);\r
-\r
-    }\r
-  }\r
-\r
-\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * 
+ * 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/>.
+ */
+package jalview.gui;
+
+import java.awt.*;
+import java.awt.event.*;
+import javax.swing.*;
+
+import jalview.datamodel.*;
+
+/**
+ * DOCUMENT ME!
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class ScalePanel extends JPanel implements MouseMotionListener,
+        MouseListener
+{
+  protected int offy = 4;
+
+  /** DOCUMENT ME!! */
+  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;
+
+  // wants to delete columns
+  public ScalePanel(AlignViewport av, AlignmentPanel ap)
+  {
+    this.av = av;
+    this.ap = ap;
+
+    addMouseListener(this);
+    addMouseMotionListener(this);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param evt
+   *          DOCUMENT ME!
+   */
+  public void mousePressed(MouseEvent evt)
+  {
+    int x = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+    final int res;
+
+    if (av.hasHiddenColumns)
+    {
+      x = av.getColumnSelection().adjustForHiddenColumns(x);
+    }
+
+    if (x >= av.alignment.getWidth())
+    {
+      res = av.alignment.getWidth() - 1;
+    }
+    else
+    {
+      res = x;
+    }
+
+    min = res;
+    max = res;
+
+    if (SwingUtilities.isRightMouseButton(evt))
+    {
+      JPopupMenu pop = new JPopupMenu();
+      if (reveal != null)
+      {
+        JMenuItem item = new JMenuItem("Reveal");
+        item.addActionListener(new ActionListener()
+        {
+          public void actionPerformed(ActionEvent e)
+          {
+            av.showColumn(reveal[0]);
+            reveal = null;
+            ap.paintAlignment(true);
+            if (ap.overviewPanel != null)
+            {
+              ap.overviewPanel.updateOverviewImage();
+            }
+          }
+        });
+        pop.add(item);
+
+        if (av.getColumnSelection().getHiddenColumns().size() > 1)
+        {
+          item = new JMenuItem("Reveal All");
+          item.addActionListener(new ActionListener()
+          {
+            public void actionPerformed(ActionEvent e)
+            {
+              av.showAllHiddenColumns();
+              reveal = null;
+              ap.paintAlignment(true);
+              if (ap.overviewPanel != null)
+              {
+                ap.overviewPanel.updateOverviewImage();
+              }
+            }
+          });
+          pop.add(item);
+        }
+        pop.show(this, evt.getX(), evt.getY());
+      }
+      else if (av.getColumnSelection().contains(res))
+      {
+        JMenuItem item = new JMenuItem("Hide Columns");
+        item.addActionListener(new ActionListener()
+        {
+          public void actionPerformed(ActionEvent e)
+          {
+            av.hideColumns(res, res);
+            if (av.getSelectionGroup() != null
+                    && av.getSelectionGroup().getSize() == av.alignment
+                            .getHeight())
+            {
+              av.setSelectionGroup(null);
+            }
+
+            ap.paintAlignment(true);
+            if (ap.overviewPanel != null)
+            {
+              ap.overviewPanel.updateOverviewImage();
+            }
+          }
+        });
+        pop.add(item);
+        pop.show(this, evt.getX(), evt.getY());
+      }
+    }
+    else
+    // LEFT MOUSE TO SELECT
+    {
+      if (!evt.isControlDown() && !evt.isShiftDown())
+      {
+        av.getColumnSelection().clear();
+      }
+
+      av.getColumnSelection().addElement(res);
+      SequenceGroup sg = new SequenceGroup();
+      // try to be as quick as possible
+      SequenceI[] iVec = av.alignment.getSequencesArray();
+      for (int i = 0; i < iVec.length; i++)
+      {
+        sg.addSequence(iVec[i], false);
+        iVec[i] = null;
+      }
+      iVec = null;
+      sg.setStartRes(res);
+      sg.setEndRes(res);
+
+      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);
+      }
+      av.setSelectionGroup(sg);
+    }
+
+    ap.paintAlignment(false);
+    av.sendSelection();
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param evt
+   *          DOCUMENT ME!
+   */
+  public void mouseReleased(MouseEvent evt)
+  {
+    mouseDragging = false;
+
+    int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+
+    if (av.hasHiddenColumns)
+    {
+      res = av.getColumnSelection().adjustForHiddenColumns(res);
+    }
+
+    if (res >= av.alignment.getWidth())
+    {
+      res = av.alignment.getWidth() - 1;
+    }
+
+    if (!stretchingGroup)
+    {
+      ap.paintAlignment(false);
+
+      return;
+    }
+
+    SequenceGroup sg = av.getSelectionGroup();
+
+    if (sg != null)
+    {
+      if (res > sg.getStartRes())
+      {
+        sg.setEndRes(res);
+      }
+      else if (res < sg.getStartRes())
+      {
+        sg.setStartRes(res);
+      }
+    }
+    stretchingGroup = false;
+    ap.paintAlignment(false);
+    av.sendSelection();
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param evt
+   *          DOCUMENT ME!
+   */
+  public void mouseDragged(MouseEvent evt)
+  {
+    mouseDragging = true;
+
+    int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+    if (res < 0)
+    {
+      res = 0;
+    }
+
+    if (av.hasHiddenColumns)
+    {
+      res = av.getColumnSelection().adjustForHiddenColumns(res);
+    }
+
+    if (res >= av.alignment.getWidth())
+    {
+      res = av.alignment.getWidth() - 1;
+    }
+
+    if (res < min)
+    {
+      min = res;
+    }
+
+    if (res > max)
+    {
+      max = res;
+    }
+
+    SequenceGroup sg = av.getSelectionGroup();
+
+    if (sg != null)
+    {
+      stretchingGroup = true;
+
+      if (!av.getColumnSelection().contains(res))
+      {
+        av.getColumnSelection().addElement(res);
+      }
+
+      if (res > sg.getStartRes())
+      {
+        sg.setEndRes(res);
+      }
+      if (res < sg.getStartRes())
+      {
+        sg.setStartRes(res);
+      }
+
+      int col;
+      for (int i = min; i <= max; i++)
+      {
+        col = i; // av.getColumnSelection().adjustForHiddenColumns(i);
+
+        if ((col < sg.getStartRes()) || (col > sg.getEndRes()))
+        {
+          av.getColumnSelection().removeElement(col);
+        }
+        else
+        {
+          av.getColumnSelection().addElement(col);
+        }
+      }
+
+      ap.paintAlignment(false);
+    }
+  }
+
+  public void mouseEntered(MouseEvent evt)
+  {
+    if (mouseDragging)
+    {
+      ap.seqPanel.scrollCanvas(null);
+    }
+  }
+
+  public void mouseExited(MouseEvent evt)
+  {
+    if (mouseDragging)
+    {
+      ap.seqPanel.scrollCanvas(evt);
+    }
+  }
+
+  public void mouseClicked(MouseEvent evt)
+  {
+  }
+
+  public void mouseMoved(MouseEvent evt)
+  {
+    if (!av.hasHiddenColumns)
+    {
+      return;
+    }
+
+    int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
+
+    res = av.getColumnSelection().adjustForHiddenColumns(res);
+
+    reveal = null;
+    for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
+    {
+      int[] region = (int[]) av.getColumnSelection().getHiddenColumns()
+              .elementAt(i);
+      if (res + 1 == region[0] || res - 1 == region[1])
+      {
+        reveal = region;
+        ToolTipManager.sharedInstance().registerComponent(this);
+        this.setToolTipText("Reveal Hidden Columns with Right Mouse Button");
+        break;
+      }
+      else
+      {
+        this.setToolTipText(null);
+      }
+
+    }
+
+    repaint();
+  }
+
+  int[] reveal;
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param g
+   *          DOCUMENT ME!
+   */
+  public void paintComponent(Graphics g)
+  {
+    drawScale(g, av.getStartRes(), av.getEndRes(), getWidth(), getHeight());
+  }
+
+  // scalewidth will normally be screenwidth,
+  public void drawScale(Graphics g, int startx, int endx, int width,
+          int height)
+  {
+    Graphics2D gg = (Graphics2D) g;
+    gg.setFont(av.getFont());
+
+    if (av.antiAlias)
+    {
+      gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+              RenderingHints.VALUE_ANTIALIAS_ON);
+    }
+
+    // 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();
+    int s;
+    if (cs != null)
+    {
+      gg.setColor(new Color(220, 0, 0));
+
+      for (int i = 0; i < cs.size(); i++)
+      {
+        int sel = cs.columnAt(i);
+        if (av.hasHiddenColumns)
+        {
+          if (cs.isVisible(sel))
+          {
+            sel = cs.findColumnPosition(sel);
+          }
+          else
+          {
+            continue;
+          }
+        }
+
+        if ((sel >= startx) && (sel <= endx))
+        {
+          gg.fillRect((sel - startx) * av.charWidth, 0, av.charWidth,
+                  getHeight());
+        }
+      }
+    }
+    // Draw the scale numbers
+    gg.setColor(Color.black);
+
+    int scalestartx = (startx / 10) * 10;
+
+    FontMetrics fm = gg.getFontMetrics(av.getFont());
+    int y = av.charHeight - fm.getDescent();
+
+    if ((scalestartx % 10) == 0)
+    {
+      scalestartx += 5;
+    }
+
+    String string;
+    int maxX = 0;
+
+    for (int i = scalestartx; i < endx; i += 5)
+    {
+      if ((i % 10) == 0)
+      {
+        string = String.valueOf(av.getColumnSelection()
+                .adjustForHiddenColumns(i));
+        if ((i - startx - 1) * av.charWidth > maxX)
+        {
+          gg.drawString(string, (i - startx - 1) * av.charWidth, y);
+          maxX = (i - startx + 1) * av.charWidth + fm.stringWidth(string);
+        }
+
+        gg.drawLine(
+                (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
+                y + 2,
+                (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
+                y + (fm.getDescent() * 2));
+
+      }
+      else
+      {
+        gg.drawLine(
+                (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
+                y + fm.getDescent(),
+                (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
+                y + (fm.getDescent() * 2));
+      }
+    }
+
+    if (av.hasHiddenColumns)
+    {
+      gg.setColor(Color.blue);
+      int res;
+      if (av.getShowHiddenMarkers())
+      {
+        for (int i = 0; i < av.getColumnSelection().getHiddenColumns()
+                .size(); i++)
+        {
+
+          res = av.getColumnSelection().findHiddenRegionPosition(i)
+                  - startx;
+
+          if (res < 0 || res > endx - scalestartx)
+          {
+            continue;
+          }
+
+          gg.fillPolygon(new int[]
+          { res * av.charWidth - av.charHeight / 4,
+              res * av.charWidth + av.charHeight / 4, res * av.charWidth },
+                  new int[]
+                  { y - av.charHeight / 2, y - av.charHeight / 2, y + 8 },
+                  3);
+
+        }
+      }
+
+      if (reveal != null && reveal[0] > startx && reveal[0] < endx)
+      {
+        gg.drawString("Reveal Columns", reveal[0] * av.charWidth, 0);
+      }
+    }
+
+  }
+}