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