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