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