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