JAL-3210 merge. j2sclasslist_jmol seems to be removed
[jalview.git] / src / jalview / gui / FeatureSettings.java
index 0cd8620..5aa9499 100644 (file)
  */
 package jalview.gui;
 
+import jalview.api.AlignViewportI;
 import jalview.api.FeatureColourI;
 import jalview.api.FeatureSettingsControllerI;
+import jalview.api.ViewStyleI;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.SequenceI;
 import jalview.datamodel.features.FeatureMatcher;
@@ -36,6 +38,7 @@ import jalview.schemes.FeatureColour;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.viewmodel.seqfeatures.FeatureRendererModel.FeatureSettingsBean;
+import jalview.viewmodel.styles.ViewStyle;
 import jalview.xml.binding.jalview.JalviewUserColours;
 import jalview.xml.binding.jalview.JalviewUserColours.Colour;
 import jalview.xml.binding.jalview.JalviewUserColours.Filter;
@@ -45,6 +48,7 @@ import java.awt.BorderLayout;
 import java.awt.Color;
 import java.awt.Component;
 import java.awt.Dimension;
+import java.awt.FlowLayout;
 import java.awt.Font;
 import java.awt.Graphics;
 import java.awt.GridLayout;
@@ -131,7 +135,8 @@ public class FeatureSettings extends JPanel
 
   private static final int MIN_HEIGHT = 400;
 
-  private final static String BASE_TOOLTIP = MessageManager.getString("label.click_to_edit");
+  private final static String BASE_TOOLTIP = MessageManager
+          .getString("label.click_to_edit");
 
   final FeatureRenderer fr;
 
@@ -144,7 +149,9 @@ public class FeatureSettings extends JPanel
 
   float originalTransparency;
 
-  Map<String, FeatureMatcherSetI> originalFilters;
+  private ViewStyleI originalViewStyle;
+
+  private Map<String, FeatureMatcherSetI> originalFilters;
 
   final JInternalFrame frame;
 
@@ -191,6 +198,7 @@ public class FeatureSettings extends JPanel
     transparency.setMaximum(100 - originalTransparencyAsPercent);
 
     originalFilters = new HashMap<>(fr.getFeatureFilters()); // shallow copy
+    originalViewStyle = new ViewStyle(af.viewport.getViewStyle());
 
     try
     {
@@ -231,10 +239,9 @@ public class FeatureSettings extends JPanel
         default:
           break;
         }
-        
+
         return tip;
       }
-      
 
       /**
        * Position the tooltip near the bottom edge of, and half way across, the
@@ -261,7 +268,7 @@ public class FeatureSettings extends JPanel
 
     table.setDefaultEditor(FeatureMatcherSet.class, new FilterEditor());
     table.setDefaultRenderer(FeatureMatcherSet.class, new FilterRenderer());
-    
+
     TableColumn colourColumn = new TableColumn(COLOUR_COLUMN, 75,
             new ColorRenderer(), new ColorEditor());
     table.addColumn(colourColumn);
@@ -277,20 +284,23 @@ public class FeatureSettings extends JPanel
       @Override
       public void mousePressed(MouseEvent evt)
       {
-        selectedRow = table.rowAtPoint(evt.getPoint());
+        Point pt = evt.getPoint();
+        selectedRow = table.rowAtPoint(pt);
         String type = (String) table.getValueAt(selectedRow, TYPE_COLUMN);
         if (evt.isPopupTrigger())
         {
           Object colour = table.getValueAt(selectedRow, COLOUR_COLUMN);
           showPopupMenu(selectedRow, type, colour, evt.getPoint());
         }
-        else if (evt.getClickCount() == 2)
+        else if (evt.getClickCount() == 2
+                && table.columnAtPoint(pt) == TYPE_COLUMN)
         {
           boolean invertSelection = evt.isAltDown();
           boolean toggleSelection = Platform.isControlDown(evt);
           boolean extendSelection = evt.isShiftDown();
           fr.ap.alignFrame.avc.markColumnsContainingFeatures(
                   invertSelection, extendSelection, toggleSelection, type);
+          fr.ap.av.sendSelection();
         }
       }
 
@@ -379,21 +389,21 @@ public class FeatureSettings extends JPanel
                       javax.swing.event.InternalFrameEvent evt)
               {
                 fr.removePropertyChangeListener(change);
-              };
+              }
             });
     frame.setLayer(JLayeredPane.PALETTE_LAYER);
     inConstruction = false;
   }
 
-       /**
-        * Constructs and shows a popup menu of possible actions on the selected row and
-        * feature type
-        * 
-        * @param rowSelected
-        * @param type
-        * @param typeCol
-        * @param pt
-        */
+  /**
+   * Constructs and shows a popup menu of possible actions on the selected row
+   * and feature type
+   * 
+   * @param rowSelected
+   * @param type
+   * @param typeCol
+   * @param pt
+   */
   protected void showPopupMenu(final int rowSelected, final String type,
           final Object typeCol, final Point pt)
   {
@@ -409,7 +419,7 @@ public class FeatureSettings extends JPanel
             MessageManager.getString("label.variable_colour"));
     variableColourCB.setSelected(!featureColour.isSimpleColour());
     men.add(variableColourCB);
