default parameter for colours in annotation shading (JAL-234), ensure
[jalview.git] / src / jalview / appletgui / AnnotationColourChooser.java
index c932962..25e08b0 100755 (executable)
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * 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 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.
- *
- * 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
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, 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.appletgui;
 
@@ -27,16 +26,21 @@ import jalview.datamodel.*;
 import jalview.schemes.*;
 import java.awt.Rectangle;
 
-public class AnnotationColourChooser
-    extends Panel implements ActionListener,
-    AdjustmentListener, ItemListener, MouseListener
+public class AnnotationColourChooser extends Panel implements
+        ActionListener, AdjustmentListener, ItemListener, MouseListener
 {
   Frame frame;
+
   AlignViewport av;
+
   AlignmentPanel ap;
+
   ColourSchemeI oldcs;
+
   Hashtable oldgroupColours;
+
   jalview.datamodel.AlignmentAnnotation currentAnnotation;
+
   boolean adjusting = false;
 
   public AnnotationColourChooser(AlignViewport av, AlignmentPanel ap)
@@ -44,9 +48,9 @@ public class AnnotationColourChooser
     try
     {
       jbInit();
+    } catch (Exception ex)
+    {
     }
-    catch (Exception ex)
-    {}
 
     oldcs = av.getGlobalColourScheme();
     if (av.alignment.getGroups() != null)
@@ -57,10 +61,12 @@ public class AnnotationColourChooser
       for (int g = 0; g < allGroups.size(); g++)
       {
         sg = (SequenceGroup) allGroups.elementAt(g);
-        if (sg.cs!=null)
+        if (sg.cs != null)
+        {
+          oldgroupColours.put(sg, sg.cs);
+        }
+        else
         {
-            oldgroupColours.put(sg, sg.cs);
-        } else {
           oldgroupColours.put(sg, "null");
         }
       }
@@ -76,16 +82,17 @@ public class AnnotationColourChooser
       return;
     }
 
+    minColour.setBackground(av.applet.getDefaultColourParameter("ANNOTATIONCOLOUR_MIN",Color.orange));
+    maxColour.setBackground(av.applet.getDefaultColourParameter("ANNOTATIONCOLOUR_MAX",Color.red));
+
     if (oldcs instanceof AnnotationColourGradient)
     {
       AnnotationColourGradient acg = (AnnotationColourGradient) oldcs;
-      minColour.setBackground(acg.getMinColour());
-      maxColour.setBackground(acg.getMaxColour());
-    }
-    else
-    {
-      minColour.setBackground(Color.orange);
-      maxColour.setBackground(Color.red);
+      currentColours.setState(acg.predefinedColours);
+      if (!acg.predefinedColours) {
+        minColour.setBackground(acg.getMinColour());
+        maxColour.setBackground(acg.getMaxColour());
+      }
     }
 
     adjusting = true;
@@ -98,25 +105,47 @@ public class AnnotationColourChooser
       if (!list.contains(label))
         list.addElement(label);
       else
-        list.addElement(label+"_"+(index++));
+        list.addElement(label + "_" + (index++));
     }
 
     for (int i = 0; i < list.size(); i++)
     {
-        annotations.addItem(list.elementAt(i).toString());
+      annotations.addItem(list.elementAt(i).toString());
     }
 
     threshold.addItem("No Threshold");
     threshold.addItem("Above Threshold");
     threshold.addItem("Below Threshold");
 
+    if (oldcs instanceof AnnotationColourGradient)
+    {
+      AnnotationColourGradient acg = (AnnotationColourGradient) oldcs;
+      annotations.select(acg.getAnnotation());
+      switch (acg.getAboveThreshold()) {
+      case AnnotationColourGradient.NO_THRESHOLD:
+          threshold.select("No Threshold");
+        break;
+      case AnnotationColourGradient.ABOVE_THRESHOLD:
+          threshold.select("Above Threshold");
+        break;
+      case AnnotationColourGradient.BELOW_THRESHOLD:
+        threshold.select("Below Threshold");
+        break;
+        default:
+          throw new Error("Implementation error: don't know about threshold setting for current AnnotationColourGradient.");
+      }
+      thresholdIsMin.setState(acg.thresholdIsMinMax);
+      thresholdValue.setText(""+acg.getAnnotationThreshold());
+    }
+
     adjusting = false;
 
     changeColour();
 
     frame = new Frame();
     frame.add(this);
