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