-    
+
     /*
      * checkbox action listener doubles up as listener to OK
      * from the variable colour / filters dialog
@@ -421,8 +431,10 @@ public class FeatureSettings extends JPanel
       {
         if (e.getSource() == variableColourCB)
         {
-          men.setVisible(true); // BH 2018 for JavaScript because this is a checkbox
-          men.setVisible(false); // BH 2018 for JavaScript because this is a checkbox
+          men.setVisible(true); // BH 2018 for JavaScript because this is a
+                                // checkbox
+          men.setVisible(false); // BH 2018 for JavaScript because this is a
+                                 // checkbox
           if (featureColour.isSimpleColour())
           {
             /*
@@ -436,7 +448,8 @@ public class FeatureSettings extends JPanel
             /*
              * toggle variable to simple colour - show colour chooser
              */
-            String title = MessageManager.formatMessage("label.select_colour_for", type);
+            String title = MessageManager
+                    .formatMessage("label.select_colour_for", type);
             ColourChooserListener listener = new ColourChooserListener()
             {
               @Override
@@ -450,11 +463,11 @@ public class FeatureSettings extends JPanel
                         false);
               }
             };
-            JalviewColourChooser.showColourChooser(FeatureSettings.this, title,
-               featureColour.getMaxColour(), listener);
+            JalviewColourChooser.showColourChooser(FeatureSettings.this,
+                    title, featureColour.getMaxColour(), listener);
           }
         }
-        else    
+        else
         {
           if (e.getSource() instanceof FeatureTypeSettings)
           {
@@ -465,13 +478,13 @@ public class FeatureSettings extends JPanel
             FeatureColourI fci = fr.getFeatureColours().get(type);
             table.setValueAt(fci, rowSelected, COLOUR_COLUMN);
             // BH 2018 setting a table value does not invalidate it.
-//                 System.out.println("FeatureSettings is valied" + table.isValid());
-//                 table.validate();
+            // System.out.println("FeatureSettings is valied" +
+            // table.validate();
           }
         }
       }
     });
-    
+
     men.addSeparator();
 
     JMenuItem scr = new JMenuItem(
@@ -510,6 +523,7 @@ public class FeatureSettings extends JPanel
       {
         fr.ap.alignFrame.avc.markColumnsContainingFeatures(false, false,
                 false, type);
+        fr.ap.av.sendSelection();
       }
     });
     JMenuItem clearCols = new JMenuItem(MessageManager
@@ -521,6 +535,7 @@ public class FeatureSettings extends JPanel
       {
         fr.ap.alignFrame.avc.markColumnsContainingFeatures(true, false,
                 false, type);
+        fr.ap.av.sendSelection();
       }
     });
     JMenuItem hideCols = new JMenuItem(
@@ -531,6 +546,7 @@ public class FeatureSettings extends JPanel
       public void actionPerformed(ActionEvent arg0)
       {
         fr.ap.alignFrame.hideFeatureColumns(type, true);
+        fr.ap.av.sendSelection();
       }
     });
     JMenuItem hideOtherCols = new JMenuItem(
@@ -541,6 +557,7 @@ public class FeatureSettings extends JPanel
       public void actionPerformed(ActionEvent arg0)
       {
         fr.ap.alignFrame.hideFeatureColumns(type, false);
+        fr.ap.av.sendSelection();
       }
     });
     men.add(selCols);
