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