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