src/jalview/gui/FeatureSettings.java

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