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