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