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