src/jalview/gui/FeatureTypeSettings.java

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