Update features
[jalview.git] / src / jalview / gui / FeatureRenderer.java
index fdbd7eb..14dd1a0 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Copyright (C) 2006 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
@@ -25,6 +25,9 @@ import java.awt.*;
 import java.util.*;\r
 \r
 import java.awt.image.*;\r
+import javax.swing.*;\r
+import javax.swing.JOptionPane;\r
+import java.awt.event.*;\r
 \r
 \r
 /**\r
@@ -41,18 +44,19 @@ public class FeatureRenderer
     FontMetrics fm;\r
     int charOffset;\r
 \r
+    Hashtable featureColours = new Hashtable();\r
+\r
+\r
     // A higher level for grouping features of a\r
    // particular type\r
     Hashtable featureGroups = null;\r
 \r
-\r
     // This is actually an Integer held in the hashtable,\r
     // Retrieved using the key feature type\r
     Object currentColour;\r
 \r
     String [] renderOrder;\r
 \r
-\r
     /**\r
      * Creates a new FeatureRenderer object.\r
      *\r
@@ -61,7 +65,6 @@ public class FeatureRenderer
     public FeatureRenderer(AlignViewport av)\r
     {\r
         this.av = av;\r
-        initColours();\r
     }\r
 \r
     public void transferSettings(FeatureRenderer fr)\r
@@ -76,33 +79,30 @@ public class FeatureRenderer
     boolean offscreenRender = false;\r
     public Color findFeatureColour(Color initialCol, SequenceI seq, int res)\r
     {\r
-      int seqindex = av.alignment.findIndex(seq);\r
-\r
       return new Color( findFeatureColour (initialCol.getRGB(),\r
-                        seqindex, res ));\r
+                        seq, res ));\r
     }\r
 \r
     /**\r
-     * This is used by the Molecule Viewer to get the accurate colour\r
-     * of the rendered sequence\r
+     * This is used by the Molecule Viewer and Overview to\r
+     * get the accurate colourof the rendered sequence\r
      */\r
