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