src/jalview/gui/FeatureTypeSettings.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.AlignmentViewPanel;
  24 import jalview.api.FeatureColourI;
  25 import jalview.datamodel.GraphLine;
  26 import jalview.datamodel.features.FeatureAttributes;
  27 import jalview.datamodel.features.FeatureAttributes.Datatype;
  28 import jalview.datamodel.features.FeatureMatcher;
  29 import jalview.datamodel.features.FeatureMatcherI;
  30 import jalview.datamodel.features.FeatureMatcherSet;
  31 import jalview.datamodel.features.FeatureMatcherSetI;
  32 import jalview.schemes.FeatureColour;
  33 import jalview.util.ColorUtils;
  34 import jalview.util.MessageManager;
  35 import jalview.util.matcher.Condition;
  36
  37 import java.awt.BorderLayout;
  38 import java.awt.Color;
  39 import java.awt.Dimension;
  40 import java.awt.FlowLayout;
  41 import java.awt.GridLayout;
  42 import java.awt.event.ActionEvent;
  43 import java.awt.event.ActionListener;
  44 import java.awt.event.FocusAdapter;
  45 import java.awt.event.FocusEvent;
  46 import java.awt.event.ItemEvent;
  47 import java.awt.event.ItemListener;
  48 import java.awt.event.MouseAdapter;
  49 import java.awt.event.MouseEvent;
  50 import java.text.DecimalFormat;
  51 import java.util.ArrayList;
  52 import java.util.List;
  53
  54 import javax.swing.BorderFactory;
  55 import javax.swing.BoxLayout;
  56 import javax.swing.ButtonGroup;
  57 import javax.swing.JButton;
  58 import javax.swing.JCheckBox;
  59 import javax.swing.JColorChooser;
  60 import javax.swing.JComboBox;
  61 import javax.swing.JLabel;
  62 import javax.swing.JPanel;
  63 import javax.swing.JRadioButton;
  64 import javax.swing.JSlider;
  65 import javax.swing.JTabbedPane;
  66 import javax.swing.JTextField;
  67 import javax.swing.SwingConstants;
  68 import javax.swing.border.LineBorder;
  69 import javax.swing.event.ChangeEvent;
  70 import javax.swing.event.ChangeListener;
  71 import javax.swing.plaf.basic.BasicArrowButton;
  72
  73 /**
  74  * A dialog where the user can configure colour scheme, and any filters, for one
  75  * feature type
  76  * <p>
  77  * (Was FeatureColourChooser prior to Jalview 1.11, renamed with the addition of
  78  * filter options)
  79  */
  80 public class FeatureTypeSettings extends JalviewDialog
  81 {
  82   private final static String LABEL_18N = MessageManager
  83           .getString("label.label");
  84
  85   private final static String SCORE_18N = MessageManager
  86           .getString("label.score");
  87
  88   private static final int RADIO_WIDTH = 130;
  89
  90   private static final String COLON = ":";
  91
  92   private static final int MAX_TOOLTIP_LENGTH = 50;
  93
  94   private static final int NO_COLOUR_OPTION = 0;
  95
  96   private static final int MIN_COLOUR_OPTION = 1;
  97
  98   private static final int MAX_COLOUR_OPTION = 2;
  99
 100   private static final int ABOVE_THRESHOLD_OPTION = 1;
 101
 102   private static final int BELOW_THRESHOLD_OPTION = 2;
 103
 104   private static final DecimalFormat DECFMT_2_2 = new DecimalFormat(
 105           "##.##");
 106
 107   /*
 108    * FeatureRenderer holds colour scheme and filters for feature types
 109    */
 110   private final FeatureRenderer fr; // todo refactor to allow interface type here
 111
 112   /*
 113    * the view panel to update when settings change
 114    */
 115   private final AlignmentViewPanel ap;
 116
 117   private final String featureType;
 118
 119   /*
 120    * the colour and filters to reset to on Cancel
 121    */
 122   private final FeatureColourI originalColour;
 123
 124   private final FeatureMatcherSetI originalFilter;
 125
 126   /*
 127    * set flag to true when setting values programmatically,
 128    * to avoid invocation of action handlers
 129    */
 130   private boolean adjusting = false;
 131
 132   /*
 133    * minimum of the value range for graduated colour
 134    * (may be for feature score or for a numeric attribute)
 135    */
 136   private float min;
 137
 138   /*
 139    * maximum of the value range for graduated colour
 140    */
 141   private float max;
 142
 143   /*
 144    * scale factor for conversion between absolute min-max and slider
 145    */
 146   private float scaleFactor;
 147
 148   /*
 149    * radio button group, to select what to colour by:
 150    * simple colour, by category (text), or graduated
 151    */
 152   private JRadioButton simpleColour = new JRadioButton();
 153
 154   private JRadioButton byCategory = new JRadioButton();
 155
 156   private JRadioButton graduatedColour = new JRadioButton();
 157
 158   private JPanel singleColour = new JPanel();
 159
 160   private JPanel minColour = new JPanel();
 161
 162   private JPanel maxColour = new JPanel();
 163
 164   private JComboBox<String> threshold = new JComboBox<>();
 165
 166   private JSlider slider = new JSlider();
 167
 168   private JTextField thresholdValue = new JTextField(20);
 169
 170   private JCheckBox thresholdIsMin = new JCheckBox();
 171
 172   private GraphLine threshline;
 173
 174   private ActionListener featureSettings = null;
 175
 176   private ActionListener changeColourAction;
 177
 178   /*
 179    * choice of option for 'colour for no value'
 180    */
 181   private JComboBox<String> noValueCombo;
 182
 183   /*
 184    * choice of what to colour by text (Label or attribute)
 185    */
 186   private JComboBox<String> colourByTextCombo;
 187
 188   /*
 189    * choice of what to colour by range (Score or attribute)
 190    */
 191   private JComboBox<String> colourByRangeCombo;
 192
 193   private JRadioButton andFilters;
 194
 195   private JRadioButton orFilters;
 196
 197   /*
 198    * filters for the currently selected feature type
 199    */
 200   private List<FeatureMatcherI> filters;
 201
 202   // set white normally, black to debug layout
 203   private Color debugBorderColour = Color.white;
 204
 205   private JPanel chooseFiltersPanel;
 206
 207   private JTabbedPane tabbedPane;
 208
 209   /**
 210    * Constructor
 211    *
 212    * @param frender
 213    * @param theType
 214    */
 215   public FeatureTypeSettings(FeatureRenderer frender, String theType)
 216   {
 217     this(frender, false, theType);
 218   }
 219
 220   /**
 221    * Constructor, with option to make a blocking dialog (has to complete in the
 222    * AWT event queue thread). Currently this option is always set to false.
 223    *
 224    * @param frender
 225    * @param blocking
 226    * @param theType
 227    */
 228   FeatureTypeSettings(FeatureRenderer frender, boolean blocking,
 229           String theType)
 230   {
 231     this.fr = frender;
 232     this.featureType = theType;
 233     ap = fr.ap;
 234     originalFilter = fr.getFeatureFilter(theType);
 235     originalColour = fr.getFeatureColours().get(theType);
 236
 237     adjusting = true;
 238
 239     try
 240     {
 241       initialise();
 242     } catch (Exception ex)
 243     {
 244       ex.printStackTrace();
 245       return;
 246     }
 247
 248     updateColoursTab();
 249
 250     updateFiltersTab();
 251
 252     adjusting = false;
 253
 254     colourChanged(false);
 255
 256     String title = MessageManager
 257             .formatMessage("label.display_settings_for", new String[]
 258             { theType });
 259     initDialogFrame(this, true, blocking, title, 600, 360);
 260
 261     waitForInput();
 262   }
 263
 264   /**
 265    * Configures the widgets on the Colours tab according to the current feature
 266    * colour scheme
 267    */
 268   private void updateColoursTab()
 269   {
 270     FeatureColourI fc = fr.getFeatureColours().get(featureType);
 271
 272     /*
 273      * suppress action handling while updating values programmatically
 274      */
 275     adjusting = true;
 276     try
 277     {
 278       /*
 279        * single colour
 280        */
 281       if (fc.isSimpleColour())
 282       {
 283         simpleColour.setSelected(true);
 284         singleColour.setBackground(fc.getColour());
 285         singleColour.setForeground(fc.getColour());
 286       }
 287
 288       /*
 289        * colour by text (Label or attribute text)
 290        */
 291       if (fc.isColourByLabel())
 292       {
 293         byCategory.setSelected(true);
 294         colourByTextCombo.setEnabled(colourByTextCombo.getItemCount() > 1);
 295         if (fc.isColourByAttribute())
 296         {
 297           String[] attributeName = fc.getAttributeName();
 298           colourByTextCombo.setSelectedItem(
 299                   FeatureMatcher.toAttributeDisplayName(attributeName));
 300         }
 301         else
 302         {
 303           colourByTextCombo.setSelectedItem(LABEL_18N);
 304         }
 305       }
 306       else
 307       {
 308         colourByTextCombo.setEnabled(false);
 309       }
 310
 311       if (!fc.isGraduatedColour())
 312       {
 313         colourByRangeCombo.setEnabled(false);
 314         minColour.setEnabled(false);
 315         maxColour.setEnabled(false);
 316         noValueCombo.setEnabled(false);
 317         threshold.setEnabled(false);
 318         slider.setEnabled(false);
 319         thresholdValue.setEnabled(false);
 320         thresholdIsMin.setEnabled(false);
 321         return;
 322       }
 323
 324       /*
 325        * Graduated colour, by score or attribute value range
 326        */
 327       graduatedColour.setSelected(true);
 328       updateColourMinMax(); // ensure min, max are set
 329       colourByRangeCombo.setEnabled(colourByRangeCombo.getItemCount() > 1);
 330       minColour.setEnabled(true);
 331       maxColour.setEnabled(true);
 332       noValueCombo.setEnabled(true);
 333       threshold.setEnabled(true);
 334       minColour.setBackground(fc.getMinColour());
 335       maxColour.setBackground(fc.getMaxColour());
 336
 337       if (fc.isColourByAttribute())
 338       {
 339         String[] attributeName = fc.getAttributeName();
 340         colourByRangeCombo.setSelectedItem(
 341                 FeatureMatcher.toAttributeDisplayName(attributeName));
 342       }
 343       else
 344       {
 345         colourByRangeCombo.setSelectedItem(SCORE_18N);
 346       }
 347       Color noColour = fc.getNoColour();
 348       if (noColour == null)
 349       {
 350         noValueCombo.setSelectedIndex(NO_COLOUR_OPTION);
 351       }
 352       else if (noColour.equals(fc.getMinColour()))
 353       {
 354         noValueCombo.setSelectedIndex(MIN_COLOUR_OPTION);
 355       }
 356       else if (noColour.equals(fc.getMaxColour()))
 357       {
 358         noValueCombo.setSelectedIndex(MAX_COLOUR_OPTION);
 359       }
 360
 361       /*
 362        * update min-max scaling if there is a range to work with,
 363        * else disable the widgets (this shouldn't happen if only
 364        * valid options are offered in the combo box)
 365        */
 366       scaleFactor = (max == min) ? 1f : 100f / (max - min);
 367       float range = (max - min) * scaleFactor;
 368       slider.setMinimum((int) (min * scaleFactor));
 369       slider.setMaximum((int) (max * scaleFactor));
 370       slider.setMajorTickSpacing((int) (range / 10f));
 371
 372       threshline = new GraphLine((max - min) / 2f, "Threshold",
 373               Color.black);
 374       threshline.value = fc.getThreshold();
 375
 376       if (fc.hasThreshold())
 377       {
 378         threshold.setSelectedIndex(
 379                 fc.isAboveThreshold() ? ABOVE_THRESHOLD_OPTION
 380                         : BELOW_THRESHOLD_OPTION);
 381         slider.setEnabled(true);
 382         slider.setValue((int) (fc.getThreshold() * scaleFactor));
 383         thresholdValue.setText(String.valueOf(getRoundedSliderValue()));
 384         thresholdValue.setEnabled(true);
 385         thresholdIsMin.setEnabled(true);
 386       }
 387       else
 388       {
 389         slider.setEnabled(false);
 390         thresholdValue.setEnabled(false);
 391         thresholdIsMin.setEnabled(false);
 392       }
 393       thresholdIsMin.setSelected(!fc.isAutoScaled());
 394     } finally
 395     {
 396       adjusting = false;
 397     }
 398   }
 399
 400   /**
 401    * Configures the initial layout
 402    */
 403   private void initialise()
 404   {
 405     this.setLayout(new BorderLayout());
 406     tabbedPane = new JTabbedPane();
 407     this.add(tabbedPane, BorderLayout.CENTER);
 408
 409     /*
 410      * an ActionListener that applies colour changes
 411      */
 412     changeColourAction = new ActionListener()
 413     {
 414       @Override
 415       public void actionPerformed(ActionEvent e)
 416       {
 417         colourChanged(true);
 418       }
 419     };
 420
 421     /*
 422      * first tab: colour options
 423      */
 424     JPanel coloursPanel = initialiseColoursPanel();
 425     tabbedPane.addTab(MessageManager.getString("action.colour"),
 426             coloursPanel);
 427
 428     /*
 429      * second tab: filter options
 430      */
 431     JPanel filtersPanel = initialiseFiltersPanel();
 432     tabbedPane.addTab(MessageManager.getString("label.filters"),
 433             filtersPanel);
 434
 435     JPanel okCancelPanel = initialiseOkCancelPanel();
 436
 437     this.add(okCancelPanel, BorderLayout.SOUTH);
 438   }
 439
 440   /**
 441    * Updates the min-max range if Colour By selected item is Score, or an
 442    * attribute, with a min-max range
 443    */
 444   protected void updateColourMinMax()
 445   {
 446     if (!graduatedColour.isSelected())
 447     {
 448       return;
 449     }
 450
 451     String colourBy = (String) colourByRangeCombo.getSelectedItem();
 452     float[] minMax = getMinMax(colourBy);
 453
 454     if (minMax != null)
 455     {
 456       min = minMax[0];
 457       max = minMax[1];
 458     }
 459   }
 460
 461   /**
 462    * Retrieves the min-max range:
 463    * <ul>
 464    * <li>of feature score, if colour or filter is by Score</li>
 465    * <li>else of the selected attribute</li>
 466    * </ul>
 467    *
 468    * @param attName
 469    * @return
 470    */
 471   private float[] getMinMax(String attName)
 472   {
 473     float[] minMax = null;
 474     if (SCORE_18N.equals(attName))
 475     {
 476       minMax = fr.getMinMax().get(featureType)[0];
 477     }
 478     else
 479     {
 480       // colour by attribute range
 481       minMax = FeatureAttributes.getInstance().getMinMax(featureType,
 482               FeatureMatcher.fromAttributeDisplayName(attName));
 483     }
 484     return minMax;
 485   }
 486
 487   /**
 488    * Lay out fields for graduated colour (by score or attribute value)
 489    *
 490    * @return
 491    */
 492   private JPanel initialiseGraduatedColourPanel()
 493   {
 494     JPanel graduatedColourPanel = new JPanel();
 495     graduatedColourPanel.setLayout(
 496             new BoxLayout(graduatedColourPanel, BoxLayout.Y_AXIS));
 497     JvSwingUtils.createTitledBorder(graduatedColourPanel,
 498             MessageManager.getString("label.graduated_colour"), true);
 499     graduatedColourPanel.setBackground(Color.white);
 500
 501     /*
 502      * first row: graduated colour radio button, score/attribute drop-down
 503      */
 504     JPanel graduatedChoicePanel = new JPanel(
 505             new FlowLayout(FlowLayout.LEFT));
 506     graduatedChoicePanel.setBackground(Color.white);
 507     graduatedColour = new JRadioButton(
 508             MessageManager.getString("label.by_range_of") + COLON);
 509     graduatedColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
 510     graduatedColour.addItemListener(new ItemListener()
 511     {
 512       @Override
 513       public void itemStateChanged(ItemEvent e)
 514       {
 515         if (graduatedColour.isSelected())
 516         {
 517           colourChanged(true);
 518         }
 519       }
 520     });
 521     graduatedChoicePanel.add(graduatedColour);
 522
 523     List<String[]> attNames = FeatureAttributes.getInstance()
 524             .getAttributes(featureType);
 525     colourByRangeCombo = populateAttributesDropdown(attNames, true, false);
 526     colourByRangeCombo.addItemListener(new ItemListener()
 527     {
 528       @Override
 529       public void itemStateChanged(ItemEvent e)
 530       {
 531         colourChanged(true);
 532       }
 533     });
 534
 535     /*
 536      * disable graduated colour option if no range found
 537      */
 538     graduatedColour.setEnabled(colourByRangeCombo.getItemCount() > 0);
 539
 540     graduatedChoicePanel.add(colourByRangeCombo);
 541     graduatedColourPanel.add(graduatedChoicePanel);
 542
 543     /*
 544      * second row - min/max/no colours
 545      */
 546     JPanel colourRangePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 547     colourRangePanel.setBackground(Color.white);
 548     graduatedColourPanel.add(colourRangePanel);
 549
 550     minColour.setFont(JvSwingUtils.getLabelFont());
 551     minColour.setBorder(BorderFactory.createLineBorder(Color.black));
 552     minColour.setPreferredSize(new Dimension(40, 20));
 553     minColour.setToolTipText(MessageManager.getString("label.min_colour"));
 554     minColour.addMouseListener(new MouseAdapter()
 555     {
 556       @Override
 557       public void mousePressed(MouseEvent e)
 558       {
 559         if (minColour.isEnabled())
 560         {
 561           showColourChooser(minColour, "label.select_colour_minimum_value");
 562         }
 563       }
 564     });
 565
 566     maxColour.setFont(JvSwingUtils.getLabelFont());
 567     maxColour.setBorder(BorderFactory.createLineBorder(Color.black));
 568     maxColour.setPreferredSize(new Dimension(40, 20));
 569     maxColour.setToolTipText(MessageManager.getString("label.max_colour"));
 570     maxColour.addMouseListener(new MouseAdapter()
 571     {
 572       @Override
 573       public void mousePressed(MouseEvent e)
 574       {
 575         if (maxColour.isEnabled())
 576         {
 577           showColourChooser(maxColour, "label.select_colour_maximum_value");
 578         }
 579       }
 580     });
 581     maxColour.setBorder(new LineBorder(Color.black));
 582
 583     /*
 584      * default max colour to current colour (if a plain colour),
 585      * or to Black if colour by label;  make min colour a pale
 586      * version of max colour
 587      */
 588     FeatureColourI fc = fr.getFeatureColours().get(featureType);
 589     Color bg = fc.isSimpleColour() ? fc.getColour() : Color.BLACK;
 590     maxColour.setBackground(bg);
 591     minColour.setBackground(ColorUtils.bleachColour(bg, 0.9f));
 592
 593     noValueCombo = new JComboBox<>();
 594     noValueCombo.addItem(MessageManager.getString("label.no_colour"));
 595     noValueCombo.addItem(MessageManager.getString("label.min_colour"));
 596     noValueCombo.addItem(MessageManager.getString("label.max_colour"));
 597     noValueCombo.addItemListener(new ItemListener()
 598     {
 599       @Override
 600       public void itemStateChanged(ItemEvent e)
 601       {
 602         colourChanged(true);
 603       }
 604     });
 605
 606     JLabel minText = new JLabel(
 607             MessageManager.getString("label.min_value") + COLON);
 608     minText.setFont(JvSwingUtils.getLabelFont());
 609     JLabel maxText = new JLabel(
 610             MessageManager.getString("label.max_value") + COLON);
 611     maxText.setFont(JvSwingUtils.getLabelFont());
 612     JLabel noText = new JLabel(
 613             MessageManager.getString("label.no_value") + COLON);
 614     noText.setFont(JvSwingUtils.getLabelFont());
 615
 616     colourRangePanel.add(minText);
 617     colourRangePanel.add(minColour);
 618     colourRangePanel.add(maxText);
 619     colourRangePanel.add(maxColour);
 620     colourRangePanel.add(noText);
 621     colourRangePanel.add(noValueCombo);
 622
 623     /*
 624      * third row - threshold options and value
 625      */
 626     JPanel thresholdPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 627     thresholdPanel.setBackground(Color.white);
 628     graduatedColourPanel.add(thresholdPanel);
 629
 630     threshold.addActionListener(changeColourAction);
 631     threshold.setToolTipText(MessageManager
 632             .getString("label.threshold_feature_display_by_score"));
 633     threshold.addItem(MessageManager
 634             .getString("label.threshold_feature_no_threshold")); // index 0
 635     threshold.addItem(MessageManager
 636             .getString("label.threshold_feature_above_threshold")); // index 1
 637     threshold.addItem(MessageManager
 638             .getString("label.threshold_feature_below_threshold")); // index 2
 639
 640     thresholdValue.addActionListener(new ActionListener()
 641     {
 642       @Override
 643       public void actionPerformed(ActionEvent e)
 644       {
 645         thresholdValue_actionPerformed();
 646       }
 647     });
 648     thresholdValue.addFocusListener(new FocusAdapter()
 649     {
 650       @Override
 651       public void focusLost(FocusEvent e)
 652       {
 653         thresholdValue_actionPerformed();
 654       }
 655     });
 656     slider.setPaintLabels(false);
 657     slider.setPaintTicks(true);
 658     slider.setBackground(Color.white);
 659     slider.setEnabled(false);
 660     slider.setOpaque(false);
 661     slider.setPreferredSize(new Dimension(100, 32));
 662     slider.setToolTipText(
 663             MessageManager.getString("label.adjust_threshold"));
 664
 665     slider.addChangeListener(new ChangeListener()
 666     {
 667       @Override
 668       public void stateChanged(ChangeEvent evt)
 669       {
 670         if (!adjusting)
 671         {
 672           thresholdValue
 673                   .setText(String.valueOf(slider.getValue() / scaleFactor));
 674           sliderValueChanged();
 675         }
 676       }
 677     });
 678     slider.addMouseListener(new MouseAdapter()
 679     {
 680       @Override
 681       public void mouseReleased(MouseEvent evt)
 682       {
 683         /*
 684          * only update Overview and/or structure colouring
 685          * when threshold slider drag ends (mouse up)
 686          */
 687         if (ap != null)
 688         {
 689           ap.paintAlignment(true, true);
 690         }
 691       }
 692     });
 693
 694     thresholdValue.setEnabled(false);
 695     thresholdValue.setColumns(7);
 696
 697     thresholdPanel.add(threshold);
 698     thresholdPanel.add(slider);
 699     thresholdPanel.add(thresholdValue);
 700
 701     thresholdIsMin.setBackground(Color.white);
 702     thresholdIsMin
 703             .setText(MessageManager.getString("label.threshold_minmax"));
 704     thresholdIsMin.setToolTipText(MessageManager
 705             .getString("label.toggle_absolute_relative_display_threshold"));
 706     thresholdIsMin.addActionListener(changeColourAction);
 707     thresholdPanel.add(thresholdIsMin);
 708
 709     return graduatedColourPanel;
 710   }
 711
 712   /**
 713    * Lay out OK and Cancel buttons
 714    *
 715    * @return
 716    */
 717   private JPanel initialiseOkCancelPanel()
 718   {
 719     JPanel okCancelPanel = new JPanel();
 720     // okCancelPanel.setBackground(Color.white);
 721     okCancelPanel.add(ok);
 722     okCancelPanel.add(cancel);
 723     return okCancelPanel;
 724   }
 725
 726   /**
 727    * Lay out Colour options panel, containing
 728    * <ul>
 729    * <li>plain colour, with colour picker</li>
 730    * <li>colour by text, with choice of Label or other attribute</li>
 731    * <li>colour by range, of score or other attribute, when available</li>
 732    * </ul>
 733    *
 734    * @return
 735    */
 736   private JPanel initialiseColoursPanel()
 737   {
 738     JPanel colourByPanel = new JPanel();
 739     colourByPanel.setLayout(new BoxLayout(colourByPanel, BoxLayout.Y_AXIS));
 740
 741     /*
 742      * simple colour radio button and colour picker
 743      */
 744     JPanel simpleColourPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 745     simpleColourPanel.setBackground(Color.white);
 746     JvSwingUtils.createTitledBorder(simpleColourPanel,
 747             MessageManager.getString("label.simple"), true);
 748     colourByPanel.add(simpleColourPanel);
 749
 750     simpleColour = new JRadioButton(
 751             MessageManager.getString("label.simple_colour"));
 752     simpleColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
 753     simpleColour.addItemListener(new ItemListener()
 754     {
 755       @Override
 756       public void itemStateChanged(ItemEvent e)
 757       {
 758         if (simpleColour.isSelected() && !adjusting)
 759         {
 760           showColourChooser(singleColour, "label.select_colour");
 761         }
 762       }
 763
 764     });
 765
 766     singleColour.setFont(JvSwingUtils.getLabelFont());
 767     singleColour.setBorder(BorderFactory.createLineBorder(Color.black));
 768     singleColour.setPreferredSize(new Dimension(40, 20));
 769     singleColour.addMouseListener(new MouseAdapter()
 770     {
 771       @Override
 772       public void mousePressed(MouseEvent e)
 773       {
 774         if (simpleColour.isSelected())
 775         {
 776           showColourChooser(singleColour, "label.select_colour");
 777         }
 778       }
 779     });
 780     simpleColourPanel.add(simpleColour); // radio button
 781     simpleColourPanel.add(singleColour); // colour picker button
 782
 783     /*
 784      * colour by text (category) radio button and drop-down choice list
 785      */
 786     JPanel byTextPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 787     byTextPanel.setBackground(Color.white);
 788     JvSwingUtils.createTitledBorder(byTextPanel,
 789             MessageManager.getString("label.colour_by_text"), true);
 790     colourByPanel.add(byTextPanel);
 791     byCategory = new JRadioButton(
 792             MessageManager.getString("label.by_text_of") + COLON);
 793     byCategory.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
 794     byCategory.addItemListener(new ItemListener()
 795     {
 796       @Override
 797       public void itemStateChanged(ItemEvent e)
 798       {
 799         if (byCategory.isSelected())
 800         {
 801           colourChanged(true);
 802         }
 803       }
 804     });
 805     byTextPanel.add(byCategory);
 806
 807     List<String[]> attNames = FeatureAttributes.getInstance()
 808             .getAttributes(featureType);
 809     colourByTextCombo = populateAttributesDropdown(attNames, false, true);
 810     colourByTextCombo.addItemListener(new ItemListener()
 811     {
 812       @Override
 813       public void itemStateChanged(ItemEvent e)
 814       {
 815         colourChanged(true);
 816       }
 817     });
 818     byTextPanel.add(colourByTextCombo);
 819
 820     /*
 821      * graduated colour panel
 822      */
 823     JPanel graduatedColourPanel = initialiseGraduatedColourPanel();
 824     colourByPanel.add(graduatedColourPanel);
 825
 826     /*
 827      * 3 radio buttons select between simple colour,
 828      * by category (text), or graduated
 829      */
 830     ButtonGroup bg = new ButtonGroup();
 831     bg.add(simpleColour);
 832     bg.add(byCategory);
 833     bg.add(graduatedColour);
 834
 835     return colourByPanel;
 836   }
 837
 838   private void showColourChooser(JPanel colourPanel, String key)
 839   {
 840     Color col = JColorChooser.showDialog(this,
 841             MessageManager.getString(key), colourPanel.getBackground());
 842     if (col != null)
 843     {
 844       colourPanel.setBackground(col);
 845       colourPanel.setForeground(col);
 846     }
 847     colourPanel.repaint();
 848     colourChanged(true);
 849   }
 850
 851   /**
 852    * Constructs and sets the selected colour options as the colour for the feature
 853    * type, and repaints the alignment, and optionally the Overview and/or
 854    * structure viewer if open
 855    *
 856    * @param updateStructsAndOverview
 857    */
 858   void colourChanged(boolean updateStructsAndOverview)
 859   {
 860     if (adjusting)
 861     {
 862       /*
 863        * ignore action handlers while setting values programmatically
 864        */
 865       return;
 866     }
 867
 868     /*
 869      * ensure min-max range is for the latest choice of
 870      * 'graduated colour by'
 871      */
 872     updateColourMinMax();
 873
 874     FeatureColourI acg = makeColourFromInputs();
 875
 876     /*
 877      * save the colour, and repaint stuff
 878      */
 879     fr.setColour(featureType, acg);
 880     ap.paintAlignment(updateStructsAndOverview, updateStructsAndOverview);
 881
 882     updateColoursTab();
 883   }
 884
 885   /**
 886    * Converts the input values into an instance of FeatureColour
 887    *
 888    * @return
 889    */
 890   private FeatureColourI makeColourFromInputs()
 891   {
 892     /*
 893      * easiest case - a single colour
 894      */
 895     if (simpleColour.isSelected())
 896     {
 897       return new FeatureColour(singleColour.getBackground());
 898     }
 899
 900     /*
 901      * next easiest case - colour by Label, or attribute text
 902      */
 903     if (byCategory.isSelected())
 904     {
 905       Color c = this.getBackground();
 906       FeatureColourI fc = new FeatureColour(c, c, null, 0f, 0f);
 907       fc.setColourByLabel(true);
 908       String byWhat = (String) colourByTextCombo.getSelectedItem();
 909       if (!LABEL_18N.equals(byWhat))
 910       {
 911         fc.setAttributeName(
 912                 FeatureMatcher.fromAttributeDisplayName(byWhat));
 913       }
 914       return fc;
 915     }
 916
 917     /*
 918      * remaining case - graduated colour by score, or attribute value
 919      */
 920     Color noColour = null;
 921     if (noValueCombo.getSelectedIndex() == MIN_COLOUR_OPTION)
 922     {
 923       noColour = minColour.getBackground();
 924     }
 925     else if (noValueCombo.getSelectedIndex() == MAX_COLOUR_OPTION)
 926     {
 927       noColour = maxColour.getBackground();
 928     }
 929
 930     float thresh = 0f;
 931     try
 932     {
 933       thresh = Float.valueOf(thresholdValue.getText());
 934     } catch (NumberFormatException e)
 935     {
 936       // invalid inputs are already handled on entry
 937     }
 938
 939     /*
 940      * min-max range is to (or from) threshold value if
 941      * 'threshold is min/max' is selected
 942      */
 943     float minValue = min;
 944     float maxValue = max;
 945     final int thresholdOption = threshold.getSelectedIndex();
 946     if (thresholdIsMin.isSelected()
 947             && thresholdOption == ABOVE_THRESHOLD_OPTION)
 948     {
 949       minValue = thresh;
 950     }
 951     if (thresholdIsMin.isSelected()
 952             && thresholdOption == BELOW_THRESHOLD_OPTION)
 953     {
 954       maxValue = thresh;
 955     }
 956
 957     /*
 958      * make the graduated colour
 959      */
 960     FeatureColourI fc = new FeatureColour(minColour.getBackground(),
 961             maxColour.getBackground(), noColour, minValue, maxValue);
 962
 963     /*
 964      * set attribute to colour by if selected
 965      */
 966     String byWhat = (String) colourByRangeCombo.getSelectedItem();
 967     if (!SCORE_18N.equals(byWhat))
 968     {
 969       fc.setAttributeName(FeatureMatcher.fromAttributeDisplayName(byWhat));
 970     }
 971
 972     /*
 973      * set threshold options and 'autoscaled' which is
 974      * false if 'threshold is min/max' is selected
 975      * else true (colour range is on actual range of values)
 976      */
 977     fc.setThreshold(thresh);
 978     fc.setAutoScaled(!thresholdIsMin.isSelected());
 979     fc.setAboveThreshold(thresholdOption == ABOVE_THRESHOLD_OPTION);
 980     fc.setBelowThreshold(thresholdOption == BELOW_THRESHOLD_OPTION);
 981
 982     if (threshline == null)
 983     {
 984       /*
 985        * todo not yet implemented: visual indication of feature threshold
 986        */
 987       threshline = new GraphLine((max - min) / 2f, "Threshold",
 988               Color.black);
 989     }
 990
 991     return fc;
 992   }
 993
 994   @Override
 995   protected void raiseClosed()
 996   {
 997     if (this.featureSettings != null)
 998     {
 999       featureSettings.actionPerformed(new ActionEvent(this, 0, "CLOSED"));
1000     }
1001   }
1002
1003   /**
1004    * Action on OK is just to dismiss the dialog - any changes have already been
1005    * applied
1006    */
1007   @Override
1008   public void okPressed()
1009   {
1010   }
1011
1012   /**
1013    * Action on Cancel is to restore colour scheme and filters as they were when
1014    * the dialog was opened
1015    */
1016   @Override
1017   public void cancelPressed()
1018   {
1019     fr.setColour(featureType, originalColour);
1020     fr.setFeatureFilter(featureType, originalFilter);
1021     ap.paintAlignment(true, true);
1022   }
1023
1024   /**
1025    * Action on text entry of a threshold value
1026    */
1027   protected void thresholdValue_actionPerformed()
1028   {
1029     try
1030     {
1031       adjusting = true;
1032       float f = Float.parseFloat(thresholdValue.getText());
1033       slider.setValue((int) (f * scaleFactor));
1034       threshline.value = f;
1035       thresholdValue.setBackground(Color.white); // ok
1036
1037       /*
1038        * force repaint of any Overview window or structure
1039        */
1040       ap.paintAlignment(true, true);
1041     } catch (NumberFormatException ex)
1042     {
1043       thresholdValue.setBackground(Color.red); // not ok
1044     } finally
1045     {
1046       adjusting = false;
1047     }
1048   }
1049
1050   /**
1051    * Action on change of threshold slider value. This may be done interactively
1052    * (by moving the slider), or programmatically (to update the slider after
1053    * manual input of a threshold value).
1054    */
1055   protected void sliderValueChanged()
1056   {
1057     threshline.value = getRoundedSliderValue();
1058
1059     /*
1060      * repaint alignment, but not Overview or structure,
1061      * to avoid overload while dragging the slider
1062      */
1063     colourChanged(false);
1064   }
1065
1066   /**
1067    * Converts the slider value to its absolute value by dividing by the
1068    * scaleFactor. Rounding errors are squashed by forcing min/max of slider range
1069    * to the actual min/max of feature score range
1070    *
1071    * @return
1072    */
1073   private float getRoundedSliderValue()
1074   {
1075     int value = slider.getValue();
1076     float f = value == slider.getMaximum() ? max
1077             : (value == slider.getMinimum() ? min : value / scaleFactor);
1078     return f;
1079   }
1080
1081   void addActionListener(ActionListener listener)
1082   {
1083     if (featureSettings != null)
1084     {
1085       System.err.println(
1086               "IMPLEMENTATION ISSUE: overwriting action listener for FeatureColourChooser");
1087     }
1088     featureSettings = listener;
1089   }
1090
1091   /**
1092    * A helper method to build the drop-down choice of attributes for a feature. If
1093    * 'withRange' is true, then Score, and any attributes with a min-max range, are
1094    * added. If 'withText' is true, Label and any known attributes are added. This
1095    * allows 'categorical numerical' attributes e.g. codon position to be coloured
1096    * by text.
1097    * <p>
1098    * Where metadata is available with a description for an attribute, that is
1099    * added as a tooltip.
1100    * <p>
1101    * Attribute names may be 'simple' e.g. "AC" or 'compound' e.g. {"CSQ",
1102    * "Allele"}. Compound names are rendered for display as (e.g.) CSQ:Allele.
1103    * <p>
1104    * This method does not add any ActionListener to the JComboBox.
1105    *
1106    * @param attNames
1107    * @param withRange
1108    * @param withText
1109    */
1110   protected JComboBox<String> populateAttributesDropdown(
1111           List<String[]> attNames, boolean withRange, boolean withText)
1112   {
1113     List<String> displayAtts = new ArrayList<>();
1114     List<String> tooltips = new ArrayList<>();
1115
1116     if (withText)
1117     {
1118       displayAtts.add(LABEL_18N);
1119       tooltips.add(MessageManager.getString("label.description"));
1120     }
1121     if (withRange)
1122     {
1123       float[][] minMax = fr.getMinMax().get(featureType);
1124       if (minMax != null && minMax[0][0] != minMax[0][1])
1125       {
1126         displayAtts.add(SCORE_18N);
1127         tooltips.add(SCORE_18N);
1128       }
1129     }
1130
1131     FeatureAttributes fa = FeatureAttributes.getInstance();
1132     for (String[] attName : attNames)
1133     {
1134       float[] minMax = fa.getMinMax(featureType, attName);
1135       boolean hasRange = minMax != null && minMax[0] != minMax[1];
1136       if (!withText && !hasRange)
1137       {
1138         continue;
1139       }
1140       displayAtts.add(FeatureMatcher.toAttributeDisplayName(attName));
1141       String desc = fa.getDescription(featureType, attName);
1142       if (desc != null && desc.length() > MAX_TOOLTIP_LENGTH)
1143       {
1144         desc = desc.substring(0, MAX_TOOLTIP_LENGTH) + "...";
1145       }
1146       tooltips.add(desc == null ? "" : desc);
1147     }
1148
1149     JComboBox<String> attCombo = JvSwingUtils
1150             .buildComboWithTooltips(displayAtts, tooltips);
1151
1152     return attCombo;
1153   }
1154
1155   /**
1156    * Populates initial layout of the feature attribute filters panel
1157    */
1158   private JPanel initialiseFiltersPanel()
1159   {
1160     filters = new ArrayList<>();
1161
1162     JPanel filtersPanel = new JPanel();
1163     filtersPanel.setLayout(new BoxLayout(filtersPanel, BoxLayout.Y_AXIS));
1164     filtersPanel.setBackground(Color.white);
1165     JvSwingUtils.createTitledBorder(filtersPanel,
1166             MessageManager.getString("label.filters"), true);
1167
1168     JPanel andOrPanel = initialiseAndOrPanel();
1169     filtersPanel.add(andOrPanel);
1170
1171     /*
1172      * panel with filters - populated by refreshFiltersDisplay,
1173      * which also sets the layout manager
1174      */
1175     chooseFiltersPanel = new JPanel();
1176     chooseFiltersPanel.setBackground(Color.white);
1177     filtersPanel.add(chooseFiltersPanel);
1178
1179     return filtersPanel;
1180   }
1181
1182   /**
1183    * Lays out the panel with radio buttons to AND or OR filter conditions
1184    *
1185    * @return
1186    */
1187   private JPanel initialiseAndOrPanel()
1188   {
1189     JPanel andOrPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
1190     andOrPanel.setBackground(Color.white);
1191     andOrPanel.setBorder(BorderFactory.createLineBorder(debugBorderColour));
1192     andFilters = new JRadioButton(MessageManager.getString("label.and"));
1193     orFilters = new JRadioButton(MessageManager.getString("label.or"));
1194     ActionListener actionListener = new ActionListener()
1195     {
1196       @Override
1197       public void actionPerformed(ActionEvent e)
1198       {
1199         filtersChanged();
1200       }
1201     };
1202     andFilters.addActionListener(actionListener);
1203     orFilters.addActionListener(actionListener);
1204     ButtonGroup andOr = new ButtonGroup();
1205     andOr.add(andFilters);
1206     andOr.add(orFilters);
1207     andFilters.setSelected(true);
1208     andOrPanel.add(
1209             new JLabel(MessageManager.getString("label.join_conditions")));
1210     andOrPanel.add(andFilters);
1211     andOrPanel.add(orFilters);
1212     return andOrPanel;
1213   }
1214
1215   /**
1216    * Refreshes the display to show any filters currently configured for the
1217    * selected feature type (editable, with 'remove' option), plus one extra row
1218    * for adding a condition. This should be called after a filter has been
1219    * removed, added or amended.
1220    */
1221   private void updateFiltersTab()
1222   {
1223     /*
1224      * clear the panel and list of filter conditions
1225      */
1226     chooseFiltersPanel.removeAll();
1227     filters.clear();
1228
1229     /*
1230      * look up attributes known for feature type
1231      */
1232     List<String[]> attNames = FeatureAttributes.getInstance()
1233             .getAttributes(featureType);
1234
1235     /*
1236      * if this feature type has filters set, load them first
1237      */
1238     FeatureMatcherSetI featureFilters = fr.getFeatureFilter(featureType);
1239     if (featureFilters != null)
1240     {
1241       if (!featureFilters.isAnded())
1242       {
1243         orFilters.setSelected(true);
1244       }
1245       featureFilters.getMatchers().forEach(matcher -> filters.add(matcher));
1246     }
1247
1248     /*
1249      * and an empty filter for the user to populate (add)
1250      */
1251     filters.add(FeatureMatcher.NULL_MATCHER);
1252
1253     /*
1254      * use GridLayout to 'justify' rows to the top of the panel, until
1255      * there are too many to fit in, then fall back on BoxLayout
1256      */
1257     if (filters.size() <= 5)
1258     {
1259       chooseFiltersPanel.setLayout(new GridLayout(5, 1));
1260     }
1261     else
1262     {
1263       chooseFiltersPanel.setLayout(
1264               new BoxLayout(chooseFiltersPanel, BoxLayout.Y_AXIS));
1265     }
1266
1267     /*
1268      * render the conditions in rows, each in its own JPanel
1269      */
1270     int filterIndex = 0;
1271     for (FeatureMatcherI filter : filters)
1272     {
1273       JPanel row = addFilter(filter, attNames, filterIndex);
1274       row.setBorder(BorderFactory.createLineBorder(debugBorderColour));
1275       chooseFiltersPanel.add(row);
1276       filterIndex++;
1277     }
1278
1279     this.validate();
1280     this.repaint();
1281   }
1282
1283   /**
1284    * A helper method that constructs a row (panel) with one filter condition:
1285    * <ul>
1286    * <li>a drop-down list of Label, Score and attribute names to choose from</li>
1287    * <li>a drop-down list of conditions to choose from</li>
1288    * <li>a text field for input of a match pattern</li>
1289    * <li>optionally, a 'remove' button</li>
1290    * </ul>
1291    * The filter values are set as defaults for the input fields. The 'remove'
1292    * button is added unless the pattern is empty (incomplete filter condition).
1293    * <p>
1294    * Action handlers on these fields provide for
1295    * <ul>
1296    * <li>validate pattern field - should be numeric if condition is numeric</li>
1297    * <li>save filters and refresh display on any (valid) change</li>
1298    * <li>remove filter and refresh on 'Remove'</li>
1299    * <li>update conditions list on change of Label/Score/Attribute</li>
1300    * <li>refresh value field tooltip with min-max range on change of
1301    * attribute</li>
1302    * </ul>
1303    *
1304    * @param filter
1305    * @param attNames
1306    * @param filterIndex
1307    * @return
1308    */
1309   protected JPanel addFilter(FeatureMatcherI filter,
1310           List<String[]> attNames, int filterIndex)
1311   {
1312     String[] attName = filter.getAttribute();
1313     Condition cond = filter.getMatcher().getCondition();
1314     String pattern = filter.getMatcher().getPattern();
1315
1316     JPanel filterRow = new JPanel(new FlowLayout(FlowLayout.LEFT));
1317     filterRow.setBackground(Color.white);
1318
1319     /*
1320      * drop-down choice of attribute, with description as a tooltip
1321      * if we can obtain it
1322      */
1323     final JComboBox<String> attCombo = populateAttributesDropdown(attNames,
1324             true, true);
1325     String filterBy = setSelectedAttribute(attCombo, filter);
1326
1327     JComboBox<Condition> condCombo = new JComboBox<>();
1328
1329     JTextField patternField = new JTextField(8);
1330     patternField.setText(pattern);
1331
1332     /*
1333      * action handlers that validate and (if valid) apply changes
1334      */
1335     ActionListener actionListener = new ActionListener()
1336     {
1337       @Override
1338       public void actionPerformed(ActionEvent e)
1339       {
1340         if (validateFilter(patternField, condCombo))
1341         {
1342           if (updateFilter(attCombo, condCombo, patternField, filterIndex))
1343           {
1344             filtersChanged();
1345           }
1346         }
1347       }
1348     };
1349     ItemListener itemListener = new ItemListener()
1350     {
1351       @Override
1352       public void itemStateChanged(ItemEvent e)
1353       {
1354         actionListener.actionPerformed(null);
1355       }
1356     };
1357
1358     if (filter == FeatureMatcher.NULL_MATCHER) // the 'add a condition' row
1359     {
1360       attCombo.setSelectedIndex(0);
1361     }
1362     else
1363     {
1364       attCombo.setSelectedItem(
1365               FeatureMatcher.toAttributeDisplayName(attName));
1366     }
1367     attCombo.addItemListener(new ItemListener()
1368     {
1369       @Override
1370       public void itemStateChanged(ItemEvent e)
1371       {
1372         /*
1373          * on change of attribute, refresh the conditions list to
1374          * ensure it is appropriate for the attribute datatype
1375          */
1376         populateConditions((String) attCombo.getSelectedItem(),
1377                 (Condition) condCombo.getSelectedItem(), condCombo,
1378                 patternField);
1379         actionListener.actionPerformed(null);
1380       }
1381     });
1382
1383     filterRow.add(attCombo);
1384
1385     /*
1386      * drop-down choice of test condition
1387      */
1388     populateConditions(filterBy, cond, condCombo, patternField);
1389     condCombo.setPreferredSize(new Dimension(150, 20));
1390     condCombo.addItemListener(itemListener);
1391     filterRow.add(condCombo);
1392
1393     /*
1394      * pattern to match against
1395      */
1396     patternField.addActionListener(actionListener);
1397     patternField.addFocusListener(new FocusAdapter()
1398     {
1399       @Override
1400       public void focusLost(FocusEvent e)
1401       {
1402         actionListener.actionPerformed(null);
1403       }
1404     });
1405     filterRow.add(patternField);
1406
1407     /*
1408      * disable pattern field for condition 'Present / NotPresent'
1409      */
1410     Condition selectedCondition = (Condition) condCombo.getSelectedItem();
1411     patternField.setEnabled(selectedCondition.needsAPattern());
1412
1413     /*
1414      * if a numeric condition is selected, show the value range
1415      * as a tooltip on the value input field
1416      */
1417     setPatternTooltip(filterBy, selectedCondition, patternField);
1418
1419     /*
1420      * add remove button if filter is populated (non-empty pattern)
1421      */
1422     if (!patternField.isEnabled()
1423             || (pattern != null && pattern.trim().length() > 0))
1424     {
1425       // todo: gif for button drawing '-' or 'x'
1426       JButton removeCondition = new BasicArrowButton(SwingConstants.WEST);
1427       removeCondition
1428               .setToolTipText(MessageManager.getString("label.delete_row"));
1429       removeCondition.addActionListener(new ActionListener()
1430       {
1431         @Override
1432         public void actionPerformed(ActionEvent e)
1433         {
1434           filters.remove(filterIndex);
1435           filtersChanged();
1436         }
1437       });
1438       filterRow.add(removeCondition);
1439     }
1440
1441     return filterRow;
1442   }
1443
1444   /**
1445    * Sets the selected item in the Label/Score/Attribute drop-down to match the
1446    * filter
1447    *
1448    * @param attCombo
1449    * @param filter
1450    */
1451   private String setSelectedAttribute(JComboBox<String> attCombo,
1452           FeatureMatcherI filter)
1453   {
1454     String item = null;
1455     if (filter.isByScore())
1456     {
1457       item = SCORE_18N;
1458     }
1459     else if (filter.isByLabel())
1460     {
1461       item = LABEL_18N;
1462     }
1463     else
1464     {
1465       item = FeatureMatcher.toAttributeDisplayName(filter.getAttribute());
1466     }
1467     attCombo.setSelectedItem(item);
1468     return item;
1469   }
1470
1471   /**
1472    * If a numeric comparison condition is selected, retrieve the min-max range for
1473    * the value (score or attribute), and set it as a tooltip on the value file
1474    *
1475    * @param attName
1476    * @param selectedCondition
1477    * @param patternField
1478    */
1479   private void setPatternTooltip(String attName,
1480           Condition selectedCondition, JTextField patternField)
1481   {
1482     patternField.setToolTipText("");
1483
1484     if (selectedCondition.isNumeric())
1485     {
1486       float[] minMax = getMinMax(attName);
1487       if (minMax != null)
1488       {
1489         String tip = String.format("(%s - %s)",
1490                 DECFMT_2_2.format(minMax[0]), DECFMT_2_2.format(minMax[1]));
1491         patternField.setToolTipText(tip);
1492       }
1493     }
1494   }
1495
1496   /**
1497    * Populates the drop-down list of comparison conditions for the given attribute
1498    * name. The conditions added depend on the datatype of the attribute values.
1499    * The supplied condition is set as the selected item in the list, provided it
1500    * is in the list. If the pattern is now invalid (non-numeric pattern for a
1501    * numeric condition), it is cleared.
1502    *
1503    * @param attName
1504    * @param cond
1505    * @param condCombo
1506    * @param patternField
1507    */
1508   private void populateConditions(String attName, Condition cond,
1509           JComboBox<Condition> condCombo, JTextField patternField)
1510   {
1511     Datatype type = FeatureAttributes.getInstance().getDatatype(featureType,
1512             FeatureMatcher.fromAttributeDisplayName(attName));
1513     if (LABEL_18N.equals(attName))
1514     {
1515       type = Datatype.Character;
1516     }
1517     else if (SCORE_18N.equals(attName))
1518     {
1519       type = Datatype.Number;
1520     }
1521
1522     /*
1523      * remove itemListener before starting
1524      */
1525     ItemListener listener = condCombo.getItemListeners()[0];
1526     condCombo.removeItemListener(listener);
1527     boolean condIsValid = false;
1528     condCombo.removeAllItems();
1529     for (Condition c : Condition.values())
1530     {
1531       if ((c.isNumeric() && type != Datatype.Character)
1532               || (!c.isNumeric() && type != Datatype.Number))
1533       {
1534         condCombo.addItem(c);
1535         if (c == cond)
1536         {
1537           condIsValid = true;
1538         }
1539       }
1540     }
1541
1542     /*
1543      * set the selected condition (does nothing if not in the list)
1544      */
1545     if (condIsValid)
1546     {
1547       condCombo.setSelectedItem(cond);
1548     }
1549     else
1550     {
1551       condCombo.setSelectedIndex(0);
1552     }
1553
1554     condCombo.addItemListener(listener);
1555
1556     /*
1557      * clear pattern if it is now invalid for condition
1558      */
1559     if (((Condition) condCombo.getSelectedItem()).isNumeric())
1560     {
1561       try
1562       {
1563         String pattern = patternField.getText().trim();
1564         if (pattern.length() > 0)
1565         {
1566           Float.valueOf(pattern);
1567         }
1568       } catch (NumberFormatException e)
1569       {
1570         patternField.setText("");
1571       }
1572     }
1573   }
1574
1575   /**
1576    * Answers true unless a numeric condition has been selected with a non-numeric
1577    * value. Sets the value field to RED with a tooltip if in error.
1578    * <p>
1579    * If the pattern is expected but is empty, this method returns false, but does
1580    * not mark the field as invalid. This supports selecting an attribute for a new
1581    * condition before a match pattern has been entered.
1582    *
1583    * @param value
1584    * @param condCombo
1585    */
1586   protected boolean validateFilter(JTextField value,
1587           JComboBox<Condition> condCombo)
1588   {
1589     if (value == null || condCombo == null)
1590     {
1591       return true; // fields not populated
1592     }
1593
1594     Condition cond = (Condition) condCombo.getSelectedItem();
1595     if (!cond.needsAPattern())
1596     {
1597       return true;
1598     }
1599
1600     value.setBackground(Color.white);
1601     value.setToolTipText("");
1602     String v1 = value.getText().trim();
1603     if (v1.length() == 0)
1604     {
1605       // return false;
1606     }
1607
1608     if (cond.isNumeric() && v1.length() > 0)
1609     {
1610       try
1611       {
1612         Float.valueOf(v1);
1613       } catch (NumberFormatException e)
1614       {
1615         value.setBackground(Color.red);
1616         value.setToolTipText(
1617                 MessageManager.getString("label.numeric_required"));
1618         return false;
1619       }
1620     }
1621
1622     return true;
1623   }
1624
1625   /**
1626    * Constructs a filter condition from the given input fields, and replaces the
1627    * condition at filterIndex with the new one. Does nothing if the pattern field
1628    * is blank (unless the match condition is one that doesn't require a pattern,
1629    * e.g. 'Is present'). Answers true if the filter was updated, else false.
1630    * <p>
1631    * This method may update the tooltip on the filter value field to show the
1632    * value range, if a numeric condition is selected. This ensures the tooltip is
1633    * updated when a numeric valued attribute is chosen on the last 'add a filter'
1634    * row.
1635    *
1636    * @param attCombo
1637    * @param condCombo
1638    * @param valueField
1639    * @param filterIndex
1640    */
1641   protected boolean updateFilter(JComboBox<String> attCombo,
1642           JComboBox<Condition> condCombo, JTextField valueField,
1643           int filterIndex)
1644   {
1645     String attName = (String) attCombo.getSelectedItem();
1646     Condition cond = (Condition) condCombo.getSelectedItem();
1647     String pattern = valueField.getText().trim();
1648
1649     setPatternTooltip(attName, cond, valueField);
1650
1651     if (pattern.length() == 0 && cond.needsAPattern())
1652     {
1653       valueField.setEnabled(true); // ensure pattern field is enabled!
1654       return false;
1655     }
1656
1657     /*
1658      * Construct a matcher that operates on Label, Score,
1659      * or named attribute
1660      */
1661     FeatureMatcherI km = null;
1662     if (LABEL_18N.equals(attName))
1663     {
1664       km = FeatureMatcher.byLabel(cond, pattern);
1665     }
1666     else if (SCORE_18N.equals(attName))
1667     {
1668       km = FeatureMatcher.byScore(cond, pattern);
1669     }
1670     else
1671     {
1672       km = FeatureMatcher.byAttribute(cond, pattern,
1673               FeatureMatcher.fromAttributeDisplayName(attName));
1674     }
1675
1676     filters.set(filterIndex, km);
1677
1678     return true;
1679   }
1680
1681   /**
1682    * Makes the dialog visible, at the Feature Colour tab or at the Filters tab
1683    *
1684    * @param coloursTab
1685    */
1686   public void showTab(boolean coloursTab)
1687   {
1688     setVisible(true);
1689     tabbedPane.setSelectedIndex(coloursTab ? 0 : 1);
1690   }
1691
1692   /**
1693    * Action on any change to feature filtering, namely
1694    * <ul>
1695    * <li>change of selected attribute</li>
1696    * <li>change of selected condition</li>
1697    * <li>change of match pattern</li>
1698    * <li>removal of a condition</li>
1699    * </ul>
1700    * The inputs are parsed into a combined filter and this is set for the feature
1701    * type, and the alignment redrawn.
1702    */
1703   protected void filtersChanged()
1704   {
1705     /*
1706      * update the filter conditions for the feature type
1707      */
1708     boolean anded = andFilters.isSelected();
1709     FeatureMatcherSetI combined = new FeatureMatcherSet();
1710
1711     for (FeatureMatcherI filter : filters)
1712     {
1713       String pattern = filter.getMatcher().getPattern();
1714       Condition condition = filter.getMatcher().getCondition();
1715       if (pattern.trim().length() > 0 || !condition.needsAPattern())
1716       {
1717         if (anded)
1718         {
1719           combined.and(filter);
1720         }
1721         else
1722         {
1723           combined.or(filter);
1724         }
1725       }
1726     }
1727
1728     /*
1729      * save the filter conditions in the FeatureRenderer
1730      * (note this might now be an empty filter with no conditions)
1731      */
1732     fr.setFeatureFilter(featureType, combined.isEmpty() ? null : combined);
1733     ap.paintAlignment(true, true);
1734
1735     updateFiltersTab();
1736   }
1737 }