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