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