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