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.addActionListener(new ActionListener()
1270     {
1271       @Override
1272       public void actionPerformed(ActionEvent e)
1273       {
1274         af.getViewport()
1275                 .setShowComplementFeatures(showComplement.isSelected());
1276         refreshDisplay();
1277       }
1278     });
1279
1280     JPanel transPanel = new JPanel(new GridLayout(1, 2));
1281     bigPanel.add(transPanel, BorderLayout.SOUTH);
1282
1283     JPanel transbuttons = new JPanel(new GridLayout(5, 1));
1284     transbuttons.add(optimizeOrder);
1285     transbuttons.add(invert);
1286     transbuttons.add(sortByScore);
1287     transbuttons.add(sortByDens);
1288     transbuttons.add(help);
1289
1290     boolean hasComplement = af.getViewport().getCodingComplement() != null;
1291     JPanel transPanelLeft = new JPanel(
1292             new GridLayout(hasComplement ? 2 : 1, 1));
1293     transPanelLeft.add(transparency);
1294     if (hasComplement)
1295     {
1296       transPanelLeft.add(showComplement);
1297     }
1298     transPanel.add(transPanelLeft);
1299     transPanel.add(transbuttons);
1300
1301     JPanel buttonPanel = new JPanel();
1302     buttonPanel.add(ok);
1303     buttonPanel.add(cancel);
1304     buttonPanel.add(loadColours);
1305     buttonPanel.add(saveColours);
1306     bigPanel.add(scrollPane, BorderLayout.CENTER);
1307     settingsPane.add(bigPanel, BorderLayout.CENTER);
1308     settingsPane.add(buttonPanel, BorderLayout.SOUTH);
1309     this.add(settingsPane);
1310   }
1311
1312   /**
1313    * Repaints alignment, structure and overview (if shown). If there is a
1314    * complementary view which is showing this view's features, then also
1315    * repaints that.
1316    */
1317   void refreshDisplay()
1318   {
1319     af.alignPanel.paintAlignment(true, true);
1320     AlignViewportI complement = af.getViewport().getCodingComplement();
1321     if (complement != null && complement.isShowComplementFeatures())
1322     {
1323       AlignFrame af2 = Desktop.getAlignFrameFor(complement);
1324       af2.alignPanel.paintAlignment(true, true);
1325     }
1326   }
1327
1328   // ///////////////////////////////////////////////////////////////////////
1329   // http://java.sun.com/docs/books/tutorial/uiswing/components/table.html
1330   // ///////////////////////////////////////////////////////////////////////
1331   class FeatureTableModel extends AbstractTableModel
1332   {
1333     private String[] columnNames = {
1334         MessageManager.getString("label.feature_type"),
1335         MessageManager.getString("action.colour"),
1336         MessageManager.getString("label.configuration"),
1337         MessageManager.getString("label.show") };
1338
1339     private Object[][] data;
1340
1341     FeatureTableModel(Object[][] data)
1342     {
1343       this.data = data;
1344     }
1345
1346     public Object[][] getData()
1347     {
1348       return data;
1349     }
1350
1351     public void setData(Object[][] data)
1352     {
1353       this.data = data;
1354     }
1355
1356     @Override
1357     public int getColumnCount()
1358     {
1359       return columnNames.length;
1360     }
1361
1362     public Object[] getRow(int row)
1363     {
1364       return data[row];
1365     }
1366
1367     @Override
1368     public int getRowCount()
1369     {
1370       return data.length;
1371     }
1372
1373     @Override
1374     public String getColumnName(int col)
1375     {
1376       return columnNames[col];
1377     }
1378
1379     @Override
1380     public Object getValueAt(int row, int col)
1381     {
1382       return data[row][col];
1383     }
1384
1385     /**
1386      * Answers the class of the object in column c of the first row of the table
1387      */
1388     @Override
1389     public Class<?> getColumnClass(int c)
1390     {
1391       Object v = getValueAt(0, c);
1392       return v == null ? null : v.getClass();
1393     }
1394
1395     @Override
1396     public boolean isCellEditable(int row, int col)
1397     {
1398       return col == 0 ? false : true;
1399     }
1400
1401     @Override
1402     public void setValueAt(Object value, int row, int col)
1403     {
1404       data[row][col] = value;
1405       fireTableCellUpdated(row, col);
1406       updateFeatureRenderer(data);
1407     }
1408
1409   }
1410
1411   class ColorRenderer extends JLabel implements TableCellRenderer
1412   {
1413     javax.swing.border.Border unselectedBorder = null;
1414
1415     javax.swing.border.Border selectedBorder = null;
1416
1417     final String baseTT = "Click to edit, right/apple click for menu.";
1418
1419     public ColorRenderer()
1420     {
1421       setOpaque(true); // MUST do this for background to show up.
1422       setHorizontalTextPosition(SwingConstants.CENTER);
1423       setVerticalTextPosition(SwingConstants.CENTER);
1424     }
1425
1426     @Override
1427     public Component getTableCellRendererComponent(JTable tbl, Object color,
1428             boolean isSelected, boolean hasFocus, int row, int column)
1429     {
1430       FeatureColourI cellColour = (FeatureColourI) color;
1431       setOpaque(true);
1432       setToolTipText(baseTT);
1433       setBackground(tbl.getBackground());
1434       if (!cellColour.isSimpleColour())
1435       {
1436         Rectangle cr = tbl.getCellRect(row, column, false);
1437         FeatureSettings.renderGraduatedColor(this, cellColour,
1438                 (int) cr.getWidth(), (int) cr.getHeight());
1439       }
1440       else
1441       {
1442         this.setText("");
1443         this.setIcon(null);
1444         setBackground(cellColour.getColour());
1445       }
1446       if (isSelected)
1447       {
1448         if (selectedBorder == null)
1449         {
1450           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1451                   tbl.getSelectionBackground());
1452         }
1453         setBorder(selectedBorder);
1454       }
1455       else
1456       {
1457         if (unselectedBorder == null)
1458         {
1459           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1460                   tbl.getBackground());
1461         }
1462         setBorder(unselectedBorder);
1463       }
1464
1465       return this;
1466     }
1467   }
1468
1469   class FilterRenderer extends JLabel implements TableCellRenderer
1470   {
1471     javax.swing.border.Border unselectedBorder = null;
1472
1473     javax.swing.border.Border selectedBorder = null;
1474
1475     public FilterRenderer()
1476     {
1477       setOpaque(true); // MUST do this for background to show up.
1478       setHorizontalTextPosition(SwingConstants.CENTER);
1479       setVerticalTextPosition(SwingConstants.CENTER);
1480     }
1481
1482     @Override
1483     public Component getTableCellRendererComponent(JTable tbl,
1484             Object filter, boolean isSelected, boolean hasFocus, int row,
1485             int column)
1486     {
1487       FeatureMatcherSetI theFilter = (FeatureMatcherSetI) filter;
1488       setOpaque(true);
1489       String asText = theFilter.toString();
1490       setBackground(tbl.getBackground());
1491       this.setText(asText);
1492       this.setIcon(null);
1493
1494       if (isSelected)
1495       {
1496         if (selectedBorder == null)
1497         {
1498           selectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1499                   tbl.getSelectionBackground());
1500         }
1501         setBorder(selectedBorder);
1502       }
1503       else
1504       {
1505         if (unselectedBorder == null)
1506         {
1507           unselectedBorder = BorderFactory.createMatteBorder(2, 5, 2, 5,
1508                   tbl.getBackground());
1509         }
1510         setBorder(unselectedBorder);
1511       }
1512
1513       return this;
1514     }
1515   }
1516
1517   /**
1518    * update comp using rendering settings from gcol
1519    *
1520    * @param comp
1521    * @param gcol
1522    */
1523   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol)
1524   {
1525     int w = comp.getWidth(), h = comp.getHeight();
1526     if (w < 20)
1527     {
1528       w = (int) comp.getPreferredSize().getWidth();
1529       h = (int) comp.getPreferredSize().getHeight();
1530       if (w < 20)
1531       {
1532         w = 80;
1533         h = 12;
1534       }
1535     }
1536     renderGraduatedColor(comp, gcol, w, h);
1537   }
1538
1539   public static void renderGraduatedColor(JLabel comp, FeatureColourI gcol,
1540           int w, int h)
1541   {
1542     boolean thr = false;
1543     StringBuilder tt = new StringBuilder();
1544     StringBuilder tx = new StringBuilder();
1545
1546     if (gcol.isColourByAttribute())
1547     {
1548       tx.append(String.join(":", gcol.getAttributeName()));
1549     }
1550     else if (!gcol.isColourByLabel())
1551     {
1552       tx.append(MessageManager.getString("label.score"));
1553     }
1554     tx.append(" ");
1555     if (gcol.isAboveThreshold())
1556     {
1557       thr = true;
1558       tx.append(">");
1559       tt.append("Thresholded (Above ").append(gcol.getThreshold())
1560               .append(") ");
1561     }
1562     if (gcol.isBelowThreshold())
1563     {
1564       thr = true;
1565       tx.append("<");
1566       tt.append("Thresholded (Below ").append(gcol.getThreshold())
1567               .append(") ");
1568     }
1569     if (gcol.isColourByLabel())
1570     {
1571       tt.append("Coloured by label text. ").append(tt);
1572       if (thr)
1573       {
1574         tx.append(" ");
1575       }
1576       if (!gcol.isColourByAttribute())
1577       {
1578         tx.append("Label");
1579       }
1580       comp.setIcon(null);
1581     }
1582     else
1583     {
1584       Color newColor = gcol.getMaxColour();
1585       comp.setBackground(newColor);
1586       // System.err.println("Width is " + w / 2);
1587       Icon ficon = new FeatureIcon(gcol, comp.getBackground(), w, h, thr);
1588       comp.setIcon(ficon);
1589       // tt+="RGB value: Max (" + newColor.getRed() + ", "
1590       // + newColor.getGreen() + ", " + newColor.getBlue()
1591       // + ")\nMin (" + minCol.getRed() + ", " + minCol.getGreen()
1592       // + ", " + minCol.getBlue() + ")");
1593     }
1594     comp.setHorizontalAlignment(SwingConstants.CENTER);
1595     comp.setText(tx.toString());
1596     if (tt.length() > 0)
1597     {
1598       if (comp.getToolTipText() == null)
1599       {
1600         comp.setToolTipText(tt.toString());
1601       }
1602       else
1603       {
1604         comp.setToolTipText(
1605                 tt.append(" ").append(comp.getToolTipText()).toString());
1606       }
1607     }
1608   }
1609
1610   class ColorEditor extends AbstractCellEditor
1611           implements TableCellEditor, ActionListener
1612   {
1613     FeatureSettings me;
1614
1615     FeatureColourI currentColor;
1616
1617     FeatureTypeSettings chooser;
1618
1619     String type;
1620
1621     JButton button;
1622
1623     JColorChooser colorChooser;
1624
1625     JDialog dialog;
1626
1627     protected static final String EDIT = "edit";
1628
1629     int rowSelected = 0;
1630
1631     public ColorEditor(FeatureSettings me)
1632     {
1633       this.me = me;
1634       // Set up the editor (from the table's point of view),
1635       // which is a button.
1636       // This button brings up the color chooser dialog,
1637       // which is the editor from the user's point of view.
1638       button = new JButton();
1639       button.setActionCommand(EDIT);
1640       button.addActionListener(this);
1641       button.setBorderPainted(false);
1642       // Set up the dialog that the button brings up.
1643       colorChooser = new JColorChooser();
1644       dialog = JColorChooser.createDialog(button,
1645               MessageManager.getString("label.select_colour"), true, // modal
1646               colorChooser, this, // OK button handler
1647               null); // no CANCEL button handler
1648     }
1649
1650     /**
1651      * Handles events from the editor button and from the dialog's OK button.
1652      */
1653     @Override
1654     public void actionPerformed(ActionEvent e)
1655     {
1656       // todo test e.getSource() instead here
1657       if (EDIT.equals(e.getActionCommand()))
1658       {
1659         // The user has clicked the cell, so
1660         // bring up the dialog.
1661         if (currentColor.isSimpleColour())
1662         {
1663           // bring up simple color chooser
1664           button.setBackground(currentColor.getColour());
1665           colorChooser.setColor(currentColor.getColour());
1666           dialog.setVisible(true);
1667         }
1668         else
1669         {
1670           // bring up graduated chooser.
1671           chooser = new FeatureTypeSettings(me.fr, type);
1672           /**
1673            * @j2sNative
1674            */
1675           {
1676             chooser.setRequestFocusEnabled(true);
1677             chooser.requestFocus();
1678           }
1679           chooser.addActionListener(this);
1680           // Make the renderer reappear.
1681           fireEditingStopped();
1682         }
1683       }
1684       else
1685       {
1686         if (currentColor.isSimpleColour())
1687         {
1688           /*
1689            * read off colour picked in colour chooser after OK pressed
1690            */
1691           currentColor = new FeatureColour(colorChooser.getColor());
1692           me.table.setValueAt(currentColor, rowSelected, COLOUR_COLUMN);
1693         }
1694         else
1695         {
1696           /*
1697            * after OK in variable colour dialog, any changes to colour
1698            * (or filters!) are already set in FeatureRenderer, so just
1699            * update table data without triggering updateFeatureRenderer
1700            */
1701           currentColor = fr.getFeatureColours().get(type);
1702           FeatureMatcherSetI currentFilter = me.fr.getFeatureFilter(type);
1703           if (currentFilter == null)
1704           {
1705             currentFilter = new FeatureMatcherSet();
1706           }
1707           Object[] data = ((FeatureTableModel) table.getModel())
1708                   .getData()[rowSelected];
1709           data[COLOUR_COLUMN] = currentColor;
1710           data[FILTER_COLUMN] = currentFilter;
1711         }
1712         fireEditingStopped();
1713         me.table.validate();
1714       }
1715     }
1716
1717     // Implement the one CellEditor method that AbstractCellEditor doesn't.
1718     @Override
1719     public Object getCellEditorValue()
1720     {
1721       return currentColor;
1722     }
1723
1724     // Implement the one method defined by TableCellEditor.
1725     @Override
1726     public Component getTableCellEditorComponent(JTable theTable, Object value,
1727             boolean isSelected, int row, int column)
1728     {
1729       currentColor = (FeatureColourI) value;
1730       this.rowSelected = row;
1731       type = me.table.getValueAt(row, TYPE_COLUMN).toString();
1732       button.setOpaque(true);
1733       button.setBackground(me.getBackground());
1734       if (!currentColor.isSimpleColour())
1735       {
1736         JLabel btn = new JLabel();
1737         btn.setSize(button.getSize());
1738         FeatureSettings.renderGraduatedColor(btn, currentColor);
1739         button.setBackground(btn.getBackground());
1740         button.setIcon(btn.getIcon());
1741         button.setText(btn.getText());
1742       }
1743       else
1744       {
1745         button.setText("");
1746         button.setIcon(null);
1747         button.setBackground(currentColor.getColour());
1748       }
1749       return button;
1750     }
1751   }
1752
1753   /**
1754    * The cell editor for the Filter column. It displays the text of any filters
1755    * for the feature type in that row (in full as a tooltip, possible abbreviated
1756    * as display text). On click in the cell, opens the Feature Display Settings
1757    * dialog at the Filters tab.
1758    */
1759   class FilterEditor extends AbstractCellEditor
1760           implements TableCellEditor, ActionListener
1761   {
1762     FeatureSettings me;
1763
1764     FeatureMatcherSetI currentFilter;
1765
1766     Point lastLocation;
1767
1768     String type;
1769
1770     JButton button;
1771
1772     protected static final String EDIT = "edit";
1773
1774     int rowSelected = 0;
1775
1776     public FilterEditor(FeatureSettings me)
1777     {
1778       this.me = me;
1779       button = new JButton();
1780       button.setActionCommand(EDIT);
1781       button.addActionListener(this);
1782       button.setBorderPainted(false);
1783     }
1784
1785     /**
1786      * Handles events from the editor button
1787      */
1788     @Override
1789     public void actionPerformed(ActionEvent e)
1790     {
1791       if (button == e.getSource())
1792       {
1793         FeatureTypeSettings chooser = new FeatureTypeSettings(me.fr, type);
1794         chooser.addActionListener(this);
1795         chooser.setRequestFocusEnabled(true);
1796         chooser.requestFocus();
1797         if (lastLocation != null)
1798         {
1799           // todo open at its last position on screen
1800           chooser.setBounds(lastLocation.x, lastLocation.y,
1801                   chooser.getWidth(), chooser.getHeight());
1802           chooser.validate();
1803         }
1804         fireEditingStopped();
1805       }
1806       else if (e.getSource() instanceof Component)
1807       {
1808
1809         /*
1810          * after OK in variable colour dialog, any changes to filter
1811          * (or colours!) are already set in FeatureRenderer, so just
1812          * update table data without triggering updateFeatureRenderer
1813          */
1814         FeatureColourI currentColor = fr.getFeatureColours().get(type);
1815         currentFilter = me.fr.getFeatureFilter(type);
1816         if (currentFilter == null)
1817         {
1818           currentFilter = new FeatureMatcherSet();
1819         }
1820         Object[] data = ((FeatureTableModel) table.getModel())
1821                 .getData()[rowSelected];
1822         data[COLOUR_COLUMN] = currentColor;
1823         data[FILTER_COLUMN] = currentFilter;
1824         fireEditingStopped();
1825         me.table.validate();
1826       }
1827     }
1828
1829     @Override
1830     public Object getCellEditorValue()
1831     {
1832       return currentFilter;
1833     }
1834
1835     @Override
1836     public Component getTableCellEditorComponent(JTable theTable, Object value,
1837             boolean isSelected, int row, int column)
1838     {
1839       currentFilter = (FeatureMatcherSetI) value;
1840       this.rowSelected = row;
1841       type = me.table.getValueAt(row, TYPE_COLUMN).toString();
1842       button.setOpaque(true);
1843       button.setBackground(me.getBackground());
1844       button.setText(currentFilter.toString());
1845       button.setToolTipText(currentFilter.toString());
1846       button.setIcon(null);
1847       return button;
1848     }
1849   }
1850 }
1851
1852 class FeatureIcon implements Icon
1853 {
1854   FeatureColourI gcol;
1855
1856   Color backg;
1857
1858   boolean midspace = false;
1859
1860   int width = 50, height = 20;
1861
1862   int s1, e1; // start and end of midpoint band for thresholded symbol
1863
1864   Color mpcolour = Color.white;
1865
1866   FeatureIcon(FeatureColourI gfc, Color bg, int w, int h, boolean mspace)
1867   {
1868     gcol = gfc;
1869     backg = bg;
1870     width = w;
1871     height = h;
1872     midspace = mspace;
1873     if (midspace)
1874     {
1875       s1 = width / 3;
1876       e1 = s1 * 2;
1877     }
1878     else
1879     {
1880       s1 = width / 2;
1881       e1 = s1;
1882     }
1883   }
1884
1885   @Override
1886   public int getIconWidth()
1887   {
1888     return width;
1889   }
1890
1891   @Override
1892   public int getIconHeight()
1893   {
1894     return height;
1895   }
1896
1897   @Override
1898   public void paintIcon(Component c, Graphics g, int x, int y)
1899   {
1900
1901     if (gcol.isColourByLabel())
1902     {
1903       g.setColor(backg);
1904       g.fillRect(0, 0, width, height);
1905       // need an icon here.
1906       g.setColor(gcol.getMaxColour());
1907
1908       g.setFont(new Font("Verdana", Font.PLAIN, 9));
1909
1910       // g.setFont(g.getFont().deriveFont(
1911       // AffineTransform.getScaleInstance(
1912       // width/g.getFontMetrics().stringWidth("Label"),
1913       // height/g.getFontMetrics().getHeight())));
1914
1915       g.drawString(MessageManager.getString("label.label"), 0, 0);
1916
1917     }
1918     else
1919     {
1920       Color minCol = gcol.getMinColour();
1921       g.setColor(minCol);
1922       g.fillRect(0, 0, s1, height);
1923       if (midspace)
1924       {
1925         g.setColor(Color.white);
1926         g.fillRect(s1, 0, e1 - s1, height);
1927       }
1928       g.setColor(gcol.getMaxColour());
1929       g.fillRect(0, e1, width - e1, height);
1930     }
1931   }
1932 }