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