Merge branch 'develop' into features/JAL-3010ontologyFeatureSettings
[jalview.git] / src / jalview / gui / FeatureTypeSettings.java
index c572798..9609996 100644 (file)
@@ -29,6 +29,7 @@ import jalview.datamodel.features.FeatureMatcher;
 import jalview.datamodel.features.FeatureMatcherI;
 import jalview.datamodel.features.FeatureMatcherSet;
 import jalview.datamodel.features.FeatureMatcherSetI;
+import jalview.io.gff.SequenceOntologyFactory;
 import jalview.schemes.FeatureColour;
 import jalview.util.ColorUtils;
 import jalview.util.MessageManager;
@@ -49,7 +50,11 @@ import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.text.DecimalFormat;
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
 
 import javax.swing.BorderFactory;
 import javax.swing.BoxLayout;
@@ -118,10 +123,11 @@ public class FeatureTypeSettings extends JalviewDialog
 
   /*
    * the colour and filters to reset to on Cancel
+   * (including feature sub-types if modified)
    */
-  private final FeatureColourI originalColour;
+  private Map<String, FeatureColourI> originalColours;
 
-  private final FeatureMatcherSetI originalFilter;
+  private Map<String, FeatureMatcherSetI> originalFilters;
 
   /*
    * set flag to true when setting values programmatically,
@@ -206,36 +212,56 @@ public class FeatureTypeSettings extends JalviewDialog
 
   private JPanel chooseFiltersPanel;
 
-  /**
-   * Constructor
-   * 
-   * @param frender
-   * @param theType
+  /*
+   * feature types present in Feature Renderer which are
+   * sub-types of the one this editor is acting on
    */
-  public FeatureTypeSettings(FeatureRenderer frender, String theType)
-  {
-    this(frender, false, theType);
-  }
+  private final List<String> subTypes;
+
+  /*
+   * if true, filter or colour settings are also applied to 
+   * any feature sub-types in the Sequence Ontology
+   */
+  private boolean applyFiltersToSubtypes;
+
+  private boolean applyColourToSubtypes;
 
   /**
-   * Constructor, with option to make a blocking dialog (has to complete in the
-   * AWT event queue thread). Currently this option is always set to false.
+   * Constructor
    * 
    * @param frender
-   * @param blocking
    * @param theType
    */
-  FeatureTypeSettings(FeatureRenderer frender, boolean blocking,
-          String theType)
+  public FeatureTypeSettings(FeatureRenderer frender, String theType)
   {
     this.fr = frender;
     this.featureType = theType;
     ap = fr.ap;
-    originalFilter = fr.getFeatureFilter(theType);
-    originalColour = fr.getFeatureColours().get(theType);
 
-    adjusting = true;
+    /*
+     * determine sub-types (if any) of this feature type
+     */
+    List<String> types = fr.getRenderOrder();
+    subTypes = SequenceOntologyFactory.getInstance()
+            .getChildTerms(this.featureType, types);
+    Collections.sort(subTypes); // sort for ease of reading in tooltip
 
+    /*
+     * save original colours and filters for this feature type
+     * and any sub-types, to restore on Cancel
+     */
+    originalFilters = new HashMap<>();
+    originalFilters.put(theType, fr.getFeatureFilter(theType));
+    originalColours = new HashMap<>();
+    originalColours.put(theType, fr.getFeatureColours().get(theType));
+    for (String child : subTypes)
+    {
+      originalFilters.put(child, fr.getFeatureFilter(child));
+      originalColours.put(child, fr.getFeatureColours().get(child));
+    }
+
+    adjusting = true;
+    
     try
     {
       initialise();
@@ -244,20 +270,20 @@ public class FeatureTypeSettings extends JalviewDialog
       ex.printStackTrace();
       return;
     }
-
+    
     updateColoursTab();
-
+    
     updateFiltersTab();
-
+    
     adjusting = false;
-
+    
     colourChanged(false);
-
+    
     String title = MessageManager
             .formatMessage("label.display_settings_for", new String[]
             { theType });
-    initDialogFrame(this, true, blocking, title, 500, 500);
-
+    initDialogFrame(this, true, false, title, 500, 500);
+    
     waitForInput();
   }
 
@@ -280,9 +306,9 @@ public class FeatureTypeSettings extends JalviewDialog
        */
       if (fc.isSimpleColour())
       {
-        simpleColour.setSelected(true);
         singleColour.setBackground(fc.getColour());
         singleColour.setForeground(fc.getColour());
+        simpleColour.setSelected(true);
       }
 
       /*
@@ -577,12 +603,11 @@ public class FeatureTypeSettings extends JalviewDialog
     maxColour.setBorder(new LineBorder(Color.black));
 
     /*
-     * default max colour to current colour (if a plain colour),
-     * or to Black if colour by label;  make min colour a pale
-     * version of max colour
+     * default max colour to last plain colour;
+     * make min colour a pale version of max colour
      */
     FeatureColourI fc = fr.getFeatureColours().get(featureType);
