src/jalview/gui/FeatureSettings.java

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