-    jalview.bin.JalviewLite.addFrame(frame, "Colour by Annotation", 480, 145);
+    jalview.bin.JalviewLite.addFrame(frame, "Colour by Annotation", 480,
+            145);
     validate();
   }
 
@@ -125,15 +154,13 @@ public class AnnotationColourChooser
     try
     {
       jbInit();
-    }
-    catch (Exception ex)
+    } catch (Exception ex)
     {
       ex.printStackTrace();
     }
   }
 
-  private void jbInit()
-      throws Exception
+  private void jbInit() throws Exception
   {
     minColour.setFont(new java.awt.Font("Verdana", Font.PLAIN, 11));
     minColour.setLabel("Min Colour");
@@ -191,19 +218,33 @@ public class AnnotationColourChooser
   }
 
   Choice annotations = new Choice();
+
   Button minColour = new Button();
+
   Button maxColour = new Button();
+
   Button ok = new Button();
+
   Button cancel = new Button();
+
   Panel jPanel1 = new Panel();
+
   Panel jPanel2 = new Panel();
+
   Choice threshold = new Choice();
+
   FlowLayout flowLayout1 = new FlowLayout();
+
   Panel jPanel3 = new Panel();
+
   Scrollbar slider = new Scrollbar(Scrollbar.HORIZONTAL);
+
   TextField thresholdValue = new TextField(20);
+
   Checkbox currentColours = new Checkbox();
+
   BorderLayout borderLayout1 = new BorderLayout();
+
   Checkbox thresholdIsMin = new Checkbox();
 
   public void actionPerformed(ActionEvent evt)
@@ -213,11 +254,11 @@ public class AnnotationColourChooser
       try
       {
         float f = new Float(thresholdValue.getText()).floatValue();
-        slider.setValue( (int) (f * 1000));
+        slider.setValue((int) (f * 1000));
         adjustmentValueChanged(null);
+      } catch (NumberFormatException ex)
+      {
       }
-      catch (NumberFormatException ex)
-      {}
     }
     else if (evt.getSource() == minColour)
     {
@@ -267,9 +308,9 @@ public class AnnotationColourChooser
   {
     if (!adjusting)
     {
-      thresholdValue.setText( ( (float) slider.getValue() / 1000f) + "");
+      thresholdValue.setText(((float) slider.getValue() / 1000f) + "");
       if (currentColours.getState()
-          && ! (av.getGlobalColourScheme() instanceof AnnotationColourGradient))
+              && !(av.getGlobalColourScheme() instanceof AnnotationColourGradient))
       {
         changeColour();
       }
@@ -289,8 +330,7 @@ public class AnnotationColourChooser
     }
     else
     {
-      new UserDefinedColours(this, "Min Colour",
-                             minColour.getBackground());
+      new UserDefinedColours(this, "Min Colour", minColour.getBackground());
     }
 
   }
@@ -305,8 +345,7 @@ public class AnnotationColourChooser
     }
     else
     {
-      new UserDefinedColours(this, "Max Colour",
-                             maxColour.getBackground());
+      new UserDefinedColours(this, "Max Colour", maxColour.getBackground());
     }
   }
 
@@ -318,9 +357,8 @@ public class AnnotationColourChooser
       return;
     }
 
-
-    currentAnnotation = av.alignment.getAlignmentAnnotation()
-        [annotations.getSelectedIndex()];
+    currentAnnotation = av.alignment.getAlignmentAnnotation()[annotations
+            .getSelectedIndex()];
 
     int aboveThreshold = -1;
     if (threshold.getSelectedItem().equals("Above Threshold"))
@@ -341,23 +379,22 @@ public class AnnotationColourChooser
       thresholdValue.setEnabled(false);
       thresholdValue.setText("");
     }
