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(WindowIcons.featuresIcon);
 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, new Runnable()
 952     {
 953       @Override
 954       public void run()
 955       {
 956         File file = chooser.getSelectedFile();
 957         load(file);
 958       }
 959     });
 960     chooser.showOpenDialog(this);
 961   }
 962
 963   /**
 964    * Loads feature colours and filters from XML stored in the given file
 965    *
 966    * @param file
 967    */
 968   void load(File file)
 969   {
 970     try
 971     {
 972       InputStreamReader in = new InputStreamReader(
 973               new FileInputStream(file), "UTF-8");
 974
 975       JAXBContext jc = JAXBContext
 976               .newInstance("jalview.xml.binding.jalview");
 977       javax.xml.bind.Unmarshaller um = jc.createUnmarshaller();
 978       XMLStreamReader streamReader = XMLInputFactory.newInstance()
 979               .createXMLStreamReader(in);
 980       JAXBElement<JalviewUserColours> jbe = um.unmarshal(streamReader,
 981               JalviewUserColours.class);
 982       JalviewUserColours jucs = jbe.getValue();
 983
 984       // JalviewUserColours jucs = JalviewUserColours.unmarshal(in);
 985
 986       /*
 987        * load feature colours
 988        */
 989       for (int i = jucs.getColour().size() - 1; i >= 0; i--)
 990       {
 991         Colour newcol = jucs.getColour().get(i);
 992         FeatureColourI colour = jalview.project.Jalview2XML
 993                 .parseColour(newcol);
 994         fr.setColour(newcol.getName(), colour);
 995         fr.setOrder(newcol.getName(), i / (float) jucs.getColour().size());
 996       }
 997
 998       /*
 999        * load feature filters; loaded filters will replace any that are
1000        * currently defined, other defined filters are left unchanged
1001        */
1002       for (int i = 0; i < jucs.getFilter().size(); i++)
1003       {
1004         Filter filterModel = jucs.getFilter().get(i);
1005         String featureType = filterModel.getFeatureType();
1006         FeatureMatcherSetI filter = jalview.project.Jalview2XML
1007                 .parseFilter(featureType, filterModel.getMatcherSet());
1008         if (!filter.isEmpty())
1009         {
1010           fr.setFeatureFilter(featureType, filter);
1011         }
1012       }
1013
1014       /*
1015        * update feature settings table
1016        */
1017       if (table != null)
1018       {
1019         resetTable(null);
1020         Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1021         ensureOrder(data);
1022         updateFeatureRenderer(data, false);
1023         table.repaint();
1024       }
1025     } catch (Exception ex)
1026     {
1027       System.out.println("Error loading User Colour File\n" + ex);
1028     }
1029   }
1030
1031   /**
1032    * Offers a file chooser dialog, and then saves the current feature colours
1033    * and any filters to the selected file in XML format
1034    */
1035   void save()
1036   {
1037     JalviewFileChooser chooser = new JalviewFileChooser("fc",
1038             SEQUENCE_FEATURE_COLOURS);
1039     chooser.setFileView(new JalviewFileView());
1040     chooser.setDialogTitle(
1041             MessageManager.getString("label.save_feature_colours"));
1042     chooser.setToolTipText(MessageManager.getString("action.save"));
1043     int option = chooser.showSaveDialog(this);
1044     if (option == JalviewFileChooser.APPROVE_OPTION)
1045     {
1046       File file = chooser.getSelectedFile();
1047       save(file);
1048     }
1049   }
1050
1051   /**
1052    * Saves feature colours and filters to the given file
1053    *
1054    * @param file
1055    */
1056   void save(File file)
1057   {
1058     JalviewUserColours ucs = new JalviewUserColours();
1059     ucs.setSchemeName("Sequence Features");
1060     try
1061     {
1062       PrintWriter out = new PrintWriter(
1063               new OutputStreamWriter(new FileOutputStream(file), "UTF-8"));
1064
1065       /*
1066        * sort feature types by colour order, from 0 (highest)
1067        * to 1 (lowest)
1068        */
1069       Set<String> fr_colours = fr.getAllFeatureColours();
1070       String[] sortedTypes = fr_colours
1071               .toArray(new String[fr_colours.size()]);
1072       Arrays.sort(sortedTypes, new Comparator<String>()
1073       {
1074         @Override
1075         public int compare(String type1, String type2)
1076         {
1077           return Float.compare(fr.getOrder(type1), fr.getOrder(type2));
1078         }
1079       });
1080
1081       /*
1082        * save feature colours
1083        */
1084       for (String featureType : sortedTypes)
1085       {
1086         FeatureColourI fcol = fr.getFeatureStyle(featureType);
1087         Colour col = jalview.project.Jalview2XML.marshalColour(featureType,
1088                 fcol);
1089         ucs.getColour().add(col);
1090       }
1091
1092       /*
1093        * save any feature filters
1094        */
1095       for (String featureType : sortedTypes)
1096       {
1097         FeatureMatcherSetI filter = fr.getFeatureFilter(featureType);
1098         if (filter != null && !filter.isEmpty())
1099         {
1100           Iterator<FeatureMatcherI> iterator = filter.getMatchers()
1101                   .iterator();
1102           FeatureMatcherI firstMatcher = iterator.next();
1103           jalview.xml.binding.jalview.FeatureMatcherSet ms = jalview.project.Jalview2XML
1104                   .marshalFilter(firstMatcher, iterator, filter.isAnded());
1105           Filter filterModel = new Filter();
1106           filterModel.setFeatureType(featureType);
1107           filterModel.setMatcherSet(ms);
1108           ucs.getFilter().add(filterModel);
1109         }
1110       }
1111       JAXBContext jaxbContext = JAXBContext
1112               .newInstance(JalviewUserColours.class);
1113       Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
1114       jaxbMarshaller.marshal(
1115               new ObjectFactory().createJalviewUserColours(ucs), out);
1116
1117       // jaxbMarshaller.marshal(object, pout);
1118       // marshaller.marshal(object);
1119       out.flush();
1120
1121       // ucs.marshal(out);
1122       out.close();
1123     } catch (Exception ex)
1124     {
1125       ex.printStackTrace();
1126     }
1127   }
1128
1129   public void invertSelection()
1130   {
1131     Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1132     for (int i = 0; i < data.length; i++)
1133     {
1134       data[i][SHOW_COLUMN] = !(Boolean) data[i][SHOW_COLUMN];
1135     }
1136     updateFeatureRenderer(data, true);
1137     table.repaint();
1138   }
1139
1140   public void orderByAvWidth()
1141   {
1142     if (table == null || table.getModel() == null)
1143     {
1144       return;
1145     }
1146     Object[][] data = ((FeatureTableModel) table.getModel()).getData();
1147     float[] width = new float[data.length];
1148     float[] awidth;
1149     float max = 0;
1150
1151     for (int i = 0; i < data.length; i++)
1152     {
1153       awidth = typeWidth.get(data[i][TYPE_COLUMN]);
1154       if (awidth[0] > 0)
1155       {
1156         width[i] = awidth[1] / awidth[0];// *awidth[0]*awidth[2]; - better
1157         // weight - but have to make per
1158         // sequence, too (awidth[2])
1159         // if (width[i]==1) // hack to distinguish single width sequences.
1160       }
1161       else
1162       {
1163         width[i] = 0;
1164       }
1165       if (max < width[i])
1166       {
1167         max = width[i];
1168       }
1169     }
1170     boolean sort = false;
1171     for (int i = 0; i < width.length; i++)
1172     {
1173       // awidth = (float[]) typeWidth.get(data[i][0]);
1174       if (width[i] == 0)
1175       {
1176         width[i] = fr.getOrder(data[i][TYPE_COLUMN].toString());
1177         if (width[i] < 0)
1178         {
1179           width[i] = fr.setOrder(data[i][TYPE_COLUMN].toString(),
1180                   i / data.length);
1181         }
1182       }
1183       else
1184       {
1185         width[i] /= max; // normalize
1186         fr.setOrder(data[i][TYPE_COLUMN].toString(), width[i]); // store for
1187                                                                 // later
1188       }
1189       if (i > 0)
1190       {
1191         sort = sort || width[i - 1] > width[i];
1192       }
1193     }
1194     if (sort)
1195     {
1196       jalview.util.QuickSort.sort(width, data);
1197       // update global priority order
1198     }
1199
1200     updateFeatureRenderer(data, false);
1201     table.repaint();
1202   }
1203
1204   /**
1205    * close ourselves but leave any existing UI handlers (e.g a CDS/Protein
1206    * tabbed feature settings dialog) intact
1207    */
1208   public void closeOldSettings()
1209   {
1210     closeDialog(false);
1211   }
1212
1213   /**
1214    * close the feature settings dialog (and any containing frame)
1215    */
1216   public void close()
1217   {
1218     closeDialog(true);
1219   }
1220
1221   private void closeDialog(boolean closeContainingFrame)
1222   {
1223     try
1224     {
1225       if (frame != null)
1226       {
1227         af.setFeatureSettingsGeometry(frame.getBounds());
1228         frame.setClosed(true);
1229       }
1230       else
1231       {
1232         SplitContainerI sc = af.getSplitViewContainer();
1233         sc.closeFeatureSettings(this, closeContainingFrame);
1234         af.featureSettings = null;
1235       }
1236     } catch (Exception exe)
1237     {
1238     }
1239
1240   }
1241
1242   public void updateFeatureRenderer(Object[][] data)
1243   {
1244     updateFeatureRenderer(data, true);
1245   }
1246
1247   /**
1248    * Update the priority order of features; only repaint if this changed the
1249    * order of visible features
1250    *
1251    * @param data
1252    * @param visibleNew
1253    */
1254   void updateFeatureRenderer(Object[][] data, boolean visibleNew)
1255   {
1256     FeatureSettingsBean[] rowData = getTableAsBeans(data);
1257
1258     if (fr.setFeaturePriority(rowData, visibleNew))
1259     {
1260       refreshDisplay();
1261     }
1262   }
1263
1264   /**
1265    * Converts table data into an array of data beans
1266    */
1267   private FeatureSettingsBean[] getTableAsBeans(Object[][] data)
1268   {
1269     FeatureSettingsBean[] rowData = new FeatureSettingsBean[data.length];
1270     for (int i = 0; i < data.length; i++)
1271     {
1272       String type = (String) data[i][TYPE_COLUMN];
1273       FeatureColourI colour = (FeatureColourI) data[i][COLOUR_COLUMN];
1274       FeatureMatcherSetI theFilter = (FeatureMatcherSetI) data[i][FILTER_COLUMN];
1275       Boolean isShown = (Boolean) data[i][SHOW_COLUMN];
1276       rowData[i] = new FeatureSettingsBean(type, colour, theFilter,
1277               isShown);
1278     }
1279     return rowData;
1280   }
1281
1282   private void jbInit() throws Exception
1283   {
1284     this.setLayout(new BorderLayout());
1285
1286     final boolean hasComplement = af.getViewport()
1287             .getCodingComplement() != null;
1288
1289     JPanel settingsPane = new JPanel();
1290     settingsPane.setLayout(new BorderLayout());
1291
1292     JPanel bigPanel = new JPanel();
1293     bigPanel.setLayout(new BorderLayout());
1294
1295     groupPanel = new JPanel();
1296     bigPanel.add(groupPanel, BorderLayout.NORTH);
1297
1298     JButton invert = new JButton(
1299             MessageManager.getString("label.invert_selection"));
1300     invert.setFont(JvSwingUtils.getLabelFont());
1301     invert.addActionListener(new ActionListener()
1302     {
1303       @Override
1304       public void actionPerformed(ActionEvent e)
1305       {
1306         invertSelection();
1307       }
1308     });
1309
1310     JButton optimizeOrder = new JButton(
1311             MessageManager.getString("label.optimise_order"));
1312     optimizeOrder.setFont(JvSwingUtils.getLabelFont());
1313     optimizeOrder.addActionListener(new ActionListener()
1314     {
1315       @Override
1316       public void actionPerformed(ActionEvent e)
1317       {
1318         orderByAvWidth();
1319       }
1320     });
1321
1322     final String byScoreLabel = MessageManager
1323             .getString("label.seq_sort_by_score");
1324     JButton sortByScore = new JButton(byScoreLabel);
1325     sortByScore.setFont(JvSwingUtils.getLabelFont());
1326     sortByScore.addActionListener(new ActionListener()
1327     {
1328       @Override
1329       public void actionPerformed(ActionEvent e)
1330       {
1331         if (canSortBy(byScoreLabel))
1332         {
1333           sortByScore(null);
1334         }
1335       }
1336     });
1337     final String byDensityLabel = MessageManager
1338             .getString("label.sequence_sort_by_density");
1339     JButton sortByDens = new JButton(byDensityLabel);
1340     sortByDens.setFont(JvSwingUtils.getLabelFont());
1341     sortByDens.addActionListener(new ActionListener()
1342     {
1343       @Override
1344       public void actionPerformed(ActionEvent e)
1345       {
1346         if (canSortBy(byDensityLabel))
1347         {
1348           sortByDensity(null);
1349         }
1350       }
1351     });
1352
1353     JButton help = new JButton(MessageManager.getString("action.help"));
1354     help.setFont(JvSwingUtils.getLabelFont());
1355     help.addActionListener(new ActionListener()
1356     {
1357       @Override
1358       public void actionPerformed(ActionEvent e)
1359       {
1360         try
1361         {
1362           Help.showHelpWindow(HelpId.SequenceFeatureSettings);
1363         } catch (HelpSetException e1)
1364         {
1365           e1.printStackTrace();
1366         }
1367       }
1368     });
1369     // Cancel for a SplitFrame should just revert changes to the currently
1370     // displayed
1371     // settings. May want to do this for either or both - so need a splitview
1372     // feature settings cancel/OK.
1373     JButton cancel = new JButton(MessageManager
1374             .getString(hasComplement ? "action.revert" : "action.cancel"));
1375     cancel.setToolTipText(MessageManager.getString(hasComplement
1376             ? "action.undo_changes_to_feature_settings"
1377             : "action.undo_changes_to_feature_settings_and_close_the_dialog"));
1378     cancel.setFont(JvSwingUtils.getLabelFont());
1379     // TODO: disable cancel (and apply!) until current settings are different
1380     cancel.addActionListener(new ActionListener()
1381     {
1382       @Override
1383       public void actionPerformed(ActionEvent e)
1384       {
1385         revert();
1386         refreshDisplay();
1387         if (!hasComplement)
1388         {
1389           close();
1390         }
1391       }
1392     });
1393     // Cancel for the whole dialog should cancel both CDS and Protein.
1394     // OK for an individual feature settings just applies changes, but dialog
1395     // remains open
1396     JButton ok = new JButton(MessageManager
1397             .getString(hasComplement ? "action.apply" : "action.ok"));
1398     ok.setFont(JvSwingUtils.getLabelFont());
1399     ok.addActionListener(new ActionListener()
1400     {
1401       @Override
1402       public void actionPerformed(ActionEvent e)
1403       {
1404         if (!hasComplement)
1405         {
1406           close();
1407         }
1408         else
1409         {
1410           storeOriginalSettings();
1411         }
1412       }
1413     });
1414
1415     JButton loadColours = new JButton(
1416             MessageManager.getString("label.load_colours"));
1417     loadColours.setFont(JvSwingUtils.getLabelFont());
1418     loadColours.setToolTipText(
1419             MessageManager.getString("label.load_colours_tooltip"));
1420     loadColours.addActionListener(new ActionListener()
1421     {
1422       @Override
1423       public void actionPerformed(ActionEvent e)
1424       {
1425         load();
1426       }
1427     });
1428
1429     JButton saveColours = new JButton(
1430             MessageManager.getString("label.save_colours"));
1431     saveColours.setFont(JvSwingUtils.getLabelFont());
1432     saveColours.setToolTipText(
1433             MessageManager.getString("label.save_colours_tooltip"));
1434     saveColours.addActionListener(new ActionListener()
1435     {
1436       @Override
1437       public void actionPerformed(ActionEvent e)
1438       {
1439         save();
1440       }
1441     });
1442     transparency.addChangeListener(new ChangeListener()
1443     {
1444       @Override
1445       public void stateChanged(ChangeEvent evt)
1446       {
1447         if (!inConstruction)
1448         {
1449           fr.setTransparency((100 - transparency.getValue()) / 100f);
1450           refreshDisplay();
1451         }
1452       }
1453     });
1454
1455     transparency.setMaximum(70);
1456     transparency.setToolTipText(
1457             MessageManager.getString("label.transparency_tip"));
1458
1459     boolean nucleotide = af.getViewport().getAlignment().isNucleotide();
1460     String text = MessageManager
1461             .formatMessage("label.show_linked_features",
1462                     nucleotide
1463                             ? MessageManager.getString("label.protein")
1464                                     .toLowerCase(Locale.ROOT)
1465                             : "CDS");
1466     showComplement = new JCheckBox(text);
1467     showComplement.addActionListener(new ActionListener()
1468     {
1469       @Override
1470       public void actionPerformed(ActionEvent e)
1471       {
1472         af.getViewport()
1473                 .setShowComplementFeatures(showComplement.isSelected());
1474         refreshDisplay();
1475       }
1476     });
1477
1478     showComplementOnTop = new JCheckBox(
1479             MessageManager.getString("label.on_top"));
1480     showComplementOnTop.addActionListener(new ActionListener()
1481     {
1482       @Override
1483       public void actionPerformed(ActionEvent e)
1484       {
1485         af.getViewport().setShowComplementFeaturesOnTop(
1486                 showComplementOnTop.isSelected());
1487         refreshDisplay();
1488       }
1489     });
1490
1491     updateComplementButtons();
1492
1493     JPanel lowerPanel = new JPanel(new GridLayout(1, 2));
1494     bigPanel.add(lowerPanel, BorderLayout.SOUTH);
1495
1496     JPanel transbuttons = new JPanel(new GridLayout(5, 1));
1497     transbuttons.add(optimizeOrder);
1498     transbuttons.add(invert);
1499     transbuttons.add(sortByScore);
1500     transbuttons.add(sortByDens);
1501     transbuttons.add(help);
1502
1503     JPanel transPanelLeft = new JPanel(
1504             new GridLayout(hasComplement ? 4 : 2, 1));
1505     transPanelLeft.add(new JLabel(" Colour transparency" + ":"));
1506     transPanelLeft.add(transparency);
1507     if (hasComplement)
1508     {
1509       JPanel cp = new JPanel(new FlowLayout(FlowLayout.LEFT));
1510       cp.add(showComplement);
1511       cp.add(showComplementOnTop);
1512       transPanelLeft.add(cp);
1513     }
1514     lowerPanel.add(transPanelLeft);
1515     lowerPanel.add(transbuttons);
1516
1517     JPanel buttonPanel = new JPanel();
1518     buttonPanel.add(ok);
1519     buttonPanel.add(cancel);
1520     buttonPanel.add(loadColours);
1521     buttonPanel.add(saveColours);
1522     bigPanel.add(scrollPane, BorderLayout.CENTER);
1523     settingsPane.add(bigPanel, BorderLayout.CENTER);
1524     settingsPane.add(buttonPanel, BorderLayout.SOUTH);
1525     this.add(settingsPane);
1526   }
1527
1528   /**
1529    * Repaints alignment, structure and overview (if shown). If there is a
1530    * complementary view which is showing this view's features, then also
1531    * repaints that.
1532    */
1533   void refreshDisplay()
1534   {
1535     af.alignPanel.paintAlignment(true, true);
1536     AlignViewportI complement = af.getViewport().getCodingComplement();
1537     if (complement != null && complement.isShowComplementFeatures())
1538     {
1539       AlignFrame af2 = Desktop.getAlignFrameFor(complement);
1540       af2.alignPanel.paintAlignment(true, true);
1541     }
1542   }
1543
1544   /**
1545    * Answers a suitable tooltip to show on the colour cell of the table
1546    *
1547    * @param fcol
1548    * @param withHint
1549    *          if true include 'click to edit' and similar text
1550    * @return
1551    */
1552   public static String getColorTooltip(FeatureColourI fcol,
1553           boolean withHint)
1554   {
1555     if (fcol == null)
1556     {
1557       return null;
1558     }
1559     if (fcol.isSimpleColour())
1560     {
1561       return withHint ? BASE_TOOLTIP : null;
1562     }
1563     String description = fcol.getDescription();
1564     description = description.replaceAll("<", "&lt;");
1565     description = description.replaceAll(">", "&gt;");
1566     StringBuilder tt = new StringBuilder(description);
1567     if (withHint)
1568     {
1569       tt.append("<br>").append(BASE_TOOLTIP).append("</br>");
1570     }
1571     return JvSwingUtils.wrapTooltip(true, tt.toString());
1572   }
1573
1574   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol,
1575           int w, int h)
1576   {
1577     boolean thr = false;
1578     StringBuilder tx = new StringBuilder();
1579
1580     if (gcol.isColourByAttribute())
1581     {
1582       tx.append(FeatureMatcher
1583               .toAttributeDisplayName(gcol.getAttributeName()));
1584     }
1585     else if (!gcol.isColourByLabel())
1586     {
1587       tx.append(MessageManager.getString("label.score"));
1588     }
1589     tx.append(" ");
1590     if (gcol.isAboveThreshold())
1591     {
1592       thr = true;
1593       tx.append(">");
1594     }
1595     if (gcol.isBelowThreshold())
1596     {
1597       thr = true;
1598       tx.append("<");
1599     }
1600     if (gcol.isColourByLabel())
1601     {
1602       if (thr)
1603       {
1604         tx.append(" ");
1605       }
1606       if (!gcol.isColourByAttribute())
1607       {
1608         tx.append("Label");
1609       }
1610       comp.setIcon(null);
1611     }
1612     else
1613     {
1614       Color newColor = gcol.getMaxColour();
1615       comp.setBackground(newColor);
1616       // System.err.println("Width is " + w / 2);
1617       Icon ficon = new FeatureIcon(gcol, comp.getBackground(), w, h, thr);
1618       comp.setIcon(ficon);
1619       // tt+="RGB value: Max (" + newColor.getRed() + ", "
1620       // + newColor.getGreen() + ", " + newColor.getBlue()
1621       // + ")\nMin (" + minCol.getRed() + ", " + minCol.getGreen()
1622       // + ", " + minCol.getBlue() + ")");
1623     }
1624     comp.setHorizontalAlignment(SwingConstants.CENTER);
1625     comp.setText(tx.toString());
1626   }
1627
1628   // ///////////////////////////////////////////////////////////////////////
1629   // http://java.sun.com/docs/books/tutorial/uiswing/components/table.html
1630   // ///////////////////////////////////////////////////////////////////////
1631   class FeatureTableModel extends AbstractTableModel
1632   {
1633     private String[] columnNames = {
1634         MessageManager.getString("label.feature_type"),
1635         MessageManager.getString("action.colour"),
1636         MessageManager.getString("label.configuration"),
1637         MessageManager.getString("label.show") };
1638
1639     private Object[][] data;
1640
1641     FeatureTableModel(Object[][] data)
1642     {
1643       this.data = data;
1644     }
1645
1646     public Object[][] getData()
1647     {
1648       return data;
1649     }
1650
1651     public void setData(Object[][] data)
1652     {
1653       this.data = data;
1654     }
1655
1656     @Override
1657     public int getColumnCount()
1658     {
1659       return columnNames.length;
1660     }
1661
1662     public Object[] getRow(int row)
1663     {
1664       return data[row];
1665     }
1666
1667     @Override
1668     public int getRowCount()
1669     {
1670       return data.length;
1671     }
1672
1673     @Override
1674     public String getColumnName(int col)
1675     {
1676       return columnNames[col];
1677     }
1678
1679     @Override
1680     public Object getValueAt(int row, int col)
1681     {
1682       return data[row][col];
1683     }
1684
1685     /**
1686      * Answers the class of column c of the table
1687      */
1688     @Override
1689     public Class<?> getColumnClass(int c)
1690     {
1691       switch (c)
1692       {
1693       case TYPE_COLUMN:
1694         return String.class;
1695       case COLOUR_COLUMN:
1696         return FeatureColour.class;
1697       case FILTER_COLUMN:
1698         return FeatureMatcherSet.class;
1699       default:
1700         return Boolean.class;
1701       }
1702     }
1703
1704     @Override
1705     public boolean isCellEditable(int row, int col)
1706     {
1707       return col == 0 ? false : true;
1708     }
1709
1710     @Override
1711     public void setValueAt(Object value, int row, int col)
1712     {
1713       data[row][col] = value;
1714       fireTableCellUpdated(row, col);
1715       updateFeatureRenderer(data);
1716     }
1717
1718   }
1719
1720   class ColorRenderer extends JLabel implements TableCellRenderer
1721   {
1722     Border unselectedBorder = null;
1723
1724     Border selectedBorder = null;
1725
1726     public ColorRenderer()
1727     {
1728       setOpaque(true); // MUST do this for background to show up.
1729       setHorizontalTextPosition(SwingConstants.CENTER);
1730       setVerticalTextPosition(SwingConstants.CENTER);
1731     }
1732
1733     @Override
1734     public Component getTableCellRendererComponent(JTable tbl, Object color,
1735             boolean isSelected, boolean hasFocus, int row, int column)
1736     {
1737       FeatureColourI cellColour = (FeatureColourI) color;
1738       setOpaque(true);
1739       setBackground(tbl.getBackground());
1740       if (!cellColour.isSimpleColour())
1741       {
1742         Rectangle cr = tbl.getCellRect(row, column, false);
1743         FeatureSettings.renderGraduatedColor(this, cellColour,
1744                 (int) cr.getWidth(), (int) cr.getHeight());
1745       }
1746       else
1747       {
1748         this.setText("");
1749         this.setIcon(null);
1750         setBackground(cellColour.getColour());
1751       }
1752       if (isSelected)
1753       {
1754         if (selectedBorder == null)
1755         {
1756           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1757                   tbl.getSelectionBackground());
1758         }
1759         setBorder(selectedBorder);
1760       }
1761       else
1762       {
1763         if (unselectedBorder == null)
1764         {
1765           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1766                   tbl.getBackground());
1767         }
1768         setBorder(unselectedBorder);
1769       }
1770
1771       return this;
1772     }
1773   }
1774
1775   class FilterRenderer extends JLabel implements TableCellRenderer
1776   {
1777     javax.swing.border.Border unselectedBorder = null;
1778
1779     javax.swing.border.Border selectedBorder = null;
1780
1781     public FilterRenderer()
1782     {
1783       setOpaque(true); // MUST do this for background to show up.
1784       setHorizontalTextPosition(SwingConstants.CENTER);
1785       setVerticalTextPosition(SwingConstants.CENTER);
1786     }
1787
1788     @Override
1789     public Component getTableCellRendererComponent(JTable tbl,
1790             Object filter, boolean isSelected, boolean hasFocus, int row,
1791             int column)
1792     {
1793       FeatureMatcherSetI theFilter = (FeatureMatcherSetI) filter;
1794       setOpaque(true);
1795       String asText = theFilter.toString();
1796       setBackground(tbl.getBackground());
1797       this.setText(asText);
1798       this.setIcon(null);
1799
1800       if (isSelected)
1801       {
1802         if (selectedBorder == null)
1803         {
1804           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1805                   tbl.getSelectionBackground());
1806         }
1807         setBorder(selectedBorder);
1808       }
1809       else
1810       {
1811         if (unselectedBorder == null)
1812         {
1813           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1814                   tbl.getBackground());
1815         }
1816         setBorder(unselectedBorder);
1817       }
1818
1819       return this;
1820     }
1821   }
1822
1823   /**
1824    * update comp using rendering settings from gcol
1825    *
1826    * @param comp
1827    * @param gcol
1828    */
1829   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol)
1830   {
1831     int w = comp.getWidth(), h = comp.getHeight();
1832     if (w < 20)
1833     {
1834       w = (int) comp.getPreferredSize().getWidth();
1835       h = (int) comp.getPreferredSize().getHeight();
1836       if (w < 20)
1837       {
1838         w = 80;
1839         h = 12;
1840       }
1841     }
1842     renderGraduatedColor(comp, gcol, w, h);
1843   }
1844
1845   @SuppressWarnings("serial")
1846   class ColorEditor extends AbstractCellEditor
1847           implements TableCellEditor, ActionListener
1848   {
1849     FeatureColourI currentColor;
1850
1851     FeatureTypeSettings chooser;
1852
1853     String type;
1854
1855     JButton button;
1856
1857     protected static final String EDIT = "edit";
1858
1859     int rowSelected = 0;
1860
1861     public ColorEditor()
1862     {
1863       // Set up the editor (from the table's point of view),
1864       // which is a button.
1865       // This button brings up the color chooser dialog,
1866       // which is the editor from the user's point of view.
1867       button = new JButton();
1868       button.setActionCommand(EDIT);
1869       button.addActionListener(this);
1870       button.setBorderPainted(false);
1871     }
1872
1873     /**
1874      * Handles events from the editor button, and from the colour/filters
1875      * dialog's OK button
1876      */
1877     @Override
1878     public void actionPerformed(ActionEvent e)
1879     {
1880       if (button == e.getSource())
1881       {
1882         if (currentColor.isSimpleColour())
1883         {
1884           /*
1885            * simple colour chooser
1886            */
1887           String ttl = MessageManager
1888                   .formatMessage("label.select_colour_for", type);
1889           ColourChooserListener listener = new ColourChooserListener()
1890           {
1891             @Override
1892             public void colourSelected(Color c)
1893             {
1894               currentColor = new FeatureColour(c);
1895               table.setValueAt(currentColor, rowSelected, COLOUR_COLUMN);
1896               fireEditingStopped();
1897             }
1898
1899             @Override
1900             public void cancel()
1901             {
1902               fireEditingStopped();
1903             }
1904           };
1905           JalviewColourChooser.showColourChooser(button, ttl,
1906                   currentColor.getColour(), listener);
1907         }
1908         else
1909         {
1910           /*
1911            * variable colour and filters dialog
1912            */
1913           chooser = new FeatureTypeSettings(fr, type);
1914           if (!Platform.isJS())
1915           /**
1916            * Java only
1917            *
1918            * @j2sIgnore
1919            */
1920           {
1921             chooser.setRequestFocusEnabled(true);
1922             chooser.requestFocus();
1923           }
1924           chooser.addActionListener(this);
1925           fireEditingStopped();
1926         }
1927       }
1928       else
1929       {
1930         /*
1931          * after OK in variable colour dialog, any changes to colour
1932          * (or filters!) are already set in FeatureRenderer, so just
1933          * update table data without triggering updateFeatureRenderer
1934          */
1935         currentColor = fr.getFeatureColours().get(type);
1936         FeatureMatcherSetI currentFilter = fr.getFeatureFilter(type);
1937         if (currentFilter == null)
1938         {
1939           currentFilter = new FeatureMatcherSet();
1940         }
1941         Object[] data = ((FeatureTableModel) table.getModel())
1942                 .getData()[rowSelected];
1943         data[COLOUR_COLUMN] = currentColor;
1944         data[FILTER_COLUMN] = currentFilter;
1945         fireEditingStopped();
1946         // SwingJS needs an explicit repaint() here,
1947         // rather than relying upon no validation having
1948         // occurred since the stopEditing call was made.
1949         // Its laying out has not been stopped by the modal frame
1950         table.validate();
1951         table.repaint();
1952       }
1953     }
1954
1955     /**
1956      * Override allows access to this method from anonymous inner classes
1957      */
1958     @Override
1959     protected void fireEditingStopped()
1960     {
1961       super.fireEditingStopped();
1962     }
1963
1964     // Implement the one CellEditor method that AbstractCellEditor doesn't.
1965     @Override
1966     public Object getCellEditorValue()
1967     {
1968       return currentColor;
1969     }
1970
1971     // Implement the one method defined by TableCellEditor.
1972     @Override
1973     public Component getTableCellEditorComponent(JTable theTable,
1974             Object value, boolean isSelected, int row, int column)
1975     {
1976       currentColor = (FeatureColourI) value;
1977       this.rowSelected = row;
1978       type = table.getValueAt(row, TYPE_COLUMN).toString();
1979       button.setOpaque(true);
1980       button.setBackground(FeatureSettings.this.getBackground());
1981       if (!currentColor.isSimpleColour())
1982       {
1983         JLabel btn = new JLabel();
1984         btn.setSize(button.getSize());
1985         FeatureSettings.renderGraduatedColor(btn, currentColor);
1986         button.setBackground(btn.getBackground());
1987         button.setIcon(btn.getIcon());
1988         button.setText(btn.getText());
1989       }
1990       else
1991       {
1992         button.setText("");
1993         button.setIcon(null);
1994         button.setBackground(currentColor.getColour());
1995       }
1996       return button;
1997     }
1998   }
1999
2000   /**
2001    * The cell editor for the Filter column. It displays the text of any filters
2002    * for the feature type in that row (in full as a tooltip, possible
2003    * abbreviated as display text). On click in the cell, opens the Feature
2004    * Display Settings dialog at the Filters tab.
2005    */
2006   @SuppressWarnings("serial")
2007   class FilterEditor extends AbstractCellEditor
2008           implements TableCellEditor, ActionListener
2009   {
2010
2011     FeatureMatcherSetI currentFilter;
2012
2013     Point lastLocation;
2014
2015     String type;
2016
2017     JButton button;
2018
2019     protected static final String EDIT = "edit";
2020
2021     int rowSelected = 0;
2022
2023     public FilterEditor()
2024     {
2025       button = new JButton();
2026       button.setActionCommand(EDIT);
2027       button.addActionListener(this);
2028       button.setBorderPainted(false);
2029     }
2030
2031     /**
2032      * Handles events from the editor button
2033      */
2034     @Override
2035     public void actionPerformed(ActionEvent e)
2036     {
2037       if (button == e.getSource())
2038       {
2039         FeatureTypeSettings chooser = new FeatureTypeSettings(fr, type);
2040         chooser.addActionListener(this);
2041         chooser.setRequestFocusEnabled(true);
2042         chooser.requestFocus();
2043         if (lastLocation != null)
2044         {
2045           // todo open at its last position on screen
2046           chooser.setBounds(lastLocation.x, lastLocation.y,
2047                   chooser.getWidth(), chooser.getHeight());
2048           chooser.validate();
2049         }
2050         fireEditingStopped();
2051       }
2052       else if (e.getSource() instanceof Component)
2053       {
2054
2055         /*
2056          * after OK in variable colour dialog, any changes to filter
2057          * (or colours!) are already set in FeatureRenderer, so just
2058          * update table data without triggering updateFeatureRenderer
2059          */
2060         FeatureColourI currentColor = fr.getFeatureColours().get(type);
2061         currentFilter = fr.getFeatureFilter(type);
2062         if (currentFilter == null)
2063         {
2064           currentFilter = new FeatureMatcherSet();
2065         }
2066
2067         Object[] data = ((FeatureTableModel) table.getModel())
2068                 .getData()[rowSelected];
2069         data[COLOUR_COLUMN] = currentColor;
2070         data[FILTER_COLUMN] = currentFilter;
2071         fireEditingStopped();
2072         // SwingJS needs an explicit repaint() here,
2073         // rather than relying upon no validation having
2074         // occurred since the stopEditing call was made.
2075         // Its laying out has not been stopped by the modal frame
2076         table.validate();
2077         table.repaint();
2078       }
2079     }
2080
2081     @Override
2082     public Object getCellEditorValue()
2083     {
2084       return currentFilter;
2085     }
2086
2087     @Override
2088     public Component getTableCellEditorComponent(JTable theTable,
2089             Object value, boolean isSelected, int row, int column)
2090     {
2091       currentFilter = (FeatureMatcherSetI) value;
2092       this.rowSelected = row;
2093       type = table.getValueAt(row, TYPE_COLUMN).toString();
2094       button.setOpaque(true);
2095       button.setBackground(FeatureSettings.this.getBackground());
2096       button.setText(currentFilter.toString());
2097       button.setIcon(null);
2098       return button;
2099     }
2100   }
2101
2102   public boolean isOpen()
2103   {
2104     if (af.getSplitViewContainer() != null)
2105     {
2106       return af.getSplitViewContainer().isFeatureSettingsOpen();
2107     }
2108     return frame != null && !frame.isClosed();
2109   }
2110
2111   @Override
2112   public void revert()
2113   {
2114     fr.setTransparency(originalTransparency);
2115     fr.setFeatureFilters(originalFilters);
2116     updateFeatureRenderer(originalData);
2117     af.getViewport().setViewStyle(originalViewStyle);
2118     updateTransparencySliderFromFR();
2119     updateComplementButtons();
2120     refreshDisplay();
2121   }
2122 }
2123
2124 class FeatureIcon implements Icon
2125 {
2126   FeatureColourI gcol;
2127
2128   Color backg;
2129
2130   boolean midspace = false;
2131
2132   int width = 50, height = 20;
2133
2134   int s1, e1; // start and end of midpoint band for thresholded symbol
2135
2136   Color mpcolour = Color.white;
2137
2138   FeatureIcon(FeatureColourI gfc, Color bg, int w, int h, boolean mspace)
2139   {
2140     gcol = gfc;
2141     backg = bg;
2142     width = w;
2143     height = h;
2144     midspace = mspace;
2145     if (midspace)
2146     {
2147       s1 = width / 3;
2148       e1 = s1 * 2;
2149     }
2150     else
2151     {
2152       s1 = width / 2;
2153       e1 = s1;
2154     }
2155   }
2156
2157   @Override
2158   public int getIconWidth()
2159   {
2160     return width;
2161   }
2162
2163   @Override
2164   public int getIconHeight()
2165   {
2166     return height;
2167   }
2168
2169   @Override
2170   public void paintIcon(Component c, Graphics g, int x, int y)
2171   {
2172
2173     if (gcol.isColourByLabel())
2174     {
2175       g.setColor(backg);
2176       g.fillRect(0, 0, width, height);
2177       // need an icon here.
2178       g.setColor(gcol.getMaxColour());
2179
2180       g.setFont(new Font("Verdana", Font.PLAIN, 9));
2181
2182       // g.setFont(g.getFont().deriveFont(
2183       // AffineTransform.getScaleInstance(
2184       // width/g.getFontMetrics().stringWidth("Label"),
2185       // height/g.getFontMetrics().getHeight())));
2186
2187       g.drawString(MessageManager.getString("label.label"), 0, 0);
2188
2189     }
2190     else
2191     {
2192       Color minCol = gcol.getMinColour();
2193       g.setColor(minCol);
2194       g.fillRect(0, 0, s1, height);
2195       if (midspace)
2196       {
2197         g.setColor(Color.white);
2198         g.fillRect(s1, 0, e1 - s1, height);
2199       }
2200       g.setColor(gcol.getMaxColour());
2201       // g.fillRect(0, e1, width - e1, height); // BH 2018
2202       g.fillRect(e1, 0, width - e1, height);
2203     }
2204   }
2205 }