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, 580, 500);
 246     waitForInput();
 247   }
 248
 249   /**
 250    * Configures the widgets on the Colours tab according to the current feature
 251    * colour scheme
 252    */
 253   private void updateColoursTab()
 254   {
 255     FeatureColourI fc = fr.getFeatureColours().get(featureType);
 256
 257     /*
 258      * suppress action handling while updating values programmatically
 259      */
 260     adjusting = true;
 261     try
 262     {
 263       /*
 264        * single colour
 265        */
 266       if (fc.isSimpleColour())
 267       {
 268         singleColour.setBackground(fc.getColour());
 269         singleColour.setForeground(fc.getColour());
 270         simpleColour.setSelected(true);
 271       }
 272
 273       /*
 274        * colour by text (Label or attribute text)
 275        */
 276       if (fc.isColourByLabel())
 277       {
 278         byCategory.setSelected(true);
 279         colourByTextCombo.setEnabled(colourByTextCombo.getItemCount() > 1);
 280         if (fc.isColourByAttribute())
 281         {
 282           String[] attributeName = fc.getAttributeName();
 283           colourByTextCombo.setSelectedItem(
 284                   FeatureMatcher.toAttributeDisplayName(attributeName));
 285         }
 286         else
 287         {
 288           colourByTextCombo.setSelectedItem(LABEL_18N);
 289         }
 290       }
 291       else
 292       {
 293         colourByTextCombo.setEnabled(false);
 294       }
 295
 296       if (!fc.isGraduatedColour())
 297       {
 298         colourByRangeCombo.setEnabled(false);
 299         minColour.setEnabled(false);
 300         maxColour.setEnabled(false);
 301         noValueCombo.setEnabled(false);
 302         threshold.setEnabled(false);
 303         slider.setEnabled(false);
 304         thresholdValue.setEnabled(false);
 305         thresholdIsMin.setEnabled(false);
 306         return;
 307       }
 308
 309       /*
 310        * Graduated colour, by score or attribute value range
 311        */
 312       graduatedColour.setSelected(true);
 313       updateColourMinMax(); // ensure min, max are set
 314       colourByRangeCombo.setEnabled(colourByRangeCombo.getItemCount() > 1);
 315       minColour.setEnabled(true);
 316       maxColour.setEnabled(true);
 317       noValueCombo.setEnabled(true);
 318       threshold.setEnabled(true);
 319       minColour.setBackground(fc.getMinColour());
 320       maxColour.setBackground(fc.getMaxColour());
 321
 322       if (fc.isColourByAttribute())
 323       {
 324         String[] attributeName = fc.getAttributeName();
 325         colourByRangeCombo.setSelectedItem(
 326                 FeatureMatcher.toAttributeDisplayName(attributeName));
 327       }
 328       else
 329       {
 330         colourByRangeCombo.setSelectedItem(SCORE_18N);
 331       }
 332       Color noColour = fc.getNoColour();
 333       if (noColour == null)
 334       {
 335         noValueCombo.setSelectedIndex(NO_COLOUR_OPTION);
 336       }
 337       else if (noColour.equals(fc.getMinColour()))
 338       {
 339         noValueCombo.setSelectedIndex(MIN_COLOUR_OPTION);
 340       }
 341       else if (noColour.equals(fc.getMaxColour()))
 342       {
 343         noValueCombo.setSelectedIndex(MAX_COLOUR_OPTION);
 344       }
 345
 346       /*
 347        * update min-max scaling if there is a range to work with,
 348        * else disable the widgets (this shouldn't happen if only
 349        * valid options are offered in the combo box)
 350        */
 351       scaleFactor = (max == min) ? 1f : 100f / (max - min);
 352       float range = (max - min) * scaleFactor;
 353       slider.setMinimum((int) (min * scaleFactor));
 354       slider.setMaximum((int) (max * scaleFactor));
 355       slider.setMajorTickSpacing((int) (range / 10f));
 356
 357       threshline = new GraphLine((max - min) / 2f, "Threshold",
 358               Color.black);
 359       threshline.value = fc.getThreshold();
 360
 361       if (fc.hasThreshold())
 362       {
 363         threshold.setSelectedIndex(
 364                 fc.isAboveThreshold() ? ABOVE_THRESHOLD_OPTION
 365                         : BELOW_THRESHOLD_OPTION);
 366         slider.setEnabled(true);
 367         slider.setValue((int) (fc.getThreshold() * scaleFactor));
 368         thresholdValue.setText(String.valueOf(fc.getThreshold()));
 369         thresholdValue.setEnabled(true);
 370         thresholdIsMin.setEnabled(true);
 371       }
 372       else
 373       {
 374         slider.setEnabled(false);
 375         thresholdValue.setEnabled(false);
 376         thresholdIsMin.setEnabled(false);
 377       }
 378       thresholdIsMin.setSelected(!fc.isAutoScaled());
 379     } finally
 380     {
 381       adjusting = false;
 382     }
 383   }
 384
 385   /**
 386    * Configures the initial layout
 387    */
 388   private void initialise()
 389   {
 390     this.setLayout(new BorderLayout());
 391
 392     /*
 393      * an ActionListener that applies colour changes
 394      */
 395     changeColourAction = new ActionListener()
 396     {
 397       @Override
 398       public void actionPerformed(ActionEvent e)
 399       {
 400         colourChanged(true);
 401       }
 402     };
 403
 404     /*
 405      * first panel/tab: colour options
 406      */
 407     JPanel coloursPanel = initialiseColoursPanel();
 408     this.add(coloursPanel, BorderLayout.NORTH);
 409
 410     /*
 411      * second panel/tab: filter options
 412      */
 413     JPanel filtersPanel = initialiseFiltersPanel();
 414     this.add(filtersPanel, BorderLayout.CENTER);
 415
 416     JPanel okCancelPanel = initialiseOkCancelPanel();
 417
 418     this.add(okCancelPanel, BorderLayout.SOUTH);
 419   }
 420
 421   /**
 422    * Updates the min-max range if Colour By selected item is Score, or an
 423    * attribute, with a min-max range
 424    */
 425   protected void updateColourMinMax()
 426   {
 427     if (!graduatedColour.isSelected())
 428     {
 429       return;
 430     }
 431
 432     String colourBy = (String) colourByRangeCombo.getSelectedItem();
 433     float[] minMax = getMinMax(colourBy);
 434
 435     if (minMax != null)
 436     {
 437       min = minMax[0];
 438       max = minMax[1];
 439     }
 440   }
 441
 442   /**
 443    * Retrieves the min-max range:
 444    * <ul>
 445    * <li>of feature score, if colour or filter is by Score</li>
 446    * <li>else of the selected attribute</li>
 447    * </ul>
 448    *
 449    * @param attName
 450    * @return
 451    */
 452   private float[] getMinMax(String attName)
 453   {
 454     float[] minMax = null;
 455     if (SCORE_18N.equals(attName))
 456     {
 457       minMax = fr.getMinMax().get(featureType)[0];
 458     }
 459     else
 460     {
 461       // colour by attribute range
 462       minMax = FeatureAttributes.getInstance().getMinMax(featureType,
 463               FeatureMatcher.fromAttributeDisplayName(attName));
 464     }
 465     return minMax;
 466   }
 467
 468   /**
 469    * Lay out fields for graduated colour (by score or attribute value)
 470    *
 471    * @return
 472    */
 473   private JPanel initialiseGraduatedColourPanel()
 474   {
 475     JPanel graduatedColourPanel = new JPanel();
 476     graduatedColourPanel.setLayout(
 477             new BoxLayout(graduatedColourPanel, BoxLayout.Y_AXIS));
 478     JvSwingUtils.createTitledBorder(graduatedColourPanel,
 479             MessageManager.getString("label.graduated_colour"), true);
 480     graduatedColourPanel.setBackground(Color.white);
 481
 482     /*
 483      * first row: graduated colour radio button, score/attribute drop-down
 484      */
 485     JPanel graduatedChoicePanel = new JPanel(
 486             new FlowLayout(FlowLayout.LEFT));
 487     graduatedChoicePanel.setBackground(Color.white);
 488     graduatedColour = new JRadioButton(
 489             MessageManager.getString("label.by_range_of") + COLON);
 490     graduatedColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
 491     graduatedColour.addItemListener(new ItemListener()
 492     {
 493       @Override
 494       public void itemStateChanged(ItemEvent e)
 495       {
 496         if (graduatedColour.isSelected())
 497         {
 498           colourChanged(true);
 499         }
 500       }
 501     });
 502     graduatedChoicePanel.add(graduatedColour);
 503
 504     List<String[]> attNames = FeatureAttributes.getInstance()
 505             .getAttributes(featureType);
 506     colourByRangeCombo = populateAttributesDropdown(attNames, true, false);
 507     colourByRangeCombo.addItemListener(new ItemListener()
 508     {
 509       @Override
 510       public void itemStateChanged(ItemEvent e)
 511       {
 512         colourChanged(true);
 513       }
 514     });
 515
 516     /*
 517      * disable graduated colour option if no range found
 518      */
 519     graduatedColour.setEnabled(colourByRangeCombo.getItemCount() > 0);
 520
 521     graduatedChoicePanel.add(colourByRangeCombo);
 522     graduatedColourPanel.add(graduatedChoicePanel);
 523
 524     /*
 525      * second row - min/max/no colours
 526      */
 527     JPanel colourRangePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 528     colourRangePanel.setBackground(Color.white);
 529     graduatedColourPanel.add(colourRangePanel);
 530
 531     minColour.setFont(JvSwingUtils.getLabelFont());
 532     minColour.setBorder(BorderFactory.createLineBorder(Color.black));
 533     minColour.setPreferredSize(new Dimension(40, 20));
 534     minColour.setToolTipText(MessageManager.getString("label.min_colour"));
 535     minColour.addMouseListener(new MouseAdapter()
 536     {
 537       @Override
 538       public void mousePressed(MouseEvent e)
 539       {
 540         if (minColour.isEnabled())
 541         {
 542           showColourChooser(minColour, "label.select_colour_minimum_value");
 543         }
 544       }
 545     });
 546
 547     maxColour.setFont(JvSwingUtils.getLabelFont());
 548     maxColour.setBorder(BorderFactory.createLineBorder(Color.black));
 549     maxColour.setPreferredSize(new Dimension(40, 20));
 550     maxColour.setToolTipText(MessageManager.getString("label.max_colour"));
 551     maxColour.addMouseListener(new MouseAdapter()
 552     {
 553       @Override
 554       public void mousePressed(MouseEvent e)
 555       {
 556         if (maxColour.isEnabled())
 557         {
 558           showColourChooser(maxColour, "label.select_colour_maximum_value");
 559         }
 560       }
 561     });
 562     maxColour.setBorder(new LineBorder(Color.black));
 563
 564     /*
 565      * if not set, default max colour to last plain colour,
 566      * and make min colour a pale version of max colour
 567      */
 568     Color max = originalColour.getMaxColour();
 569     if (max == null)
 570     {
 571       max = originalColour.getColour();
 572       minColour.setBackground(ColorUtils.bleachColour(max, 0.9f));
 573     }
 574     else
 575     {
 576       maxColour.setBackground(max);
 577       minColour.setBackground(originalColour.getMinColour());
 578     }
 579
 580     noValueCombo = new JComboBox<>();
 581     noValueCombo.addItem(MessageManager.getString("label.no_colour"));
 582     noValueCombo.addItem(MessageManager.getString("label.min_colour"));
 583     noValueCombo.addItem(MessageManager.getString("label.max_colour"));
 584     noValueCombo.addItemListener(new ItemListener()
 585     {
 586       @Override
 587       public void itemStateChanged(ItemEvent e)
 588       {
 589         colourChanged(true);
 590       }
 591     });
 592
 593     JLabel minText = new JLabel(
 594             MessageManager.getString("label.min_value") + COLON);
 595     minText.setFont(JvSwingUtils.getLabelFont());
 596     JLabel maxText = new JLabel(
 597             MessageManager.getString("label.max_value") + COLON);
 598     maxText.setFont(JvSwingUtils.getLabelFont());
 599     JLabel noText = new JLabel(
 600             MessageManager.getString("label.no_value") + COLON);
 601     noText.setFont(JvSwingUtils.getLabelFont());
 602
 603     colourRangePanel.add(minText);
 604     colourRangePanel.add(minColour);
 605     colourRangePanel.add(maxText);
 606     colourRangePanel.add(maxColour);
 607     colourRangePanel.add(noText);
 608     colourRangePanel.add(noValueCombo);
 609
 610     /*
 611      * third row - threshold options and value
 612      */
 613     JPanel thresholdPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
 614     thresholdPanel.setBackground(Color.white);
 615     graduatedColourPanel.add(thresholdPanel);
 616
 617     threshold.addActionListener(changeColourAction);
 618     threshold.setToolTipText(MessageManager
 619             .getString("label.threshold_feature_display_by_score"));
 620     threshold.addItem(MessageManager
 621             .getString("label.threshold_feature_no_threshold")); // index 0
 622     threshold.addItem(MessageManager
 623             .getString("label.threshold_feature_above_threshold")); // index 1
 624     threshold.addItem(MessageManager
 625             .getString("label.threshold_feature_below_threshold")); // index 2
 626
 627     thresholdValue.addActionListener(new ActionListener()
 628     {
 629       @Override
 630       public void actionPerformed(ActionEvent e)
 631       {
 632         thresholdValue_actionPerformed();
 633       }
 634     });
 635     thresholdValue.addFocusListener(new FocusAdapter()
 636     {
 637       @Override
 638       public void focusLost(FocusEvent e)
 639       {
 640         thresholdValue_actionPerformed();
 641       }
 642     });
 643     slider.setPaintLabels(false);
 644     slider.setPaintTicks(true);
 645     slider.setBackground(Color.white);
 646     slider.setEnabled(false);
 647     slider.setOpaque(false);
 648     slider.setPreferredSize(new Dimension(100, 32));
 649     slider.setToolTipText(
 650             MessageManager.getString("label.adjust_threshold"));
 651
 652     slider.addChangeListener(new ChangeListener()
 653     {
 654       @Override
 655       public void stateChanged(ChangeEvent evt)
 656       {
 657         if (!adjusting)
 658         {
 659           thresholdValue
 660                   .setText(String.valueOf(slider.getValue() / scaleFactor));
 661           thresholdValue.setBackground(Color.white); // to reset red for invalid
 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       /*
1028        * set 'adjusting' flag while moving the slider, so it
1029        * doesn't then in turn change the value (with rounding)
1030        */
1031       adjusting = true;
1032       float f = Float.parseFloat(thresholdValue.getText());
1033       f = Float.max(f,  this.min);
1034       f = Float.min(f, this.max);
1035       thresholdValue.setText(String.valueOf(f));
1036       slider.setValue((int) (f * scaleFactor));
1037       threshline.value = f;
1038       thresholdValue.setBackground(Color.white); // ok
1039       adjusting = false;
1040       colourChanged(true);
1041     } catch (NumberFormatException ex)
1042     {
1043       thresholdValue.setBackground(Color.red); // not ok
1044       adjusting = false;
1045     }
1046   }
1047
1048   /**
1049    * Action on change of threshold slider value. This may be done interactively
1050    * (by moving the slider), or programmatically (to update the slider after
1051    * manual input of a threshold value).
1052    */
1053   protected void sliderValueChanged()
1054   {
1055     threshline.value = getRoundedSliderValue();
1056
1057     /*
1058      * repaint alignment, but not Overview or structure,
1059      * to avoid overload while dragging the slider
1060      */
1061     colourChanged(false);
1062   }
1063
1064   /**
1065    * Converts the slider value to its absolute value by dividing by the
1066    * scaleFactor. Rounding errors are squashed by forcing min/max of slider
1067    * range to the actual min/max of feature score range
1068    *
1069    * @return
1070    */
1071   private float getRoundedSliderValue()
1072   {
1073     int value = slider.getValue();
1074     float f = value == slider.getMaximum() ? max
1075             : (value == slider.getMinimum() ? min : value / scaleFactor);
1076     return f;
1077   }
1078
1079   void addActionListener(ActionListener listener)
1080   {
1081     if (featureSettings != null)
1082     {
1083       System.err.println(
1084               "IMPLEMENTATION ISSUE: overwriting action listener for FeatureColourChooser");
1085     }
1086     featureSettings = listener;
1087   }
1088
1089   /**
1090    * A helper method to build the drop-down choice of attributes for a feature.
1091    * If 'withRange' is true, then Score, and any attributes with a min-max
1092    * range, are added. If 'withText' is true, Label and any known attributes are
1093    * added. This allows 'categorical numerical' attributes e.g. codon position
1094    * to be coloured by text.
1095    * <p>
1096    * Where metadata is available with a description for an attribute, that is
1097    * added as a tooltip.
1098    * <p>
1099    * Attribute names may be 'simple' e.g. "AC" or 'compound' e.g. {"CSQ",
1100    * "Allele"}. Compound names are rendered for display as (e.g.) CSQ:Allele.
1101    * <p>
1102    * This method does not add any ActionListener to the JComboBox.
1103    *
1104    * @param attNames
1105    * @param withRange
1106    * @param withText
1107    */
1108   protected JComboBox<String> populateAttributesDropdown(
1109           List<String[]> attNames, boolean withRange, boolean withText)
1110   {
1111     List<String> displayAtts = new ArrayList<>();
1112     List<String> tooltips = new ArrayList<>();
1113
1114     if (withText)
1115     {
1116       displayAtts.add(LABEL_18N);
1117       tooltips.add(MessageManager.getString("label.description"));
1118     }
1119     if (withRange)
1120     {
1121       float[][] minMax = fr.getMinMax().get(featureType);
1122       if (minMax != null && minMax[0][0] != minMax[0][1])
1123       {
1124         displayAtts.add(SCORE_18N);
1125         tooltips.add(SCORE_18N);
1126       }
1127     }
1128
1129     FeatureAttributes fa = FeatureAttributes.getInstance();
1130     for (String[] attName : attNames)
1131     {
1132       float[] minMax = fa.getMinMax(featureType, attName);
1133       boolean hasRange = minMax != null && minMax[0] != minMax[1];
1134       if (!withText && !hasRange)
1135       {
1136         continue;
1137       }
1138       displayAtts.add(FeatureMatcher.toAttributeDisplayName(attName));
1139       String desc = fa.getDescription(featureType, attName);
1140       if (desc != null && desc.length() > MAX_TOOLTIP_LENGTH)
1141       {
1142         desc = desc.substring(0, MAX_TOOLTIP_LENGTH) + "...";
1143       }
1144       tooltips.add(desc == null ? "" : desc);
1145     }
1146
1147     JComboBox<String> attCombo = JvSwingUtils
1148             .buildComboWithTooltips(displayAtts, tooltips);
1149
1150     return attCombo;
1151   }
1152
1153   /**
1154    * Populates initial layout of the feature attribute filters panel
1155    */
1156   private JPanel initialiseFiltersPanel()
1157   {
1158     filters = new ArrayList<>();
1159
1160     JPanel filtersPanel = new JPanel();
1161     filtersPanel.setLayout(new BoxLayout(filtersPanel, BoxLayout.Y_AXIS));
1162     filtersPanel.setBackground(Color.white);
1163     JvSwingUtils.createTitledBorder(filtersPanel,
1164             MessageManager.getString("label.filters"), true);
1165
1166     JPanel andOrPanel = initialiseAndOrPanel();
1167     filtersPanel.add(andOrPanel);
1168
1169     /*
1170      * panel with filters - populated by refreshFiltersDisplay,
1171      * which also sets the layout manager
1172      */
1173     chooseFiltersPanel = new JPanel();
1174     chooseFiltersPanel.setBackground(Color.white);
1175     filtersPanel.add(chooseFiltersPanel);
1176
1177     return filtersPanel;
1178   }
1179
1180   /**
1181    * Lays out the panel with radio buttons to AND or OR filter conditions
1182    *
1183    * @return
1184    */
1185   private JPanel initialiseAndOrPanel()
1186   {
1187     JPanel andOrPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
1188     andOrPanel.setBackground(Color.white);
1189     andFilters = new JRadioButton(MessageManager.getString("label.and"));
1190     orFilters = new JRadioButton(MessageManager.getString("label.or"));
1191     ActionListener actionListener = new ActionListener()
1192     {
1193       @Override
1194       public void actionPerformed(ActionEvent e)
1195       {
1196         filtersChanged();
1197       }
1198     };
1199     andFilters.addActionListener(actionListener);
1200     orFilters.addActionListener(actionListener);
1201     ButtonGroup andOr = new ButtonGroup();
1202     andOr.add(andFilters);
1203     andOr.add(orFilters);
1204     andFilters.setSelected(true);
1205     andOrPanel.add(
1206             new JLabel(MessageManager.getString("label.join_conditions")));
1207     andOrPanel.add(andFilters);
1208     andOrPanel.add(orFilters);
1209     return andOrPanel;
1210   }
1211
1212   /**
1213    * Refreshes the display to show any filters currently configured for the
1214    * selected feature type (editable, with 'remove' option), plus one extra row
1215    * for adding a condition. This should be called after a filter has been
1216    * removed, added or amended.
1217    */
1218   private void updateFiltersTab()
1219   {
1220     /*
1221      * clear the panel and list of filter conditions
1222      */
1223     chooseFiltersPanel.removeAll();
1224     filters.clear();
1225
1226     /*
1227      * look up attributes known for feature type
1228      */
1229     List<String[]> attNames = FeatureAttributes.getInstance()
1230             .getAttributes(featureType);
1231
1232     /*
1233      * if this feature type has filters set, load them first
1234      */
1235     FeatureMatcherSetI featureFilters = fr.getFeatureFilter(featureType);
1236     if (featureFilters != null)
1237     {
1238       if (!featureFilters.isAnded())
1239       {
1240         orFilters.setSelected(true);
1241       }
1242       featureFilters.getMatchers().forEach(matcher -> filters.add(matcher));
1243     }
1244
1245     /*
1246      * and an empty filter for the user to populate (add)
1247      */
1248     filters.add(FeatureMatcher.NULL_MATCHER);
1249
1250     /*
1251      * use GridLayout to 'justify' rows to the top of the panel, until
1252      * there are too many to fit in, then fall back on BoxLayout
1253      */
1254     if (filters.size() <= 5)
1255     {
1256       chooseFiltersPanel.setLayout(new GridLayout(5, 1));
1257     }
1258     else
1259     {
1260       chooseFiltersPanel.setLayout(
1261               new BoxLayout(chooseFiltersPanel, BoxLayout.Y_AXIS));
1262     }
1263
1264     /*
1265      * render the conditions in rows, each in its own JPanel
1266      */
1267     int filterIndex = 0;
1268     for (FeatureMatcherI filter : filters)
1269     {
1270       JPanel row = addFilter(filter, attNames, filterIndex);
1271       chooseFiltersPanel.add(row);
1272       filterIndex++;
1273     }
1274
1275     this.validate();
1276     this.repaint();
1277   }
1278
1279   /**
1280    * A helper method that constructs a row (panel) with one filter condition:
1281    * <ul>
1282    * <li>a drop-down list of Label, Score and attribute names to choose
1283    * from</li>
1284    * <li>a drop-down list of conditions to choose from</li>
1285    * <li>a text field for input of a match pattern</li>
1286    * <li>optionally, a 'remove' button</li>
1287    * </ul>
1288    * The filter values are set as defaults for the input fields. The 'remove'
1289    * button is added unless the pattern is empty (incomplete filter condition).
1290    * <p>
1291    * Action handlers on these fields provide for
1292    * <ul>
1293    * <li>validate pattern field - should be numeric if condition is numeric</li>
1294    * <li>save filters and refresh display on any (valid) change</li>
1295    * <li>remove filter and refresh on 'Remove'</li>
1296    * <li>update conditions list on change of Label/Score/Attribute</li>
1297    * <li>refresh value field tooltip with min-max range on change of
1298    * attribute</li>
1299    * </ul>
1300    *
1301    * @param filter
1302    * @param attNames
1303    * @param filterIndex
1304    * @return
1305    */
1306   protected JPanel addFilter(FeatureMatcherI filter,
1307           List<String[]> attNames, int filterIndex)
1308   {
1309     String[] attName = filter.getAttribute();
1310     Condition cond = filter.getMatcher().getCondition();
1311     String pattern = filter.getMatcher().getPattern();
1312
1313     JPanel filterRow = new JPanel(new FlowLayout(FlowLayout.LEFT));
1314     filterRow.setBackground(Color.white);
1315
1316     /*
1317      * drop-down choice of attribute, with description as a tooltip
1318      * if we can obtain it
1319      */
1320     final JComboBox<String> attCombo = populateAttributesDropdown(attNames,
1321             true, true);
1322     String filterBy = setSelectedAttribute(attCombo, filter);
1323
1324     JComboBox<Condition> condCombo = new JComboBox<>();
1325
1326     JTextField patternField = new JTextField(8);
1327     patternField.setText(pattern);
1328
1329     /*
1330      * action handlers that validate and (if valid) apply changes
1331      */
1332     ActionListener actionListener = new ActionListener()
1333     {
1334       @Override
1335       public void actionPerformed(ActionEvent e)
1336       {
1337         if (validateFilter(patternField, condCombo))
1338         {
1339           if (updateFilter(attCombo, condCombo, patternField, filterIndex))
1340           {
1341             filtersChanged();
1342           }
1343         }
1344       }
1345     };
1346     ItemListener itemListener = new ItemListener()
1347     {
1348       @Override
1349       public void itemStateChanged(ItemEvent e)
1350       {
1351         actionListener.actionPerformed(null);
1352       }
1353     };
1354
1355     if (filter == FeatureMatcher.NULL_MATCHER) // the 'add a condition' row
1356     {
1357       attCombo.setSelectedIndex(0);
1358     }
1359     else
1360     {
1361       attCombo.setSelectedItem(
1362               FeatureMatcher.toAttributeDisplayName(attName));
1363     }
1364     attCombo.addItemListener(new ItemListener()
1365     {
1366       @Override
1367       public void itemStateChanged(ItemEvent e)
1368       {
1369         /*
1370          * on change of attribute, refresh the conditions list to
1371          * ensure it is appropriate for the attribute datatype
1372          */
1373         populateConditions((String) attCombo.getSelectedItem(),
1374                 (Condition) condCombo.getSelectedItem(), condCombo,
1375                 patternField);
1376         actionListener.actionPerformed(null);
1377       }
1378     });
1379
1380     filterRow.add(attCombo);
1381
1382     /*
1383      * drop-down choice of test condition
1384      */
1385     populateConditions(filterBy, cond, condCombo, patternField);
1386     condCombo.setPreferredSize(new Dimension(150, 20));
1387     condCombo.addItemListener(itemListener);
1388     filterRow.add(condCombo);
1389
1390     /*
1391      * pattern to match against
1392      */
1393     patternField.addActionListener(actionListener);
1394     patternField.addFocusListener(new FocusAdapter()
1395     {
1396       @Override
1397       public void focusLost(FocusEvent e)
1398       {
1399         actionListener.actionPerformed(null);
1400       }
1401     });
1402     filterRow.add(patternField);
1403
1404     /*
1405      * disable pattern field for condition 'Present / NotPresent'
1406      */
1407     Condition selectedCondition = (Condition) condCombo.getSelectedItem();
1408     patternField.setEnabled(selectedCondition.needsAPattern());
1409
1410     /*
1411      * if a numeric condition is selected, show the value range
1412      * as a tooltip on the value input field
1413      */
1414     setNumericHints(filterBy, selectedCondition, patternField);
1415
1416     /*
1417      * add remove button if filter is populated (non-empty pattern)
1418      */
1419     if (!patternField.isEnabled()
1420             || (pattern != null && pattern.trim().length() > 0))
1421     {
1422       // todo: gif for button drawing '-' or 'x'
1423       JButton removeCondition = new BasicArrowButton(SwingConstants.WEST);
1424       removeCondition
1425               .setToolTipText(MessageManager.getString("label.delete_row"));
1426       removeCondition.addActionListener(new ActionListener()
1427       {
1428         @Override
1429         public void actionPerformed(ActionEvent e)
1430         {
1431           filters.remove(filterIndex);
1432           filtersChanged();
1433         }
1434       });
1435       filterRow.add(removeCondition);
1436     }
1437
1438     return filterRow;
1439   }
1440
1441   /**
1442    * Sets the selected item in the Label/Score/Attribute drop-down to match the
1443    * filter
1444    *
1445    * @param attCombo
1446    * @param filter
1447    */
1448   private String setSelectedAttribute(JComboBox<String> attCombo,
1449           FeatureMatcherI filter)
1450   {
1451     String item = null;
1452     if (filter.isByScore())
1453     {
1454       item = SCORE_18N;
1455     }
1456     else if (filter.isByLabel())
1457     {
1458       item = LABEL_18N;
1459     }
1460     else
1461     {
1462       item = FeatureMatcher.toAttributeDisplayName(filter.getAttribute());
1463     }
1464     attCombo.setSelectedItem(item);
1465     return item;
1466   }
1467
1468   /**
1469    * If a numeric comparison condition is selected, retrieves the min-max range
1470    * for the value (score or attribute), and sets it as a tooltip on the value
1471    * field. If the field is currently empty, then pre-populates it with
1472    * <ul>
1473    * <li>the minimum value, if condition is > or >=</li>
1474    * <li>the maximum value, if condition is < or <=</li>
1475    * </ul>
1476    *
1477    * @param attName
1478    * @param selectedCondition
1479    * @param patternField
1480    */
1481   private void setNumericHints(String attName, Condition selectedCondition,
1482           JTextField patternField)
1483   {
1484     patternField.setToolTipText("");
1485
1486     if (selectedCondition.isNumeric())
1487     {
1488       float[] minMax = getMinMax(attName);
1489       if (minMax != null)
1490       {
1491         String minFormatted = DECFMT_2_2.format(minMax[0]);
1492         String maxFormatted = DECFMT_2_2.format(minMax[1]);
1493         String tip = String.format("(%s - %s)", minFormatted, maxFormatted);
1494         patternField.setToolTipText(tip);
1495         if (patternField.getText().isEmpty())
1496         {
1497           if (selectedCondition == Condition.GE
1498                   || selectedCondition == Condition.GT)
1499           {
1500             patternField.setText(minFormatted);
1501           }
1502           else
1503           {
1504             if (selectedCondition == Condition.LE
1505                     || selectedCondition == Condition.LT)
1506             {
1507               patternField.setText(maxFormatted);
1508             }
1509           }
1510         }
1511       }
1512     }
1513   }
1514
1515   /**
1516    * Populates the drop-down list of comparison conditions for the given
1517    * attribute name. The conditions added depend on the datatype of the
1518    * attribute values. The supplied condition is set as the selected item in the
1519    * list, provided it is in the list. If the pattern is now invalid
1520    * (non-numeric pattern for a numeric condition), it is cleared.
1521    *
1522    * @param attName
1523    * @param cond
1524    * @param condCombo
1525    * @param patternField
1526    */
1527   private void populateConditions(String attName, Condition cond,
1528           JComboBox<Condition> condCombo, JTextField patternField)
1529   {
1530     Datatype type = FeatureAttributes.getInstance().getDatatype(featureType,
1531             FeatureMatcher.fromAttributeDisplayName(attName));
1532     if (LABEL_18N.equals(attName))
1533     {
1534       type = Datatype.Character;
1535     }
1536     else if (SCORE_18N.equals(attName))
1537     {
1538       type = Datatype.Number;
1539     }
1540
1541     /*
1542      * remove itemListener before starting
1543      */
1544     ItemListener listener = condCombo.getItemListeners()[0];
1545     condCombo.removeItemListener(listener);
1546     boolean condIsValid = false;
1547
1548     condCombo.removeAllItems();
1549     for (Condition c : Condition.values())
1550     {
1551       if ((c.isNumeric() && type == Datatype.Number)
1552               || (!c.isNumeric() && type != Datatype.Number))
1553       {
1554         condCombo.addItem(c);
1555         if (c == cond)
1556         {
1557           condIsValid = true;
1558         }
1559       }
1560     }
1561
1562     /*
1563      * set the selected condition (does nothing if not in the list)
1564      */
1565     if (condIsValid)
1566     {
1567       condCombo.setSelectedItem(cond);
1568     }
1569     else
1570     {
1571       condCombo.setSelectedIndex(0);
1572     }
1573
1574     /*
1575      * clear pattern if it is now invalid for condition
1576      */
1577     if (((Condition) condCombo.getSelectedItem()).isNumeric())
1578     {
1579       try
1580       {
1581         String pattern = patternField.getText().trim();
1582         if (pattern.length() > 0)
1583         {
1584           Float.valueOf(pattern);
1585         }
1586       } catch (NumberFormatException e)
1587       {
1588         patternField.setText("");
1589       }
1590     }
1591
1592     /*
1593      * restore the listener
1594      */
1595     condCombo.addItemListener(listener);
1596   }
1597
1598   /**
1599    * Answers true unless a numeric condition has been selected with a
1600    * non-numeric value. Sets the value field to RED with a tooltip if in error.
1601    * <p>
1602    * If the pattern is expected but is empty, this method returns false, but
1603    * does not mark the field as invalid. This supports selecting an attribute
1604    * for a new condition before a match pattern has been entered.
1605    *
1606    * @param value
1607    * @param condCombo
1608    */
1609   protected boolean validateFilter(JTextField value,
1610           JComboBox<Condition> condCombo)
1611   {
1612     if (value == null || condCombo == null)
1613     {
1614       return true; // fields not populated
1615     }
1616
1617     Condition cond = (Condition) condCombo.getSelectedItem();
1618     if (!cond.needsAPattern())
1619     {
1620       return true;
1621     }
1622
1623     value.setBackground(Color.white);
1624     value.setToolTipText("");
1625     String v1 = value.getText().trim();
1626     if (v1.length() == 0)
1627     {
1628       // return false;
1629     }
1630
1631     if (cond.isNumeric() && v1.length() > 0)
1632     {
1633       try
1634       {
1635         Float.valueOf(v1);
1636       } catch (NumberFormatException e)
1637       {
1638         value.setBackground(Color.red);
1639         value.setToolTipText(
1640                 MessageManager.getString("label.numeric_required"));
1641         return false;
1642       }
1643     }
1644
1645     return true;
1646   }
1647
1648   /**
1649    * Constructs a filter condition from the given input fields, and replaces the
1650    * condition at filterIndex with the new one. Does nothing if the pattern
1651    * field is blank (unless the match condition is one that doesn't require a
1652    * pattern, e.g. 'Is present'). Answers true if the filter was updated, else
1653    * false.
1654    * <p>
1655    * This method may update the tooltip on the filter value field to show the
1656    * value range, if a numeric condition is selected. This ensures the tooltip
1657    * is updated when a numeric valued attribute is chosen on the last 'add a
1658    * filter' row.
1659    *
1660    * @param attCombo
1661    * @param condCombo
1662    * @param valueField
1663    * @param filterIndex
1664    */
1665   protected boolean updateFilter(JComboBox<String> attCombo,
1666           JComboBox<Condition> condCombo, JTextField valueField,
1667           int filterIndex)
1668   {
1669     String attName = (String) attCombo.getSelectedItem();
1670     Condition cond = (Condition) condCombo.getSelectedItem();
1671     String pattern = valueField.getText().trim();
1672
1673     setNumericHints(attName, cond, valueField);
1674
1675     if (pattern.length() == 0 && cond.needsAPattern())
1676     {
1677       valueField.setEnabled(true); // ensure pattern field is enabled!
1678       return false;
1679     }
1680
1681     /*
1682      * Construct a matcher that operates on Label, Score,
1683      * or named attribute
1684      */
1685     FeatureMatcherI km = null;
1686     if (LABEL_18N.equals(attName))
1687     {
1688       km = FeatureMatcher.byLabel(cond, pattern);
1689     }
1690     else if (SCORE_18N.equals(attName))
1691     {
1692       km = FeatureMatcher.byScore(cond, pattern);
1693     }
1694     else
1695     {
1696       km = FeatureMatcher.byAttribute(cond, pattern,
1697               FeatureMatcher.fromAttributeDisplayName(attName));
1698     }
1699
1700     filters.set(filterIndex, km);
1701
1702     return true;
1703   }
1704
1705   /**
1706    * Action on any change to feature filtering, namely
1707    * <ul>
1708    * <li>change of selected attribute</li>
1709    * <li>change of selected condition</li>
1710    * <li>change of match pattern</li>
1711    * <li>removal of a condition</li>
1712    * </ul>
1713    * The inputs are parsed into a combined filter and this is set for the
1714    * feature type, and the alignment redrawn.
1715    */
1716   protected void filtersChanged()
1717   {
1718     /*
1719      * update the filter conditions for the feature type
1720      */
1721     boolean anded = andFilters.isSelected();
1722     FeatureMatcherSetI combined = new FeatureMatcherSet();
1723
1724     for (FeatureMatcherI filter : filters)
1725     {
1726       String pattern = filter.getMatcher().getPattern();
1727       Condition condition = filter.getMatcher().getCondition();
1728       if (pattern.trim().length() > 0 || !condition.needsAPattern())
1729       {
1730         if (anded)
1731         {
1732           combined.and(filter);
1733         }
1734         else
1735         {
1736           combined.or(filter);
1737         }
1738       }
1739     }
1740
1741     /*
1742      * save the filter conditions in the FeatureRenderer
1743      * (note this might now be an empty filter with no conditions)
1744      */
1745     fr.setFeatureFilter(featureType, combined.isEmpty() ? null : combined);
1746     ap.paintAlignment(true, true);
1747
1748     updateFiltersTab();
1749   }
1750 }