-    Color bg = fc.isSimpleColour() ? fc.getColour() : Color.BLACK;
+    Color bg = fc.getColour() == null ? Color.BLACK : fc.getColour();
     maxColour.setBackground(bg);
     minColour.setBackground(ColorUtils.bleachColour(bg, 0.9f));
 
@@ -738,12 +763,19 @@ public class FeatureTypeSettings extends JalviewDialog
             MessageManager.getString("action.colour"), true);
 
     /*
+     * option to apply colour to sub-types as well (if there are any)
+     */
+    if (!subTypes.isEmpty())
+    {
+      applyColourToSubtypes = false;
+      colourByPanel.add(initSubtypesPanel(false));
+    }
+
+    /*
      * simple colour radio button and colour picker
      */
     JPanel simpleColourPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
     simpleColourPanel.setBackground(Color.white);
-//    JvSwingUtils.createTitledBorder(simpleColourPanel,
-//            MessageManager.getString("label.simple"), true);
     colourByPanel.add(simpleColourPanel);
 
     simpleColour = new JRadioButton(
@@ -756,15 +788,24 @@ public class FeatureTypeSettings extends JalviewDialog
       {
         if (simpleColour.isSelected() && !adjusting)
         {
-          showColourChooser(singleColour, "label.select_colour");
+          colourChanged(true);
         }
       }
-
     });
 
     singleColour.setFont(JvSwingUtils.getLabelFont());
     singleColour.setBorder(BorderFactory.createLineBorder(Color.black));
     singleColour.setPreferredSize(new Dimension(40, 20));
