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