2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.api.AlignmentViewPanel;
24 import jalview.api.FeatureColourI;
25 import jalview.bin.Cache;
26 import jalview.datamodel.GraphLine;
27 import jalview.datamodel.features.FeatureAttributes;
28 import jalview.datamodel.features.FeatureAttributes.Datatype;
29 import jalview.datamodel.features.FeatureMatcher;
30 import jalview.datamodel.features.FeatureMatcherI;
31 import jalview.datamodel.features.FeatureMatcherSet;
32 import jalview.datamodel.features.FeatureMatcherSetI;
33 import jalview.schemes.FeatureColour;
34 import jalview.util.ColorUtils;
35 import jalview.util.MessageManager;
36 import jalview.util.matcher.Condition;
38 import java.awt.BorderLayout;
39 import java.awt.Color;
40 import java.awt.Dimension;
41 import java.awt.FlowLayout;
42 import java.awt.GridLayout;
43 import java.awt.event.ActionEvent;
44 import java.awt.event.ActionListener;
45 import java.awt.event.FocusAdapter;
46 import java.awt.event.FocusEvent;
47 import java.awt.event.ItemEvent;
48 import java.awt.event.ItemListener;
49 import java.awt.event.MouseAdapter;
50 import java.awt.event.MouseEvent;
51 import java.text.DecimalFormat;
52 import java.util.ArrayList;
53 import java.util.List;
55 import javax.swing.BorderFactory;
56 import javax.swing.BoxLayout;
57 import javax.swing.ButtonGroup;
58 import javax.swing.JButton;
59 import javax.swing.JCheckBox;
60 import javax.swing.JColorChooser;
61 import javax.swing.JComboBox;
62 import javax.swing.JLabel;
63 import javax.swing.JPanel;
64 import javax.swing.JRadioButton;
65 import javax.swing.JSlider;
66 import javax.swing.JTextField;
67 import javax.swing.border.EmptyBorder;
68 import javax.swing.border.LineBorder;
69 import javax.swing.event.ChangeEvent;
70 import javax.swing.event.ChangeListener;
73 * A dialog where the user can configure colour scheme, and any filters, for one
76 * (Was FeatureColourChooser prior to Jalview 1.11, renamed with the addition of
79 public class FeatureTypeSettings extends JalviewDialog
81 private final static String LABEL_18N = MessageManager
82 .getString("label.label");
84 private final static String SCORE_18N = MessageManager
85 .getString("label.score");
87 private static final int RADIO_WIDTH = 130;
89 private static final String COLON = ":";
91 private static final int MAX_TOOLTIP_LENGTH = 50;
93 private static final int NO_COLOUR_OPTION = 0;
95 private static final int MIN_COLOUR_OPTION = 1;
97 private static final int MAX_COLOUR_OPTION = 2;
99 private static final int ABOVE_THRESHOLD_OPTION = 1;
101 private static final int BELOW_THRESHOLD_OPTION = 2;
103 private static final DecimalFormat DECFMT_2_2 = new DecimalFormat(
107 * FeatureRenderer holds colour scheme and filters for feature types
109 private final FeatureRenderer fr; // todo refactor to allow interface type
113 * the view panel to update when settings change
115 private final AlignmentViewPanel ap;
117 private final String featureType;
120 * the colour and filters to reset to on Cancel
122 private final FeatureColourI originalColour;
124 private final FeatureMatcherSetI originalFilter;
127 * set flag to true when setting values programmatically,
128 * to avoid invocation of action handlers
130 private boolean adjusting = false;
133 * minimum of the value range for graduated colour
134 * (may be for feature score or for a numeric attribute)
139 * maximum of the value range for graduated colour
144 * scale factor for conversion between absolute min-max and slider
146 private float scaleFactor;
149 * radio button group, to select what to colour by:
150 * simple colour, by category (text), or graduated
152 private JRadioButton simpleColour = new JRadioButton();
154 private JRadioButton byCategory = new JRadioButton();
156 private JRadioButton graduatedColour = new JRadioButton();
159 * colours and filters are shown in tabbed view or single content pane
161 JPanel coloursPanel, filtersPanel;
163 JPanel singleColour = new JPanel();
165 private JPanel minColour = new JPanel();
167 private JPanel maxColour = new JPanel();
169 private JComboBox<Object> threshold = new JComboBox<>();
171 private JSlider slider = new JSlider();
173 private JTextField thresholdValue = new JTextField(20);
175 private JCheckBox thresholdIsMin = new JCheckBox();
177 private GraphLine threshline;
179 private ActionListener featureSettings = null;
181 private ActionListener changeColourAction;
184 * choice of option for 'colour for no value'
186 private JComboBox<Object> noValueCombo;
189 * choice of what to colour by text (Label or attribute)
191 private JComboBox<Object> colourByTextCombo;
194 * choice of what to colour by range (Score or attribute)
196 private JComboBox<Object> colourByRangeCombo;
198 private JRadioButton andFilters;
200 private JRadioButton orFilters;
203 * filters for the currently selected feature type
205 private List<FeatureMatcherI> filters;
207 private JPanel chooseFiltersPanel;
215 public FeatureTypeSettings(FeatureRenderer frender, String theType)
218 this.featureType = theType;
220 originalFilter = fr.getFeatureFilter(theType);
221 originalColour = fr.getFeatureColours().get(theType);
228 } catch (Exception ex)
230 ex.printStackTrace();
240 colourChanged(false);
242 String title = MessageManager
243 .formatMessage("label.display_settings_for", new String[]
245 initDialogFrame(this, true, false, title, 580, 500);
250 * Configures the widgets on the Colours tab according to the current feature
253 private void updateColoursTab()
255 FeatureColourI fc = fr.getFeatureColours().get(featureType);
258 * suppress action handling while updating values programmatically
266 if (fc.isSimpleColour())
268 singleColour.setBackground(fc.getColour());
269 singleColour.setForeground(fc.getColour());
270 simpleColour.setSelected(true);
274 * colour by text (Label or attribute text)
276 if (fc.isColourByLabel())
278 byCategory.setSelected(true);
279 colourByTextCombo.setEnabled(colourByTextCombo.getItemCount() > 1);
280 if (fc.isColourByAttribute())
282 String[] attributeName = fc.getAttributeName();
283 colourByTextCombo.setSelectedItem(
284 FeatureMatcher.toAttributeDisplayName(attributeName));
288 colourByTextCombo.setSelectedItem(LABEL_18N);
293 colourByTextCombo.setEnabled(false);
296 if (!fc.isGraduatedColour())
298 colourByRangeCombo.setEnabled(false);
299 minColour.setEnabled(false);
300 maxColour.setEnabled(false);
301 noValueCombo.setEnabled(false);
302 threshold.setEnabled(false);
303 slider.setEnabled(false);
304 thresholdValue.setEnabled(false);
305 thresholdIsMin.setEnabled(false);
310 * Graduated colour, by score or attribute value range
312 graduatedColour.setSelected(true);
313 updateColourMinMax(); // ensure min, max are set
314 colourByRangeCombo.setEnabled(colourByRangeCombo.getItemCount() > 1);
315 minColour.setEnabled(true);
316 maxColour.setEnabled(true);
317 noValueCombo.setEnabled(true);
318 threshold.setEnabled(true);
319 minColour.setBackground(fc.getMinColour());
320 maxColour.setBackground(fc.getMaxColour());
322 if (fc.isColourByAttribute())
324 String[] attributeName = fc.getAttributeName();
325 colourByRangeCombo.setSelectedItem(
326 FeatureMatcher.toAttributeDisplayName(attributeName));
330 colourByRangeCombo.setSelectedItem(SCORE_18N);
332 Color noColour = fc.getNoColour();
333 if (noColour == null)
335 noValueCombo.setSelectedIndex(NO_COLOUR_OPTION);
337 else if (noColour.equals(fc.getMinColour()))
339 noValueCombo.setSelectedIndex(MIN_COLOUR_OPTION);
341 else if (noColour.equals(fc.getMaxColour()))
343 noValueCombo.setSelectedIndex(MAX_COLOUR_OPTION);
347 * update min-max scaling if there is a range to work with,
348 * else disable the widgets (this shouldn't happen if only
349 * valid options are offered in the combo box)
351 scaleFactor = (max == min) ? 1f : 100f / (max - min);
352 float range = (max - min) * scaleFactor;
353 slider.setMinimum((int) (min * scaleFactor));
354 slider.setMaximum((int) (max * scaleFactor));
355 slider.setMajorTickSpacing((int) (range / 10f));
357 threshline = new GraphLine((max - min) / 2f, "Threshold",
359 threshline.value = fc.getThreshold();
361 if (fc.hasThreshold())
363 threshold.setSelectedIndex(
364 fc.isAboveThreshold() ? ABOVE_THRESHOLD_OPTION
365 : BELOW_THRESHOLD_OPTION);
366 slider.setEnabled(true);
367 slider.setValue((int) (fc.getThreshold() * scaleFactor));
368 thresholdValue.setText(String.valueOf(fc.getThreshold()));
369 thresholdValue.setEnabled(true);
370 thresholdIsMin.setEnabled(true);
374 slider.setEnabled(false);
375 thresholdValue.setEnabled(false);
376 thresholdIsMin.setEnabled(false);
378 thresholdIsMin.setSelected(!fc.isAutoScaled());
386 * Configures the initial layout
388 private void initialise()
390 this.setLayout(new BorderLayout());
393 * an ActionListener that applies colour changes
395 changeColourAction = new ActionListener()
398 public void actionPerformed(ActionEvent e)
405 * first panel/tab: colour options
407 JPanel coloursPanel = initialiseColoursPanel();
408 this.add(coloursPanel, BorderLayout.NORTH);
411 * second panel/tab: filter options
413 JPanel filtersPanel = initialiseFiltersPanel();
414 this.add(filtersPanel, BorderLayout.CENTER);
416 JPanel okCancelPanel = initialiseOkCancelPanel();
418 this.add(okCancelPanel, BorderLayout.SOUTH);
422 * Updates the min-max range if Colour By selected item is Score, or an
423 * attribute, with a min-max range
425 protected void updateColourMinMax()
427 if (!graduatedColour.isSelected())
432 String colourBy = (String) colourByRangeCombo.getSelectedItem();
433 float[] minMax = getMinMax(colourBy);
443 * Retrieves the min-max range:
445 * <li>of feature score, if colour or filter is by Score</li>
446 * <li>else of the selected attribute</li>
452 private float[] getMinMax(String attName)
454 float[] minMax = null;
455 if (SCORE_18N.equals(attName))
457 minMax = fr.getMinMax().get(featureType)[0];
461 // colour by attribute range
462 minMax = FeatureAttributes.getInstance().getMinMax(featureType,
463 FeatureMatcher.fromAttributeDisplayName(attName));
469 * Lay out fields for graduated colour (by score or attribute value)
473 private JPanel initialiseGraduatedColourPanel()
475 JPanel graduatedColourPanel = new JPanel();
476 graduatedColourPanel.setLayout(
477 new BoxLayout(graduatedColourPanel, BoxLayout.Y_AXIS));
478 JvSwingUtils.createTitledBorder(graduatedColourPanel,
479 MessageManager.getString("label.graduated_colour"), true);
480 graduatedColourPanel.setBackground(Color.white);
483 * first row: graduated colour radio button, score/attribute drop-down
485 JPanel graduatedChoicePanel = new JPanel(
486 new FlowLayout(FlowLayout.LEFT));
487 graduatedChoicePanel.setBackground(Color.white);
488 graduatedColour = new JRadioButton(
489 MessageManager.getString("label.by_range_of") + COLON);
490 graduatedColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
491 graduatedColour.addItemListener(new ItemListener()
494 public void itemStateChanged(ItemEvent e)
496 if (graduatedColour.isSelected())
502 graduatedChoicePanel.add(graduatedColour);
504 List<String[]> attNames = FeatureAttributes.getInstance()
505 .getAttributes(featureType);
506 colourByRangeCombo = populateAttributesDropdown(attNames, true, false);
507 colourByRangeCombo.addItemListener(new ItemListener()
510 public void itemStateChanged(ItemEvent e)
517 * disable graduated colour option if no range found
519 graduatedColour.setEnabled(colourByRangeCombo.getItemCount() > 0);
521 graduatedChoicePanel.add(colourByRangeCombo);
522 graduatedColourPanel.add(graduatedChoicePanel);
525 * second row - min/max/no colours
527 JPanel colourRangePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
528 colourRangePanel.setBackground(Color.white);
529 graduatedColourPanel.add(colourRangePanel);
531 minColour.setFont(JvSwingUtils.getLabelFont());
532 minColour.setBorder(BorderFactory.createLineBorder(Color.black));
533 minColour.setPreferredSize(new Dimension(40, 20));
534 minColour.setToolTipText(MessageManager.getString("label.min_colour"));
535 minColour.addMouseListener(new MouseAdapter()
538 public void mousePressed(MouseEvent e)
540 if (minColour.isEnabled())
542 showColourChooser(minColour, "label.select_colour_minimum_value");
547 maxColour.setFont(JvSwingUtils.getLabelFont());
548 maxColour.setBorder(BorderFactory.createLineBorder(Color.black));
549 maxColour.setPreferredSize(new Dimension(40, 20));
550 maxColour.setToolTipText(MessageManager.getString("label.max_colour"));
551 maxColour.addMouseListener(new MouseAdapter()
554 public void mousePressed(MouseEvent e)
556 if (maxColour.isEnabled())
558 showColourChooser(maxColour, "label.select_colour_maximum_value");
562 maxColour.setBorder(new LineBorder(Color.black));
565 * if not set, default max colour to last plain colour,
566 * and make min colour a pale version of max colour
568 Color max = originalColour.getMaxColour();
571 max = originalColour.getColour();
572 minColour.setBackground(ColorUtils.bleachColour(max, 0.9f));
576 maxColour.setBackground(max);
577 minColour.setBackground(originalColour.getMinColour());
580 noValueCombo = new JComboBox<>();
581 noValueCombo.addItem(MessageManager.getString("label.no_colour"));
582 noValueCombo.addItem(MessageManager.getString("label.min_colour"));
583 noValueCombo.addItem(MessageManager.getString("label.max_colour"));
584 noValueCombo.addItemListener(new ItemListener()
587 public void itemStateChanged(ItemEvent e)
593 JLabel minText = new JLabel(
594 MessageManager.getString("label.min_value") + COLON);
595 minText.setFont(JvSwingUtils.getLabelFont());
596 JLabel maxText = new JLabel(
597 MessageManager.getString("label.max_value") + COLON);
598 maxText.setFont(JvSwingUtils.getLabelFont());
599 JLabel noText = new JLabel(
600 MessageManager.getString("label.no_value") + COLON);
601 noText.setFont(JvSwingUtils.getLabelFont());
603 colourRangePanel.add(minText);
604 colourRangePanel.add(minColour);
605 colourRangePanel.add(maxText);
606 colourRangePanel.add(maxColour);
607 colourRangePanel.add(noText);
608 colourRangePanel.add(noValueCombo);
611 * third row - threshold options and value
613 JPanel thresholdPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
614 thresholdPanel.setBackground(Color.white);
615 graduatedColourPanel.add(thresholdPanel);
617 threshold.addActionListener(changeColourAction);
618 threshold.setToolTipText(MessageManager
619 .getString("label.threshold_feature_display_by_score"));
620 threshold.addItem(MessageManager
621 .getString("label.threshold_feature_no_threshold")); // index 0
622 threshold.addItem(MessageManager
623 .getString("label.threshold_feature_above_threshold")); // index 1
624 threshold.addItem(MessageManager
625 .getString("label.threshold_feature_below_threshold")); // index 2
627 thresholdValue.addActionListener(new ActionListener()
630 public void actionPerformed(ActionEvent e)
632 thresholdValue_actionPerformed();
635 thresholdValue.addFocusListener(new FocusAdapter()
638 public void focusLost(FocusEvent e)
640 thresholdValue_actionPerformed();
643 slider.setPaintLabels(false);
644 slider.setPaintTicks(true);
645 slider.setBackground(Color.white);
646 slider.setEnabled(false);
647 slider.setOpaque(false);
648 slider.setPreferredSize(new Dimension(100, 32));
649 slider.setToolTipText(
650 MessageManager.getString("label.adjust_threshold"));
652 slider.addChangeListener(new ChangeListener()
655 public void stateChanged(ChangeEvent evt)
660 .setText(String.valueOf(slider.getValue() / scaleFactor));
661 thresholdValue.setBackground(Color.white); // to reset red for invalid
662 sliderValueChanged();
666 slider.addMouseListener(new MouseAdapter()
669 public void mouseReleased(MouseEvent evt)
672 * only update Overview and/or structure colouring
673 * when threshold slider drag ends (mouse up)
677 ap.paintAlignment(true, true);
682 thresholdValue.setEnabled(false);
683 thresholdValue.setColumns(7);
685 thresholdPanel.add(threshold);
686 thresholdPanel.add(slider);
687 thresholdPanel.add(thresholdValue);
689 thresholdIsMin.setBackground(Color.white);
691 .setText(MessageManager.getString("label.threshold_minmax"));
692 thresholdIsMin.setToolTipText(MessageManager
693 .getString("label.toggle_absolute_relative_display_threshold"));
694 thresholdIsMin.addActionListener(changeColourAction);
695 thresholdPanel.add(thresholdIsMin);
697 return graduatedColourPanel;
701 * Lay out OK and Cancel buttons
705 private JPanel initialiseOkCancelPanel()
707 JPanel okCancelPanel = new JPanel();
708 // okCancelPanel.setBackground(Color.white);
709 okCancelPanel.add(ok);
710 okCancelPanel.add(cancel);
711 return okCancelPanel;
715 * Lay out Colour options panel, containing
717 * <li>plain colour, with colour picker</li>
718 * <li>colour by text, with choice of Label or other attribute</li>
719 * <li>colour by range, of score or other attribute, when available</li>
724 private JPanel initialiseColoursPanel()
726 JPanel colourByPanel = new JPanel();
727 colourByPanel.setBackground(Color.white);
728 colourByPanel.setLayout(new BoxLayout(colourByPanel, BoxLayout.Y_AXIS));
729 JvSwingUtils.createTitledBorder(colourByPanel,
730 MessageManager.getString("action.colour"), true);
733 * simple colour radio button and colour picker
735 JPanel simpleColourPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
736 simpleColourPanel.setBackground(Color.white);
737 colourByPanel.add(simpleColourPanel);
739 simpleColour = new JRadioButton(
740 MessageManager.getString("label.simple_colour"));
741 simpleColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
742 simpleColour.addItemListener(new ItemListener()
745 public void itemStateChanged(ItemEvent e)
747 if (simpleColour.isSelected() && !adjusting)
754 singleColour.setFont(JvSwingUtils.getLabelFont());
755 singleColour.setBorder(BorderFactory.createLineBorder(Color.black));
756 singleColour.setPreferredSize(new Dimension(40, 20));
757 // if (originalColour.isGraduatedColour())
759 // singleColour.setBackground(originalColour.getMaxColour());
760 // singleColour.setForeground(originalColour.getMaxColour());
764 singleColour.setBackground(originalColour.getColour());
765 singleColour.setForeground(originalColour.getColour());
767 singleColour.addMouseListener(new MouseAdapter()
770 public void mousePressed(MouseEvent e)
772 if (simpleColour.isSelected())
774 showColourChooser(singleColour, "label.select_colour");
778 simpleColourPanel.add(simpleColour); // radio button
779 simpleColourPanel.add(singleColour); // colour picker button
782 * colour by text (category) radio button and drop-down choice list
784 JPanel byTextPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
785 byTextPanel.setBackground(Color.white);
786 JvSwingUtils.createTitledBorder(byTextPanel,
787 MessageManager.getString("label.colour_by_text"), true);
788 colourByPanel.add(byTextPanel);
789 byCategory = new JRadioButton(
790 MessageManager.getString("label.by_text_of") + COLON);
791 byCategory.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
792 byCategory.addItemListener(new ItemListener()
795 public void itemStateChanged(ItemEvent e)
797 if (byCategory.isSelected())
803 byTextPanel.add(byCategory);
805 List<String[]> attNames = FeatureAttributes.getInstance()
806 .getAttributes(featureType);
807 colourByTextCombo = populateAttributesDropdown(attNames, false, true);
808 colourByTextCombo.addItemListener(new ItemListener()
811 public void itemStateChanged(ItemEvent e)
816 byTextPanel.add(colourByTextCombo);
819 * graduated colour panel
821 JPanel graduatedColourPanel = initialiseGraduatedColourPanel();
822 colourByPanel.add(graduatedColourPanel);
825 * 3 radio buttons select between simple colour,
826 * by category (text), or graduated
828 ButtonGroup bg = new ButtonGroup();
829 bg.add(simpleColour);
831 bg.add(graduatedColour);
833 return colourByPanel;
836 private void showColourChooser(JPanel colourPanel, String key)
838 Color col = JColorChooser.showDialog(this,
839 MessageManager.getString(key), colourPanel.getBackground());
842 colourPanel.setBackground(col);
843 colourPanel.setForeground(col);
845 colourPanel.repaint();
850 * Constructs and sets the selected colour options as the colour for the
851 * feature type, and repaints the alignment, and optionally the Overview
852 * and/or structure viewer if open
854 * @param updateStructsAndOverview
856 void colourChanged(boolean updateStructsAndOverview)
861 * ignore action handlers while setting values programmatically
867 * ensure min-max range is for the latest choice of
868 * 'graduated colour by'
870 updateColourMinMax();
872 FeatureColourI acg = makeColourFromInputs();
875 * save the colour, and repaint stuff
877 fr.setColour(featureType, acg);
878 ap.paintAlignment(updateStructsAndOverview, updateStructsAndOverview);
884 * Converts the input values into an instance of FeatureColour
888 private FeatureColourI makeColourFromInputs()
891 * min-max range is to (or from) threshold value if
892 * 'threshold is min/max' is selected
898 thresh = Float.valueOf(thresholdValue.getText());
899 } catch (NumberFormatException e)
901 // invalid inputs are already handled on entry
903 float minValue = min;
904 float maxValue = max;
905 final int thresholdOption = threshold.getSelectedIndex();
906 if (thresholdIsMin.isSelected()
907 && thresholdOption == ABOVE_THRESHOLD_OPTION)
911 if (thresholdIsMin.isSelected()
912 && thresholdOption == BELOW_THRESHOLD_OPTION)
916 Color noColour = null;
917 if (noValueCombo.getSelectedIndex() == MIN_COLOUR_OPTION)
919 noColour = minColour.getBackground();
921 else if (noValueCombo.getSelectedIndex() == MAX_COLOUR_OPTION)
923 noColour = maxColour.getBackground();
927 * construct a colour that 'remembers' all the options, including
928 * those not currently selected
930 FeatureColourI fc = new FeatureColour(singleColour.getBackground(),
931 minColour.getBackground(), maxColour.getBackground(), noColour,
935 * easiest case - a single colour
937 if (simpleColour.isSelected())
939 ((FeatureColour) fc).setGraduatedColour(false);
944 * next easiest case - colour by Label, or attribute text
946 if (byCategory.isSelected())
948 fc.setColourByLabel(true);
949 String byWhat = (String) colourByTextCombo.getSelectedItem();
950 if (!LABEL_18N.equals(byWhat))
953 FeatureMatcher.fromAttributeDisplayName(byWhat));
959 * remaining case - graduated colour by score, or attribute value;
960 * set attribute to colour by if selected
962 String byWhat = (String) colourByRangeCombo.getSelectedItem();
963 if (!SCORE_18N.equals(byWhat))
965 fc.setAttributeName(FeatureMatcher.fromAttributeDisplayName(byWhat));
969 * set threshold options and 'autoscaled' which is
970 * false if 'threshold is min/max' is selected
971 * else true (colour range is on actual range of values)
973 fc.setThreshold(thresh);
974 fc.setAutoScaled(!thresholdIsMin.isSelected());
975 fc.setAboveThreshold(thresholdOption == ABOVE_THRESHOLD_OPTION);
976 fc.setBelowThreshold(thresholdOption == BELOW_THRESHOLD_OPTION);
978 if (threshline == null)
981 * todo not yet implemented: visual indication of feature threshold
983 threshline = new GraphLine((max - min) / 2f, "Threshold",
991 protected void raiseClosed()
993 if (this.featureSettings != null)
995 featureSettings.actionPerformed(new ActionEvent(this, 0, "CLOSED"));
1000 * Action on OK is just to dismiss the dialog - any changes have already been
1004 public void okPressed()
1009 * Action on Cancel is to restore colour scheme and filters as they were when
1010 * the dialog was opened
1013 public void cancelPressed()
1015 fr.setColour(featureType, originalColour);
1016 fr.setFeatureFilter(featureType, originalFilter);
1017 ap.paintAlignment(true, true);
1021 * Action on text entry of a threshold value
1023 protected void thresholdValue_actionPerformed()
1028 * set 'adjusting' flag while moving the slider, so it
1029 * doesn't then in turn change the value (with rounding)
1032 float f = Float.parseFloat(thresholdValue.getText());
1033 f = Float.max(f, this.min);
1034 f = Float.min(f, this.max);
1035 thresholdValue.setText(String.valueOf(f));
1036 slider.setValue((int) (f * scaleFactor));
1037 threshline.value = f;
1038 thresholdValue.setBackground(Color.white); // ok
1040 colourChanged(true);
1041 } catch (NumberFormatException ex)
1043 thresholdValue.setBackground(Color.red); // not ok
1049 * Action on change of threshold slider value. This may be done interactively
1050 * (by moving the slider), or programmatically (to update the slider after
1051 * manual input of a threshold value).
1053 protected void sliderValueChanged()
1055 threshline.value = getRoundedSliderValue();
1058 * repaint alignment, but not Overview or structure,
1059 * to avoid overload while dragging the slider
1061 colourChanged(false);
1065 * Converts the slider value to its absolute value by dividing by the
1066 * scaleFactor. Rounding errors are squashed by forcing min/max of slider
1067 * range to the actual min/max of feature score range
1071 private float getRoundedSliderValue()
1073 int value = slider.getValue();
1074 float f = value == slider.getMaximum() ? max
1075 : (value == slider.getMinimum() ? min : value / scaleFactor);
1079 void addActionListener(ActionListener listener)
1081 if (featureSettings != null)
1084 "IMPLEMENTATION ISSUE: overwriting action listener for FeatureColourChooser");
1086 featureSettings = listener;
1090 * A helper method to build the drop-down choice of attributes for a feature.
1091 * If 'withRange' is true, then Score, and any attributes with a min-max
1092 * range, are added. If 'withText' is true, Label and any known attributes are
1093 * added. This allows 'categorical numerical' attributes e.g. codon position
1094 * to be coloured by text.
1096 * Where metadata is available with a description for an attribute, that is
1097 * added as a tooltip.
1099 * Attribute names may be 'simple' e.g. "AC" or 'compound' e.g. {"CSQ",
1100 * "Allele"}. Compound names are rendered for display as (e.g.) CSQ:Allele.
1102 * This method does not add any ActionListener to the JComboBox.
1108 protected JComboBox<Object> populateAttributesDropdown(
1109 List<String[]> attNames, boolean withRange, boolean withText)
1111 List<String> displayAtts = new ArrayList<>();
1112 List<String> tooltips = new ArrayList<>();
1116 displayAtts.add(LABEL_18N);
1117 tooltips.add(MessageManager.getString("label.description"));
1121 float[][] minMax = fr.getMinMax().get(featureType);
1122 if (minMax != null && minMax[0][0] != minMax[0][1])
1124 displayAtts.add(SCORE_18N);
1125 tooltips.add(SCORE_18N);
1129 FeatureAttributes fa = FeatureAttributes.getInstance();
1130 for (String[] attName : attNames)
1132 float[] minMax = fa.getMinMax(featureType, attName);
1133 boolean hasRange = minMax != null && minMax[0] != minMax[1];
1134 if (!withText && !hasRange)
1138 displayAtts.add(FeatureMatcher.toAttributeDisplayName(attName));
1139 String desc = fa.getDescription(featureType, attName);
1140 if (desc != null && desc.length() > MAX_TOOLTIP_LENGTH)
1142 desc = desc.substring(0, MAX_TOOLTIP_LENGTH) + "...";
1144 tooltips.add(desc == null ? "" : desc);
1147 // now convert String List to Object List for buildComboWithTooltips
1148 List<Object> displayAttsObjects = new ArrayList<>(displayAtts);
1149 JComboBox<Object> attCombo = JvSwingUtils
1150 .buildComboWithTooltips(displayAttsObjects, tooltips);
1156 * Populates initial layout of the feature attribute filters panel
1158 private JPanel initialiseFiltersPanel()
1160 filters = new ArrayList<>();
1162 JPanel filtersPanel = new JPanel();
1163 filtersPanel.setLayout(new BoxLayout(filtersPanel, BoxLayout.Y_AXIS));
1164 filtersPanel.setBackground(Color.white);
1165 JvSwingUtils.createTitledBorder(filtersPanel,
1166 MessageManager.getString("label.filters"), true);
1168 JPanel andOrPanel = initialiseAndOrPanel();
1169 filtersPanel.add(andOrPanel);
1172 * panel with filters - populated by refreshFiltersDisplay,
1173 * which also sets the layout manager
1175 chooseFiltersPanel = new JPanel();
1176 chooseFiltersPanel.setBackground(Color.white);
1177 filtersPanel.add(chooseFiltersPanel);
1179 return filtersPanel;
1183 * Lays out the panel with radio buttons to AND or OR filter conditions
1187 private JPanel initialiseAndOrPanel()
1189 JPanel andOrPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
1190 andOrPanel.setBackground(Color.white);
1191 andFilters = new JRadioButton(MessageManager.getString("label.and"));
1192 orFilters = new JRadioButton(MessageManager.getString("label.or"));
1193 ActionListener actionListener = new ActionListener()
1196 public void actionPerformed(ActionEvent e)
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);
1208 new JLabel(MessageManager.getString("label.join_conditions")));
1209 andOrPanel.add(andFilters);
1210 andOrPanel.add(orFilters);
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.
1220 private void updateFiltersTab()
1223 * clear the panel and list of filter conditions
1225 chooseFiltersPanel.removeAll();
1229 * look up attributes known for feature type
1231 List<String[]> attNames = FeatureAttributes.getInstance()
1232 .getAttributes(featureType);
1235 * if this feature type has filters set, load them first
1237 FeatureMatcherSetI featureFilters = fr.getFeatureFilter(featureType);
1238 if (featureFilters != null)
1240 if (!featureFilters.isAnded())
1242 orFilters.setSelected(true);
1244 featureFilters.getMatchers().forEach(matcher -> filters.add(matcher));
1248 * and an empty filter for the user to populate (add)
1250 filters.add(FeatureMatcher.NULL_MATCHER);
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
1256 if (filters.size() <= 5)
1258 chooseFiltersPanel.setLayout(new GridLayout(5, 1));
1262 chooseFiltersPanel.setLayout(
1263 new BoxLayout(chooseFiltersPanel, BoxLayout.Y_AXIS));
1267 * render the conditions in rows, each in its own JPanel
1269 int filterIndex = 0;
1270 for (FeatureMatcherI filter : filters)
1272 JPanel row = addFilter(filter, attNames, filterIndex);
1273 chooseFiltersPanel.add(row);
1282 * A helper method that constructs a row (panel) with one filter condition:
1284 * <li>a drop-down list of Label, Score and attribute names to choose
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>
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).
1293 * Action handlers on these fields provide for
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
1305 * @param filterIndex
1308 protected JPanel addFilter(FeatureMatcherI filter,
1309 List<String[]> attNames, int filterIndex)
1311 String[] attName = filter.getAttribute();
1312 Condition cond = filter.getMatcher().getCondition();
1313 String pattern = filter.getMatcher().getPattern();
1315 JPanel filterRow = new JPanel(new FlowLayout(FlowLayout.LEFT));
1316 filterRow.setBackground(Color.white);
1319 * drop-down choice of attribute, with description as a tooltip
1320 * if we can obtain it
1322 final JComboBox<Object> attCombo = populateAttributesDropdown(attNames,
1324 String filterBy = setSelectedAttribute(attCombo, filter);
1326 JComboBox<Condition> condCombo = new JComboBox<>();
1328 JTextField patternField = new JTextField(8);
1329 patternField.setText(pattern);
1332 * action handlers that validate and (if valid) apply changes
1334 ActionListener actionListener = new ActionListener()
1337 public void actionPerformed(ActionEvent e)
1339 if (validateFilter(patternField, condCombo))
1341 if (updateFilter(attCombo, condCombo, patternField, filterIndex))
1348 ItemListener itemListener = new ItemListener()
1351 public void itemStateChanged(ItemEvent e)
1353 actionListener.actionPerformed(null);
1357 if (filter == FeatureMatcher.NULL_MATCHER) // the 'add a condition' row
1359 attCombo.setSelectedIndex(0);
1363 attCombo.setSelectedItem(
1364 FeatureMatcher.toAttributeDisplayName(attName));
1366 attCombo.addItemListener(new ItemListener()
1369 public void itemStateChanged(ItemEvent e)
1372 * on change of attribute, refresh the conditions list to
1373 * ensure it is appropriate for the attribute datatype
1375 populateConditions((String) attCombo.getSelectedItem(),
1376 (Condition) condCombo.getSelectedItem(), condCombo,
1378 actionListener.actionPerformed(null);
1382 filterRow.add(attCombo);
1385 * drop-down choice of test condition
1387 populateConditions(filterBy, cond, condCombo, patternField);
1388 condCombo.setPreferredSize(new Dimension(150, 20));
1389 condCombo.addItemListener(itemListener);
1390 filterRow.add(condCombo);
1393 * pattern to match against
1395 patternField.addActionListener(actionListener);
1396 patternField.addFocusListener(new FocusAdapter()
1399 public void focusLost(FocusEvent e)
1401 actionListener.actionPerformed(null);
1404 filterRow.add(patternField);
1407 * disable pattern field for condition 'Present / NotPresent'
1409 Condition selectedCondition = (Condition) condCombo.getSelectedItem();
1410 patternField.setEnabled(selectedCondition.needsAPattern());
1413 * if a numeric condition is selected, show the value range
1414 * as a tooltip on the value input field
1416 setNumericHints(filterBy, selectedCondition, patternField);
1419 * add remove button if filter is populated (non-empty pattern)
1421 if (!patternField.isEnabled()
1422 || (pattern != null && pattern.trim().length() > 0))
1424 JButton removeCondition = new JButton("\u2717"); // Dingbats cursive x
1425 removeCondition.setToolTipText(
1426 MessageManager.getString("label.delete_condition"));
1427 removeCondition.setBorder(new EmptyBorder(0, 0, 0, 0));
1428 removeCondition.addActionListener(new ActionListener()
1431 public void actionPerformed(ActionEvent e)
1433 filters.remove(filterIndex);
1437 filterRow.add(removeCondition);
1444 * Sets the selected item in the Label/Score/Attribute drop-down to match the
1450 private String setSelectedAttribute(JComboBox<Object> attCombo,
1451 FeatureMatcherI filter)
1454 if (filter.isByScore())
1458 else if (filter.isByLabel())
1464 item = FeatureMatcher.toAttributeDisplayName(filter.getAttribute());
1466 attCombo.setSelectedItem(item);
1471 * If a numeric comparison condition is selected, retrieves the min-max range
1472 * for the value (score or attribute), and sets it as a tooltip on the value
1473 * field. If the field is currently empty, then pre-populates it with
1475 * <li>the minimum value, if condition is > or >=</li>
1476 * <li>the maximum value, if condition is < or <=</li>
1480 * @param selectedCondition
1481 * @param patternField
1483 private void setNumericHints(String attName, Condition selectedCondition,
1484 JTextField patternField)
1486 patternField.setToolTipText("");
1488 if (selectedCondition.isNumeric())
1490 float[] minMax = getMinMax(attName);
1493 String minFormatted = DECFMT_2_2.format(minMax[0]);
1494 String maxFormatted = DECFMT_2_2.format(minMax[1]);
1495 String tip = String.format("(%s - %s)", minFormatted, maxFormatted);
1496 patternField.setToolTipText(tip);
1497 if (patternField.getText().isEmpty())
1499 if (selectedCondition == Condition.GE
1500 || selectedCondition == Condition.GT)
1502 patternField.setText(minFormatted);
1506 if (selectedCondition == Condition.LE
1507 || selectedCondition == Condition.LT)
1509 patternField.setText(maxFormatted);
1518 * Populates the drop-down list of comparison conditions for the given
1519 * attribute name. The conditions added depend on the datatype of the
1520 * attribute values. The supplied condition is set as the selected item in the
1521 * list, provided it is in the list. If the pattern is now invalid
1522 * (non-numeric pattern for a numeric condition), it is cleared.
1527 * @param patternField
1529 private void populateConditions(String attName, Condition cond,
1530 JComboBox<Condition> condCombo, JTextField patternField)
1532 Datatype type = FeatureAttributes.getInstance().getDatatype(featureType,
1533 FeatureMatcher.fromAttributeDisplayName(attName));
1534 if (LABEL_18N.equals(attName))
1536 type = Datatype.Character;
1538 else if (SCORE_18N.equals(attName))
1540 type = Datatype.Number;
1544 * remove itemListener before starting
1546 ItemListener listener = condCombo.getItemListeners()[0];
1547 condCombo.removeItemListener(listener);
1548 boolean condIsValid = false;
1550 condCombo.removeAllItems();
1551 for (Condition c : Condition.values())
1553 if ((c.isNumeric() && type == Datatype.Number)
1554 || (!c.isNumeric() && type != Datatype.Number))
1556 condCombo.addItem(c);
1565 * set the selected condition (does nothing if not in the list)
1569 condCombo.setSelectedItem(cond);
1573 condCombo.setSelectedIndex(0);
1577 * clear pattern if it is now invalid for condition
1579 if (((Condition) condCombo.getSelectedItem()).isNumeric())
1583 String pattern = patternField.getText().trim();
1584 if (pattern.length() > 0)
1586 Float.valueOf(pattern);
1588 } catch (NumberFormatException e)
1590 patternField.setText("");
1595 * restore the listener
1597 condCombo.addItemListener(listener);
1601 * Answers true unless a numeric condition has been selected with a
1602 * non-numeric value. Sets the value field to RED with a tooltip if in error.
1604 * If the pattern is expected but is empty, this method returns false, but
1605 * does not mark the field as invalid. This supports selecting an attribute
1606 * for a new condition before a match pattern has been entered.
1611 protected boolean validateFilter(JTextField value,
1612 JComboBox<Condition> condCombo)
1614 if (value == null || condCombo == null)
1616 return true; // fields not populated
1619 Condition cond = (Condition) condCombo.getSelectedItem();
1620 if (!cond.needsAPattern())
1625 value.setBackground(Color.white);
1626 value.setToolTipText("");
1627 String v1 = value.getText().trim();
1628 if (v1.length() == 0)
1633 if (cond.isNumeric() && v1.length() > 0)
1638 } catch (NumberFormatException e)
1640 value.setBackground(Color.red);
1641 value.setToolTipText(
1642 MessageManager.getString("label.numeric_required"));
1651 * Constructs a filter condition from the given input fields, and replaces the
1652 * condition at filterIndex with the new one. Does nothing if the pattern
1653 * field is blank (unless the match condition is one that doesn't require a
1654 * pattern, e.g. 'Is present'). Answers true if the filter was updated, else
1657 * This method may update the tooltip on the filter value field to show the
1658 * value range, if a numeric condition is selected. This ensures the tooltip
1659 * is updated when a numeric valued attribute is chosen on the last 'add a
1665 * @param filterIndex
1667 protected boolean updateFilter(JComboBox<Object> attCombo,
1668 JComboBox<Condition> condCombo, JTextField valueField,
1674 attName = (String) attCombo.getSelectedItem();
1675 } catch (Exception e)
1677 Cache.log.error("Problem casting Combo box entry to String");
1678 attName = attCombo.getSelectedItem().toString();
1680 Condition cond = (Condition) condCombo.getSelectedItem();
1681 String pattern = valueField.getText().trim();
1683 setNumericHints(attName, cond, valueField);
1685 if (pattern.length() == 0 && cond.needsAPattern())
1687 valueField.setEnabled(true); // ensure pattern field is enabled!
1692 * Construct a matcher that operates on Label, Score,
1693 * or named attribute
1695 FeatureMatcherI km = null;
1696 if (LABEL_18N.equals(attName))
1698 km = FeatureMatcher.byLabel(cond, pattern);
1700 else if (SCORE_18N.equals(attName))
1702 km = FeatureMatcher.byScore(cond, pattern);
1706 km = FeatureMatcher.byAttribute(cond, pattern,
1707 FeatureMatcher.fromAttributeDisplayName(attName));
1710 filters.set(filterIndex, km);
1716 * Action on any change to feature filtering, namely
1718 * <li>change of selected attribute</li>
1719 * <li>change of selected condition</li>
1720 * <li>change of match pattern</li>
1721 * <li>removal of a condition</li>
1723 * The inputs are parsed into a combined filter and this is set for the
1724 * feature type, and the alignment redrawn.
1726 protected void filtersChanged()
1729 * update the filter conditions for the feature type
1731 boolean anded = andFilters.isSelected();
1732 FeatureMatcherSetI combined = new FeatureMatcherSet();
1734 for (FeatureMatcherI filter : filters)
1736 String pattern = filter.getMatcher().getPattern();
1737 Condition condition = filter.getMatcher().getCondition();
1738 if (pattern.trim().length() > 0 || !condition.needsAPattern())
1742 combined.and(filter);
1746 combined.or(filter);
1752 * save the filter conditions in the FeatureRenderer
1753 * (note this might now be an empty filter with no conditions)
1755 fr.setFeatureFilter(featureType, combined.isEmpty() ? null : combined);
1756 ap.paintAlignment(true, true);