-    public int findFeatureColour(int initialCol, int seqIndex, int column)\r
+    public int findFeatureColour(int initialCol, SequenceI seq, int column)\r
     {\r
       if(!av.showSequenceFeatures)\r
         return initialCol;\r
 \r
-      if(seqIndex!=lastSequenceIndex)\r
+      if(seq!=lastSeq)\r
       {\r
-        lastSequence = av.alignment.getSequenceAt(seqIndex);\r
-        lastSequenceIndex = seqIndex;\r
-        sequenceFeatures = lastSequence.getDatasetSequence().getSequenceFeatures();\r
+        lastSeq = seq;\r
+        sequenceFeatures = lastSeq.getDatasetSequence().getSequenceFeatures();\r
         if(sequenceFeatures==null)\r
           return initialCol;\r
 \r
         sfSize = sequenceFeatures.length;\r
       }\r
 \r
-      if(jalview.util.Comparison.isGap(lastSequence.getCharAt(column)))\r
+      if(jalview.util.Comparison.isGap(lastSeq.getCharAt(column)))\r
         return Color.white.getRGB();\r
 \r
 \r
@@ -120,7 +120,7 @@ public class FeatureRenderer
       {\r
         offscreenImage.setRGB(0,0,initialCol);\r
         drawSequence(offscreenImage.getGraphics(),\r
-                     lastSequence,\r
+                     lastSeq,\r
                      column,column,0);\r
 \r
         return offscreenImage.getRGB(0,0);\r
@@ -128,8 +128,8 @@ public class FeatureRenderer
       else\r
       {\r
         drawSequence(null,\r
-                    lastSequence,\r
-                    lastSequence.findPosition(column),\r
+                    lastSeq,\r
+                    lastSeq.findPosition(column),\r
                     -1, -1);\r
 \r
         if (currentColour == null)\r
@@ -157,8 +157,7 @@ public class FeatureRenderer
      */\r
    // String type;\r
    // SequenceFeature sf;\r
-    int lastSequenceIndex=-1;\r
-    SequenceI lastSequence;\r
+    SequenceI lastSeq;\r
     SequenceFeature [] sequenceFeatures;\r
     int sfSize, sfindex, spos, epos;\r
 \r
@@ -169,12 +168,13 @@ public class FeatureRenderer
           || seq.getDatasetSequence().getSequenceFeatures().length==0)\r
         return;\r
 \r
-\r
       if(g!=null)\r
         fm = g.getFontMetrics();\r
 \r
 \r
-      if (av.featuresDisplayed == null || renderOrder==null)\r
+      if (av.featuresDisplayed == null\r
+          || renderOrder==null\r
+          || newFeatureAdded)\r
        {\r
          findAllFeatures();\r
          if(av.featuresDisplayed.size()<1)\r
@@ -184,9 +184,9 @@ public class FeatureRenderer
          sfSize = sequenceFeatures.length;\r
        }\r
 \r
-       if(lastSequence==null || seq!=lastSequence)\r
+       if(lastSeq==null || seq!=lastSeq)\r
       {\r
-        lastSequence = seq;\r
+        lastSeq = seq;\r
         sequenceFeatures = seq.getDatasetSequence().getSequenceFeatures();\r
         sfSize = sequenceFeatures.length;\r
       }\r
@@ -202,8 +202,8 @@ public class FeatureRenderer
 \r
       if(!offscreenRender)\r
       {\r
-        spos = lastSequence.findPosition(start);\r
-        epos = lastSequence.findPosition(end);\r
+        spos = lastSeq.findPosition(start);\r
+        epos = lastSeq.findPosition(end);\r
       }\r
 \r
 \r
@@ -211,6 +211,7 @@ public class FeatureRenderer
       for(int renderIndex=0; renderIndex<renderOrder.length; renderIndex++)\r
        {\r
         type =  renderOrder[renderIndex];\r
+\r
         if(!av.featuresDisplayed.containsKey(type))\r
           continue;\r
 \r
@@ -332,9 +333,34 @@ public class FeatureRenderer
       }\r
     }\r
 \r
-    void findAllFeatures()\r
+\r
+    boolean newFeatureAdded = false;\r
+\r
+    public void featuresAdded()\r
     {\r
-      av.featuresDisplayed = new Hashtable();\r
+      findAllFeatures();\r
+    }\r
+\r
+   boolean findingFeatures = false;\r
+   synchronized void findAllFeatures()\r
+   {\r
+      newFeatureAdded = false;\r
+\r
+      if(findingFeatures)\r
+      {\r
+        newFeatureAdded = true;\r
+        return;\r
+      }\r
+\r
+      findingFeatures = true;\r
+      jalview.schemes.UserColourScheme ucs = new\r
+          jalview.schemes.UserColourScheme();\r
+\r
+      if(av.featuresDisplayed==null)\r
+        av.featuresDisplayed = new Hashtable();\r
+\r
+      av.featuresDisplayed.clear();\r
+\r
       Vector allfeatures = new Vector();\r
       for (int i = 0; i < av.alignment.getHeight(); i++)\r
       {\r
@@ -349,9 +375,23 @@ public class FeatureRenderer
         {\r
           if (!av.featuresDisplayed.containsKey(features[index].getType()))\r
           {\r
-            av.featuresDisplayed.put(features[index].getType(),\r
-                                  new Integer( getColour(features[index].getType()).getRGB()) );\r
-            allfeatures.addElement(features[index].getType());\r
+            if(!(features[index].begin == 0 && features[index].end ==0))\r
+            {\r
+              // If beginning and end are 0, the feature is for the whole sequence\r
+              // and we don't want to render the feature in the normal way\r
+\r
+              if (getColour(features[index].getType()) == null)\r
+              {\r
+                 featureColours.put(features[index].getType(),\r
+                                   ucs.createColourFromName(features[index].\r
+                    getType()));\r
+              }\r
+\r
+              av.featuresDisplayed.put(features[index].getType(),\r
+                                       new Integer(getColour(features[index].\r
+                  getType()).getRGB()));\r
+              allfeatures.addElement(features[index].getType());\r
+            }\r
           }\r
           index++;\r
         }\r
@@ -365,24 +405,240 @@ public class FeatureRenderer
         renderOrder[i] = en.nextElement().toString();\r
         i--;\r
       }\r
+\r
+      findingFeatures = false;\r
     }\r
 \r
     public Color getColour(String featureType)\r
     {\r
-      return (Color)featureColours.get(featureType);\r
+      Color colour = (Color)featureColours.get(featureType);\r
+      return colour;\r
     }\r
 \r
-    public void addNewFeature(String name, Color col, String group)\r
+\r
+    static String lastFeatureAdded;\r
+    static String lastFeatureGroupAdded;\r
+    static String lastDescriptionAdded;\r
+\r
+    public boolean createNewFeatures(SequenceI[] sequences,\r
+                                  SequenceFeature [] features)\r
     {\r
+      return amendFeatures(sequences, features, true);\r
+    }\r
 \r
-      setColour(name, col);\r
-      if(av.featuresDisplayed==null)\r
-        av.featuresDisplayed = new Hashtable();\r
+    boolean amendFeatures(SequenceI[] sequences,\r
+                           final SequenceFeature [] features,\r
+                           boolean newFeatures)\r
+    {\r
+      JPanel bigPanel = new JPanel(new BorderLayout());\r
+      final JComboBox name = new JComboBox();\r
+      final JComboBox source = new JComboBox();\r
+      final JTextArea description = new JTextArea(3,25);\r
+      final JTextField start = new JTextField(6);\r
+      final JTextField end = new JTextField(6);\r
+      final JButton colour = new JButton("     ");\r
+      colour.setMaximumSize(new Dimension(40,10));\r
+      colour.setBackground(new Color(60, 160, 115));\r
+      colour.addActionListener(new ActionListener()\r
+          {\r
+            public void actionPerformed(ActionEvent evt)\r
+            {\r
+              colour.setBackground(\r
+                  JColorChooser.showDialog(Desktop.desktop,\r
+                                           "Select Feature Colour",\r
+                                           colour.getBackground()));\r
+            }\r
+          });\r
+\r
+      JPanel panel = new JPanel(new GridLayout(3, 2));\r
+      panel.add(new JLabel("Sequence Feature Name: ",JLabel.RIGHT));\r
+      panel.add(name);\r
+      panel.add(new JLabel("Feature Group: ", JLabel.RIGHT));\r
+      panel.add(source);\r
+      panel.add(new JLabel("Feature Colour: ", JLabel.RIGHT));\r
+      JPanel tmp = new JPanel();\r
+      tmp.add(colour);\r
+      colour.setPreferredSize(new Dimension(150,15));\r
+      panel.add(tmp);\r
+      name.setEditable(true);\r
+      source.setEditable(true);\r
+\r
+      bigPanel.add(panel, BorderLayout.NORTH);\r
+      panel = new JPanel();\r
+      panel.add(new JLabel("Description: ", JLabel.RIGHT));\r
+      description.setFont(new java.awt.Font("Verdana", Font.PLAIN, 11));\r
+      description.setLineWrap(true);\r
+      panel.add(new JScrollPane(description));\r
+\r
+      if(!newFeatures)\r
+      {\r
+        bigPanel.add(panel, BorderLayout.SOUTH);\r
+\r
+        panel = new JPanel();\r
+        panel.add(new JLabel("Start: ", JLabel.RIGHT));\r
+        panel.add(start);\r
+        panel.add(new JLabel("End: ", JLabel.RIGHT));\r
+        panel.add(end);\r
+        bigPanel.add(panel, BorderLayout.CENTER);\r
+      }\r
+      else\r
+        bigPanel.add(panel, BorderLayout.CENTER);\r
+\r
+      if (lastFeatureAdded == null)\r
+        if (features[0].type != null)\r
+          lastFeatureAdded = features[0].type;\r
+        else\r
+          lastFeatureAdded = "feature_1";\r
+\r
+      if (lastFeatureGroupAdded == null)\r
+        if (features[0].featureGroup != null)\r
+          lastFeatureGroupAdded = features[0].featureGroup;\r
+        else\r
+          lastFeatureAdded = "Jalview";\r
 \r
-      if(group == null)\r
-        group = "NOGROUP";\r
 \r
-      av.featuresDisplayed.put(name, new Integer(col.getRGB()));\r
+      Enumeration en;\r
+      if (featureGroups != null)\r
+      {\r
+        en = featureGroups.keys();\r
+        while (en.hasMoreElements())\r
+        {\r
+          source.addItem(en.nextElement().toString());\r
+        }\r
+      }\r
+\r
+      if (newFeatures)\r
+      {\r
+        if(av.featuresDisplayed != null)\r
+        {\r
+          en = av.featuresDisplayed.keys();\r
+          while (en.hasMoreElements())\r
+          {\r
+            name.addItem(en.nextElement().toString());\r
+          }\r
+        }\r
+\r
+        name.setSelectedItem(lastFeatureAdded);\r
+        source.setSelectedItem(lastFeatureGroupAdded);\r
+        description.setText(\r
+            lastDescriptionAdded == null ?\r
+            features[0].description : lastDescriptionAdded);\r
+      }\r
+      else if (!newFeatures)\r
+      {\r
+        for(int f=0; f<features.length; f++)\r
+        {\r
+          name.addItem(features[f].getType().toString());\r
+        }\r
+\r
+        description.setText(features[0].getDescription());\r
+        source.setSelectedItem(features[0].getFeatureGroup());\r
+        start.setText(features[0].getBegin()+"");\r
+        end.setText(features[0].getEnd()+"");\r
+        colour.setBackground(\r
+                getColour(name.getSelectedItem().toString()));\r
+        name.addItemListener(new ItemListener()\r
+        {\r
+          public void itemStateChanged(ItemEvent e)\r
+          {\r
+            int index = name.getSelectedIndex();\r
+            description.setText(features[index].getDescription());\r
+            source.setSelectedItem(features[index].getFeatureGroup());\r
+            start.setText(features[index].getBegin() + "");\r
+            end.setText(features[index].getEnd() + "");\r
+            colour.setBackground(\r
+                getColour(name.getSelectedItem().toString()));\r
+          }\r
+        });\r
+\r
+      }\r
+\r
+\r
+      Object [] options;\r
+      if(!newFeatures)\r
+        options = new Object[]{"Amend", "Delete", "Cancel"};\r
+      else\r
+        options = new Object[]{"OK", "Cancel"};\r
+\r
+      int reply = JOptionPane.showInternalOptionDialog(Desktop.desktop,\r
+                                                   bigPanel,\r
+                                                   newFeatures ?\r
+                                                   "Create New Sequence Feature(s)" :\r
+                                                   "Amend/Delete Features",\r
+                                                   JOptionPane.YES_NO_CANCEL_OPTION,\r
+                                                   JOptionPane.QUESTION_MESSAGE,\r
+                                                   null,\r
+                                                   options, null);\r
+\r
+      jalview.io.FeaturesFile ffile = new jalview.io.FeaturesFile();\r
+\r
+      if (reply == JOptionPane.OK_OPTION\r
+          && name.getSelectedItem() != null\r
+          && source.getSelectedItem() != null)\r
+      {\r
+        lastFeatureAdded = name.getSelectedItem().toString();\r
+        lastFeatureGroupAdded = source.getSelectedItem().toString();\r
+        lastDescriptionAdded = description.getText().replaceAll("\n", " ");\r
+      }\r
+\r
+      if(!newFeatures)\r
+      {\r
+        SequenceFeature sf = features[name.getSelectedIndex()];\r
+        if(reply==JOptionPane.NO_OPTION)\r
+          sequences[0].getDatasetSequence().deleteFeature(sf);\r
+        else if(reply==JOptionPane.YES_OPTION)\r
+        {\r
+          sf.type = lastFeatureAdded;\r
+          sf.featureGroup = lastFeatureGroupAdded;\r
+          sf.description = lastDescriptionAdded;\r
+          setColour(sf.type, colour.getBackground());\r
+          try{\r
+            sf.begin = Integer.parseInt( start.getText() );\r
+            sf.end = Integer.parseInt( end.getText() );\r
+          }catch(NumberFormatException ex)\r
+          {}\r
+\r
+          ffile.parseDescriptionHTML(sf, false);\r
+        }\r
+      }\r
+      else\r
+      {\r
+        if (reply == JOptionPane.OK_OPTION\r
+            && name.getSelectedItem() != null\r
+            && source.getSelectedItem() != null)\r
+        {\r
+          for (int i = 0; i < sequences.length; i++)\r
+          {\r
+            features[i].type = lastFeatureAdded;\r
+            features[i].featureGroup = lastFeatureGroupAdded;\r
+            features[i].description = lastDescriptionAdded;\r
+            sequences[i].addSequenceFeature(features[i]);\r
+            ffile.parseDescriptionHTML(features[i], false);\r
+          }\r
+\r
+          if (av.featuresDisplayed == null)\r
+            av.featuresDisplayed = new Hashtable();\r
+\r
+          if (featureGroups == null)\r
+            featureGroups = new Hashtable();\r
+\r
+          featureGroups.put(lastFeatureGroupAdded, new Boolean(true));\r
+\r
+          Color col = colour.getBackground();\r
+          setColour(lastFeatureAdded, colour.getBackground());\r
+\r
+          av.featuresDisplayed.put(lastFeatureGroupAdded,\r
+                                   new Integer(col.getRGB()));\r
+\r
+          findAllFeatures();\r
+\r
+          return true;\r
+        }\r
+        else\r
+          return false;\r
+      }\r
+\r
+      return true;\r
     }\r
 \r
     public void setColour(String featureType, Color col)\r
@@ -427,47 +683,7 @@ public class FeatureRenderer
 \r
     }\r
 \r