+    if (originalColour.isGraduatedColour())
+    {
+      singleColour.setBackground(originalColour.getMaxColour());
+      singleColour.setForeground(originalColour.getMaxColour());
+    }
+    else
+    {
+      singleColour.setBackground(originalColour.getColour());
+      singleColour.setForeground(originalColour.getColour());
+    }
     singleColour.addMouseListener(new MouseAdapter()
     {
       @Override
@@ -834,6 +875,46 @@ public class FeatureTypeSettings extends JalviewDialog
     return colourByPanel;
   }
 
+  /**
+   * Constructs and returns a panel with a checkbox for the option to apply any
+   * changes also to sub-types of the feature type
+   * 
+   * @return
+   */
+  protected JPanel initSubtypesPanel(final boolean forFilters)
+  {
+    JPanel toSubtypes = new JPanel(new FlowLayout(FlowLayout.LEFT));
+    toSubtypes.setBackground(Color.WHITE);
+    JCheckBox applyToSubtypesCB = new JCheckBox(MessageManager
+            .formatMessage("label.apply_to_subtypes", featureType));
+    applyToSubtypesCB.setToolTipText(getSubtypesTooltip());
+    applyToSubtypesCB.addActionListener(new ActionListener()
+    {
+      /*
+       * reset and reapply settings on toggle of checkbox
+       */
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        if (forFilters)
+        {
+          applyFiltersToSubtypes = applyToSubtypesCB.isSelected();
+          restoreOriginalFilters();
+          filtersChanged();
+        }
+        else
+        {
+          applyColourToSubtypes = applyToSubtypesCB.isSelected();
+          restoreOriginalColours();
+          colourChanged(true);
+        }
+      }
+    });
+    toSubtypes.add(applyToSubtypesCB);
+
+    return toSubtypes;
+  }
+
   private void showColourChooser(JPanel colourPanel, String key)
   {
     Color col = JColorChooser.showDialog(this,
@@ -873,9 +954,17 @@ public class FeatureTypeSettings extends JalviewDialog
     FeatureColourI acg = makeColourFromInputs();
 
     /*
-     * save the colour, and repaint stuff
+     * save the colour, and set on subtypes if selected
      */
     fr.setColour(featureType, acg);
+    if (applyColourToSubtypes)
+    {
+      for (String child : subTypes)
+      {
+        fr.setColour(child, acg);
+      }
+    }
+    refreshFeatureSettings();
     ap.paintAlignment(updateStructsAndOverview, updateStructsAndOverview);
 
     updateColoursTab();
@@ -901,8 +990,8 @@ public class FeatureTypeSettings extends JalviewDialog
      */
     if (byCategory.isSelected())
     {
-      Color c = this.getBackground();
-      FeatureColourI fc = new FeatureColour(c, c, null, 0f, 0f);
+      Color c = singleColour.getBackground();
+      FeatureColourI fc = new FeatureColour(c);
       fc.setColourByLabel(true);
       String byWhat = (String) colourByTextCombo.getSelectedItem();
       if (!LABEL_18N.equals(byWhat))
@@ -993,9 +1082,14 @@ public class FeatureTypeSettings extends JalviewDialog
   @Override
   protected void raiseClosed()
   {
+    refreshFeatureSettings();
+  }
+
+  protected void refreshFeatureSettings()
+  {
     if (this.featureSettings != null)
     {
-      featureSettings.actionPerformed(new ActionEvent(this, 0, "CLOSED"));
+      featureSettings.actionPerformed(new ActionEvent(this, 0, "REFRESH"));
     }
   }
 
@@ -1010,16 +1104,34 @@ public class FeatureTypeSettings extends JalviewDialog
 
   /**
    * Action on Cancel is to restore colour scheme and filters as they were when
-   * the dialog was opened
+   * the dialog was opened (including any feature sub-types that may have been
+   * changed)
    */
   @Override
   public void cancelPressed()
   {
-    fr.setColour(featureType, originalColour);
-    fr.setFeatureFilter(featureType, originalFilter);
+    restoreOriginalColours();
+    restoreOriginalFilters();
     ap.paintAlignment(true, true);
   }
 
+  protected void restoreOriginalFilters()
+  {
+    for (Entry<String, FeatureMatcherSetI> entry : originalFilters
+            .entrySet())
+    {
+      fr.setFeatureFilter(entry.getKey(), entry.getValue());
+    }
+  }
+
+  protected void restoreOriginalColours()
+  {
+    for (Entry<String, FeatureColourI> entry : originalColours.entrySet())
+    {
+      fr.setColour(entry.getKey(), entry.getValue());
+    }
+  }
+
   /**
    * Action on text entry of a threshold value
    */
@@ -1158,11 +1270,25 @@ public class FeatureTypeSettings extends JalviewDialog
   {
     filters = new ArrayList<>();
 
+    JPanel outerPanel = new JPanel();
+    outerPanel.setLayout(new BoxLayout(outerPanel, BoxLayout.Y_AXIS));
+    outerPanel.setBackground(Color.white);
+
+    /*
+     * option to apply colour to sub-types as well (if there are any)
+     */
+    if (!subTypes.isEmpty())
+    {
+      applyFiltersToSubtypes = false;
+      outerPanel.add(initSubtypesPanel(true));
+    }
+
     JPanel filtersPanel = new JPanel();
     filtersPanel.setLayout(new BoxLayout(filtersPanel, BoxLayout.Y_AXIS));
     filtersPanel.setBackground(Color.white);
     JvSwingUtils.createTitledBorder(filtersPanel,
             MessageManager.getString("label.filters"), true);
+    outerPanel.add(filtersPanel);
 
     JPanel andOrPanel = initialiseAndOrPanel();
     filtersPanel.add(andOrPanel);
@@ -1175,7 +1301,7 @@ public class FeatureTypeSettings extends JalviewDialog
     chooseFiltersPanel.setBackground(Color.white);
     filtersPanel.add(chooseFiltersPanel);
 
-    return filtersPanel;
+    return outerPanel;
   }
 
   /**
@@ -1185,8 +1311,13 @@ public class FeatureTypeSettings extends JalviewDialog
    */
   private JPanel initialiseAndOrPanel()
   {
-    JPanel andOrPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
+    JPanel andOrPanel = new JPanel(new BorderLayout());
     andOrPanel.setBackground(Color.white);
+
+//    JPanel panel1 = new JPanel(new FlowLayout(FlowLayout.LEFT));
+//    andOrPanel.add(panel1, BorderLayout.WEST);
+//    panel1.setBackground(Color.white);
+//    panel1.setBorder(BorderFactory.createLineBorder(debugBorderColour));
     andFilters = new JRadioButton(MessageManager.getString("label.and"));
     orFilters = new JRadioButton(MessageManager.getString("label.or"));
     ActionListener actionListener = new ActionListener()
@@ -1207,10 +1338,29 @@ public class FeatureTypeSettings extends JalviewDialog
             new JLabel(MessageManager.getString("label.join_conditions")));
     andOrPanel.add(andFilters);
     andOrPanel.add(orFilters);
+
     return andOrPanel;
   }
 
   /**
+   * Builds a tooltip for the 'Apply to subtypes' checkbox with a list of
+   * subtypes of this feature type
+   * 
+   * @return
+   */
+  protected String getSubtypesTooltip()
+  {
+    StringBuilder sb = new StringBuilder(20 * subTypes.size());
+    sb.append(MessageManager.getString("label.apply_also_to"));
+    for (String child : subTypes)
+    {
+      sb.append("<br>").append(child);
+    }
+    String tooltip = JvSwingUtils.wrapTooltip(true, sb.toString());
+    return tooltip;
+  }
+
+  /**
    * Refreshes the display to show any filters currently configured for the
    * selected feature type (editable, with 'remove' option), plus one extra row
    * for adding a condition. This should be called after a filter has been
@@ -1744,6 +1894,15 @@ public class FeatureTypeSettings extends JalviewDialog
      * (note this might now be an empty filter with no conditions)
      */
     fr.setFeatureFilter(featureType, combined.isEmpty() ? null : combined);
+    if (applyFiltersToSubtypes)
+    {
+      for (String child : subTypes)
+      {
+        fr.setFeatureFilter(child, combined.isEmpty() ? null : combined);
+      }
+    }
+
+    refreshFeatureSettings();
     ap.paintAlignment(true, true);
 
     updateFiltersTab();