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