-    Hashtable featureColours = new Hashtable();\r
-    void initColours()\r
-    {\r
-      featureColours.put("active site", new Color(255, 75, 0));\r
-      featureColours.put("binding site", new Color(245, 85, 0));\r
-      featureColours.put("calcium-binding region", new Color(235, 95, 0));\r
-      featureColours.put("chain", new Color(225, 105, 0));\r
-      featureColours.put("coiled-coil region", new Color(215, 115, 0));\r
-      featureColours.put("compositionally biased region", new Color(205, 125, 0));\r
-      featureColours.put("cross-link", new Color(195, 135, 0));\r
-      featureColours.put("disulfide bond", new Color(230,230,0));\r
-      featureColours.put("DNA-binding region", new Color(175, 155, 0));\r
-      featureColours.put("domain", new Color(165, 165, 0));\r
-      featureColours.put("glycosylation site", new Color(155, 175, 0));\r
-      featureColours.put("helix", new Color(145, 185, 0));\r
-      featureColours.put("initiator methionine", new Color(135, 195, 5));\r
-      featureColours.put("lipid moiety-binding region", new Color(125, 205, 15));\r
-      featureColours.put("metal ion-binding site", new Color(115, 215, 25));\r
-      featureColours.put("modified residue", new Color(105, 225, 35));\r
-      featureColours.put("mutagenesis site", new Color(95, 235, 45));\r
-      featureColours.put("non-consecutive residues", new Color(85, 245, 55));\r
-      featureColours.put("non-terminal residue", new Color(75, 255, 65));\r
-      featureColours.put("nucleotide phosphate-binding region",new Color(65, 245, 75));\r
-      featureColours.put("peptide", new Color(55, 235, 85));\r
-      featureColours.put("propeptide", new Color(45, 225, 95));\r
-      featureColours.put("region of interest", new Color(35, 215, 105));\r
-      featureColours.put("repeat", new Color(25, 205, 115));\r
-      featureColours.put("selenocysteine", new Color(15, 195, 125));\r
-      featureColours.put("sequence conflict", new Color(5, 185, 135));\r
-      featureColours.put("sequence variant", new Color(0, 175, 145));\r
-      featureColours.put("short sequence motif", new Color(0, 165, 155));\r
-      featureColours.put("signal peptide", new Color(0, 155, 165));\r
-      featureColours.put("site", new Color(0, 145, 175));\r
-      featureColours.put("splice variant", new Color(0, 135, 185));\r
-      featureColours.put("strand", new Color(0, 125, 195));\r
-      featureColours.put("topological domain", new Color(0, 115, 205));\r
-      featureColours.put("transit peptide", new Color(0, 105, 215));\r
-      featureColours.put("transmembrane region", new Color(0, 95, 225));\r
-      featureColours.put("turn", new Color(0, 85, 235));\r
-      featureColours.put("unsure residue", new Color(0, 75, 245));\r
-      featureColours.put("zinc finger region", new Color(0, 65, 255));\r
-    }\r
+\r
+\r
 \r
 }\r