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.datamodel.GraphLine;
26 import jalview.datamodel.features.FeatureAttributes;
27 import jalview.datamodel.features.FeatureAttributes.Datatype;
28 import jalview.datamodel.features.FeatureMatcher;
29 import jalview.datamodel.features.FeatureMatcherI;
30 import jalview.datamodel.features.FeatureMatcherSet;
31 import jalview.datamodel.features.FeatureMatcherSetI;
32 import jalview.gui.JalviewColourChooser.ColourChooserListener;
33 import jalview.schemes.FeatureColour;
34 import jalview.util.ColorUtils;
35 import jalview.util.MessageManager;
36 import jalview.util.matcher.Condition;
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.JComboBox;
61 import javax.swing.JLabel;
62 import javax.swing.JPanel;
63 import javax.swing.JRadioButton;
64 import javax.swing.JSlider;
65 import javax.swing.JTextField;
66 import javax.swing.border.LineBorder;
67 import javax.swing.event.ChangeEvent;
68 import javax.swing.event.ChangeListener;
71 * A dialog where the user can configure colour scheme, and any filters, for one
74 * (Was FeatureColourChooser prior to Jalview 1.11, renamed with the addition of
77 public class FeatureTypeSettings extends JalviewDialog
79 private final static String LABEL_18N = MessageManager
80 .getString("label.label");
82 private final static String SCORE_18N = MessageManager
83 .getString("label.score");
85 private static final int RADIO_WIDTH = 130;
87 private static final String COLON = ":";
89 private static final int MAX_TOOLTIP_LENGTH = 50;
91 private static final int NO_COLOUR_OPTION = 0;
93 private static final int MIN_COLOUR_OPTION = 1;
95 private static final int MAX_COLOUR_OPTION = 2;
97 private static final int ABOVE_THRESHOLD_OPTION = 1;
99 private static final int BELOW_THRESHOLD_OPTION = 2;
101 private static final DecimalFormat DECFMT_2_2 = new DecimalFormat(
105 * FeatureRenderer holds colour scheme and filters for feature types
107 private final FeatureRenderer fr; // todo refactor to allow interface type
111 * the view panel to update when settings change
113 final AlignmentViewPanel ap;
115 final String featureType;
118 * the colour and filters to reset to on Cancel
120 private final FeatureColourI originalColour;
122 private final FeatureMatcherSetI originalFilter;
125 * set flag to true when setting values programmatically,
126 * to avoid invocation of action handlers
128 boolean adjusting = false;
131 * minimum of the value range for graduated colour
132 * (may be for feature score or for a numeric attribute)
137 * maximum of the value range for graduated colour
142 * scale factor for conversion between absolute min-max and slider
147 * radio button group, to select what to colour by:
148 * simple colour, by category (text), or graduated
150 JRadioButton simpleColour = new JRadioButton();
152 JRadioButton byCategory = new JRadioButton();
154 JRadioButton graduatedColour = new JRadioButton();
160 JPanel singleColour = new JPanel();
162 JPanel minColour = new JPanel();
164 JPanel maxColour = new JPanel();
166 private JComboBox<String> threshold = new JComboBox<>();
168 JSlider slider = new JSlider();
170 JTextField thresholdValue = new JTextField(20);
172 private JCheckBox thresholdIsMin = new JCheckBox();
174 private GraphLine threshline;
176 private ActionListener featureSettings = null;
178 private ActionListener changeColourAction;
181 * choice of option for 'colour for no value'
183 private JComboBox<String> noValueCombo;
186 * choice of what to colour by text (Label or attribute)
188 private JComboBox<String> colourByTextCombo;
191 * choice of what to colour by range (Score or attribute)
193 private JComboBox<String> colourByRangeCombo;
195 private JRadioButton andFilters;
197 private JRadioButton orFilters;
200 * filters for the currently selected feature type
202 List<FeatureMatcherI> filters;
204 private JPanel chooseFiltersPanel;
212 public FeatureTypeSettings(FeatureRenderer frender, String theType)
215 this.featureType = theType;
217 originalFilter = fr.getFeatureFilter(theType);
218 originalColour = fr.getFeatureColours().get(theType);
225 } catch (Exception ex)
227 ex.printStackTrace();
231 updateColoursPanel();
233 updateFiltersPanel();
237 colourChanged(false);
239 String title = MessageManager
240 .formatMessage("label.display_settings_for", new String[]
242 initDialogFrame(this, true, false, title, 580, 500);
247 * Configures the widgets on the Colours panel according to the current feature
250 private void updateColoursPanel()
252 FeatureColourI fc = fr.getFeatureColours().get(featureType);
255 * suppress action handling while updating values programmatically
263 if (fc.isSimpleColour())
265 singleColour.setBackground(fc.getColour());
266 singleColour.setForeground(fc.getColour());
267 simpleColour.setSelected(true);
271 * colour by text (Label or attribute text)
273 if (fc.isColourByLabel())
275 byCategory.setSelected(true);
276 colourByTextCombo.setEnabled(colourByTextCombo.getItemCount() > 1);
277 if (fc.isColourByAttribute())
279 String[] attributeName = fc.getAttributeName();
280 colourByTextCombo.setSelectedItem(
281 FeatureMatcher.toAttributeDisplayName(attributeName));
285 colourByTextCombo.setSelectedItem(LABEL_18N);
290 colourByTextCombo.setEnabled(false);
293 if (!fc.isGraduatedColour())
295 colourByRangeCombo.setEnabled(false);
296 minColour.setEnabled(false);
297 maxColour.setEnabled(false);
298 noValueCombo.setEnabled(false);
299 threshold.setEnabled(false);
300 slider.setEnabled(false);
301 thresholdValue.setEnabled(false);
302 thresholdIsMin.setEnabled(false);
307 * Graduated colour, by score or attribute value range
309 graduatedColour.setSelected(true);
310 updateColourMinMax(); // ensure min, max are set
311 colourByRangeCombo.setEnabled(colourByRangeCombo.getItemCount() > 1);
312 minColour.setEnabled(true);
313 maxColour.setEnabled(true);
314 noValueCombo.setEnabled(true);
315 threshold.setEnabled(true);
316 minColour.setBackground(fc.getMinColour());
317 maxColour.setBackground(fc.getMaxColour());
319 if (fc.isColourByAttribute())
321 String[] attributeName = fc.getAttributeName();
322 colourByRangeCombo.setSelectedItem(
323 FeatureMatcher.toAttributeDisplayName(attributeName));
327 colourByRangeCombo.setSelectedItem(SCORE_18N);
329 Color noColour = fc.getNoColour();
330 if (noColour == null)
332 noValueCombo.setSelectedIndex(NO_COLOUR_OPTION);
334 else if (noColour.equals(fc.getMinColour()))
336 noValueCombo.setSelectedIndex(MIN_COLOUR_OPTION);
338 else if (noColour.equals(fc.getMaxColour()))
340 noValueCombo.setSelectedIndex(MAX_COLOUR_OPTION);
344 * update min-max scaling if there is a range to work with,
345 * else disable the widgets (this shouldn't happen if only
346 * valid options are offered in the combo box)
348 scaleFactor = (max == min) ? 1f : 100f / (max - min);
349 float range = (max - min) * scaleFactor;
350 slider.setMinimum((int) (min * scaleFactor));
351 slider.setMaximum((int) (max * scaleFactor));
352 slider.setMajorTickSpacing((int) (range / 10f));
354 threshline = new GraphLine((max - min) / 2f, "Threshold",
356 threshline.value = fc.getThreshold();
358 if (fc.hasThreshold())
360 threshold.setSelectedIndex(
361 fc.isAboveThreshold() ? ABOVE_THRESHOLD_OPTION
362 : BELOW_THRESHOLD_OPTION);
363 slider.setEnabled(true);
364 slider.setValue((int) (fc.getThreshold() * scaleFactor));
365 thresholdValue.setText(String.valueOf(fc.getThreshold()));
366 thresholdValue.setEnabled(true);
367 thresholdIsMin.setEnabled(true);
371 slider.setEnabled(false);
372 thresholdValue.setEnabled(false);
373 thresholdIsMin.setEnabled(false);
375 thresholdIsMin.setSelected(!fc.isAutoScaled());
383 * Configures the initial layout
385 private void initialise()
387 this.setLayout(new BorderLayout());
390 * an ActionListener that applies colour changes
392 changeColourAction = new ActionListener()
395 public void actionPerformed(ActionEvent e)
402 * first panel: colour options
404 JPanel coloursPanel = initialiseColoursPanel();
405 this.add(coloursPanel, BorderLayout.NORTH);
408 * second panel: filter options
410 JPanel filtersPanel = initialiseFiltersPanel();
411 this.add(filtersPanel, BorderLayout.CENTER);
413 JPanel okCancelPanel = initialiseOkCancelPanel();
415 this.add(okCancelPanel, BorderLayout.SOUTH);
419 * Updates the min-max range if Colour By selected item is Score, or an
420 * attribute, with a min-max range
422 protected void updateColourMinMax()
424 if (!graduatedColour.isSelected())
429 String colourBy = (String) colourByRangeCombo.getSelectedItem();
430 float[] minMax = getMinMax(colourBy);
440 * Retrieves the min-max range:
442 * <li>of feature score, if colour or filter is by Score</li>
443 * <li>else of the selected attribute</li>
449 private float[] getMinMax(String attName)
451 float[] minMax = null;
452 if (SCORE_18N.equals(attName))
454 minMax = fr.getMinMax().get(featureType)[0];
458 // colour by attribute range
459 minMax = FeatureAttributes.getInstance().getMinMax(featureType,
460 FeatureMatcher.fromAttributeDisplayName(attName));
466 * Lay out fields for graduated colour (by score or attribute value)
470 private JPanel initialiseGraduatedColourPanel()
472 JPanel graduatedColourPanel = new JPanel();
473 graduatedColourPanel.setLayout(
474 new BoxLayout(graduatedColourPanel, BoxLayout.Y_AXIS));
475 JvSwingUtils.createTitledBorder(graduatedColourPanel,
476 MessageManager.getString("label.graduated_colour"), true);
477 graduatedColourPanel.setBackground(Color.white);
480 * first row: graduated colour radio button, score/attribute drop-down
482 JPanel graduatedChoicePanel = new JPanel(
483 new FlowLayout(FlowLayout.LEFT));
484 graduatedChoicePanel.setBackground(Color.white);
485 graduatedColour = new JRadioButton(
486 MessageManager.getString("label.by_range_of") + COLON);
487 graduatedColour.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
488 graduatedColour.setOpaque(false);
489 graduatedColour.addItemListener(new ItemListener()
492 public void itemStateChanged(ItemEvent e)
494 if (graduatedColour.isSelected())
500 graduatedChoicePanel.add(graduatedColour);
502 List<String[]> attNames = FeatureAttributes.getInstance()
503 .getAttributes(featureType);
504 colourByRangeCombo = populateAttributesDropdown(attNames, true, false);
505 colourByRangeCombo.addItemListener(new ItemListener()
508 public void itemStateChanged(ItemEvent e)
515 * disable graduated colour option if no range found
517 graduatedColour.setEnabled(colourByRangeCombo.getItemCount() > 0);
519 graduatedChoicePanel.add(colourByRangeCombo);
520 graduatedColourPanel.add(graduatedChoicePanel);
523 * second row - min/max/no colours
525 JPanel colourRangePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
526 colourRangePanel.setBackground(Color.white);
527 graduatedColourPanel.add(colourRangePanel);
529 minColour.setFont(JvSwingUtils.getLabelFont());
530 minColour.setBorder(BorderFactory.createLineBorder(Color.black));
531 minColour.setPreferredSize(new Dimension(40, 20));
532 minColour.setToolTipText(MessageManager.getString("label.min_colour"));
533 minColour.addMouseListener(new MouseAdapter()
536 public void mousePressed(MouseEvent e)
538 if (minColour.isEnabled())
540 String ttl = MessageManager.getString("label.select_colour_minimum_value");
541 showColourChooser(minColour, ttl);
546 maxColour.setFont(JvSwingUtils.getLabelFont());
547 maxColour.setBorder(BorderFactory.createLineBorder(Color.black));
548 maxColour.setPreferredSize(new Dimension(40, 20));
549 maxColour.setToolTipText(MessageManager.getString("label.max_colour"));
550 maxColour.addMouseListener(new MouseAdapter()
553 public void mousePressed(MouseEvent e)
555 if (maxColour.isEnabled())
557 String ttl = MessageManager.getString("label.select_colour_maximum_value");
558 showColourChooser(maxColour, ttl);
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.setOpaque(false);
743 simpleColour.addItemListener(new ItemListener()
746 public void itemStateChanged(ItemEvent e)
748 if (simpleColour.isSelected() && !adjusting)
755 singleColour.setFont(JvSwingUtils.getLabelFont());
756 singleColour.setBorder(BorderFactory.createLineBorder(Color.black));
757 singleColour.setPreferredSize(new Dimension(40, 20));
758 // if (originalColour.isGraduatedColour())
760 // singleColour.setBackground(originalColour.getMaxColour());
761 // singleColour.setForeground(originalColour.getMaxColour());
765 singleColour.setBackground(originalColour.getColour());
766 singleColour.setForeground(originalColour.getColour());
768 singleColour.addMouseListener(new MouseAdapter()
771 public void mousePressed(MouseEvent e)
773 if (simpleColour.isSelected())
775 String ttl = MessageManager.formatMessage("label.select_colour_for", featureType);
776 showColourChooser(singleColour, ttl);
780 simpleColourPanel.add(simpleColour); // radio button
781 simpleColourPanel.add(singleColour); // colour picker button
784 * colour by text (category) radio button and drop-down choice list
786 JPanel byTextPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
787 byTextPanel.setBackground(Color.white);
788 JvSwingUtils.createTitledBorder(byTextPanel,
789 MessageManager.getString("label.colour_by_text"), true);
790 colourByPanel.add(byTextPanel);
791 byCategory = new JRadioButton(
792 MessageManager.getString("label.by_text_of") + COLON);
793 byCategory.setPreferredSize(new Dimension(RADIO_WIDTH, 20));
794 byCategory.setOpaque(false);
795 byCategory.addItemListener(new ItemListener()
798 public void itemStateChanged(ItemEvent e)
800 if (byCategory.isSelected())
806 byTextPanel.add(byCategory);
808 List<String[]> attNames = FeatureAttributes.getInstance()
809 .getAttributes(featureType);
810 colourByTextCombo = populateAttributesDropdown(attNames, false, true);
811 colourByTextCombo.addItemListener(new ItemListener()
814 public void itemStateChanged(ItemEvent e)
819 byTextPanel.add(colourByTextCombo);
822 * graduated colour panel
824 JPanel graduatedColourPanel = initialiseGraduatedColourPanel();
825 colourByPanel.add(graduatedColourPanel);
828 * 3 radio buttons select between simple colour,
829 * by category (text), or graduated
831 ButtonGroup bg = new ButtonGroup();
832 bg.add(simpleColour);
834 bg.add(graduatedColour);
836 return colourByPanel;
840 * Shows a colour chooser dialog, and if a selection is made, updates the
841 * colour of the given panel
844 * the panel whose background colour is being picked
847 void showColourChooser(JPanel colourPanel, String title)
849 ColourChooserListener listener = new ColourChooserListener()
852 public void colourSelected(Color col)
854 colourPanel.setBackground(col);
855 colourPanel.setForeground(col);
856 colourPanel.repaint();
860 JalviewColourChooser.showColourChooser(this, title,
861 colourPanel.getBackground(), listener);
865 * Constructs and sets the selected colour options as the colour for the
866 * feature type, and repaints the alignment, and optionally the Overview
867 * and/or structure viewer if open
869 * @param updateStructsAndOverview
871 void colourChanged(boolean updateStructsAndOverview)
876 * ignore action handlers while setting values programmatically
882 * ensure min-max range is for the latest choice of
883 * 'graduated colour by'
885 updateColourMinMax();
887 FeatureColourI acg = makeColourFromInputs();
890 * save the colour, and repaint stuff
892 fr.setColour(featureType, acg);
893 ap.paintAlignment(updateStructsAndOverview, updateStructsAndOverview);
895 updateColoursPanel();
899 * Converts the input values into an instance of FeatureColour
903 private FeatureColourI makeColourFromInputs()
906 * min-max range is to (or from) threshold value if
907 * 'threshold is min/max' is selected
913 thresh = Float.valueOf(thresholdValue.getText());
914 } catch (NumberFormatException e)
916 // invalid inputs are already handled on entry
918 float minValue = min;
919 float maxValue = max;
920 int thresholdOption = threshold.getSelectedIndex();
921 if (thresholdIsMin.isSelected()
922 && thresholdOption == ABOVE_THRESHOLD_OPTION)
926 if (thresholdIsMin.isSelected()
927 && thresholdOption == BELOW_THRESHOLD_OPTION)
931 Color noColour = null;
932 if (noValueCombo.getSelectedIndex() == MIN_COLOUR_OPTION)
934 noColour = minColour.getBackground();
936 else if (noValueCombo.getSelectedIndex() == MAX_COLOUR_OPTION)
938 noColour = maxColour.getBackground();
942 * construct a colour that 'remembers' all the options, including
943 * those not currently selected
945 FeatureColourI fc = new FeatureColour(singleColour.getBackground(),
946 minColour.getBackground(), maxColour.getBackground(), noColour,
950 * easiest case - a single colour
952 if (simpleColour.isSelected())
954 ((FeatureColour) fc).setGraduatedColour(false);
959 * next easiest case - colour by Label, or attribute text
961 if (byCategory.isSelected())
963 fc.setColourByLabel(true);
964 String byWhat = (String) colourByTextCombo.getSelectedItem();
965 if (!LABEL_18N.equals(byWhat))
968 FeatureMatcher.fromAttributeDisplayName(byWhat));
974 * remaining case - graduated colour by score, or attribute value;
975 * set attribute to colour by if selected
977 String byWhat = (String) colourByRangeCombo.getSelectedItem();
978 if (!SCORE_18N.equals(byWhat))
980 fc.setAttributeName(FeatureMatcher.fromAttributeDisplayName(byWhat));
984 * set threshold options and 'autoscaled' which is
985 * false if 'threshold is min/max' is selected
986 * else true (colour range is on actual range of values)
988 fc.setThreshold(thresh);
989 fc.setAutoScaled(!thresholdIsMin.isSelected());
990 fc.setAboveThreshold(thresholdOption == ABOVE_THRESHOLD_OPTION);
991 fc.setBelowThreshold(thresholdOption == BELOW_THRESHOLD_OPTION);
993 if (threshline == null)
996 * todo not yet implemented: visual indication of feature threshold
998 threshline = new GraphLine((max - min) / 2f, "Threshold",
1006 protected void raiseClosed()
1008 if (this.featureSettings != null)
1010 featureSettings.actionPerformed(new ActionEvent(this, 0, "CLOSED"));
1015 * Action on OK is just to dismiss the dialog - any changes have already been
1019 public void okPressed()
1024 * Action on Cancel is to restore colour scheme and filters as they were when
1025 * the dialog was opened
1028 public void cancelPressed()
1030 fr.setColour(featureType, originalColour);
1031 fr.setFeatureFilter(featureType, originalFilter);
1032 ap.paintAlignment(true, true);
1036 * Action on text entry of a threshold value
1038 protected void thresholdValue_actionPerformed()
1043 * set 'adjusting' flag while moving the slider, so it
1044 * doesn't then in turn change the value (with rounding)
1047 float f = Float.parseFloat(thresholdValue.getText());
1048 f = Float.max(f, this.min);
1049 f = Float.min(f, this.max);
1050 thresholdValue.setText(String.valueOf(f));
1051 slider.setValue((int) (f * scaleFactor));
1052 threshline.value = f;
1053 thresholdValue.setBackground(Color.white); // ok
1055 colourChanged(true);
1056 } catch (NumberFormatException ex)
1058 thresholdValue.setBackground(Color.red); // not ok
1064 * Action on change of threshold slider value. This may be done interactively
1065 * (by moving the slider), or programmatically (to update the slider after
1066 * manual input of a threshold value).
1068 protected void sliderValueChanged()
1070 threshline.value = getRoundedSliderValue();
1073 * repaint alignment, but not Overview or structure,
1074 * to avoid overload while dragging the slider
1076 colourChanged(false);
1080 * Converts the slider value to its absolute value by dividing by the
1081 * scaleFactor. Rounding errors are squashed by forcing min/max of slider
1082 * range to the actual min/max of feature score range
1086 private float getRoundedSliderValue()
1088 int value = slider.getValue();
1089 float f = value == slider.getMaximum() ? max
1090 : (value == slider.getMinimum() ? min : value / scaleFactor);
1094 void addActionListener(ActionListener listener)
1096 if (featureSettings != null)
1099 "IMPLEMENTATION ISSUE: overwriting action listener for FeatureColourChooser");
1101 featureSettings = listener;
1105 * A helper method to build the drop-down choice of attributes for a feature.
1106 * If 'withRange' is true, then Score, and any attributes with a min-max
1107 * range, are added. If 'withText' is true, Label and any known attributes are
1108 * added. This allows 'categorical numerical' attributes e.g. codon position
1109 * to be coloured by text.
1111 * Where metadata is available with a description for an attribute, that is
1112 * added as a tooltip.
1114 * Attribute names may be 'simple' e.g. "AC" or 'compound' e.g. {"CSQ",
1115 * "Allele"}. Compound names are rendered for display as (e.g.) CSQ:Allele.
1117 * This method does not add any ActionListener to the JComboBox.
1123 protected JComboBox<String> populateAttributesDropdown(
1124 List<String[]> attNames, boolean withRange, boolean withText)
1126 List<String> displayAtts = new ArrayList<>();
1127 List<String> tooltips = new ArrayList<>();
1131 displayAtts.add(LABEL_18N);
1132 tooltips.add(MessageManager.getString("label.description"));
1136 float[][] minMax = fr.getMinMax().get(featureType);
1137 if (minMax != null && minMax[0][0] != minMax[0][1])
1139 displayAtts.add(SCORE_18N);
1140 tooltips.add(SCORE_18N);
1144 FeatureAttributes fa = FeatureAttributes.getInstance();
1145 for (String[] attName : attNames)
1147 float[] minMax = fa.getMinMax(featureType, attName);
1148 boolean hasRange = minMax != null && minMax[0] != minMax[1];
1149 if (!withText && !hasRange)
1153 displayAtts.add(FeatureMatcher.toAttributeDisplayName(attName));
1154 String desc = fa.getDescription(featureType, attName);
1155 if (desc != null && desc.length() > MAX_TOOLTIP_LENGTH)
1157 desc = desc.substring(0, MAX_TOOLTIP_LENGTH) + "...";
1159 tooltips.add(desc == null ? "" : desc);
1162 JComboBox<String> attCombo = JvSwingUtils
1163 .buildComboWithTooltips(displayAtts, tooltips);
1169 * Populates initial layout of the feature attribute filters panel
1171 private JPanel initialiseFiltersPanel()
1173 filters = new ArrayList<>();
1175 JPanel filtersPanel = new JPanel();
1176 filtersPanel.setLayout(new BoxLayout(filtersPanel, BoxLayout.Y_AXIS));
1177 filtersPanel.setBackground(Color.white);
1178 JvSwingUtils.createTitledBorder(filtersPanel,
1179 MessageManager.getString("label.filters"), true);
1181 JPanel andOrPanel = initialiseAndOrPanel();
1182 filtersPanel.add(andOrPanel);
1185 * panel with filters - populated by refreshFiltersDisplay,
1186 * which also sets the layout manager
1188 chooseFiltersPanel = new JPanel();
1189 chooseFiltersPanel.setBackground(Color.white);
1190 filtersPanel.add(chooseFiltersPanel);
1192 return filtersPanel;
1196 * Lays out the panel with radio buttons to AND or OR filter conditions
1200 private JPanel initialiseAndOrPanel()
1202 JPanel andOrPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
1203 andOrPanel.setBackground(Color.white);
1204 andFilters = new JRadioButton(MessageManager.getString("label.and"));
1205 orFilters = new JRadioButton(MessageManager.getString("label.or"));
1206 andFilters.setOpaque(false);
1207 orFilters.setOpaque(false);
1208 ActionListener actionListener = new ActionListener()
1211 public void actionPerformed(ActionEvent e)
1216 andFilters.addActionListener(actionListener);
1217 orFilters.addActionListener(actionListener);
1218 ButtonGroup andOr = new ButtonGroup();
1219 andOr.add(andFilters);
1220 andOr.add(orFilters);
1221 andFilters.setSelected(true);
1223 new JLabel(MessageManager.getString("label.join_conditions")));
1224 andOrPanel.add(andFilters);
1225 andOrPanel.add(orFilters);
1230 * Refreshes the display to show any filters currently configured for the
1231 * selected feature type (editable, with 'remove' option), plus one extra row
1232 * for adding a condition. This should be called after a filter has been
1233 * removed, added or amended.
1235 private void updateFiltersPanel()
1238 * clear the panel and list of filter conditions
1240 chooseFiltersPanel.removeAll();
1244 * look up attributes known for feature type
1246 List<String[]> attNames = FeatureAttributes.getInstance()
1247 .getAttributes(featureType);
1250 * if this feature type has filters set, load them first
1252 FeatureMatcherSetI featureFilters = fr.getFeatureFilter(featureType);
1253 if (featureFilters != null)
1255 if (!featureFilters.isAnded())
1257 orFilters.setSelected(true);
1259 // avoid use of lambda expression to keep SwingJS happy
1260 // featureFilters.getMatchers().forEach(item -> filters.add(item));
1261 for (FeatureMatcherI matcher : featureFilters.getMatchers())
1263 filters.add(matcher);
1268 * and an empty filter for the user to populate (add)
1270 filters.add(FeatureMatcher.NULL_MATCHER);
1273 * use GridLayout to 'justify' rows to the top of the panel, until
1274 * there are too many to fit in, then fall back on BoxLayout
1276 if (filters.size() <= 5)
1278 chooseFiltersPanel.setLayout(new GridLayout(5, 1));
1282 chooseFiltersPanel.setLayout(
1283 new BoxLayout(chooseFiltersPanel, BoxLayout.Y_AXIS));
1287 * render the conditions in rows, each in its own JPanel
1289 int filterIndex = 0;
1290 for (FeatureMatcherI filter : filters)
1292 JPanel row = addFilter(filter, attNames, filterIndex);
1293 chooseFiltersPanel.add(row);
1302 * A helper method that constructs a row (panel) with one filter condition:
1304 * <li>a drop-down list of Label, Score and attribute names to choose
1306 * <li>a drop-down list of conditions to choose from</li>
1307 * <li>a text field for input of a match pattern</li>
1308 * <li>optionally, a 'remove' button</li>
1310 * The filter values are set as defaults for the input fields. The 'remove'
1311 * button is added unless the pattern is empty (incomplete filter condition).
1313 * Action handlers on these fields provide for
1315 * <li>validate pattern field - should be numeric if condition is numeric</li>
1316 * <li>save filters and refresh display on any (valid) change</li>
1317 * <li>remove filter and refresh on 'Remove'</li>
1318 * <li>update conditions list on change of Label/Score/Attribute</li>
1319 * <li>refresh value field tooltip with min-max range on change of
1325 * @param filterIndex
1328 protected JPanel addFilter(FeatureMatcherI filter,
1329 List<String[]> attNames, int filterIndex)
1331 String[] attName = filter.getAttribute();
1332 Condition cond = filter.getMatcher().getCondition();
1333 String pattern = filter.getMatcher().getPattern();
1335 JPanel filterRow = new JPanel(new FlowLayout(FlowLayout.LEFT));
1336 filterRow.setBackground(Color.white);
1339 * drop-down choice of attribute, with description as a tooltip
1340 * if we can obtain it
1342 JComboBox<String> attCombo = populateAttributesDropdown(attNames, true,
1344 String filterBy = setSelectedAttribute(attCombo, filter);
1346 JComboBox<Condition> condCombo = new JComboBox<>();
1348 JTextField patternField = new JTextField(8);
1349 patternField.setText(pattern);
1352 * action handlers that validate and (if valid) apply changes
1354 ActionListener actionListener = new ActionListener()
1357 public void actionPerformed(ActionEvent e)
1359 if (validateFilter(patternField, condCombo))
1361 if (updateFilter(attCombo, condCombo, patternField, filterIndex))
1368 ItemListener itemListener = new ItemListener()
1371 public void itemStateChanged(ItemEvent e)
1373 actionListener.actionPerformed(null);
1377 if (filter == FeatureMatcher.NULL_MATCHER) // the 'add a condition' row
1379 attCombo.setSelectedIndex(0);
1383 attCombo.setSelectedItem(
1384 FeatureMatcher.toAttributeDisplayName(attName));
1386 attCombo.addItemListener(new ItemListener()
1389 public void itemStateChanged(ItemEvent e)
1392 * on change of attribute, refresh the conditions list to
1393 * ensure it is appropriate for the attribute datatype
1395 populateConditions((String) attCombo.getSelectedItem(),
1396 (Condition) condCombo.getSelectedItem(), condCombo,
1398 actionListener.actionPerformed(null);
1402 filterRow.add(attCombo);
1405 * drop-down choice of test condition
1407 populateConditions(filterBy, cond, condCombo, patternField);
1408 condCombo.setPreferredSize(new Dimension(150, 20));
1409 condCombo.addItemListener(itemListener);
1410 filterRow.add(condCombo);
1413 * pattern to match against
1415 patternField.addActionListener(actionListener);
1416 patternField.addFocusListener(new FocusAdapter()
1419 public void focusLost(FocusEvent e)
1421 actionListener.actionPerformed(null);
1424 filterRow.add(patternField);
1427 * disable pattern field for condition 'Present / NotPresent'
1429 Condition selectedCondition = (Condition) condCombo.getSelectedItem();
1430 patternField.setEnabled(selectedCondition.needsAPattern());
1433 * if a numeric condition is selected, show the value range
1434 * as a tooltip on the value input field
1436 setNumericHints(filterBy, selectedCondition, patternField);
1439 * add remove button if filter is populated (non-empty pattern)
1441 if (!patternField.isEnabled()
1442 || (pattern != null && pattern.trim().length() > 0))
1444 JButton removeCondition = new JButton("\u2717"); // Dingbats cursive x
1445 removeCondition.setPreferredSize(new Dimension(23, 17));
1447 .setToolTipText(MessageManager.getString("label.delete_row"));
1448 removeCondition.addActionListener(new ActionListener()
1451 public void actionPerformed(ActionEvent e)
1453 filters.remove(filterIndex);
1457 filterRow.add(removeCondition);
1464 * Sets the selected item in the Label/Score/Attribute drop-down to match the
1470 private String setSelectedAttribute(JComboBox<String> attCombo,
1471 FeatureMatcherI filter)
1474 if (filter.isByScore())
1478 else if (filter.isByLabel())
1484 item = FeatureMatcher.toAttributeDisplayName(filter.getAttribute());
1486 attCombo.setSelectedItem(item);
1491 * If a numeric comparison condition is selected, retrieves the min-max range
1492 * for the value (score or attribute), and sets it as a tooltip on the value
1493 * field. If the field is currently empty, then pre-populates it with
1495 * <li>the minimum value, if condition is > or >=</li>
1496 * <li>the maximum value, if condition is < or <=</li>
1500 * @param selectedCondition
1501 * @param patternField
1503 private void setNumericHints(String attName, Condition selectedCondition,
1504 JTextField patternField)
1506 patternField.setToolTipText("");
1508 if (selectedCondition.isNumeric())
1510 float[] minMax = getMinMax(attName);
1513 String minFormatted = DECFMT_2_2.format(minMax[0]);
1514 String maxFormatted = DECFMT_2_2.format(minMax[1]);
1515 String tip = String.format("(%s - %s)", minFormatted, maxFormatted);
1516 patternField.setToolTipText(tip);
1517 if (patternField.getText().isEmpty())
1519 if (selectedCondition == Condition.GE
1520 || selectedCondition == Condition.GT)
1522 patternField.setText(minFormatted);
1526 if (selectedCondition == Condition.LE
1527 || selectedCondition == Condition.LT)
1529 patternField.setText(maxFormatted);
1538 * Populates the drop-down list of comparison conditions for the given
1539 * attribute name. The conditions added depend on the datatype of the
1540 * attribute values. The supplied condition is set as the selected item in the
1541 * list, provided it is in the list. If the pattern is now invalid
1542 * (non-numeric pattern for a numeric condition), it is cleared.
1547 * @param patternField
1549 void populateConditions(String attName, Condition cond,
1550 JComboBox<Condition> condCombo, JTextField patternField)
1552 Datatype type = FeatureAttributes.getInstance().getDatatype(featureType,
1553 FeatureMatcher.fromAttributeDisplayName(attName));
1554 if (LABEL_18N.equals(attName))
1556 type = Datatype.Character;
1558 else if (SCORE_18N.equals(attName))
1560 type = Datatype.Number;
1564 * remove itemListener before starting
1566 ItemListener listener = condCombo.getItemListeners()[0];
1567 condCombo.removeItemListener(listener);
1568 boolean condIsValid = false;
1570 condCombo.removeAllItems();
1571 for (Condition c : Condition.values())
1573 if ((c.isNumeric() && type == Datatype.Number)
1574 || (!c.isNumeric() && type != Datatype.Number))
1576 condCombo.addItem(c);
1585 * set the selected condition (does nothing if not in the list)
1589 condCombo.setSelectedItem(cond);
1593 condCombo.setSelectedIndex(0);
1597 * clear pattern if it is now invalid for condition
1599 if (((Condition) condCombo.getSelectedItem()).isNumeric())
1603 String pattern = patternField.getText().trim();
1604 if (pattern.length() > 0)
1606 Float.valueOf(pattern);
1608 } catch (NumberFormatException e)
1610 patternField.setText("");
1615 * restore the listener
1617 condCombo.addItemListener(listener);
1621 * Answers true unless a numeric condition has been selected with a
1622 * non-numeric value. Sets the value field to RED with a tooltip if in error.
1624 * If the pattern is expected but is empty, this method returns false, but
1625 * does not mark the field as invalid. This supports selecting an attribute
1626 * for a new condition before a match pattern has been entered.
1631 protected boolean validateFilter(JTextField value,
1632 JComboBox<Condition> condCombo)
1634 if (value == null || condCombo == null)
1636 return true; // fields not populated
1639 Condition cond = (Condition) condCombo.getSelectedItem();
1640 if (!cond.needsAPattern())
1645 value.setBackground(Color.white);
1646 value.setToolTipText("");
1647 String v1 = value.getText().trim();
1648 if (v1.length() == 0)
1653 if (cond.isNumeric() && v1.length() > 0)
1658 } catch (NumberFormatException e)
1660 value.setBackground(Color.red);
1661 value.setToolTipText(
1662 MessageManager.getString("label.numeric_required"));
1671 * Constructs a filter condition from the given input fields, and replaces the
1672 * condition at filterIndex with the new one. Does nothing if the pattern
1673 * field is blank (unless the match condition is one that doesn't require a
1674 * pattern, e.g. 'Is present'). Answers true if the filter was updated, else
1677 * This method may update the tooltip on the filter value field to show the
1678 * value range, if a numeric condition is selected. This ensures the tooltip
1679 * is updated when a numeric valued attribute is chosen on the last 'add a
1685 * @param filterIndex
1687 protected boolean updateFilter(JComboBox<String> attCombo,
1688 JComboBox<Condition> condCombo, JTextField valueField,
1691 String attName = (String) attCombo.getSelectedItem();
1692 Condition cond = (Condition) condCombo.getSelectedItem();
1693 String pattern = valueField.getText().trim();
1695 setNumericHints(attName, cond, valueField);
1697 if (pattern.length() == 0 && cond.needsAPattern())
1699 valueField.setEnabled(true); // ensure pattern field is enabled!
1704 * Construct a matcher that operates on Label, Score,
1705 * or named attribute
1707 FeatureMatcherI km = null;
1708 if (LABEL_18N.equals(attName))
1710 km = FeatureMatcher.byLabel(cond, pattern);
1712 else if (SCORE_18N.equals(attName))
1714 km = FeatureMatcher.byScore(cond, pattern);
1718 km = FeatureMatcher.byAttribute(cond, pattern,
1719 FeatureMatcher.fromAttributeDisplayName(attName));
1722 filters.set(filterIndex, km);
1728 * Action on any change to feature filtering, namely
1730 * <li>change of selected attribute</li>
1731 * <li>change of selected condition</li>
1732 * <li>change of match pattern</li>
1733 * <li>removal of a condition</li>
1735 * The inputs are parsed into a combined filter and this is set for the
1736 * feature type, and the alignment redrawn.
1738 protected void filtersChanged()
1741 * update the filter conditions for the feature type
1743 boolean anded = andFilters.isSelected();
1744 FeatureMatcherSetI combined = new FeatureMatcherSet();
1746 for (FeatureMatcherI filter : filters)
1748 String pattern = filter.getMatcher().getPattern();
1749 Condition condition = filter.getMatcher().getCondition();
1750 if (pattern.trim().length() > 0 || !condition.needsAPattern())
1754 combined.and(filter);
1758 combined.or(filter);
1764 * save the filter conditions in the FeatureRenderer
1765 * (note this might now be an empty filter with no conditions)
1767 fr.setFeatureFilter(featureType, combined.isEmpty() ? null : combined);
1768 ap.paintAlignment(true, true);
1770 updateFiltersPanel();