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