@@ -604,7 +621,7 @@ public class FeatureSettings extends JPanel
       {
         fr.setGroupVisibility(check.getText(), check.isSelected());
         resetTable(new String[] { grp });
-        af.alignPanel.paintAlignment(true, true);
+        refreshDisplay();
       }
     });
     groupPanel.add(check);
@@ -702,7 +719,7 @@ public class FeatureSettings extends JPanel
         data[dataIndex][FILTER_COLUMN] = featureFilter == null
                 ? new FeatureMatcherSet()
                 : featureFilter;
-        data[dataIndex][SHOW_COLUMN] = new Boolean(
+        data[dataIndex][SHOW_COLUMN] = Boolean.valueOf(
                 af.getViewport().getFeaturesDisplayed().isVisible(type));
         dataIndex++;
         displayableTypes.remove(type);
@@ -729,7 +746,7 @@ public class FeatureSettings extends JPanel
       data[dataIndex][FILTER_COLUMN] = featureFilter == null
               ? new FeatureMatcherSet()
               : featureFilter;
-      data[dataIndex][SHOW_COLUMN] = new Boolean(true);
+      data[dataIndex][SHOW_COLUMN] = Boolean.valueOf(true);
       dataIndex++;
       displayableTypes.remove(type);
     }
@@ -760,8 +777,8 @@ public class FeatureSettings extends JPanel
   }
 
   /**
-   * Updates 'originalData' (used for restore on Cancel) if we detect that changes
-   * have been made outwith this dialog
+   * Updates 'originalData' (used for restore on Cancel) if we detect that
+   * changes have been made outwith this dialog
    * <ul>
    * <li>a new feature type added (and made visible)</li>
    * <li>a feature colour changed (in the Amend Features dialog)</li>
@@ -825,8 +842,8 @@ public class FeatureSettings extends JPanel
 
   /**
    * Remove from the groups panel any checkboxes for groups that are not in the
-   * foundGroups set. This enables removing a group from the display when the last
-   * feature in that group is deleted.
+   * foundGroups set. This enables removing a group from the display when the
+   * last feature in that group is deleted.
    * 
    * @param foundGroups
    */
@@ -883,13 +900,13 @@ public class FeatureSettings extends JPanel
     chooser.setToolTipText(MessageManager.getString("action.load"));
     chooser.setResponseHandler(0, new Runnable()
     {
-         @Override
-         public void run() 
-         {
-           File file = chooser.getSelectedFile();
-               load(file);
-         }
-       });
+      @Override
+      public void run()
+      {
+        File file = chooser.getSelectedFile();
+        load(file);
+      }
+    });
     chooser.showOpenDialog(this);
   }
 
@@ -950,8 +967,7 @@ public class FeatureSettings extends JPanel
       if (table != null)
       {
         resetTable(null);
-        Object[][] data = ((FeatureTableModel) table.getModel())
-                .getData();
+        Object[][] data = ((FeatureTableModel) table.getModel()).getData();
         ensureOrder(data);
         updateFeatureRenderer(data, false);
         table.repaint();
@@ -975,11 +991,11 @@ public class FeatureSettings extends JPanel
             MessageManager.getString("label.save_feature_colours"));
     chooser.setToolTipText(MessageManager.getString("action.save"));
     int option = chooser.showSaveDialog(this);
