src/jalview/gui/FeatureTypeSettings.java

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