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