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