-    else if (aboveThreshold != AnnotationColourGradient.NO_THRESHOLD &&
-             currentAnnotation.threshold == null)
-    {
-      currentAnnotation.setThreshold(new jalview.datamodel.GraphLine
-                                     ( (currentAnnotation.graphMax -
-                                        currentAnnotation.graphMin) / 2f,
-                                      "Threshold",
-                                      Color.black));
+    else if (aboveThreshold != AnnotationColourGradient.NO_THRESHOLD
+            && currentAnnotation.threshold == null)
+    {
+      currentAnnotation
+              .setThreshold(new jalview.datamodel.GraphLine(
+                      (currentAnnotation.graphMax - currentAnnotation.graphMin) / 2f,
+                      "Threshold", Color.black));
     }
 
     if (aboveThreshold != AnnotationColourGradient.NO_THRESHOLD)
     {
       adjusting = true;
 
-      slider.setMinimum( (int) (currentAnnotation.graphMin * 1000));
-      slider.setMaximum( (int) (currentAnnotation.graphMax * 1000));
-      slider.setValue( (int) (currentAnnotation.threshold.value * 1000));
+      slider.setMinimum((int) (currentAnnotation.graphMin * 1000));
+      slider.setMaximum((int) (currentAnnotation.graphMax * 1000));
+      slider.setValue((int) (currentAnnotation.threshold.value * 1000));
       thresholdValue.setText(currentAnnotation.threshold.value + "");
       slider.setEnabled(true);
       thresholdValue.setEnabled(true);
@@ -367,21 +404,18 @@ public class AnnotationColourChooser
     AnnotationColourGradient acg = null;
     if (currentColours.getState())
     {
-      acg = new AnnotationColourGradient(
-          currentAnnotation,
-          av.getGlobalColourScheme(), aboveThreshold);
+      acg = new AnnotationColourGradient(currentAnnotation,
+              av.getGlobalColourScheme(), aboveThreshold);
     }
     else
     {
-      acg =
-          new AnnotationColourGradient(
-              currentAnnotation,
-              minColour.getBackground(),
-              maxColour.getBackground(),
+      acg = new AnnotationColourGradient(currentAnnotation,
+              minColour.getBackground(), maxColour.getBackground(),
               aboveThreshold);
     }
 
-    if (currentAnnotation.graphMin == 0f && currentAnnotation.graphMax == 0f)
+    if (currentAnnotation.graphMin == 0f
+            && currentAnnotation.graphMax == 0f)
     {
       acg.predefinedColours = true;
     }
@@ -405,23 +439,21 @@ public class AnnotationColourChooser
 
         if (currentColours.getState())
         {
-          sg.cs = new AnnotationColourGradient(
-              currentAnnotation,
-              sg.cs, aboveThreshold);
+          sg.cs = new AnnotationColourGradient(currentAnnotation, sg.cs,
+                  aboveThreshold);
         }
         else
         {
-          sg.cs = new AnnotationColourGradient(
-              currentAnnotation,
-              minColour.getBackground(),
-              maxColour.getBackground(),
-              aboveThreshold);
+          sg.cs = new AnnotationColourGradient(currentAnnotation,
+                  minColour.getBackground(), maxColour.getBackground(),
+                  aboveThreshold);
         }
 
       }
     }
 
-    ap.paintAlignment(false);
+    // update colours in linked windows
+    ap.paintAlignment(true);
   }
 
   void reset()
@@ -437,8 +469,10 @@ public class AnnotationColourChooser
         Object cs = oldgroupColours.get(sg);
         if (cs instanceof ColourSchemeI)
         {
-          sg.cs = (ColourSchemeI) cs; 
-        } else {
+          sg.cs = (ColourSchemeI) cs;
+        }
+        else
+        {
           // probably the "null" string we set it to if it was null originally.
           sg.cs = null;
         }
@@ -448,11 +482,25 @@ public class AnnotationColourChooser
 
   }
 
-  public void mouseClicked(MouseEvent evt){}
-  public void mousePressed(MouseEvent evt){}
-  public void mouseReleased(MouseEvent evt){ ap.paintAlignment(true);}
-  public void mouseEntered(MouseEvent evt){}
-  public void mouseExited(MouseEvent evt){}
+  public void mouseClicked(MouseEvent evt)
+  {
+  }
+
+  public void mousePressed(MouseEvent evt)
+  {
+  }
+
+  public void mouseReleased(MouseEvent evt)
+  {
+    ap.paintAlignment(true);
+  }
 
+  public void mouseEntered(MouseEvent evt)
+  {
+  }
+
+  public void mouseExited(MouseEvent evt)
+  {
+  }
 
 }