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