-       if (option == JalviewFileChooser.APPROVE_OPTION) 
-       {
-         File file = chooser.getSelectedFile();
-         save(file);
-       }
+    if (option == JalviewFileChooser.APPROVE_OPTION)
+    {
+      File file = chooser.getSelectedFile();
+      save(file);
+    }
   }
 
   /**
@@ -993,8 +1009,8 @@ public class FeatureSettings extends JPanel
     ucs.setSchemeName("Sequence Features");
     try
     {
-      PrintWriter out = new PrintWriter(new OutputStreamWriter(
-              new FileOutputStream(file), "UTF-8"));
+      PrintWriter out = new PrintWriter(
+              new OutputStreamWriter(new FileOutputStream(file), "UTF-8"));
 
       /*
        * sort feature types by colour order, from 0 (highest)
@@ -1031,11 +1047,11 @@ public class FeatureSettings extends JPanel
         FeatureMatcherSetI filter = fr.getFeatureFilter(featureType);
         if (filter != null && !filter.isEmpty())
         {
-          Iterator<FeatureMatcherI> iterator = filter.getMatchers().iterator();
+          Iterator<FeatureMatcherI> iterator = filter.getMatchers()
+                  .iterator();
           FeatureMatcherI firstMatcher = iterator.next();
           jalview.xml.binding.jalview.FeatureMatcherSet ms = jalview.project.Jalview2XML
-                  .marshalFilter(firstMatcher, iterator,
-                  filter.isAnded());
+                  .marshalFilter(firstMatcher, iterator, filter.isAnded());
           Filter filterModel = new Filter();
           filterModel.setFeatureType(featureType);
           filterModel.setMatcherSet(ms);
@@ -1117,7 +1133,8 @@ public class FeatureSettings extends JPanel
       else
       {
         width[i] /= max; // normalize
-        fr.setOrder(data[i][TYPE_COLUMN].toString(), width[i]); // store for later
+        fr.setOrder(data[i][TYPE_COLUMN].toString(), width[i]); // store for
+                                                                // later
       }
       if (i > 0)
       {
@@ -1151,8 +1168,8 @@ public class FeatureSettings extends JPanel
   }
 
   /**
-   * Update the priority order of features; only repaint if this changed the order
-   * of visible features
+   * Update the priority order of features; only repaint if this changed the
+   * order of visible features
    * 
    * @param data
    * @param visibleNew
@@ -1163,7 +1180,7 @@ public class FeatureSettings extends JPanel
 
     if (fr.setFeaturePriority(rowData, visibleNew))
     {
-      af.alignPanel.paintAlignment(true, true);
+      refreshDisplay();
     }
   }
 
@@ -1272,6 +1289,7 @@ public class FeatureSettings extends JPanel
         fr.setTransparency(originalTransparency);
         fr.setFeatureFilters(originalFilters);
         updateFeatureRenderer(originalData);
+        af.getViewport().setViewStyle(originalViewStyle);
         close();
       }
     });
@@ -1322,7 +1340,7 @@ public class FeatureSettings extends JPanel
         if (!inConstruction)
         {
           fr.setTransparency((100 - transparency.getValue()) / 100f);
-          af.alignPanel.paintAlignment(true, true);
+          refreshDisplay();
         }
       }
     });
@@ -1331,8 +1349,42 @@ public class FeatureSettings extends JPanel
     transparency.setToolTipText(
             MessageManager.getString("label.transparency_tip"));
 
-    JPanel transPanel = new JPanel(new GridLayout(1, 2));
-    bigPanel.add(transPanel, BorderLayout.SOUTH);
+    boolean nucleotide = af.getViewport().getAlignment().isNucleotide();
+    String text = MessageManager.formatMessage("label.show_linked_features",
+            nucleotide
+                    ? MessageManager.getString("label.protein")
+                            .toLowerCase()
+                    : "CDS");
+    JCheckBox showComplement = new JCheckBox(text);
+    showComplement.setSelected(af.getViewport().isShowComplementFeatures());
+    showComplement.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        af.getViewport()
+                .setShowComplementFeatures(showComplement.isSelected());
+        refreshDisplay();
+      }
+    });
+
+    JCheckBox showComplementOnTop = new JCheckBox(
+            MessageManager.getString("label.on_top"));
+    showComplementOnTop
+            .setSelected(af.getViewport().isShowComplementFeaturesOnTop());
+    showComplementOnTop.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        af.getViewport().setShowComplementFeaturesOnTop(
+                showComplementOnTop.isSelected());
+        refreshDisplay();
+      }
+    });
+
+    JPanel lowerPanel = new JPanel(new GridLayout(1, 2));
+    bigPanel.add(lowerPanel, BorderLayout.SOUTH);
 
     JPanel transbuttons = new JPanel(new GridLayout(5, 1));
     transbuttons.add(optimizeOrder);
@@ -1340,8 +1392,21 @@ public class FeatureSettings extends JPanel
     transbuttons.add(sortByScore);
     transbuttons.add(sortByDens);
     transbuttons.add(help);
-    transPanel.add(transparency);
-    transPanel.add(transbuttons);
+
+    boolean hasComplement = af.getViewport().getCodingComplement() != null;
+    JPanel transPanelLeft = new JPanel(
+            new GridLayout(hasComplement ? 3 : 2, 1));
+    transPanelLeft.add(new JLabel(" Colour transparency" + ":"));
+    transPanelLeft.add(transparency);
+    if (hasComplement)
+    {
+      JPanel cp = new JPanel(new FlowLayout(FlowLayout.LEFT));
+      cp.add(showComplement);
+      cp.add(showComplementOnTop);
+      transPanelLeft.add(cp);
+    }
+    lowerPanel.add(transPanelLeft);
+    lowerPanel.add(transbuttons);
 
     JPanel buttonPanel = new JPanel();
     buttonPanel.add(ok);
@@ -1355,11 +1420,27 @@ public class FeatureSettings extends JPanel
   }
 
   /**
+   * Repaints alignment, structure and overview (if shown). If there is a
+   * complementary view which is showing this view's features, then also
+   * repaints that.
+   */
+  void refreshDisplay()
+  {
+    af.alignPanel.paintAlignment(true, true);
+    AlignViewportI complement = af.getViewport().getCodingComplement();
+    if (complement != null && complement.isShowComplementFeatures())
+    {
+      AlignFrame af2 = Desktop.getAlignFrameFor(complement);
+      af2.alignPanel.paintAlignment(true, true);
+    }
+  }
+
+  /**
    * Answers a suitable tooltip to show on the colour cell of the table
    * 
    * @param fcol
    * @param withHint
-   *          if true include 'click to edit' and similar text
+   *                   if true include 'click to edit' and similar text
    * @return
    */
   public static String getColorTooltip(FeatureColourI fcol,
@@ -1389,7 +1470,7 @@ public class FeatureSettings extends JPanel
   {
     boolean thr = false;
     StringBuilder tx = new StringBuilder();
-  
+
     if (gcol.isColourByAttribute())
     {
       tx.append(FeatureMatcher
@@ -1496,13 +1577,22 @@ public class FeatureSettings extends JPanel
     }
 
     /**
-     * Answers the class of the object in column c of the first row of the table
+     * Answers the class of column c of the table
      */
     @Override
     public Class<?> getColumnClass(int c)
     {
-      Object v = getValueAt(0, c);
-      return v == null ? null : v.getClass();
+      switch (c)
+      {
+      case TYPE_COLUMN:
+        return String.class;
+      case COLOUR_COLUMN:
+        return FeatureColour.class;
+      case FILTER_COLUMN:
+        return FeatureMatcherSet.class;
+      default:
+        return Boolean.class;
+      }
     }
 
     @Override
@@ -1647,7 +1737,7 @@ public class FeatureSettings extends JPanel
   }
 
   @SuppressWarnings("serial")
-class ColorEditor extends AbstractCellEditor
+  class ColorEditor extends AbstractCellEditor
           implements TableCellEditor, ActionListener
   {
     FeatureColourI currentColor;
@@ -1688,8 +1778,9 @@ class ColorEditor extends AbstractCellEditor
           /*
            * simple colour chooser
            */
-          String ttl = MessageManager.formatMessage("label.select_colour_for", type);
-          ColourChooserListener listener = new ColourChooserListener() 
+          String ttl = MessageManager
+                  .formatMessage("label.select_colour_for", type);
+          ColourChooserListener listener = new ColourChooserListener()
           {
             @Override
             public void colourSelected(Color c)
@@ -1698,13 +1789,15 @@ class ColorEditor extends AbstractCellEditor
               table.setValueAt(currentColor, rowSelected, COLOUR_COLUMN);
               fireEditingStopped();
             }
-                       @Override
-                       public void cancel() 
-                       {
-                 fireEditingStopped();
-                       }
+
+            @Override
+            public void cancel()
+            {
+              fireEditingStopped();
+            }
           };
-          JalviewColourChooser.showColourChooser(button,  ttl,  currentColor.getColour(), listener);
+          JalviewColourChooser.showColourChooser(button, ttl,
+                  currentColor.getColour(), listener);
         }
         else
         {
@@ -1716,7 +1809,7 @@ class ColorEditor extends AbstractCellEditor
           /**
            * Java only
            * 
-           * @j2sNative
+           * @j2sIgnore
            */
           {
             chooser.setRequestFocusEnabled(true);
@@ -1744,7 +1837,7 @@ class ColorEditor extends AbstractCellEditor
         data[COLOUR_COLUMN] = currentColor;
         data[FILTER_COLUMN] = currentFilter;
         fireEditingStopped();
-        // SwingJS needs an explicit repaint() here, 
+        // SwingJS needs an explicit repaint() here,
         // rather than relying upon no validation having
         // occurred since the stopEditing call was made.
         // Its laying out has not been stopped by the modal frame
@@ -1754,15 +1847,15 @@ class ColorEditor extends AbstractCellEditor
     }
 
     /**
-     * Override allows access to this method from anonymous inner classes 
+     * Override allows access to this method from anonymous inner classes
      */
     @Override
-       protected void fireEditingStopped() 
+    protected void fireEditingStopped()
     {
-           super.fireEditingStopped();
-       }
+      super.fireEditingStopped();
+    }
 
-       // Implement the one CellEditor method that AbstractCellEditor doesn't.
+    // Implement the one CellEditor method that AbstractCellEditor doesn't.
     @Override
     public Object getCellEditorValue()
     {
@@ -1771,8 +1864,8 @@ class ColorEditor extends AbstractCellEditor
 
     // Implement the one method defined by TableCellEditor.
     @Override
-    public Component getTableCellEditorComponent(JTable theTable, Object value,
-            boolean isSelected, int row, int column)
+    public Component getTableCellEditorComponent(JTable theTable,
+            Object value, boolean isSelected, int row, int column)
     {
       currentColor = (FeatureColourI) value;
       this.rowSelected = row;
@@ -1800,12 +1893,12 @@ class ColorEditor extends AbstractCellEditor
 
   /**
    * The cell editor for the Filter column. It displays the text of any filters
-   * for the feature type in that row (in full as a tooltip, possible abbreviated
-   * as display text). On click in the cell, opens the Feature Display Settings
-   * dialog at the Filters tab.
+   * for the feature type in that row (in full as a tooltip, possible
+   * abbreviated as display text). On click in the cell, opens the Feature
+   * Display Settings dialog at the Filters tab.
    */
   @SuppressWarnings("serial")
-class FilterEditor extends AbstractCellEditor
+  class FilterEditor extends AbstractCellEditor
           implements TableCellEditor, ActionListener
   {
 
@@ -1864,13 +1957,13 @@ class FilterEditor extends AbstractCellEditor
         {
           currentFilter = new FeatureMatcherSet();
         }
-        
+
         Object[] data = ((FeatureTableModel) table.getModel())
                 .getData()[rowSelected];
         data[COLOUR_COLUMN] = currentColor;
         data[FILTER_COLUMN] = currentFilter;
         fireEditingStopped();
-        // SwingJS needs an explicit repaint() here, 
+        // SwingJS needs an explicit repaint() here,
         // rather than relying upon no validation having
         // occurred since the stopEditing call was made.
         // Its laying out has not been stopped by the modal frame
@@ -1886,8 +1979,8 @@ class FilterEditor extends AbstractCellEditor
     }
 
     @Override
-    public Component getTableCellEditorComponent(JTable theTable, Object value,
-            boolean isSelected, int row, int column)
+    public Component getTableCellEditorComponent(JTable theTable,
+            Object value, boolean isSelected, int row, int column)
     {
       currentFilter = (FeatureMatcherSetI) value;
       this.rowSelected = row;
@@ -1978,7 +2071,7 @@ class FeatureIcon implements Icon
         g.fillRect(s1, 0, e1 - s1, height);
       }
       g.setColor(gcol.getMaxColour());
-//      g.fillRect(0, e1, width - e1, height);  // BH 2018
+      // g.fillRect(0, e1, width - e1, height); // BH 2018
       g.fillRect(e1, 0, width - e1, height);
     }
   }