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