src/jalview/gui/FeatureSettings.java

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