JAL-1683 replace year/version strings with tokens in source
[jalview.git] / src / jalview / appletgui / FeatureSettings.java
index 7f59de5..8ce3e62 100755 (executable)
@@ -1,25 +1,27 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 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.appletgui;
 
 import java.util.*;
-
+import java.util.List;
 import java.awt.*;
 import java.awt.event.*;
 
@@ -28,6 +30,7 @@ import jalview.commands.OrderCommand;
 import jalview.datamodel.*;
 import jalview.schemes.AnnotationColourGradient;
 import jalview.schemes.GraduatedColor;
+import jalview.util.MessageManager;
 
 public class FeatureSettings extends Panel implements ItemListener,
         MouseListener, MouseMotionListener, ActionListener,
@@ -47,8 +50,6 @@ public class FeatureSettings extends Panel implements ItemListener,
 
   ScrollPane scrollPane;
 
-  boolean alignmentHasFeatures = false;
-
   Image linkImage;
 
   Scrollbar transparency;
@@ -61,9 +62,9 @@ public class FeatureSettings extends Panel implements ItemListener,
     fr = ap.seqPanel.seqCanvas.getFeatureRenderer();
 
     transparency = new Scrollbar(Scrollbar.HORIZONTAL,
-            100 - (int) (fr.transparency * 100), 1, 1, 100);
+            100 - (int) (fr.getTransparency() * 100), 1, 1, 100);
 
-    if (fr.transparencySetter != null)
+    if (fr.isTransparencyAvailable())
     {
       transparency.addAdjustmentListener(this);
     }
@@ -78,9 +79,9 @@ public class FeatureSettings extends Panel implements ItemListener,
       linkImage = java.awt.Toolkit.getDefaultToolkit().getImage(url);
     }
 
-    if (av.featuresDisplayed == null)
+    if (av.isShowSequenceFeatures() || !fr.hasRenderOrder())
     {
-      fr.findAllFeatures();
+      fr.findAllFeatures(true); // was default - now true to make all visible
     }
 
     setTableData();
@@ -88,7 +89,7 @@ public class FeatureSettings extends Panel implements ItemListener,
     this.setLayout(new BorderLayout());
     scrollPane = new ScrollPane();
     scrollPane.add(featurePanel);
-    if (alignmentHasFeatures)
+    if (fr.getAllFeatureColours()!=null && fr.getAllFeatureColours().size()>0)
     {
       add(scrollPane, BorderLayout.CENTER);
     }
@@ -101,7 +102,7 @@ public class FeatureSettings extends Panel implements ItemListener,
 
     Panel tPanel = new Panel(new BorderLayout());
 
