JAL-3746 release notes and what’s new for 2.11.2 - in progress
[jalview.git] / src / jalview / gui / FeatureSettings.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.gui;
22
23 import java.awt.BorderLayout;
24 import java.awt.Color;
25 import java.awt.Component;
26 import java.awt.Dimension;
27 import java.awt.FlowLayout;
28 import java.awt.Font;
29 import java.awt.Graphics;
30 import java.awt.GridLayout;
31 import java.awt.Point;
32 import java.awt.Rectangle;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.ItemEvent;
36 import java.awt.event.ItemListener;
37 import java.awt.event.MouseAdapter;
38 import java.awt.event.MouseEvent;
39 import java.awt.event.MouseMotionAdapter;
40 import java.beans.PropertyChangeEvent;
41 import java.beans.PropertyChangeListener;
42 import java.io.File;
43 import java.io.FileInputStream;
44 import java.io.FileOutputStream;
45 import java.io.InputStreamReader;
46 import java.io.OutputStreamWriter;
47 import java.io.PrintWriter;
48 import java.util.Arrays;
49 import java.util.Comparator;
50 import java.util.HashMap;
51 import java.util.HashSet;
52 import java.util.Hashtable;
53 import java.util.Iterator;
54 import java.util.List;
55 import java.util.Map;
56 import java.util.Set;
57
58 import javax.help.HelpSetException;
59 import javax.swing.AbstractCellEditor;
60 import javax.swing.BorderFactory;
61 import javax.swing.Icon;
62 import javax.swing.JButton;
63 import javax.swing.JCheckBox;
64 import javax.swing.JCheckBoxMenuItem;
65 import javax.swing.JInternalFrame;
66 import javax.swing.JLabel;
67 import javax.swing.JLayeredPane;
68 import javax.swing.JMenuItem;
69 import javax.swing.JPanel;
70 import javax.swing.JPopupMenu;
71 import javax.swing.JScrollPane;
72 import javax.swing.JSlider;
73 import javax.swing.JTable;
74 import javax.swing.ListSelectionModel;
75 import javax.swing.SwingConstants;
76 import javax.swing.ToolTipManager;
77 import javax.swing.border.Border;
78 import javax.swing.event.ChangeEvent;
79 import javax.swing.event.ChangeListener;
80 import javax.swing.table.AbstractTableModel;
81 import javax.swing.table.JTableHeader;
82 import javax.swing.table.TableCellEditor;
83 import javax.swing.table.TableCellRenderer;
84 import javax.swing.table.TableColumn;
85 import javax.xml.bind.JAXBContext;
86 import javax.xml.bind.JAXBElement;
87 import javax.xml.bind.Marshaller;
88 import javax.xml.stream.XMLInputFactory;
89 import javax.xml.stream.XMLStreamReader;
90
91 import jalview.api.AlignViewControllerGuiI;
92 import jalview.api.AlignViewportI;
93 import jalview.api.FeatureColourI;
94 import jalview.api.FeatureSettingsControllerI;
95 import jalview.api.SplitContainerI;
96 import jalview.api.ViewStyleI;
97 import jalview.controller.FeatureSettingsControllerGuiI;
98 import jalview.datamodel.AlignmentI;
99 import jalview.datamodel.SequenceI;
100 import jalview.datamodel.features.FeatureMatcher;
101 import jalview.datamodel.features.FeatureMatcherI;
102 import jalview.datamodel.features.FeatureMatcherSet;
103 import jalview.datamodel.features.FeatureMatcherSetI;
104 import jalview.gui.Help.HelpId;
105 import jalview.gui.JalviewColourChooser.ColourChooserListener;
106 import jalview.io.JalviewFileChooser;
107 import jalview.io.JalviewFileView;
108 import jalview.schemes.FeatureColour;
109 import jalview.util.MessageManager;
110 import jalview.util.Platform;
111 import jalview.viewmodel.seqfeatures.FeatureRendererModel.FeatureSettingsBean;
112 import jalview.viewmodel.styles.ViewStyle;
113 import jalview.xml.binding.jalview.JalviewUserColours;
114 import jalview.xml.binding.jalview.JalviewUserColours.Colour;
115 import jalview.xml.binding.jalview.JalviewUserColours.Filter;
116 import jalview.xml.binding.jalview.ObjectFactory;
117
118 public class FeatureSettings extends JPanel
119         implements FeatureSettingsControllerI, FeatureSettingsControllerGuiI
120 {
121   private static final String SEQUENCE_FEATURE_COLOURS = MessageManager
122           .getString("label.sequence_feature_colours");
123
124   /*
125    * column indices of fields in Feature Settings table
126    */
127   static final int TYPE_COLUMN = 0;
128
129   static final int COLOUR_COLUMN = 1;
130
131   static final int FILTER_COLUMN = 2;
132
133   static final int SHOW_COLUMN = 3;
134
135   private static final int COLUMN_COUNT = 4;
136
137   private static final int MIN_WIDTH = 400;
138
139   private static final int MIN_HEIGHT = 400;
140
141   private final static String BASE_TOOLTIP = MessageManager
142           .getString("label.click_to_edit");
143
144   final FeatureRenderer fr;
145
146   public final AlignFrame af;
147
148   /*
149    * 'original' fields hold settings to restore on Cancel
150    */
151   Object[][] originalData;
152
153   private float originalTransparency;
154
155   private ViewStyleI originalViewStyle;
156
157   private Map<String, FeatureMatcherSetI> originalFilters;
158
159   final JInternalFrame frame;
160
161   JScrollPane scrollPane = new JScrollPane();
162
163   JTable table;
164
165   JPanel groupPanel;
166
167   JSlider transparency = new JSlider();
168
169   private JCheckBox showComplementOnTop;
170
171   private JCheckBox showComplement;
172
173   /*
174    * when true, constructor is still executing - so ignore UI events
175    */
176   protected volatile boolean inConstruction = true;
177
178   int selectedRow = -1;
179
180   boolean resettingTable = false;
181
182   /*
183    * true when Feature Settings are updating from feature renderer
184    */
185   private boolean handlingUpdate = false;
186
187   /*
188    * a change listener to ensure the dialog is updated if
189    * FeatureRenderer discovers new features
190    */
191   private PropertyChangeListener change;
192
193   /*
194    * holds {featureCount, totalExtent} for each feature type
195    */
196   Map<String, float[]> typeWidth = null;
197
198   private void storeOriginalSettings()
199   {
200     // save transparency for restore on Cancel
201     originalTransparency = fr.getTransparency();
202
203     updateTransparencySliderFromFR();
204
205     originalFilters = new HashMap<>(fr.getFeatureFilters()); // shallow copy
206     originalViewStyle = new ViewStyle(af.viewport.getViewStyle());
207   }
208
209   private void updateTransparencySliderFromFR()
210   {
211     boolean incon = inConstruction;
212     inConstruction = true;
213
214     int transparencyAsPercent = (int) (fr.getTransparency() * 100);
215     transparency.setValue(100 - transparencyAsPercent);
216     inConstruction = incon;
217   }
218   /**
219    * Constructor
220    * 
221    * @param af
222    */
223   public FeatureSettings(AlignFrame alignFrame)
224   {
225     this.af = alignFrame;
226     fr = af.getFeatureRenderer();
227
228     storeOriginalSettings();
229
230     try
231     {
232       jbInit();
233     } catch (Exception ex)
234     {
235       ex.printStackTrace();
236     }
237
238     table = new JTable()
239     {
240       @Override
241       public String getToolTipText(MouseEvent e)
242       {
243         String tip = null;
244         int column = table.columnAtPoint(e.getPoint());
245         int row = table.rowAtPoint(e.getPoint());
246
247         switch (column)
248         {
249         case TYPE_COLUMN:
250           tip = JvSwingUtils.wrapTooltip(true, MessageManager
251                   .getString("label.feature_settings_click_drag"));
252           break;
253         case COLOUR_COLUMN:
254           FeatureColourI colour = (FeatureColourI) table.getValueAt(row,
255                   column);
256           tip = getColorTooltip(colour, true);
257           break;
258         case FILTER_COLUMN:
259           FeatureMatcherSet o = (FeatureMatcherSet) table.getValueAt(row,
260                   column);
261           tip = o.isEmpty()
262                   ? MessageManager
263                           .getString("label.configure_feature_tooltip")
264                   : o.toString();
265           break;
266         default:
267           break;
268         }
269
270         return tip;
271       }
272
273       /**
274        * Position the tooltip near the bottom edge of, and half way across, the
275        * current cell
276        */
277       @Override
278       public Point getToolTipLocation(MouseEvent e)
279       {
280         Point point = e.getPoint();
281         int column = table.columnAtPoint(point);
282         int row = table.rowAtPoint(point);
283         Rectangle r = getCellRect(row, column, false);
284         Point loc = new Point(r.x + r.width / 2, r.y + r.height - 3);
285         return loc;
286       }
287     };
288     JTableHeader tableHeader = table.getTableHeader();
289     tableHeader.setFont(new Font("Verdana", Font.PLAIN, 12));
290     tableHeader.setReorderingAllowed(false);
291     table.setFont(new Font("Verdana", Font.PLAIN, 12));
292     ToolTipManager.sharedInstance().registerComponent(table);
293     table.setDefaultEditor(FeatureColour.class, new ColorEditor());
294     table.setDefaultRenderer(FeatureColour.class, new ColorRenderer());
295
296     table.setDefaultEditor(FeatureMatcherSet.class, new FilterEditor());
297     table.setDefaultRenderer(FeatureMatcherSet.class, new FilterRenderer());
298
299     TableColumn colourColumn = new TableColumn(COLOUR_COLUMN, 75,
300             new ColorRenderer(), new ColorEditor());
301     table.addColumn(colourColumn);
302
303     TableColumn filterColumn = new TableColumn(FILTER_COLUMN, 75,
304             new FilterRenderer(), new FilterEditor());
305     table.addColumn(filterColumn);
306
307     table.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
308
309     table.addMouseListener(new MouseAdapter()
310     {
311       @Override
312       public void mousePressed(MouseEvent evt)
313       {
314         Point pt = evt.getPoint();
315         selectedRow = table.rowAtPoint(pt);
316         String type = (String) table.getValueAt(selectedRow, TYPE_COLUMN);
317         if (evt.isPopupTrigger())
318         {
319           Object colour = table.getValueAt(selectedRow, COLOUR_COLUMN);
320           showPopupMenu(selectedRow, type, colour, evt.getPoint());
321         }
322         else if (evt.getClickCount() == 2
323                 && table.columnAtPoint(pt) == TYPE_COLUMN)
324         {
325           boolean invertSelection = evt.isAltDown();
326           boolean toggleSelection = Platform.isControlDown(evt);
327           boolean extendSelection = evt.isShiftDown();
328           fr.ap.alignFrame.avc.markColumnsContainingFeatures(
329                   invertSelection, extendSelection, toggleSelection, type);
330           fr.ap.av.sendSelection();
331         }
332       }
333
334       // isPopupTrigger fires on mouseReleased on Windows
335       @Override
336       public void mouseReleased(MouseEvent evt)
337       {
338         selectedRow = table.rowAtPoint(evt.getPoint());
339         if (evt.isPopupTrigger())
340         {
341           String type = (String) table.getValueAt(selectedRow, TYPE_COLUMN);
342           Object colour = table.getValueAt(selectedRow, COLOUR_COLUMN);
343           showPopupMenu(selectedRow, type, colour, evt.getPoint());
344         }
345       }
346     });
347
348     table.addMouseMotionListener(new MouseMotionAdapter()
349     {
350       @Override
351       public void mouseDragged(MouseEvent evt)
352       {
353         int newRow = table.rowAtPoint(evt.getPoint());
354         if (newRow != selectedRow && selectedRow != -1 && newRow != -1)
355         {
356           /*
357            * reposition 'selectedRow' to 'newRow' (the dragged to location)
358            * this could be more than one row away for a very fast drag action
359            * so just swap it with adjacent rows until we get it there
360            */
361           Object[][] data = ((FeatureTableModel) table.getModel())
362                   .getData();
363           int direction = newRow < selectedRow ? -1 : 1;
364           for (int i = selectedRow; i != newRow; i += direction)
365           {
366             Object[] temp = data[i];
367             data[i] = data[i + direction];
368             data[i + direction] = temp;
369           }
370           updateFeatureRenderer(data);
371           table.repaint();
372           selectedRow = newRow;
373         }
374       }
375     });
376     // table.setToolTipText(JvSwingUtils.wrapTooltip(true,
377     // MessageManager.getString("label.feature_settings_click_drag")));
378     scrollPane.setViewportView(table);
379
380     if (af.getViewport().isShowSequenceFeatures() || !fr.hasRenderOrder())
381     {
382       fr.findAllFeatures(true); // display everything!
383     }
384
385     discoverAllFeatureData();
386     final FeatureSettings fs = this;
387     fr.addPropertyChangeListener(change = new PropertyChangeListener()
388     {
389       @Override
390       public void propertyChange(PropertyChangeEvent evt)
391       {
392         if (!fs.resettingTable && !fs.handlingUpdate)
393         {
394           fs.handlingUpdate = true;
395           fs.resetTable(null);
396           // new groups may be added with new sequence feature types only
397           fs.handlingUpdate = false;
398         }
399       }
400
401     });
402
403     SplitContainerI splitframe = af.getSplitViewContainer();
404     if (splitframe != null)
405     {
406       frame = null; // keeps eclipse happy
407       splitframe.addFeatureSettingsUI(this);
408     }
409     else
410     {
411       frame = new JInternalFrame();
412       frame.setContentPane(this);
413       Rectangle bounds = af.getFeatureSettingsGeometry();
414       String title;
415       if (af.getAlignPanels().size() > 1 || Desktop.getAlignmentPanels(
416               af.alignPanel.av.getSequenceSetId()).length > 1)
417       {
418         title = MessageManager.formatMessage(
419                 "label.sequence_feature_settings_for_view",
420                 af.alignPanel.getViewName());
421       }
422       else
423       {
424         title = MessageManager.getString("label.sequence_feature_settings");
425       }
426       if (bounds == null)
427       {
428         if (Platform.isAMacAndNotJS())
429         {
430           Desktop.addInternalFrame(frame, title, 600, 480);
431         }
432         else
433         {
434           Desktop.addInternalFrame(frame, title, 600, 450);
435         }
436       }
437       else
438       {
439         Desktop.addInternalFrame(frame, title, false, bounds.width,
440                 bounds.height);
441         frame.setBounds(bounds);
442         frame.setVisible(true);
443       }
444       frame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
445
446       frame.addInternalFrameListener(
447               new javax.swing.event.InternalFrameAdapter()
448               {
449                 @Override
450                 public void internalFrameClosed(
451                         javax.swing.event.InternalFrameEvent evt)
452                 {
453                   featureSettings_isClosed();
454                 };
455               });
456       frame.setLayer(JLayeredPane.PALETTE_LAYER);
457     }
458                 inConstruction = false;
459         }
460
461   /**
462    * Sets the state of buttons to show complement features from viewport
463    * settings
464    */
465   private void updateComplementButtons()
466   {
467     showComplement.setSelected(af.getViewport().isShowComplementFeatures());
468     showComplementOnTop
469             .setSelected(af.getViewport().isShowComplementFeaturesOnTop());
470   }
471
472   @Override
473   public AlignViewControllerGuiI getAlignframe()
474   {
475     return af;
476   }
477
478   @Override
479   public void featureSettings_isClosed()
480   {
481     fr.removePropertyChangeListener(change);
482     change = null;
483   }
484
485         /**
486          * Constructs and shows a popup menu of possible actions on the selected row and
487          * feature type
488          * 
489          * @param rowSelected
490          * @param type
491          * @param typeCol
492          * @param pt
493          */
494         protected void showPopupMenu(final int rowSelected, final String type, final Object typeCol, final Point pt)
495   {
496     JPopupMenu men = new JPopupMenu(MessageManager
497             .formatMessage("label.settings_for_param", new String[]
498             { type }));
499     final FeatureColourI featureColour = (FeatureColourI) typeCol;
500
501     /*
502      * menu option to select (or deselect) variable colour
503      */
504     final JCheckBoxMenuItem variableColourCB = new JCheckBoxMenuItem(
505             MessageManager.getString("label.variable_colour"));
506     variableColourCB.setSelected(!featureColour.isSimpleColour());
507     men.add(variableColourCB);
508
509     /*
510      * checkbox action listener doubles up as listener to OK
511      * from the variable colour / filters dialog
512      */
513     variableColourCB.addActionListener(new ActionListener()
514     {
515       @Override
516       public void actionPerformed(ActionEvent e)
517       {
518         if (e.getSource() == variableColourCB)
519         {
520                                         // BH 2018 for JavaScript because this is a checkbox
521                                         men.setVisible(true);
522           men.setVisible(false);
523           if (featureColour.isSimpleColour())
524           {
525             /*
526              * toggle simple colour to variable colour - show dialog
527              */
528             FeatureTypeSettings fc = new FeatureTypeSettings(fr, type);
529             fc.addActionListener(this);
530           }
531           else
532           {
533             /*
534              * toggle variable to simple colour - show colour chooser
535              */
536             String title = MessageManager
537                     .formatMessage("label.select_colour_for", type);
538             ColourChooserListener listener = new ColourChooserListener()
539             {
540               @Override
541               public void colourSelected(Color c)
542               {
543                 table.setValueAt(new FeatureColour(c), rowSelected,
544                         COLOUR_COLUMN);
545                 table.validate();
546                 updateFeatureRenderer(
547                         ((FeatureTableModel) table.getModel()).getData(),
548                         false);
549               }
550             };
551             JalviewColourChooser.showColourChooser(FeatureSettings.this,
552                     title, featureColour.getMaxColour(), listener);
553           }
554         }
555         else
556         {
557           if (e.getSource() instanceof FeatureTypeSettings)
558           {
559             /*
560              * update after OK in feature colour dialog; the updated
561              * colour will have already been set in the FeatureRenderer
562              */
563             FeatureColourI fci = fr.getFeatureColours().get(type);
564             table.setValueAt(fci, rowSelected, COLOUR_COLUMN);
565             // BH 2018 setting a table value does not invalidate it.
566             // System.out.println("FeatureSettings is valied" +
567             // table.validate();
568           }
569         }
570       }
571     });
572
573     men.addSeparator();
574
575     JMenuItem scr = new JMenuItem(
576             MessageManager.getString("label.sort_by_score"));
577     men.add(scr);
578     scr.addActionListener(new ActionListener()
579     {
580       @Override
581       public void actionPerformed(ActionEvent e)
582       {
583         sortByScore(Arrays.asList(new String[] { type }));
584       }
585     });
586     JMenuItem dens = new JMenuItem(
587             MessageManager.getString("label.sort_by_density"));
588     dens.addActionListener(new ActionListener()
589     {
590       @Override
591       public void actionPerformed(ActionEvent e)
592       {
593         sortByDensity(Arrays.asList(new String[] { type }));
594       }
595     });
596     men.add(dens);
597
598     JMenuItem selCols = new JMenuItem(
599             MessageManager.getString("label.select_columns_containing"));
600     selCols.addActionListener(new ActionListener()
601     {
602       @Override
603       public void actionPerformed(ActionEvent arg0)
604       {
605         fr.ap.alignFrame.avc.markColumnsContainingFeatures(false, false,
606                 false, type);
607         fr.ap.av.sendSelection();
608       }
609     });
610     JMenuItem clearCols = new JMenuItem(MessageManager
611             .getString("label.select_columns_not_containing"));
612     clearCols.addActionListener(new ActionListener()
613     {
614       @Override
615       public void actionPerformed(ActionEvent arg0)
616       {
617         fr.ap.alignFrame.avc.markColumnsContainingFeatures(true, false,
618                 false, type);
619         fr.ap.av.sendSelection();
620       }
621     });
622     JMenuItem hideCols = new JMenuItem(
623             MessageManager.getString("label.hide_columns_containing"));
624     hideCols.addActionListener(new ActionListener()
625     {
626       @Override
627       public void actionPerformed(ActionEvent arg0)
628       {
629         fr.ap.alignFrame.hideFeatureColumns(type, true);
630         fr.ap.av.sendSelection();
631       }
632     });
633     JMenuItem hideOtherCols = new JMenuItem(
634             MessageManager.getString("label.hide_columns_not_containing"));
635     hideOtherCols.addActionListener(new ActionListener()
636     {
637       @Override
638       public void actionPerformed(ActionEvent arg0)
639       {
640         fr.ap.alignFrame.hideFeatureColumns(type, false);
641         fr.ap.av.sendSelection();
642       }
643     });
644     men.add(selCols);
645     men.add(clearCols);
646     men.add(hideCols);
647     men.add(hideOtherCols);
648     men.show(table, pt.x, pt.y);
649   }
650
651   /**
652    * Sort the sequences in the alignment by the number of features for the given
653    * feature types (or all features if null)
654    * 
655    * @param featureTypes
656    */
657   protected void sortByDensity(List<String> featureTypes)
658   {
659     af.avc.sortAlignmentByFeatureDensity(featureTypes);
660   }
661
662   /**
663    * Sort the sequences in the alignment by average score for the given feature
664    * types (or all features if null)
665    * 
666    * @param featureTypes
667    */
668   protected void sortByScore(List<String> featureTypes)
669   {
670     af.avc.sortAlignmentByFeatureScore(featureTypes);
671   }
672
673   /**
674    * Returns true if at least one feature type is visible. Else shows a warning
675    * dialog and returns false.
676    * 
677    * @param title
678    * @return
679    */
680   private boolean canSortBy(String title)
681   {
682     if (fr.getDisplayedFeatureTypes().isEmpty())
683     {
684       JvOptionPane.showMessageDialog(this,
685               MessageManager.getString("label.no_features_to_sort_by"),
686               title, JvOptionPane.OK_OPTION);
687       return false;
688     }
689     return true;
690   }
691
692   @Override
693   synchronized public void discoverAllFeatureData()
694   {
695     Set<String> allGroups = new HashSet<>();
696     AlignmentI alignment = af.getViewport().getAlignment();
697
698     for (int i = 0; i < alignment.getHeight(); i++)
699     {
700       SequenceI seq = alignment.getSequenceAt(i);
701       for (String group : seq.getFeatures().getFeatureGroups(true))
702       {
703         if (group != null && !allGroups.contains(group))
704         {
705           allGroups.add(group);
706           checkGroupState(group);
707         }
708       }
709     }
710
711     resetTable(null);
712
713     validate();
714   }
715
716   /**
717    * Synchronise gui group list and check visibility of group
718    * 
719    * @param group
720    * @return true if group is visible
721    */
722   private boolean checkGroupState(String group)
723   {
724     boolean visible = fr.checkGroupVisibility(group, true);
725
726     for (int g = 0; g < groupPanel.getComponentCount(); g++)
727     {
728       if (((JCheckBox) groupPanel.getComponent(g)).getText().equals(group))
729       {
730         ((JCheckBox) groupPanel.getComponent(g)).setSelected(visible);
731         return visible;
732       }
733     }
734
735     final String grp = group;
736     final JCheckBox check = new JCheckBox(group, visible);
737     check.setFont(new Font("Serif", Font.BOLD, 12));
738     check.setToolTipText(group);
739     check.addItemListener(new ItemListener()
740     {
741       @Override
742       public void itemStateChanged(ItemEvent evt)
743       {
744         fr.setGroupVisibility(check.getText(), check.isSelected());
745         resetTable(new String[] { grp });
746         refreshDisplay();
747       }
748     });
749     groupPanel.add(check);
750     return visible;
751   }
752
753   synchronized void resetTable(String[] groupChanged)
754   {
755     if (resettingTable)
756     {
757       return;
758     }
759     resettingTable = true;
760     typeWidth = new Hashtable<>();
761     // TODO: change avWidth calculation to 'per-sequence' average and use long
762     // rather than float
763
764     Set<String> displayableTypes = new HashSet<>();
765     Set<String> foundGroups = new HashSet<>();
766
767     /*
768      * determine which feature types may be visible depending on 
769      * which groups are selected, and recompute average width data
770      */
771     for (int i = 0; i < af.getViewport().getAlignment().getHeight(); i++)
772     {
773
774       SequenceI seq = af.getViewport().getAlignment().getSequenceAt(i);
775
776       /*
777        * get the sequence's groups for positional features
778        * and keep track of which groups are visible
779        */
780       Set<String> groups = seq.getFeatures().getFeatureGroups(true);
781       Set<String> visibleGroups = new HashSet<>();
782       for (String group : groups)
783       {
784         if (group == null || checkGroupState(group))
785         {
786           visibleGroups.add(group);
787         }
788       }
789       foundGroups.addAll(groups);
790
791       /*
792        * get distinct feature types for visible groups
793        * record distinct visible types, and their count and total length
794        */
795       Set<String> types = seq.getFeatures().getFeatureTypesForGroups(true,
796               visibleGroups.toArray(new String[visibleGroups.size()]));
797       for (String type : types)
798       {
799         displayableTypes.add(type);
800         float[] avWidth = typeWidth.get(type);
801         if (avWidth == null)
802         {
803           avWidth = new float[2];
804           typeWidth.put(type, avWidth);
805         }
806         // todo this could include features with a non-visible group
807         // - do we greatly care?
808         // todo should we include non-displayable features here, and only
809         // update when features are added?
810         avWidth[0] += seq.getFeatures().getFeatureCount(true, type);
811         avWidth[1] += seq.getFeatures().getTotalFeatureLength(type);
812       }
813     }
814
815     Object[][] data = new Object[displayableTypes.size()][COLUMN_COUNT];
816     int dataIndex = 0;
817
818     if (fr.hasRenderOrder())
819     {
820       if (!handlingUpdate)
821       {
822         fr.findAllFeatures(groupChanged != null); // prod to update
823         // colourschemes. but don't
824         // affect display
825         // First add the checks in the previous render order,
826         // in case the window has been closed and reopened
827       }
828       List<String> frl = fr.getRenderOrder();
829       for (int ro = frl.size() - 1; ro > -1; ro--)
830       {
831         String type = frl.get(ro);
832
833         if (!displayableTypes.contains(type))
834         {
835           continue;
836         }
837
838         data[dataIndex][TYPE_COLUMN] = type;
839         data[dataIndex][COLOUR_COLUMN] = fr.getFeatureStyle(type);
840         FeatureMatcherSetI featureFilter = fr.getFeatureFilter(type);
841         data[dataIndex][FILTER_COLUMN] = featureFilter == null
842                 ? new FeatureMatcherSet()
843                 : featureFilter;
844         data[dataIndex][SHOW_COLUMN] = Boolean.valueOf(
845                 af.getViewport().getFeaturesDisplayed().isVisible(type));
846         dataIndex++;
847         displayableTypes.remove(type);
848       }
849     }
850
851     /*
852      * process any extra features belonging only to 
853      * a group which was just selected
854      */
855     while (!displayableTypes.isEmpty())
856     {
857       String type = displayableTypes.iterator().next();
858       data[dataIndex][TYPE_COLUMN] = type;
859
860       data[dataIndex][COLOUR_COLUMN] = fr.getFeatureStyle(type);
861       if (data[dataIndex][COLOUR_COLUMN] == null)
862       {
863         // "Colour has been updated in another view!!"
864         fr.clearRenderOrder();
865         return;
866       }
867       FeatureMatcherSetI featureFilter = fr.getFeatureFilter(type);
868       data[dataIndex][FILTER_COLUMN] = featureFilter == null
869               ? new FeatureMatcherSet()
870               : featureFilter;
871       data[dataIndex][SHOW_COLUMN] = Boolean.valueOf(true);
872       dataIndex++;
873       displayableTypes.remove(type);
874     }
875
876     if (originalData == null)
877     {
878       originalData = new Object[data.length][COLUMN_COUNT];
879       for (int i = 0; i < data.length; i++)
880       {
881         System.arraycopy(data[i], 0, originalData[i], 0, COLUMN_COUNT);
882       }
883     }
884     else
885     {
886       updateOriginalData(data);
887     }
888
889     table.setModel(new FeatureTableModel(data));
890     table.getColumnModel().getColumn(0).setPreferredWidth(200);
891
892     groupPanel.setLayout(
893             new GridLayout(fr.getFeatureGroupsSize() / 4 + 1, 4));
894     pruneGroups(foundGroups);
895     groupPanel.validate();
896
897     updateFeatureRenderer(data, groupChanged != null);
898     resettingTable = false;
899   }
900
901   /**
902    * Updates 'originalData' (used for restore on Cancel) if we detect that
903    * changes have been made outwith this dialog
904    * <ul>
905    * <li>a new feature type added (and made visible)</li>
906    * <li>a feature colour changed (in the Amend Features dialog)</li>
907    * </ul>
908    * 
909    * @param foundData
910    */
911   protected void updateOriginalData(Object[][] foundData)
912   {
913     // todo LinkedHashMap instead of Object[][] would be nice
914
915     Object[][] currentData = ((FeatureTableModel) table.getModel())
916             .getData();
917     for (Object[] row : foundData)
918     {
919       String type = (String) row[TYPE_COLUMN];
920       boolean found = false;
921       for (Object[] current : currentData)
922       {
923         if (type.equals(current[TYPE_COLUMN]))
924         {
925           found = true;
926           /*
927            * currently dependent on object equality here;
928            * really need an equals method on FeatureColour
929            */
930           if (!row[COLOUR_COLUMN].equals(current[COLOUR_COLUMN]))
931           {
932             /*
933              * feature colour has changed externally - update originalData
934              */
935             for (Object[] original : originalData)
936             {
937               if (type.equals(original[TYPE_COLUMN]))
938               {
939                 original[COLOUR_COLUMN] = row[COLOUR_COLUMN];
940                 break;
941               }
942             }
943           }
944           break;
945         }
946       }
947       if (!found)
948       {
949         /*
950          * new feature detected - add to original data (on top)
951          */
952         Object[][] newData = new Object[originalData.length
953                 + 1][COLUMN_COUNT];
954         for (int i = 0; i < originalData.length; i++)
955         {
956           System.arraycopy(originalData[i], 0, newData[i + 1], 0,
957                   COLUMN_COUNT);
958         }
959         newData[0] = row;
960         originalData = newData;
961       }
962     }
963   }
964
965   /**
966    * Remove from the groups panel any checkboxes for groups that are not in the
967    * foundGroups set. This enables removing a group from the display when the
968    * last feature in that group is deleted.
969    * 
970    * @param foundGroups
971    */
972   protected void pruneGroups(Set<String> foundGroups)
973   {
974     for (int g = 0; g < groupPanel.getComponentCount(); g++)
975     {
976       JCheckBox checkbox = (JCheckBox) groupPanel.getComponent(g);
977       if (!foundGroups.contains(checkbox.getText()))
978       {
979         groupPanel.remove(checkbox);
980       }
981     }
982   }
983
984   /**
985    * reorder data based on the featureRenderers global priority list.
986    * 
987    * @param data
988    */
989   private void ensureOrder(Object[][] data)
990   {
991     boolean sort = false;
992     float[] order = new float[data.length];
993     for (int i = 0; i < order.length; i++)
994     {
995       order[i] = fr.getOrder(data[i][0].toString());
996       if (order[i] < 0)
997       {
998         order[i] = fr.setOrder(data[i][0].toString(), i / order.length);
999       }
1000       if (i > 1)
1001       {
1002         sort = sort || order[i - 1] > order[i];
1003       }
1004     }
1005     if (sort)
1006     {
1007       jalview.util.QuickSort.sort(order, data);
1008     }
1009   }
1010
1011   /**
1012    * Offers a file chooser dialog, and then loads the feature colours and
1013    * filters from file in XML format and unmarshals to Jalview feature settings
1014    */
1015   void load()
1016   {
1017     JalviewFileChooser chooser = new JalviewFileChooser("fc",
1018             SEQUENCE_FEATURE_COLOURS);
1019     chooser.setFileView(new JalviewFileView());
1020     chooser.setDialogTitle(
1021             MessageManager.getString("label.load_feature_colours"));
1022     chooser.setToolTipText(MessageManager.getString("action.load"));
1023     chooser.setResponseHandler(0, new Runnable()
1024     {
1025       @Override
1026       public void run()
1027       {
1028         File file = chooser.getSelectedFile();
1029         load(file);
1030       }
1031     });
1032     chooser.showOpenDialog(this);
1033   }
1034
1035   /**
1036    * Loads feature colours and filters from XML stored in the given file
1037    * 
1038    * @param file
1039    */
1040   void load(File file)
1041   {
1042     try
1043     {
1044       InputStreamReader in = new InputStreamReader(
1045               new FileInputStream(file), "UTF-8");
1046
1047       JAXBContext jc = JAXBContext
1048               .newInstance("jalview.xml.binding.jalview");
1049       javax.xml.bind.Unmarshaller um = jc.createUnmarshaller();
1050       XMLStreamReader streamReader = XMLInputFactory.newInstance()
1051               .createXMLStreamReader(in);
1052       JAXBElement<JalviewUserColours> jbe = um.unmarshal(streamReader,
1053               JalviewUserColours.class);
1054       JalviewUserColours jucs = jbe.getValue();
1055
1056       // JalviewUserColours jucs = JalviewUserColours.unmarshal(in);
1057
1058       /*
1059        * load feature colours
1060        */
1061       for (int i = jucs.getColour().size() - 1; i >= 0; i--)
1062       {
1063         Colour newcol = jucs.getColour().get(i);
1064         FeatureColourI colour = jalview.project.Jalview2XML
1065                 .parseColour(newcol);
1066         fr.setColour(newcol.getName(), colour);
1067         fr.setOrder(newcol.getName(), i / (float) jucs.getColour().size());
1068       }
1069
1070       /*
1071        * load feature filters; loaded filters will replace any that are
1072        * currently defined, other defined filters are left unchanged 
1073        */
1074       for (int i = 0; i < jucs.getFilter().size(); i++)
1075       {
1076         Filter filterModel = jucs.getFilter().get(i);
1077         String featureType = filterModel.getFeatureType();
1078         FeatureMatcherSetI filter = jalview.project.Jalview2XML
1079                 .parseFilter(featureType, filterModel.getMatcherSet());
1080         if (!filter.isEmpty())
1081         {
1082           fr.setFeatureFilter(featureType, filter);
1083         }
1084       }
1085
1086       /*
1087        * update feature settings table
1088        */
1089       if (table != null)
1090       {
1091         resetTable(null);
1092         Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1093         ensureOrder(data);
1094         updateFeatureRenderer(data, false);
1095         table.repaint();
1096       }
1097     } catch (Exception ex)
1098     {
1099       System.out.println("Error loading User Colour File\n" + ex);
1100     }
1101   }
1102
1103   /**
1104    * Offers a file chooser dialog, and then saves the current feature colours
1105    * and any filters to the selected file in XML format
1106    */
1107   void save()
1108   {
1109     JalviewFileChooser chooser = new JalviewFileChooser("fc",
1110             SEQUENCE_FEATURE_COLOURS);
1111     chooser.setFileView(new JalviewFileView());
1112     chooser.setDialogTitle(
1113             MessageManager.getString("label.save_feature_colours"));
1114     chooser.setToolTipText(MessageManager.getString("action.save"));
1115     int option = chooser.showSaveDialog(this);
1116     if (option == JalviewFileChooser.APPROVE_OPTION)
1117     {
1118       File file = chooser.getSelectedFile();
1119       save(file);
1120     }
1121   }
1122
1123   /**
1124    * Saves feature colours and filters to the given file
1125    * 
1126    * @param file
1127    */
1128   void save(File file)
1129   {
1130     JalviewUserColours ucs = new JalviewUserColours();
1131     ucs.setSchemeName("Sequence Features");
1132     try
1133     {
1134       PrintWriter out = new PrintWriter(
1135               new OutputStreamWriter(new FileOutputStream(file), "UTF-8"));
1136
1137       /*
1138        * sort feature types by colour order, from 0 (highest)
1139        * to 1 (lowest)
1140        */
1141       Set<String> fr_colours = fr.getAllFeatureColours();
1142       String[] sortedTypes = fr_colours
1143               .toArray(new String[fr_colours.size()]);
1144       Arrays.sort(sortedTypes, new Comparator<String>()
1145       {
1146         @Override
1147         public int compare(String type1, String type2)
1148         {
1149           return Float.compare(fr.getOrder(type1), fr.getOrder(type2));
1150         }
1151       });
1152
1153       /*
1154        * save feature colours
1155        */
1156       for (String featureType : sortedTypes)
1157       {
1158         FeatureColourI fcol = fr.getFeatureStyle(featureType);
1159         Colour col = jalview.project.Jalview2XML.marshalColour(featureType,
1160                 fcol);
1161         ucs.getColour().add(col);
1162       }
1163
1164       /*
1165        * save any feature filters
1166        */
1167       for (String featureType : sortedTypes)
1168       {
1169         FeatureMatcherSetI filter = fr.getFeatureFilter(featureType);
1170         if (filter != null && !filter.isEmpty())
1171         {
1172           Iterator<FeatureMatcherI> iterator = filter.getMatchers()
1173                   .iterator();
1174           FeatureMatcherI firstMatcher = iterator.next();
1175           jalview.xml.binding.jalview.FeatureMatcherSet ms = jalview.project.Jalview2XML
1176                   .marshalFilter(firstMatcher, iterator, filter.isAnded());
1177           Filter filterModel = new Filter();
1178           filterModel.setFeatureType(featureType);
1179           filterModel.setMatcherSet(ms);
1180           ucs.getFilter().add(filterModel);
1181         }
1182       }
1183       JAXBContext jaxbContext = JAXBContext
1184               .newInstance(JalviewUserColours.class);
1185       Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
1186       jaxbMarshaller.marshal(
1187               new ObjectFactory().createJalviewUserColours(ucs), out);
1188
1189       // jaxbMarshaller.marshal(object, pout);
1190       // marshaller.marshal(object);
1191       out.flush();
1192
1193       // ucs.marshal(out);
1194       out.close();
1195     } catch (Exception ex)
1196     {
1197       ex.printStackTrace();
1198     }
1199   }
1200
1201   public void invertSelection()
1202   {
1203     Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1204     for (int i = 0; i < data.length; i++)
1205     {
1206       data[i][SHOW_COLUMN] = !(Boolean) data[i][SHOW_COLUMN];
1207     }
1208     updateFeatureRenderer(data, true);
1209     table.repaint();
1210   }
1211
1212   public void orderByAvWidth()
1213   {
1214     if (table == null || table.getModel() == null)
1215     {
1216       return;
1217     }
1218     Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1219     float[] width = new float[data.length];
1220     float[] awidth;
1221     float max = 0;
1222
1223     for (int i = 0; i < data.length; i++)
1224     {
1225       awidth = typeWidth.get(data[i][TYPE_COLUMN]);
1226       if (awidth[0] > 0)
1227       {
1228         width[i] = awidth[1] / awidth[0];// *awidth[0]*awidth[2]; - better
1229         // weight - but have to make per
1230         // sequence, too (awidth[2])
1231         // if (width[i]==1) // hack to distinguish single width sequences.
1232       }
1233       else
1234       {
1235         width[i] = 0;
1236       }
1237       if (max < width[i])
1238       {
1239         max = width[i];
1240       }
1241     }
1242     boolean sort = false;
1243     for (int i = 0; i < width.length; i++)
1244     {
1245       // awidth = (float[]) typeWidth.get(data[i][0]);
1246       if (width[i] == 0)
1247       {
1248         width[i] = fr.getOrder(data[i][TYPE_COLUMN].toString());
1249         if (width[i] < 0)
1250         {
1251           width[i] = fr.setOrder(data[i][TYPE_COLUMN].toString(),
1252                   i / data.length);
1253         }
1254       }
1255       else
1256       {
1257         width[i] /= max; // normalize
1258         fr.setOrder(data[i][TYPE_COLUMN].toString(), width[i]); // store for
1259                                                                 // later
1260       }
1261       if (i > 0)
1262       {
1263         sort = sort || width[i - 1] > width[i];
1264       }
1265     }
1266     if (sort)
1267     {
1268       jalview.util.QuickSort.sort(width, data);
1269       // update global priority order
1270     }
1271
1272     updateFeatureRenderer(data, false);
1273     table.repaint();
1274   }
1275
1276   /**
1277    * close ourselves but leave any existing UI handlers (e.g a CDS/Protein tabbed
1278    * feature settings dialog) intact
1279    */
1280   public void closeOldSettings()
1281   {
1282     closeDialog(false);
1283   }
1284
1285   /**
1286    * close the feature settings dialog (and any containing frame)
1287    */
1288   public void close()
1289   {
1290     closeDialog(true);
1291   }
1292
1293   private void closeDialog(boolean closeContainingFrame)
1294   {
1295     try
1296     {
1297       if (frame != null)
1298       {
1299         af.setFeatureSettingsGeometry(frame.getBounds());
1300         frame.setClosed(true);
1301       }
1302       else
1303       {
1304         SplitContainerI sc = af.getSplitViewContainer();
1305         sc.closeFeatureSettings(this, closeContainingFrame);
1306         af.featureSettings = null;
1307       }
1308     } catch (Exception exe)
1309     {
1310     }
1311
1312   }
1313
1314   public void updateFeatureRenderer(Object[][] data)
1315   {
1316     updateFeatureRenderer(data, true);
1317   }
1318
1319   /**
1320    * Update the priority order of features; only repaint if this changed the
1321    * order of visible features
1322    * 
1323    * @param data
1324    * @param visibleNew
1325    */
1326   void updateFeatureRenderer(Object[][] data, boolean visibleNew)
1327   {
1328     FeatureSettingsBean[] rowData = getTableAsBeans(data);
1329
1330     if (fr.setFeaturePriority(rowData, visibleNew))
1331     {
1332       refreshDisplay();
1333     }
1334   }
1335
1336   /**
1337    * Converts table data into an array of data beans
1338    */
1339   private FeatureSettingsBean[] getTableAsBeans(Object[][] data)
1340   {
1341     FeatureSettingsBean[] rowData = new FeatureSettingsBean[data.length];
1342     for (int i = 0; i < data.length; i++)
1343     {
1344       String type = (String) data[i][TYPE_COLUMN];
1345       FeatureColourI colour = (FeatureColourI) data[i][COLOUR_COLUMN];
1346       FeatureMatcherSetI theFilter = (FeatureMatcherSetI) data[i][FILTER_COLUMN];
1347       Boolean isShown = (Boolean) data[i][SHOW_COLUMN];
1348       rowData[i] = new FeatureSettingsBean(type, colour, theFilter,
1349               isShown);
1350     }
1351     return rowData;
1352   }
1353
1354   private void jbInit() throws Exception
1355   {
1356     this.setLayout(new BorderLayout());
1357
1358     final boolean hasComplement = af.getViewport()
1359             .getCodingComplement() != null;
1360
1361     JPanel settingsPane = new JPanel();
1362     settingsPane.setLayout(new BorderLayout());
1363
1364     JPanel bigPanel = new JPanel();
1365     bigPanel.setLayout(new BorderLayout());
1366
1367     groupPanel = new JPanel();
1368     bigPanel.add(groupPanel, BorderLayout.NORTH);
1369
1370     JButton invert = new JButton(
1371             MessageManager.getString("label.invert_selection"));
1372     invert.setFont(JvSwingUtils.getLabelFont());
1373     invert.addActionListener(new ActionListener()
1374     {
1375       @Override
1376       public void actionPerformed(ActionEvent e)
1377       {
1378         invertSelection();
1379       }
1380     });
1381
1382     JButton optimizeOrder = new JButton(
1383             MessageManager.getString("label.optimise_order"));
1384     optimizeOrder.setFont(JvSwingUtils.getLabelFont());
1385     optimizeOrder.addActionListener(new ActionListener()
1386     {
1387       @Override
1388       public void actionPerformed(ActionEvent e)
1389       {
1390         orderByAvWidth();
1391       }
1392     });
1393
1394     final String byScoreLabel = MessageManager.getString("label.seq_sort_by_score");
1395     JButton sortByScore = new JButton(byScoreLabel);
1396     sortByScore.setFont(JvSwingUtils.getLabelFont());
1397     sortByScore.addActionListener(new ActionListener()
1398     {
1399       @Override
1400       public void actionPerformed(ActionEvent e)
1401       {
1402         if (canSortBy(byScoreLabel))
1403         {
1404           sortByScore(null);
1405         }
1406       }
1407     });
1408     final String byDensityLabel = MessageManager.getString("label.sequence_sort_by_density");
1409     JButton sortByDens = new JButton(byDensityLabel);
1410     sortByDens.setFont(JvSwingUtils.getLabelFont());
1411     sortByDens.addActionListener(new ActionListener()
1412     {
1413       @Override
1414       public void actionPerformed(ActionEvent e)
1415       {
1416         if (canSortBy(byDensityLabel))
1417         {
1418           sortByDensity(null);
1419         }
1420       }
1421     });
1422
1423     JButton help = new JButton(MessageManager.getString("action.help"));
1424     help.setFont(JvSwingUtils.getLabelFont());
1425     help.addActionListener(new ActionListener()
1426     {
1427       @Override
1428       public void actionPerformed(ActionEvent e)
1429       {
1430         try
1431         {
1432           Help.showHelpWindow(HelpId.SequenceFeatureSettings);
1433         } catch (HelpSetException e1)
1434         {
1435           e1.printStackTrace();
1436         }
1437       }
1438     });
1439     // Cancel for a SplitFrame should just revert changes to the currently displayed
1440     // settings. May want to do this for either or both - so need a splitview
1441     // feature settings cancel/OK.
1442     JButton cancel = new JButton(MessageManager
1443             .getString(hasComplement ? "action.revert" : "action.cancel"));
1444     cancel.setToolTipText(MessageManager.getString(hasComplement
1445             ? "action.undo_changes_to_feature_settings"
1446             : "action.undo_changes_to_feature_settings_and_close_the_dialog"));
1447     cancel.setFont(JvSwingUtils.getLabelFont());
1448     // TODO: disable cancel (and apply!) until current settings are different
1449     cancel.addActionListener(new ActionListener()
1450     {
1451       @Override
1452       public void actionPerformed(ActionEvent e)
1453       {
1454         revert();
1455         refreshDisplay();
1456         if (!hasComplement)
1457         {
1458           close();
1459         }
1460       }
1461     });
1462     // Cancel for the whole dialog should cancel both CDS and Protein.
1463     // OK for an individual feature settings just applies changes, but dialog
1464     // remains open
1465     JButton ok = new JButton(MessageManager
1466             .getString(hasComplement ? "action.apply" : "action.ok"));
1467     ok.setFont(JvSwingUtils.getLabelFont());
1468     ok.addActionListener(new ActionListener()
1469     {
1470       @Override
1471       public void actionPerformed(ActionEvent e)
1472       {
1473         if (!hasComplement)
1474         {
1475           close();
1476         }
1477         else
1478         {
1479           storeOriginalSettings();
1480         }
1481       }
1482     });
1483
1484     JButton loadColours = new JButton(
1485             MessageManager.getString("label.load_colours"));
1486     loadColours.setFont(JvSwingUtils.getLabelFont());
1487     loadColours.setToolTipText(
1488             MessageManager.getString("label.load_colours_tooltip"));
1489     loadColours.addActionListener(new ActionListener()
1490     {
1491       @Override
1492       public void actionPerformed(ActionEvent e)
1493       {
1494         load();
1495       }
1496     });
1497
1498     JButton saveColours = new JButton(
1499             MessageManager.getString("label.save_colours"));
1500     saveColours.setFont(JvSwingUtils.getLabelFont());
1501     saveColours.setToolTipText(
1502             MessageManager.getString("label.save_colours_tooltip"));
1503     saveColours.addActionListener(new ActionListener()
1504     {
1505       @Override
1506       public void actionPerformed(ActionEvent e)
1507       {
1508         save();
1509       }
1510     });
1511     transparency.addChangeListener(new ChangeListener()
1512     {
1513       @Override
1514       public void stateChanged(ChangeEvent evt)
1515       {
1516         if (!inConstruction)
1517         {
1518           fr.setTransparency((100 - transparency.getValue()) / 100f);
1519           refreshDisplay();
1520         }
1521       }
1522     });
1523
1524     transparency.setMaximum(70);
1525     transparency.setToolTipText(
1526             MessageManager.getString("label.transparency_tip"));
1527
1528     boolean nucleotide = af.getViewport().getAlignment().isNucleotide();
1529     String text = MessageManager.formatMessage("label.show_linked_features",
1530             nucleotide
1531                     ? MessageManager.getString("label.protein")
1532                             .toLowerCase()
1533                     : "CDS");
1534     showComplement = new JCheckBox(text);
1535     showComplement.addActionListener(new ActionListener()
1536     {
1537       @Override
1538       public void actionPerformed(ActionEvent e)
1539       {
1540         af.getViewport()
1541                 .setShowComplementFeatures(showComplement.isSelected());
1542         refreshDisplay();
1543       }
1544     });
1545
1546     showComplementOnTop = new JCheckBox(
1547             MessageManager.getString("label.on_top"));
1548     showComplementOnTop.addActionListener(new ActionListener()
1549     {
1550       @Override
1551       public void actionPerformed(ActionEvent e)
1552       {
1553         af.getViewport().setShowComplementFeaturesOnTop(
1554                 showComplementOnTop.isSelected());
1555         refreshDisplay();
1556       }
1557     });
1558
1559     updateComplementButtons();
1560
1561     JPanel lowerPanel = new JPanel(new GridLayout(1, 2));
1562     bigPanel.add(lowerPanel, BorderLayout.SOUTH);
1563
1564     JPanel transbuttons = new JPanel(new GridLayout(5, 1));
1565     transbuttons.add(optimizeOrder);
1566     transbuttons.add(invert);
1567     transbuttons.add(sortByScore);
1568     transbuttons.add(sortByDens);
1569     transbuttons.add(help);
1570
1571     JPanel transPanelLeft = new JPanel(
1572             new GridLayout(hasComplement ? 4 : 2, 1));
1573     transPanelLeft.add(new JLabel(" Colour transparency" + ":"));
1574     transPanelLeft.add(transparency);
1575     if (hasComplement)
1576     {
1577       JPanel cp = new JPanel(new FlowLayout(FlowLayout.LEFT));
1578       cp.add(showComplement);
1579       cp.add(showComplementOnTop);
1580       transPanelLeft.add(cp);
1581     }
1582     lowerPanel.add(transPanelLeft);
1583     lowerPanel.add(transbuttons);
1584
1585     JPanel buttonPanel = new JPanel();
1586     buttonPanel.add(ok);
1587     buttonPanel.add(cancel);
1588     buttonPanel.add(loadColours);
1589     buttonPanel.add(saveColours);
1590     bigPanel.add(scrollPane, BorderLayout.CENTER);
1591     settingsPane.add(bigPanel, BorderLayout.CENTER);
1592     settingsPane.add(buttonPanel, BorderLayout.SOUTH);
1593     this.add(settingsPane);
1594   }
1595
1596   /**
1597    * Repaints alignment, structure and overview (if shown). If there is a
1598    * complementary view which is showing this view's features, then also
1599    * repaints that.
1600    */
1601   void refreshDisplay()
1602   {
1603     af.alignPanel.paintAlignment(true, true);
1604     AlignViewportI complement = af.getViewport().getCodingComplement();
1605     if (complement != null && complement.isShowComplementFeatures())
1606     {
1607       AlignFrame af2 = Desktop.getAlignFrameFor(complement);
1608       af2.alignPanel.paintAlignment(true, true);
1609     }
1610   }
1611
1612   /**
1613    * Answers a suitable tooltip to show on the colour cell of the table
1614    * 
1615    * @param fcol
1616    * @param withHint
1617    *                   if true include 'click to edit' and similar text
1618    * @return
1619    */
1620   public static String getColorTooltip(FeatureColourI fcol,
1621           boolean withHint)
1622   {
1623     if (fcol == null)
1624     {
1625       return null;
1626     }
1627     if (fcol.isSimpleColour())
1628     {
1629       return withHint ? BASE_TOOLTIP : null;
1630     }
1631     String description = fcol.getDescription();
1632     description = description.replaceAll("<", "&lt;");
1633     description = description.replaceAll(">", "&gt;");
1634     StringBuilder tt = new StringBuilder(description);
1635     if (withHint)
1636     {
1637       tt.append("<br>").append(BASE_TOOLTIP).append("</br>");
1638     }
1639     return JvSwingUtils.wrapTooltip(true, tt.toString());
1640   }
1641
1642   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol,
1643           int w, int h)
1644   {
1645     boolean thr = false;
1646     StringBuilder tx = new StringBuilder();
1647
1648     if (gcol.isColourByAttribute())
1649     {
1650       tx.append(FeatureMatcher
1651               .toAttributeDisplayName(gcol.getAttributeName()));
1652     }
1653     else if (!gcol.isColourByLabel())
1654     {
1655       tx.append(MessageManager.getString("label.score"));
1656     }
1657     tx.append(" ");
1658     if (gcol.isAboveThreshold())
1659     {
1660       thr = true;
1661       tx.append(">");
1662     }
1663     if (gcol.isBelowThreshold())
1664     {
1665       thr = true;
1666       tx.append("<");
1667     }
1668     if (gcol.isColourByLabel())
1669     {
1670       if (thr)
1671       {
1672         tx.append(" ");
1673       }
1674       if (!gcol.isColourByAttribute())
1675       {
1676         tx.append("Label");
1677       }
1678       comp.setIcon(null);
1679     }
1680     else
1681     {
1682       Color newColor = gcol.getMaxColour();
1683       comp.setBackground(newColor);
1684       // System.err.println("Width is " + w / 2);
1685       Icon ficon = new FeatureIcon(gcol, comp.getBackground(), w, h, thr);
1686       comp.setIcon(ficon);
1687       // tt+="RGB value: Max (" + newColor.getRed() + ", "
1688       // + newColor.getGreen() + ", " + newColor.getBlue()
1689       // + ")\nMin (" + minCol.getRed() + ", " + minCol.getGreen()
1690       // + ", " + minCol.getBlue() + ")");
1691     }
1692     comp.setHorizontalAlignment(SwingConstants.CENTER);
1693     comp.setText(tx.toString());
1694   }
1695
1696   // ///////////////////////////////////////////////////////////////////////
1697   // http://java.sun.com/docs/books/tutorial/uiswing/components/table.html
1698   // ///////////////////////////////////////////////////////////////////////
1699   class FeatureTableModel extends AbstractTableModel
1700   {
1701     private String[] columnNames = {
1702         MessageManager.getString("label.feature_type"),
1703         MessageManager.getString("action.colour"),
1704         MessageManager.getString("label.configuration"),
1705         MessageManager.getString("label.show") };
1706
1707     private Object[][] data;
1708
1709     FeatureTableModel(Object[][] data)
1710     {
1711       this.data = data;
1712     }
1713
1714     public Object[][] getData()
1715     {
1716       return data;
1717     }
1718
1719     public void setData(Object[][] data)
1720     {
1721       this.data = data;
1722     }
1723
1724     @Override
1725     public int getColumnCount()
1726     {
1727       return columnNames.length;
1728     }
1729
1730     public Object[] getRow(int row)
1731     {
1732       return data[row];
1733     }
1734
1735     @Override
1736     public int getRowCount()
1737     {
1738       return data.length;
1739     }
1740
1741     @Override
1742     public String getColumnName(int col)
1743     {
1744       return columnNames[col];
1745     }
1746
1747     @Override
1748     public Object getValueAt(int row, int col)
1749     {
1750       return data[row][col];
1751     }
1752
1753     /**
1754      * Answers the class of column c of the table
1755      */
1756     @Override
1757     public Class<?> getColumnClass(int c)
1758     {
1759       switch (c)
1760       {
1761       case TYPE_COLUMN:
1762         return String.class;
1763       case COLOUR_COLUMN:
1764         return FeatureColour.class;
1765       case FILTER_COLUMN:
1766         return FeatureMatcherSet.class;
1767       default:
1768         return Boolean.class;
1769       }
1770     }
1771
1772     @Override
1773     public boolean isCellEditable(int row, int col)
1774     {
1775       return col == 0 ? false : true;
1776     }
1777
1778     @Override
1779     public void setValueAt(Object value, int row, int col)
1780     {
1781       data[row][col] = value;
1782       fireTableCellUpdated(row, col);
1783       updateFeatureRenderer(data);
1784     }
1785
1786   }
1787
1788   class ColorRenderer extends JLabel implements TableCellRenderer
1789   {
1790     Border unselectedBorder = null;
1791
1792     Border selectedBorder = null;
1793
1794     public ColorRenderer()
1795     {
1796       setOpaque(true); // MUST do this for background to show up.
1797       setHorizontalTextPosition(SwingConstants.CENTER);
1798       setVerticalTextPosition(SwingConstants.CENTER);
1799     }
1800
1801     @Override
1802     public Component getTableCellRendererComponent(JTable tbl, Object color,
1803             boolean isSelected, boolean hasFocus, int row, int column)
1804     {
1805       FeatureColourI cellColour = (FeatureColourI) color;
1806       setOpaque(true);
1807       setBackground(tbl.getBackground());
1808       if (!cellColour.isSimpleColour())
1809       {
1810         Rectangle cr = tbl.getCellRect(row, column, false);
1811         FeatureSettings.renderGraduatedColor(this, cellColour,
1812                 (int) cr.getWidth(), (int) cr.getHeight());
1813       }
1814       else
1815       {
1816         this.setText("");
1817         this.setIcon(null);
1818         setBackground(cellColour.getColour());
1819       }
1820       if (isSelected)
1821       {
1822         if (selectedBorder == null)
1823         {
1824           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1825                   tbl.getSelectionBackground());
1826         }
1827         setBorder(selectedBorder);
1828       }
1829       else
1830       {
1831         if (unselectedBorder == null)
1832         {
1833           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1834                   tbl.getBackground());
1835         }
1836         setBorder(unselectedBorder);
1837       }
1838
1839       return this;
1840     }
1841   }
1842
1843   class FilterRenderer extends JLabel implements TableCellRenderer
1844   {
1845     javax.swing.border.Border unselectedBorder = null;
1846
1847     javax.swing.border.Border selectedBorder = null;
1848
1849     public FilterRenderer()
1850     {
1851       setOpaque(true); // MUST do this for background to show up.
1852       setHorizontalTextPosition(SwingConstants.CENTER);
1853       setVerticalTextPosition(SwingConstants.CENTER);
1854     }
1855
1856     @Override
1857     public Component getTableCellRendererComponent(JTable tbl,
1858             Object filter, boolean isSelected, boolean hasFocus, int row,
1859             int column)
1860     {
1861       FeatureMatcherSetI theFilter = (FeatureMatcherSetI) filter;
1862       setOpaque(true);
1863       String asText = theFilter.toString();
1864       setBackground(tbl.getBackground());
1865       this.setText(asText);
1866       this.setIcon(null);
1867
1868       if (isSelected)
1869       {
1870         if (selectedBorder == null)
1871         {
1872           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1873                   tbl.getSelectionBackground());
1874         }
1875         setBorder(selectedBorder);
1876       }
1877       else
1878       {
1879         if (unselectedBorder == null)
1880         {
1881           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1882                   tbl.getBackground());
1883         }
1884         setBorder(unselectedBorder);
1885       }
1886
1887       return this;
1888     }
1889   }
1890
1891   /**
1892    * update comp using rendering settings from gcol
1893    * 
1894    * @param comp
1895    * @param gcol
1896    */
1897   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol)
1898   {
1899     int w = comp.getWidth(), h = comp.getHeight();
1900     if (w < 20)
1901     {
1902       w = (int) comp.getPreferredSize().getWidth();
1903       h = (int) comp.getPreferredSize().getHeight();
1904       if (w < 20)
1905       {
1906         w = 80;
1907         h = 12;
1908       }
1909     }
1910     renderGraduatedColor(comp, gcol, w, h);
1911   }
1912
1913   @SuppressWarnings("serial")
1914   class ColorEditor extends AbstractCellEditor
1915           implements TableCellEditor, ActionListener
1916   {
1917     FeatureColourI currentColor;
1918
1919     FeatureTypeSettings chooser;
1920
1921     String type;
1922
1923     JButton button;
1924
1925     protected static final String EDIT = "edit";
1926
1927     int rowSelected = 0;
1928
1929     public ColorEditor()
1930     {
1931       // Set up the editor (from the table's point of view),
1932       // which is a button.
1933       // This button brings up the color chooser dialog,
1934       // which is the editor from the user's point of view.
1935       button = new JButton();
1936       button.setActionCommand(EDIT);
1937       button.addActionListener(this);
1938       button.setBorderPainted(false);
1939     }
1940
1941     /**
1942      * Handles events from the editor button, and from the colour/filters
1943      * dialog's OK button
1944      */
1945     @Override
1946     public void actionPerformed(ActionEvent e)
1947     {
1948       if (button == e.getSource())
1949       {
1950         if (currentColor.isSimpleColour())
1951         {
1952           /*
1953            * simple colour chooser
1954            */
1955           String ttl = MessageManager
1956                   .formatMessage("label.select_colour_for", type);
1957           ColourChooserListener listener = new ColourChooserListener()
1958           {
1959             @Override
1960             public void colourSelected(Color c)
1961             {
1962               currentColor = new FeatureColour(c);
1963               table.setValueAt(currentColor, rowSelected, COLOUR_COLUMN);
1964               fireEditingStopped();
1965             }
1966
1967             @Override
1968             public void cancel()
1969             {
1970               fireEditingStopped();
1971             }
1972           };
1973           JalviewColourChooser.showColourChooser(button, ttl,
1974                   currentColor.getColour(), listener);
1975         }
1976         else
1977         {
1978           /*
1979            * variable colour and filters dialog
1980            */
1981           chooser = new FeatureTypeSettings(fr, type);
1982           if (!Platform.isJS())
1983           /**
1984            * Java only
1985            * 
1986            * @j2sIgnore
1987            */
1988           {
1989             chooser.setRequestFocusEnabled(true);
1990             chooser.requestFocus();
1991           }
1992           chooser.addActionListener(this);
1993           fireEditingStopped();
1994         }
1995       }
1996       else
1997       {
1998         /*
1999          * after OK in variable colour dialog, any changes to colour 
2000          * (or filters!) are already set in FeatureRenderer, so just
2001          * update table data without triggering updateFeatureRenderer
2002          */
2003         currentColor = fr.getFeatureColours().get(type);
2004         FeatureMatcherSetI currentFilter = fr.getFeatureFilter(type);
2005         if (currentFilter == null)
2006         {
2007           currentFilter = new FeatureMatcherSet();
2008         }
2009         Object[] data = ((FeatureTableModel) table.getModel())
2010                 .getData()[rowSelected];
2011         data[COLOUR_COLUMN] = currentColor;
2012         data[FILTER_COLUMN] = currentFilter;
2013         fireEditingStopped();
2014         // SwingJS needs an explicit repaint() here,
2015         // rather than relying upon no validation having
2016         // occurred since the stopEditing call was made.
2017         // Its laying out has not been stopped by the modal frame
2018         table.validate();
2019         table.repaint();
2020       }
2021     }
2022
2023     /**
2024      * Override allows access to this method from anonymous inner classes
2025      */
2026     @Override
2027     protected void fireEditingStopped()
2028     {
2029       super.fireEditingStopped();
2030     }
2031
2032     // Implement the one CellEditor method that AbstractCellEditor doesn't.
2033     @Override
2034     public Object getCellEditorValue()
2035     {
2036       return currentColor;
2037     }
2038
2039     // Implement the one method defined by TableCellEditor.
2040     @Override
2041     public Component getTableCellEditorComponent(JTable theTable,
2042             Object value, boolean isSelected, int row, int column)
2043     {
2044       currentColor = (FeatureColourI) value;
2045       this.rowSelected = row;
2046       type = table.getValueAt(row, TYPE_COLUMN).toString();
2047       button.setOpaque(true);
2048       button.setBackground(FeatureSettings.this.getBackground());
2049       if (!currentColor.isSimpleColour())
2050       {
2051         JLabel btn = new JLabel();
2052         btn.setSize(button.getSize());
2053         FeatureSettings.renderGraduatedColor(btn, currentColor);
2054         button.setBackground(btn.getBackground());
2055         button.setIcon(btn.getIcon());
2056         button.setText(btn.getText());
2057       }
2058       else
2059       {
2060         button.setText("");
2061         button.setIcon(null);
2062         button.setBackground(currentColor.getColour());
2063       }
2064       return button;
2065     }
2066   }
2067
2068   /**
2069    * The cell editor for the Filter column. It displays the text of any filters
2070    * for the feature type in that row (in full as a tooltip, possible
2071    * abbreviated as display text). On click in the cell, opens the Feature
2072    * Display Settings dialog at the Filters tab.
2073    */
2074   @SuppressWarnings("serial")
2075   class FilterEditor extends AbstractCellEditor
2076           implements TableCellEditor, ActionListener
2077   {
2078
2079     FeatureMatcherSetI currentFilter;
2080
2081     Point lastLocation;
2082
2083     String type;
2084
2085     JButton button;
2086
2087     protected static final String EDIT = "edit";
2088
2089     int rowSelected = 0;
2090
2091     public FilterEditor()
2092     {
2093       button = new JButton();
2094       button.setActionCommand(EDIT);
2095       button.addActionListener(this);
2096       button.setBorderPainted(false);
2097     }
2098
2099     /**
2100      * Handles events from the editor button
2101      */
2102     @Override
2103     public void actionPerformed(ActionEvent e)
2104     {
2105       if (button == e.getSource())
2106       {
2107         FeatureTypeSettings chooser = new FeatureTypeSettings(fr, type);
2108         chooser.addActionListener(this);
2109         chooser.setRequestFocusEnabled(true);
2110         chooser.requestFocus();
2111         if (lastLocation != null)
2112         {
2113           // todo open at its last position on screen
2114           chooser.setBounds(lastLocation.x, lastLocation.y,
2115                   chooser.getWidth(), chooser.getHeight());
2116           chooser.validate();
2117         }
2118         fireEditingStopped();
2119       }
2120       else if (e.getSource() instanceof Component)
2121       {
2122
2123         /*
2124          * after OK in variable colour dialog, any changes to filter
2125          * (or colours!) are already set in FeatureRenderer, so just
2126          * update table data without triggering updateFeatureRenderer
2127          */
2128         FeatureColourI currentColor = fr.getFeatureColours().get(type);
2129         currentFilter = fr.getFeatureFilter(type);
2130         if (currentFilter == null)
2131         {
2132           currentFilter = new FeatureMatcherSet();
2133         }
2134
2135         Object[] data = ((FeatureTableModel) table.getModel())
2136                 .getData()[rowSelected];
2137         data[COLOUR_COLUMN] = currentColor;
2138         data[FILTER_COLUMN] = currentFilter;
2139         fireEditingStopped();
2140         // SwingJS needs an explicit repaint() here,
2141         // rather than relying upon no validation having
2142         // occurred since the stopEditing call was made.
2143         // Its laying out has not been stopped by the modal frame
2144         table.validate();
2145         table.repaint();
2146       }
2147     }
2148
2149     @Override
2150     public Object getCellEditorValue()
2151     {
2152       return currentFilter;
2153     }
2154
2155     @Override
2156     public Component getTableCellEditorComponent(JTable theTable,
2157             Object value, boolean isSelected, int row, int column)
2158     {
2159       currentFilter = (FeatureMatcherSetI) value;
2160       this.rowSelected = row;
2161       type = table.getValueAt(row, TYPE_COLUMN).toString();
2162       button.setOpaque(true);
2163       button.setBackground(FeatureSettings.this.getBackground());
2164       button.setText(currentFilter.toString());
2165       button.setIcon(null);
2166       return button;
2167     }
2168   }
2169
2170   public boolean isOpen()
2171   {
2172     if (af.getSplitViewContainer() != null)
2173     {
2174       return af.getSplitViewContainer().isFeatureSettingsOpen();
2175     }
2176     return frame != null && !frame.isClosed();
2177   }
2178
2179   @Override
2180   public void revert()
2181   {
2182     fr.setTransparency(originalTransparency);
2183     fr.setFeatureFilters(originalFilters);
2184     updateFeatureRenderer(originalData);
2185     af.getViewport().setViewStyle(originalViewStyle);
2186     updateTransparencySliderFromFR();
2187     updateComplementButtons();
2188     refreshDisplay();
2189   }
2190 }
2191
2192 class FeatureIcon implements Icon
2193 {
2194   FeatureColourI gcol;
2195
2196   Color backg;
2197
2198   boolean midspace = false;
2199
2200   int width = 50, height = 20;
2201
2202   int s1, e1; // start and end of midpoint band for thresholded symbol
2203
2204   Color mpcolour = Color.white;
2205
2206   FeatureIcon(FeatureColourI gfc, Color bg, int w, int h, boolean mspace)
2207   {
2208     gcol = gfc;
2209     backg = bg;
2210     width = w;
2211     height = h;
2212     midspace = mspace;
2213     if (midspace)
2214     {
2215       s1 = width / 3;
2216       e1 = s1 * 2;
2217     }
2218     else
2219     {
2220       s1 = width / 2;
2221       e1 = s1;
2222     }
2223   }
2224
2225   @Override
2226   public int getIconWidth()
2227   {
2228     return width;
2229   }
2230
2231   @Override
2232   public int getIconHeight()
2233   {
2234     return height;
2235   }
2236
2237   @Override
2238   public void paintIcon(Component c, Graphics g, int x, int y)
2239   {
2240
2241     if (gcol.isColourByLabel())
2242     {
2243       g.setColor(backg);
2244       g.fillRect(0, 0, width, height);
2245       // need an icon here.
2246       g.setColor(gcol.getMaxColour());
2247
2248       g.setFont(new Font("Verdana", Font.PLAIN, 9));
2249
2250       // g.setFont(g.getFont().deriveFont(
2251       // AffineTransform.getScaleInstance(
2252       // width/g.getFontMetrics().stringWidth("Label"),
2253       // height/g.getFontMetrics().getHeight())));
2254
2255       g.drawString(MessageManager.getString("label.label"), 0, 0);
2256
2257     }
2258     else
2259     {
2260       Color minCol = gcol.getMinColour();
2261       g.setColor(minCol);
2262       g.fillRect(0, 0, s1, height);
2263       if (midspace)
2264       {
2265         g.setColor(Color.white);
2266         g.fillRect(s1, 0, e1 - s1, height);
2267       }
2268       g.setColor(gcol.getMaxColour());
2269       // g.fillRect(0, e1, width - e1, height); // BH 2018
2270       g.fillRect(e1, 0, width - e1, height);
2271     }
2272   }
2273 }