JAL-1683 replace year/version strings with tokens in source
[jalview.git] / src / jalview / gui / ScalePanel.java
index 8e9d829..6ef5222 100755 (executable)
@@ -1,28 +1,46 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
- * This program 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 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program 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.
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
-import java.awt.*;
-import java.awt.event.*;
-import javax.swing.*;
-
-import jalview.datamodel.*;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.util.MessageManager;
+
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+
+import javax.swing.JMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+import javax.swing.ToolTipManager;
 
 /**
  * DOCUMENT ME!
@@ -64,16 +82,21 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
    * DOCUMENT ME!
    * 
    * @param evt
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void mousePressed(MouseEvent evt)
   {
     int x = (evt.getX() / av.getCharWidth()) + av.getStartRes();
     final int res;
 
-    if (av.hasHiddenColumns)
+    if (av.hasHiddenColumns())
     {
-      res = av.getColumnSelection().adjustForHiddenColumns(x);
+      x = av.getColumnSelection().adjustForHiddenColumns(x);
+    }
+
+    if (x >= av.getAlignment().getWidth())
+    {
+      res = av.getAlignment().getWidth() - 1;
     }
     else
     {
@@ -88,7 +111,8 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       JPopupMenu pop = new JPopupMenu();
       if (reveal != null)
       {
-        JMenuItem item = new JMenuItem("Reveal");
+        JMenuItem item = new JMenuItem(
+                MessageManager.getString("label.reveal"));
         item.addActionListener(new ActionListener()
         {
           public void actionPerformed(ActionEvent e)
@@ -104,9 +128,10 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
         });
         pop.add(item);
 
-        if (av.getColumnSelection().getHiddenColumns().size() > 1)
+        if (av.getColumnSelection().hasHiddenColumns())
         {
-          item = new JMenuItem("Reveal All");
+          item = new JMenuItem(
+                  MessageManager.getString("action.reveal_all"));
           item.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
@@ -126,15 +151,16 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       }
       else if (av.getColumnSelection().contains(res))
       {
-        JMenuItem item = new JMenuItem("Hide Columns");
+        JMenuItem item = new JMenuItem(
+                MessageManager.getString("label.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.getSelectionGroup().getSize() == av
+                            .getAlignment().getHeight())
             {
               av.setSelectionGroup(null);
             }
@@ -161,7 +187,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       av.getColumnSelection().addElement(res);
       SequenceGroup sg = new SequenceGroup();
       // try to be as quick as possible
-      SequenceI[] iVec = av.alignment.getSequencesArray();
+      SequenceI[] iVec = av.getAlignment().getSequencesArray();
       for (int i = 0; i < iVec.length; i++)
       {
         sg.addSequence(iVec[i], false);
@@ -170,7 +196,6 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       iVec = null;
       sg.setStartRes(res);
       sg.setEndRes(res);
-      av.setSelectionGroup(sg);
 
       if (evt.isShiftDown())
       {
@@ -183,7 +208,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
         sg.setStartRes(min);
         sg.setEndRes(max);
       }
-
+      av.setSelectionGroup(sg);
     }
 
     ap.paintAlignment(false);
@@ -194,7 +219,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
    * DOCUMENT ME!
    * 
    * @param evt
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void mouseReleased(MouseEvent evt)
   {
@@ -202,14 +227,14 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
 
     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
 
-    if (res > av.alignment.getWidth())
+    if (av.hasHiddenColumns())
     {
-      res = av.alignment.getWidth() - 1;
+      res = av.getColumnSelection().adjustForHiddenColumns(res);
     }
 
-    if (av.hasHiddenColumns)
+    if (res >= av.getAlignment().getWidth())
     {
-      res = av.getColumnSelection().adjustForHiddenColumns(res);
+      res = av.getAlignment().getWidth() - 1;
     }
 
     if (!stretchingGroup)
@@ -241,7 +266,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
    * DOCUMENT ME!
    * 
    * @param evt
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void mouseDragged(MouseEvent evt)
   {
@@ -253,14 +278,14 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       res = 0;
     }
 
-    if (av.hasHiddenColumns)
+    if (av.hasHiddenColumns())
     {
       res = av.getColumnSelection().adjustForHiddenColumns(res);
     }
 
-    if (res > av.alignment.getWidth())
+    if (res >= av.getAlignment().getWidth())
     {
-      res = av.alignment.getWidth() - 1;
+      res = av.getAlignment().getWidth() - 1;
     }
 
     if (res < min)
@@ -296,7 +321,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
       int col;
       for (int i = min; i <= max; i++)
       {
-        col = av.getColumnSelection().adjustForHiddenColumns(i);
+        col = i; // av.getColumnSelection().adjustForHiddenColumns(i);
 
         if ((col < sg.getStartRes()) || (col > sg.getEndRes()))
         {
@@ -316,7 +341,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
   {
     if (mouseDragging)
     {
-      ap.seqPanel.scrollCanvas(null);
+      ap.getSeqPanel().scrollCanvas(null);
     }
   }
 
@@ -324,7 +349,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
   {
     if (mouseDragging)
     {
-      ap.seqPanel.scrollCanvas(evt);
+      ap.getSeqPanel().scrollCanvas(evt);
     }
   }
 
@@ -334,7 +359,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
 
   public void mouseMoved(MouseEvent evt)
   {
-    if (!av.hasHiddenColumns)
+    if (!av.hasHiddenColumns())
     {
       return;
     }
@@ -344,25 +369,24 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
     res = av.getColumnSelection().adjustForHiddenColumns(res);
 
     reveal = null;
-    for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
+    if (av.getColumnSelection().getHiddenColumns() != null)
     {
-      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
+      for (int[] region : av.getColumnSelection().getHiddenColumns())
       {
-        this.setToolTipText(null);
+        if (res + 1 == region[0] || res - 1 == region[1])
+        {
+          reveal = region;
+          ToolTipManager.sharedInstance().registerComponent(this);
+          this.setToolTipText(MessageManager
+                  .getString("label.reveal_hidden_columns"));
+          break;
+        }
+        else
+        {
+          this.setToolTipText(null);
+        }
       }
-
     }
-
     repaint();
   }
 
@@ -372,7 +396,7 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
    * DOCUMENT ME!
    * 
    * @param g
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void paintComponent(Graphics g)
   {
@@ -399,23 +423,33 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
 
     // Fill the selected columns
     ColumnSelection cs = av.getColumnSelection();
-    gg.setColor(new Color(220, 0, 0));
-
-    for (int i = 0; i < cs.size(); i++)
+    int s;
+    if (cs != null)
     {
-      int sel = cs.columnAt(i);
-      if (av.hasHiddenColumns)
-      {
-        sel = av.getColumnSelection().findColumnPosition(sel);
-      }
+      gg.setColor(new Color(220, 0, 0));
 
-      if ((sel >= startx) && (sel <= endx))
+      for (int i = 0; i < cs.size(); i++)
       {
-        gg.fillRect((sel - startx) * av.charWidth, 0, av.charWidth,
-                getHeight());
+        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);
 
@@ -444,30 +478,29 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
           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));
+        gg.drawLine(
+                ((i - startx - 1) * av.charWidth) + (av.charWidth / 2),
+                y + 2,
+                ((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));
+        gg.drawLine(
+                ((i - startx - 1) * av.charWidth) + (av.charWidth / 2),
+                y + fm.getDescent(),
+                ((i - startx - 1) * av.charWidth) + (av.charWidth / 2),
+                y + (fm.getDescent() * 2));
       }
     }
 
-    if (av.hasHiddenColumns)
+    if (av.hasHiddenColumns())
     {
       gg.setColor(Color.blue);
       int res;
-      if (av.getShowHiddenMarkers())
+      if (av.getShowHiddenMarkers()
+              && av.getColumnSelection().getHiddenColumns() != null)
       {
         for (int i = 0; i < av.getColumnSelection().getHiddenColumns()
                 .size(); i++)
@@ -493,7 +526,8 @@ public class ScalePanel extends JPanel implements MouseMotionListener,
 
       if (reveal != null && reveal[0] > startx && reveal[0] < endx)
       {
-        gg.drawString("Reveal Columns", reveal[0] * av.charWidth, 0);
+        gg.drawString(MessageManager.getString("label.reveal_columns"),
+                reveal[0] * av.charWidth, 0);
       }
     }