src/jalview/gui/FeatureSettings.java

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