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