-    if (fr.transparencySetter != null)
+    if (fr.isTransparencyAvailable())
     {
       tPanel.add(transparency, BorderLayout.CENTER);
       tPanel.add(new Label("Transparency"), BorderLayout.EAST);
@@ -119,8 +120,10 @@ public class FeatureSettings extends Panel implements ItemListener,
 
     if (groupPanel != null)
     {
-      groupPanel.setLayout(new GridLayout(fr.featureGroups.size() / 4 + 1,
-              4));
+      groupPanel
+              .setLayout(new GridLayout(
+                      (fr.getFeatureGroupsSize()) / 4 + 1,
+                      4)); // JBPNote - this was scaled on number of visible groups. seems broken
       groupPanel.validate();
 
       add(groupPanel, BorderLayout.NORTH);
@@ -145,24 +148,34 @@ public class FeatureSettings extends Panel implements ItemListener,
     height = Math.max(200, height);
     height = Math.min(400, height);
     int width = 300;
-    jalview.bin.JalviewLite.addFrame(frame, "Feature Settings", width,
+    jalview.bin.JalviewLite.addFrame(frame,
+            MessageManager.getString("label.feature_settings"), width,
             height);
   }
 
   public void paint(Graphics g)
   {
     g.setColor(Color.black);
-    g.drawString("No Features added to this alignment!!", 10, 20);
-    g.drawString("(Features can be added from searches or", 10, 40);
-    g.drawString("from Jalview / GFF features files)", 10, 60);
+    g.drawString(MessageManager
+            .getString("label.no_features_added_to_this_alignment"), 10, 20);
+    g.drawString(MessageManager
+            .getString("label.features_can_be_added_from_searches_1"), 10,
+            40);
+    g.drawString(MessageManager
+            .getString("label.features_can_be_added_from_searches_2"), 10,
+            60);
   }
 
   protected void popupSort(final MyCheckbox check, final Hashtable minmax,
           int x, int y)
   {
     final String type = check.type;
-    java.awt.PopupMenu men = new PopupMenu("Settings for " + type);
-    java.awt.MenuItem scr = new MenuItem("Sort by Score");
+    final Object typeCol = fr.getFeatureStyle(type);
+    java.awt.PopupMenu men = new PopupMenu(MessageManager.formatMessage(
+            "label.settings_for_type", new String[]
+            { type }));
+    java.awt.MenuItem scr = new MenuItem(
+            MessageManager.getString("label.sort_by_score"));
     men.add(scr);
     final FeatureSettings me = this;
     scr.addActionListener(new ActionListener()
@@ -170,18 +183,19 @@ public class FeatureSettings extends Panel implements ItemListener,
 
       public void actionPerformed(ActionEvent e)
       {
-        me.sortByScore(new String[]
+        me.ap.alignFrame.avc.sortAlignmentByFeatureScore(new String[]
         { type });
       }
 
     });
-    MenuItem dens = new MenuItem("Sort by Density");
+    MenuItem dens = new MenuItem(
+            MessageManager.getString("label.sort_by_density"));
     dens.addActionListener(new ActionListener()
     {
 
       public void actionPerformed(ActionEvent e)
       {
-        me.sortByDens(new String[]
+        me.ap.alignFrame.avc.sortAlignmentByFeatureDensity(new String[]
         { type });
       }
 
@@ -206,16 +220,26 @@ public class FeatureSettings extends Panel implements ItemListener,
       {
         // graduated colourschemes for those where minmax exists for the
         // positional features
-        MenuItem mxcol = new MenuItem("Graduated Colour");
+        MenuItem mxcol = new MenuItem(
+                (typeCol instanceof Color) ? "Graduated Colour"
+                        : "Single Colour");
         men.add(mxcol);
         mxcol.addActionListener(new ActionListener()
         {
 
           public void actionPerformed(ActionEvent e)
           {
-            new FeatureColourChooser(me, type);
-            // write back the current colour object to update the table
-            check.updateColor(fr.getFeatureStyle(type));
+            if (typeCol instanceof Color)
+            {
+              new FeatureColourChooser(me, type);
+              // write back the current colour object to update the table
+              check.updateColor(fr.getFeatureStyle(type));
+            }
+            else
+            {
+              new UserDefinedColours(me, check.type,
+                      ((GraduatedColor) typeCol));
+            }
           }
 
         });
@@ -227,8 +251,7 @@ public class FeatureSettings extends Panel implements ItemListener,
 
   public void setTableData()
   {
-    alignmentHasFeatures = fr.buildGroupHash();
-    if (alignmentHasFeatures)
+    if (fr.getAllFeatureColours()!=null && fr.getAllFeatureColours().size()>0)
     {
       rebuildGroups();
 
@@ -251,18 +274,19 @@ public class FeatureSettings extends Panel implements ItemListener,
       rdrw = true;
       groupPanel.removeAll();
     }
-
-    Enumeration gps = fr.featureGroups.keys();
-    while (gps.hasMoreElements())
+    // TODO: JAL-964 - smoothly incorporate new group entries if panel already
+    // displayed and new groups present
+    for (String group:(List<String>)fr.getFeatureGroups())
     {
-      String group = (String) gps.nextElement();
-      Boolean vis = (Boolean) fr.featureGroups.get(group);
-      Checkbox check = new MyCheckbox(group, vis.booleanValue(),
+      boolean vis = fr.checkGroupVisibility(group, false);
+      Checkbox check = new MyCheckbox(group, vis,
               (fr.featureLinks != null && fr.featureLinks
                       .containsKey(group)));
       check.addMouseListener(this);
       check.setFont(new Font("Serif", Font.BOLD, 12));
-      check.addItemListener(this);
+      check.addItemListener(groupItemListener);
+      // note - visibility seems to correlate with displayed. ???wtf ??
+      check.setVisible(vis);
       groupPanel.add(check);
     }
     if (rdrw)
@@ -270,7 +294,6 @@ public class FeatureSettings extends Panel implements ItemListener,
       groupPanel.validate();
     }
   }
-
   // This routine adds and removes checkboxes depending on
   // Group selection states
   void resetTable(boolean groupsChanged)
@@ -278,22 +301,21 @@ public class FeatureSettings extends Panel implements ItemListener,
     SequenceFeature[] tmpfeatures;
     String group = null, type;
     Vector visibleChecks = new Vector();
-
-    for (int i = 0; i < av.alignment.getHeight(); i++)
+    AlignmentI alignment = av.getAlignment();
+    for (int i = 0; i < alignment.getHeight(); i++)
     {
-      if (av.alignment.getSequenceAt(i).getSequenceFeatures() == null)
+      if (alignment.getSequenceAt(i).getSequenceFeatures() == null)
       {
         continue;
       }
 
-      tmpfeatures = av.alignment.getSequenceAt(i).getSequenceFeatures();
+      tmpfeatures = alignment.getSequenceAt(i).getSequenceFeatures();
       int index = 0;
       while (index < tmpfeatures.length)
       {
         group = tmpfeatures[index].featureGroup;
 
-        if (group == null || fr.featureGroups.get(group) == null
-                || ((Boolean) fr.featureGroups.get(group)).booleanValue())
+        if (group == null || fr.checkGroupVisibility(group, true))
         {
           type = tmpfeatures[index].getType();
           if (!visibleChecks.contains(type))
@@ -322,13 +344,14 @@ public class FeatureSettings extends Panel implements ItemListener,
       }
     }
 
-    if (fr.renderOrder != null)
+    if (fr.getRenderOrder() != null)
     {
       // First add the checks in the previous render order,
       // in case the window has been closed and reopened
-      for (int ro = fr.renderOrder.length - 1; ro > -1; ro--)
+      List<String> rol = fr.getRenderOrder();
+      for (int ro = rol.size() - 1; ro > -1; ro--)
       {
-        String item = fr.renderOrder[ro];
+        String item = rol.get(ro);
 
         if (!visibleChecks.contains(item))
         {
@@ -390,7 +413,7 @@ public class FeatureSettings extends Panel implements ItemListener,
     if (addCheck)
     {
       boolean selected = false;
-      if (groupsChanged || av.featuresDisplayed.containsKey(type))
+      if (groupsChanged || av.getFeaturesDisplayed().isVisible(type))
       {
         selected = true;
       }
@@ -427,26 +450,22 @@ public class FeatureSettings extends Panel implements ItemListener,
     selectionChanged();
   }
 
-  public void itemStateChanged(ItemEvent evt)
-  {
-    if (evt != null)
-    {
-      // Is the source a top level featureGroup?
+  private ItemListener groupItemListener = new ItemListener() {
+    public void itemStateChanged(ItemEvent evt) {
       Checkbox source = (Checkbox) evt.getSource();
-      if (fr.featureGroups.containsKey(source.getLabel()))
+      fr.setGroupVisibility(source.getLabel(),
+              source.getState());
+      ap.seqPanel.seqCanvas.repaint();
+      if (ap.overviewPanel != null)
       {
-        fr.featureGroups.put(source.getLabel(), new Boolean(source
-                .getState()));
-        ap.seqPanel.seqCanvas.repaint();
-        if (ap.overviewPanel != null)
-        {
-          ap.overviewPanel.updateOverviewImage();
-        }
-
-        resetTable(true);
-        return;
+        ap.overviewPanel.updateOverviewImage();
       }
-    }
+      resetTable(true);
+      return;
+    };
+  };
+  public void itemStateChanged(ItemEvent evt)
+  {
     selectionChanged();
   }
 
@@ -555,12 +574,22 @@ public class FeatureSettings extends Panel implements ItemListener,
     }
   }
 
-  public void setUserColour(String feature, Color col)
+  public void setUserColour(String feature, Object originalColour)
   {
-    fr.setColour(feature, col);
+    if (originalColour instanceof Color
+            || originalColour instanceof GraduatedColor)
+    {
+      fr.setColour(feature, originalColour);
+    }
+    else
+    {
+      throw new Error(MessageManager.getString("error.implementation_error_unsupported_feature_colour_object"));
+    }
     refreshTable();
   }
-  public void refreshTable() {
+
+  public void refreshTable()
+  {
     featurePanel.removeAll();
     resetTable(false);
     ap.paintAlignment(true);
@@ -579,17 +608,16 @@ public class FeatureSettings extends Panel implements ItemListener,
     MyCheckbox check = (MyCheckbox) evt.getSource();
     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) != 0)
     {
-      this.popupSort(check, fr.minmax, evt.getX(), evt.getY());
+      this.popupSort(check, fr.getMinMax(), evt.getX(), evt.getY());
     }
-    if (fr.featureLinks != null
-            && fr.featureLinks.containsKey(check.type))
+    if (fr.featureLinks != null && fr.featureLinks.containsKey(check.type))
     {
       if (evt.getX() > check.stringWidth + 20)
       {
         evt.consume();
         String link = fr.featureLinks.get(check.type).toString();
-        ap.alignFrame.showURL(link.substring(link.indexOf("|") + 1), link
-                .substring(0, link.indexOf("|")));
+        ap.alignFrame.showURL(link.substring(link.indexOf("|") + 1),
+                link.substring(0, link.indexOf("|")));
       }
     }
 
@@ -604,7 +632,9 @@ public class FeatureSettings extends Panel implements ItemListener,
       if (fcol instanceof Color)
       {
         new UserDefinedColours(this, check.type, (Color) fcol);
-      } else {
+      }
+      else
+      {
         new FeatureColourChooser(this, check.type);
         // write back the current colour object to update the table
         check.updateColor(fr.getFeatureStyle(check.type));
@@ -618,7 +648,7 @@ public class FeatureSettings extends Panel implements ItemListener,
 
   public void adjustmentValueChanged(AdjustmentEvent evt)
   {
-    fr.transparency = ((float) (100 - transparency.getValue()) / 100f);
+    fr.setTransparency((float) (100 - transparency.getValue()) / 100f);
     ap.seqPanel.seqCanvas.repaint();
 
   }
@@ -626,6 +656,7 @@ public class FeatureSettings extends Panel implements ItemListener,
   class MyCheckbox extends Checkbox
   {
     public String type;
+
     public int stringWidth;
 
     boolean hasLink;
@@ -648,7 +679,7 @@ public class FeatureSettings extends Panel implements ItemListener,
       }
       else
       {
-        throw new Error("Invalid color for MyCheckBox");
+        throw new Error(MessageManager.getString("error.invalid_colour_for_mycheckbox"));
       }
       if (col != null)
       {
@@ -657,14 +688,19 @@ public class FeatureSettings extends Panel implements ItemListener,
       else
       {
         String vlabel = type;
-        if (gcol.getThreshType()!=AnnotationColourGradient.NO_THRESHOLD)
+        if (gcol.getThreshType() != AnnotationColourGradient.NO_THRESHOLD)
         {
-          vlabel += " "+((gcol.getThreshType()==AnnotationColourGradient.ABOVE_THRESHOLD) ? "(>)" : "(<)");
+          vlabel += " "
+                  + ((gcol.getThreshType() == AnnotationColourGradient.ABOVE_THRESHOLD) ? "(>)"
+                          : "(<)");
         }
-        if (gcol.isColourByLabel()) {
+        if (gcol.isColourByLabel())
+        {
           setBackground(Color.white);
           vlabel += " (by Label)";
-        } else {
+        }
+        else
+        {
           setBackground(gcol.getMinColor());
         }
         this.setLabel(vlabel);
@@ -684,7 +720,7 @@ public class FeatureSettings extends Panel implements ItemListener,
     public MyCheckbox(String type, boolean selected, boolean b,
             Object featureStyle)
     {
-      this(type,selected,b);
+      this(type, selected, b);
       updateColor(featureStyle);
     }
 
@@ -696,24 +732,25 @@ public class FeatureSettings extends Panel implements ItemListener,
         if (gcol.isColourByLabel())
         {
           g.setColor(Color.white);
-          g.fillRect(d.width/2, 0,d.width/2, d.height);
-          /*g.setColor(Color.black); 
-          Font f=g.getFont().deriveFont(9);
-          g.setFont(f);
-
-          // g.setFont(g.getFont().deriveFont(
-          // AffineTransform.getScaleInstance(
-          // width/g.getFontMetrics().stringWidth("Label"),
-          // height/g.getFontMetrics().getHeight())));
-          g.drawString("Label", width/2, 0); */
+          g.fillRect(d.width / 2, 0, d.width / 2, d.height);
+          /*
+           * g.setColor(Color.black); Font f=g.getFont().deriveFont(9);
+           * g.setFont(f);
+           * 
+           * // g.setFont(g.getFont().deriveFont( //
+           * AffineTransform.getScaleInstance( //
+           * width/g.getFontMetrics().stringWidth("Label"), //
+           * height/g.getFontMetrics().getHeight()))); g.drawString("Label",
+           * width/2, 0);
+           */
 
         }
         else
         {
           Color maxCol = gcol.getMaxColor();
           g.setColor(maxCol);
-          g.fillRect(d.width/2, 0,d.width/2, d.height);
-          
+          g.fillRect(d.width / 2, 0, d.width / 2, d.height);
+
         }
       }
 
@@ -725,81 +762,4 @@ public class FeatureSettings extends Panel implements ItemListener,
     }
   }
 
-  protected void sortByDens(String[] typ)
-  {
-    sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
-  }
-
-  private String[] getDisplayedFeatureTypes()
-  {
-    String[] typ = null;
-    if (fr != null)
-    {
-      synchronized (fr.renderOrder)
-      {
-        typ = new String[fr.renderOrder.length];
-        System.arraycopy(fr.renderOrder, 0, typ, 0, typ.length);
-        for (int i = 0; i < typ.length; i++)
-        {
-          if (av.featuresDisplayed.get(typ[i]) == null)
-          {
-            typ[i] = null;
-          }
-        }
-      }
-    }
-    return typ;
-  }
-
-  protected void sortBy(String[] typ, String methodText, final String method)
-  {
-    if (typ == null)
-    {
-      typ = getDisplayedFeatureTypes();
-    }
-    String gps[] = null;
-    gps = fr.getGroups(true);
-    if (typ != null)
-    {
-      for (int i = 0; i < typ.length; i++)
-      {
-        System.err.println("Sorting on Types:" + typ[i]);
-      }
-    }
-    if (gps != null)
-    {
-
-      for (int i = 0; i < gps.length; i++)
-      {
-        System.err.println("Sorting on groups:" + gps[i]);
-      }
-    }
-    AlignmentPanel alignPanel = ap;
-    AlignmentI al = alignPanel.av.getAlignment();
-
-    int start, stop;
-    SequenceGroup sg = alignPanel.av.getSelectionGroup();
-    if (sg != null)
-    {
-      start = sg.getStartRes();
-      stop = sg.getEndRes();
-    }
-    else
-    {
-      start = 0;
-      stop = al.getWidth();
-    }
-    SequenceI[] oldOrder = al.getSequencesArray();
-    AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
-    this.ap.alignFrame.addHistoryItem(new OrderCommand(methodText,
-            oldOrder, alignPanel.av.getAlignment()));
-    alignPanel.paintAlignment(true);
-
-  }
-
-  protected void sortByScore(String[] typ)
-  {
-    sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
-  }
-
 }