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.
24 import jalview.datamodel.ColumnSelection;
25 import jalview.schemes.AnnotationColourGradient;
26 import jalview.util.MessageManager;
27 import jalview.viewmodel.annotationfilter.AnnotationFilterParameter;
29 import java.awt.BorderLayout;
30 import java.awt.CardLayout;
31 import java.awt.Color;
32 import java.awt.event.ActionEvent;
33 import java.awt.event.ActionListener;
34 import java.awt.event.ItemEvent;
35 import java.awt.event.ItemListener;
36 import java.util.Iterator;
38 import javax.swing.ButtonGroup;
39 import javax.swing.JCheckBox;
40 import javax.swing.JComboBox;
41 import javax.swing.JInternalFrame;
42 import javax.swing.JLayeredPane;
43 import javax.swing.JPanel;
44 import javax.swing.JRadioButton;
45 import javax.swing.JTextField;
46 import javax.swing.border.TitledBorder;
47 import javax.swing.event.DocumentEvent;
48 import javax.swing.event.DocumentListener;
50 import net.miginfocom.swing.MigLayout;
52 @SuppressWarnings("serial")
53 public class AnnotationColumnChooser extends AnnotationRowFilter implements
56 private JPanel switchableViewsPanel = new JPanel(new CardLayout());
58 private JPanel annotationComboBoxPanel = new JPanel();
60 private StructureFilterPanel gStructureFilterPanel;
62 private StructureFilterPanel ngStructureFilterPanel;
64 private StructureFilterPanel currentStructureFilterPanel;
66 private SearchPanel currentSearchPanel;
68 private SearchPanel gSearchPanel;
70 private SearchPanel ngSearchPanel;
72 private FurtherActionPanel currentFurtherActionPanel;
74 private FurtherActionPanel gFurtherActionPanel;
76 private FurtherActionPanel ngFurtherActionPanel;
78 public static final int ACTION_OPTION_SELECT = 1;
80 public static int ACTION_OPTION_HIDE = 2;
82 public static String NO_GRAPH_VIEW = "0";
84 public static String GRAPH_VIEW = "1";
86 private int actionOption = ACTION_OPTION_SELECT;
88 private ColumnSelection oldColumnSelection;
90 public AnnotationColumnChooser(AlignViewport av, final AlignmentPanel ap)
93 frame = new JInternalFrame();
94 frame.setContentPane(this);
95 frame.setLayer(JLayeredPane.PALETTE_LAYER);
96 Desktop.addInternalFrame(frame,
97 MessageManager.getString("label.select_by_annotation"), 520,
100 addSliderChangeListener();
101 addSliderMouseListeners();
103 if (av.getAlignment().getAlignmentAnnotation() == null)
107 setOldColumnSelection(av.getColumnSelection());
110 setAnnotations(new JComboBox<String>(getAnnotationItems(false)));
111 populateThresholdComboBox(threshold);
112 AnnotationColumnChooser lastChooser = av
113 .getAnnotationColumnSelectionState();
114 // restore Object state from the previous session if one exists
115 if (lastChooser != null)
117 currentSearchPanel = lastChooser
118 .getCurrentSearchPanel();
119 currentStructureFilterPanel = lastChooser
120 .getCurrentStructureFilterPanel();
121 annotations.setSelectedIndex(lastChooser
122 .getAnnotations().getSelectedIndex());
123 threshold.setSelectedIndex(lastChooser
124 .getThreshold().getSelectedIndex());
125 actionOption = lastChooser
127 percentThreshold.setSelected(lastChooser.percentThreshold
134 } catch (Exception ex)
145 protected void jbInit()
149 JPanel thresholdPanel = new JPanel();
150 thresholdPanel.setBorder(new TitledBorder(MessageManager
151 .getString("label.threshold_filter")));
152 thresholdPanel.setBackground(Color.white);
153 thresholdPanel.setFont(JvSwingUtils.getLabelFont());
154 thresholdPanel.setLayout(new MigLayout("", "[left][right]", "[][]"));
156 percentThreshold.setBackground(Color.white);
157 percentThreshold.setFont(JvSwingUtils.getLabelFont());
159 JPanel actionPanel = new JPanel();
160 actionPanel.setBackground(Color.white);
161 actionPanel.setFont(JvSwingUtils.getLabelFont());
163 JPanel graphFilterView = new JPanel();
164 graphFilterView.setLayout(new MigLayout("", "[left][right]", "[][]"));
165 graphFilterView.setBackground(Color.white);
167 JPanel noGraphFilterView = new JPanel();
168 noGraphFilterView.setLayout(new MigLayout("", "[left][right]", "[][]"));
169 noGraphFilterView.setBackground(Color.white);
171 annotationComboBoxPanel.setBackground(Color.white);
172 annotationComboBoxPanel.setFont(JvSwingUtils.getLabelFont());
174 gSearchPanel = new SearchPanel(this);
175 ngSearchPanel = new SearchPanel(this);
176 gFurtherActionPanel = new FurtherActionPanel(this);
177 ngFurtherActionPanel = new FurtherActionPanel(this);
178 gStructureFilterPanel = new StructureFilterPanel(this);
179 ngStructureFilterPanel = new StructureFilterPanel(this);
181 thresholdPanel.add(getThreshold());
182 thresholdPanel.add(percentThreshold, "wrap");
183 thresholdPanel.add(slider, "grow");
184 thresholdPanel.add(thresholdValue, "span, wrap");
187 actionPanel.add(cancel);
189 graphFilterView.add(gSearchPanel, "grow, span, wrap");
190 graphFilterView.add(gStructureFilterPanel, "grow, span, wrap");
191 graphFilterView.add(thresholdPanel, "grow, span, wrap");
192 graphFilterView.add(gFurtherActionPanel);
194 noGraphFilterView.add(ngSearchPanel, "grow, span, wrap");
195 noGraphFilterView.add(ngStructureFilterPanel, "grow, span, wrap");
196 noGraphFilterView.add(ngFurtherActionPanel);
198 annotationComboBoxPanel.add(getAnnotations());
199 switchableViewsPanel.add(noGraphFilterView,
200 AnnotationColumnChooser.NO_GRAPH_VIEW);
201 switchableViewsPanel.add(graphFilterView,
202 AnnotationColumnChooser.GRAPH_VIEW);
204 this.setLayout(new BorderLayout());
205 this.add(annotationComboBoxPanel, java.awt.BorderLayout.PAGE_START);
206 this.add(switchableViewsPanel, java.awt.BorderLayout.CENTER);
207 this.add(actionPanel, java.awt.BorderLayout.SOUTH);
209 selectedAnnotationChanged();
210 updateThresholdPanelToolTip();
214 protected void updateThresholdPanelToolTip()
216 thresholdValue.setToolTipText("");
217 slider.setToolTipText("");
219 String defaultTtip = MessageManager
220 .getString("info.change_threshold_mode_to_enable");
222 String thresh = getThreshold().getSelectedItem().toString();
223 if (thresh.equalsIgnoreCase("No Threshold"))
225 thresholdValue.setToolTipText(defaultTtip);
226 slider.setToolTipText(defaultTtip);
231 protected void reset()
233 if (this.getOldColumnSelection() != null)
235 av.getColumnSelection().clear();
237 if (av.getAnnotationColumnSelectionState() != null)
239 ColumnSelection oldSelection = av
240 .getAnnotationColumnSelectionState()
241 .getOldColumnSelection();
242 if (oldSelection != null && oldSelection.getHiddenColumns() != null
243 && !oldSelection.getHiddenColumns().isEmpty())
245 for (Iterator<int[]> itr = oldSelection.getHiddenColumns()
246 .iterator(); itr.hasNext();)
248 int positions[] = itr.next();
249 av.hideColumns(positions[0], positions[1]);
252 av.setColumnSelection(oldSelection);
254 ap.paintAlignment(true);
260 public void valueChanged(boolean updateAllAnnotation)
262 if (slider.isEnabled())
264 getCurrentAnnotation().threshold.value = slider.getValue() / 1000f;
266 propagateSeqAssociatedThreshold(updateAllAnnotation,
267 getCurrentAnnotation());
268 ap.paintAlignment(false);
273 public void updateView()
275 // Check if combobox is still adjusting
281 AnnotationFilterParameter filterParams = new AnnotationFilterParameter();
283 setCurrentAnnotation(av.getAlignment().getAlignmentAnnotation()[annmap[getAnnotations()
284 .getSelectedIndex()]]);
286 int selectedThresholdItem = getSelectedThresholdItem(getThreshold()
287 .getSelectedIndex());
289 slider.setEnabled(true);
290 thresholdValue.setEnabled(true);
291 percentThreshold.setEnabled(true);
293 if (selectedThresholdItem == AnnotationColourGradient.NO_THRESHOLD)
295 slider.setEnabled(false);
296 thresholdValue.setEnabled(false);
297 thresholdValue.setText("");
298 percentThreshold.setEnabled(false);
299 // build filter params
301 else if (selectedThresholdItem != AnnotationColourGradient.NO_THRESHOLD)
303 if (getCurrentAnnotation().threshold == null)
305 getCurrentAnnotation()
307 new jalview.datamodel.GraphLine(
308 (getCurrentAnnotation().graphMax - getCurrentAnnotation().graphMin) / 2f,
309 "Threshold", Color.black));
313 float range = getCurrentAnnotation().graphMax * 1000
314 - getCurrentAnnotation().graphMin * 1000;
316 slider.setMinimum((int) (getCurrentAnnotation().graphMin * 1000));
317 slider.setMaximum((int) (getCurrentAnnotation().graphMax * 1000));
318 slider.setValue((int) (getCurrentAnnotation().threshold.value * 1000));
320 setThresholdValueText();
322 slider.setMajorTickSpacing((int) (range / 10f));
323 slider.setEnabled(true);
324 thresholdValue.setEnabled(true);
327 // build filter params
329 .setThresholdType(AnnotationFilterParameter.ThresholdType.NO_THRESHOLD);
330 if (getCurrentAnnotation().isQuantitative())
333 .setThresholdValue(getCurrentAnnotation().threshold.value);
335 if (selectedThresholdItem == AnnotationColourGradient.ABOVE_THRESHOLD)
338 .setThresholdType(AnnotationFilterParameter.ThresholdType.ABOVE_THRESHOLD);
340 else if (selectedThresholdItem == AnnotationColourGradient.BELOW_THRESHOLD)
343 .setThresholdType(AnnotationFilterParameter.ThresholdType.BELOW_THRESHOLD);
348 updateThresholdPanelToolTip();
349 if (currentStructureFilterPanel != null)
351 if (currentStructureFilterPanel.alphaHelix.isSelected())
353 filterParams.setFilterAlphaHelix(true);
355 if (currentStructureFilterPanel.betaStrand.isSelected())
357 filterParams.setFilterBetaSheet(true);
359 if (currentStructureFilterPanel.turn.isSelected())
361 filterParams.setFilterTurn(true);
365 if (currentSearchPanel != null)
368 if (!currentSearchPanel.searchBox.getText().isEmpty())
370 currentSearchPanel.description.setEnabled(true);
371 currentSearchPanel.displayName.setEnabled(true);
372 filterParams.setRegexString(currentSearchPanel.searchBox.getText());
373 if (currentSearchPanel.displayName.isSelected())
376 .addRegexSearchField(AnnotationFilterParameter.SearchableAnnotationField.DISPLAY_STRING);
378 if (currentSearchPanel.description.isSelected())
381 .addRegexSearchField(AnnotationFilterParameter.SearchableAnnotationField.DESCRIPTION);
386 currentSearchPanel.description.setEnabled(false);
387 currentSearchPanel.displayName.setEnabled(false);
391 av.getColumnSelection().filterAnnotations(
392 getCurrentAnnotation().annotations, filterParams);
394 av.showAllHiddenColumns();
395 if (getActionOption() == ACTION_OPTION_HIDE)
397 av.hideSelectedColumns();
401 av.setAnnotationColumnSelectionState(this);
402 ap.paintAlignment(true);
406 public ColumnSelection getOldColumnSelection()
408 return oldColumnSelection;
411 public void setOldColumnSelection(ColumnSelection currentColumnSelection)
413 if (currentColumnSelection != null)
415 this.oldColumnSelection = new ColumnSelection(currentColumnSelection);
419 public FurtherActionPanel getCurrentFutherActionPanel()
421 return currentFurtherActionPanel;
424 public void setCurrentFutherActionPanel(
425 FurtherActionPanel currentFutherActionPanel)
427 this.currentFurtherActionPanel = currentFutherActionPanel;
430 public SearchPanel getCurrentSearchPanel()
432 return currentSearchPanel;
435 public void setCurrentSearchPanel(SearchPanel currentSearchPanel)
437 this.currentSearchPanel = currentSearchPanel;
440 public int getActionOption()
445 public void setActionOption(int actionOption)
447 this.actionOption = actionOption;
450 public StructureFilterPanel getCurrentStructureFilterPanel()
452 return currentStructureFilterPanel;
455 public void setCurrentStructureFilterPanel(
456 StructureFilterPanel currentStructureFilterPanel)
458 this.currentStructureFilterPanel = currentStructureFilterPanel;
461 public void select_action(ActionEvent actionEvent)
463 JRadioButton radioButton = (JRadioButton) actionEvent.getSource();
464 if (radioButton.isSelected())
466 setActionOption(ACTION_OPTION_SELECT);
471 public void hide_action(ActionEvent actionEvent)
473 JRadioButton radioButton = (JRadioButton) actionEvent.getSource();
474 if (radioButton.isSelected())
476 setActionOption(ACTION_OPTION_HIDE);
482 public void itemStateChanged(ItemEvent e)
484 selectedAnnotationChanged();
488 public void selectedAnnotationChanged()
490 String currentView = AnnotationColumnChooser.NO_GRAPH_VIEW;
491 if (av.getAlignment()
492 .getAlignmentAnnotation()[annmap[getAnnotations()
493 .getSelectedIndex()]].isQuantitative())
495 currentView = AnnotationColumnChooser.GRAPH_VIEW;
498 gSearchPanel.syncState();
499 gFurtherActionPanel.syncState();
500 gStructureFilterPanel.syncState();
502 ngSearchPanel.syncState();
503 ngFurtherActionPanel.syncState();
504 ngStructureFilterPanel.syncState();
506 CardLayout switchableViewsLayout = (CardLayout) switchableViewsPanel
508 switchableViewsLayout.show(switchableViewsPanel, currentView);
512 public class FurtherActionPanel extends JPanel
514 private AnnotationColumnChooser aColChooser;
516 private JRadioButton hideOption = new JRadioButton();
518 private JRadioButton selectOption = new JRadioButton();
520 private ButtonGroup optionsGroup = new ButtonGroup();
522 public FurtherActionPanel(AnnotationColumnChooser aColChooser)
524 this.aColChooser = aColChooser;
525 JvSwingUtils.jvInitComponent(selectOption, "action.select");
526 selectOption.addActionListener(new ActionListener()
529 public void actionPerformed(ActionEvent actionEvent)
531 selectRadioAction(actionEvent);
535 JvSwingUtils.jvInitComponent(hideOption, "action.hide");
536 hideOption.addActionListener(new ActionListener()
539 public void actionPerformed(ActionEvent actionEvent)
541 hideRadioAction(actionEvent);
545 optionsGroup.add(selectOption);
546 optionsGroup.add(hideOption);
547 optionsGroup.setSelected(selectOption.getModel(), true);
549 JvSwingUtils.jvInitComponent(this);
552 this.add(selectOption);
553 this.add(hideOption);
556 public void selectRadioAction(ActionEvent actionEvent)
558 aColChooser.setCurrentFutherActionPanel(this);
559 aColChooser.select_action(actionEvent);
562 public void hideRadioAction(ActionEvent actionEvent)
564 aColChooser.setCurrentFutherActionPanel(this);
565 aColChooser.hide_action(actionEvent);
568 public void syncState()
570 if (aColChooser.getActionOption() == AnnotationColumnChooser.ACTION_OPTION_HIDE)
572 this.optionsGroup.setSelected(this.hideOption.getModel(), true);
576 this.optionsGroup.setSelected(this.selectOption.getModel(), true);
581 public class StructureFilterPanel extends JPanel
583 private AnnotationColumnChooser aColChooser;
585 private JCheckBox alphaHelix = new JCheckBox();
587 private JCheckBox betaStrand = new JCheckBox();
589 private JCheckBox turn = new JCheckBox();
591 private JCheckBox all = new JCheckBox();
593 public StructureFilterPanel(AnnotationColumnChooser aColChooser)
595 this.aColChooser = aColChooser;
597 JvSwingUtils.jvInitComponent(alphaHelix, "label.alpha_helix");
598 alphaHelix.addActionListener(new ActionListener()
601 public void actionPerformed(ActionEvent actionEvent)
603 alphaHelix_actionPerformed();
607 JvSwingUtils.jvInitComponent(betaStrand, "label.beta_strand");
608 betaStrand.addActionListener(new ActionListener()
611 public void actionPerformed(ActionEvent actionEvent)
613 betaStrand_actionPerformed();
617 JvSwingUtils.jvInitComponent(turn, "label.turn");
618 turn.addActionListener(new ActionListener()
621 public void actionPerformed(ActionEvent actionEvent)
623 turn_actionPerformed();
627 JvSwingUtils.jvInitComponent(all, "label.select_all");
628 all.addActionListener(new ActionListener()
631 public void actionPerformed(ActionEvent actionEvent)
633 all_actionPerformed();
637 this.setBorder(new TitledBorder(MessageManager
638 .getString("label.structures_filter")));
639 JvSwingUtils.jvInitComponent(this);
642 this.add(alphaHelix);
643 this.add(betaStrand);
647 public void alphaHelix_actionPerformed()
649 updateSelectAllState();
650 aColChooser.setCurrentStructureFilterPanel(this);
651 aColChooser.updateView();
654 public void betaStrand_actionPerformed()
656 updateSelectAllState();
657 aColChooser.setCurrentStructureFilterPanel(this);
658 aColChooser.updateView();
661 public void turn_actionPerformed()
663 updateSelectAllState();
664 aColChooser.setCurrentStructureFilterPanel(this);
665 aColChooser.updateView();
668 public void all_actionPerformed()
670 if (all.isSelected())
672 alphaHelix.setSelected(true);
673 betaStrand.setSelected(true);
674 turn.setSelected(true);
678 alphaHelix.setSelected(false);
679 betaStrand.setSelected(false);
680 turn.setSelected(false);
682 aColChooser.setCurrentStructureFilterPanel(this);
683 aColChooser.updateView();
686 public void updateSelectAllState()
688 if (alphaHelix.isSelected() && betaStrand.isSelected()
689 && turn.isSelected())
691 all.setSelected(true);
695 all.setSelected(false);
699 public void syncState()
701 StructureFilterPanel sfp = aColChooser
702 .getCurrentStructureFilterPanel();
705 alphaHelix.setSelected(sfp.alphaHelix.isSelected());
706 betaStrand.setSelected(sfp.betaStrand.isSelected());
707 turn.setSelected(sfp.turn.isSelected());
708 if (sfp.all.isSelected())
710 all.setSelected(true);
711 alphaHelix.setSelected(true);
712 betaStrand.setSelected(true);
713 turn.setSelected(true);
720 public class SearchPanel extends JPanel
722 private AnnotationColumnChooser aColChooser;
724 private JCheckBox displayName = new JCheckBox();
726 private JCheckBox description = new JCheckBox();
728 private JTextField searchBox = new JTextField(10);
730 public SearchPanel(AnnotationColumnChooser aColChooser)
733 this.aColChooser = aColChooser;
734 JvSwingUtils.jvInitComponent(this);
735 this.setBorder(new TitledBorder(MessageManager
736 .getString("label.search_filter")));
738 JvSwingUtils.jvInitComponent(searchBox);
739 searchBox.setToolTipText(MessageManager
740 .getString("info.enter_search_text_here"));
741 searchBox.getDocument().addDocumentListener(new DocumentListener()
744 public void insertUpdate(DocumentEvent e)
746 searchStringAction();
750 public void removeUpdate(DocumentEvent e)
752 searchStringAction();
756 public void changedUpdate(DocumentEvent e)
758 searchStringAction();
762 JvSwingUtils.jvInitComponent(displayName, "label.label");
763 displayName.setEnabled(false);
764 displayName.addActionListener(new ActionListener()
767 public void actionPerformed(ActionEvent actionEvent)
769 displayNameCheckboxAction();
773 JvSwingUtils.jvInitComponent(description, "label.description");
774 description.setEnabled(false);
775 description.addActionListener(new ActionListener()
778 public void actionPerformed(ActionEvent actionEvent)
780 discriptionCheckboxAction();
786 this.add(displayName);
787 this.add(description);
790 public void displayNameCheckboxAction()
792 aColChooser.setCurrentSearchPanel(this);
793 aColChooser.updateView();
796 public void discriptionCheckboxAction()
798 aColChooser.setCurrentSearchPanel(this);
799 aColChooser.updateView();
802 public void searchStringAction()
804 aColChooser.setCurrentSearchPanel(this);
805 aColChooser.updateView();
806 updateSearchPanelToolTips();
809 public void syncState()
811 SearchPanel sp = aColChooser.getCurrentSearchPanel();
814 description.setEnabled(sp.description.isEnabled());
815 description.setSelected(sp.description.isSelected());
817 displayName.setEnabled(sp.displayName.isEnabled());
818 displayName.setSelected(sp.displayName.isSelected());
820 searchBox.setText(sp.searchBox.getText());
822 updateSearchPanelToolTips();
825 public void updateSearchPanelToolTips()
827 String defaultTtip = MessageManager
828 .getString("info.enter_search_text_to_enable");
829 String labelTtip = MessageManager.formatMessage(
830 "info.search_in_annotation_label", annotations
831 .getSelectedItem().toString());
832 String descTtip = MessageManager.formatMessage(
833 "info.search_in_annotation_description", annotations
834 .getSelectedItem().toString());
835 displayName.setToolTipText(displayName.isEnabled() ? labelTtip
837 description.setToolTipText(description.isEnabled() ? descTtip