JAL-1645 source formatting and organise imports
[jalview.git] / src / jalview / gui / AnnotationColumnChooser.java
index 31b5b64..c0d7084 100644 (file)
@@ -1,10 +1,31 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+
 package jalview.gui;
 
-import jalview.api.analysis.AnnotationFilterParameter;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.ColumnSelection;
 import jalview.schemes.AnnotationColourGradient;
 import jalview.util.MessageManager;
+import jalview.viewmodel.annotationfilter.AnnotationFilterParameter;
 
 import java.awt.BorderLayout;
 import java.awt.CardLayout;
@@ -17,11 +38,9 @@ import java.awt.event.ItemListener;
 import java.util.Iterator;
 
 import javax.swing.ButtonGroup;
-import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JInternalFrame;
-import javax.swing.JLabel;
 import javax.swing.JLayeredPane;
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
@@ -39,10 +58,6 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
 
   private JComboBox<String> annotations;
 
-  private JButton ok = new JButton();
-
-  private JButton cancel = new JButton();
-
   private JPanel actionPanel = new JPanel();
 
   private JPanel thresholdPanel = new JPanel();
@@ -58,8 +73,6 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
 
   private JPanel annotationComboBoxPanel = new JPanel();
 
-  private JLabel annotationLabel = new JLabel();
-
   private BorderLayout borderLayout1 = new BorderLayout();
 
   private JComboBox<String> threshold = new JComboBox<String>();
@@ -181,6 +194,8 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     });
 
     annotations.addItemListener(this);
+    annotations.setToolTipText(MessageManager
+            .getString("info.select_annotation_row"));
     threshold.addActionListener(new ActionListener()
     {
       @Override
@@ -208,11 +223,8 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     slider.setOpaque(false);
     slider.setPreferredSize(new Dimension(100, 32));
 
-    annotationLabel.setBackground(Color.white);
-    annotationLabel.setFont(JvSwingUtils.getLabelFont());
-    annotationLabel.setText("Select Annotation : ");
-
-    thresholdPanel.setBorder(new TitledBorder("Threshold Filter"));
+    thresholdPanel.setBorder(new TitledBorder(MessageManager
+            .getString("label.threshold_filter")));
     thresholdPanel.setBackground(Color.white);
     thresholdPanel.setFont(JvSwingUtils.getLabelFont());
     thresholdPanel.setLayout(new MigLayout("", "[left][right]", "[][]"));
@@ -225,6 +237,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
 
     noGraphFilterView.setLayout(new MigLayout("", "[left][right]", "[][]"));
     noGraphFilterView.setBackground(Color.white);
+
     annotationComboBoxPanel.setBackground(Color.white);
     annotationComboBoxPanel.setFont(JvSwingUtils.getLabelFont());
 
@@ -263,10 +276,26 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     this.add(actionPanel, java.awt.BorderLayout.SOUTH);
 
     selectedAnnotationChanged();
+    updateThresholdPanelToolTip();
     this.validate();
   }
 
-  @SuppressWarnings("unchecked")
+  public void updateThresholdPanelToolTip()
+  {
+    thresholdValue.setToolTipText("");
+    slider.setToolTipText("");
+
+    String defaultTtip = MessageManager
+            .getString("info.change_threshold_mode_to_enable");
+
+    String threshold = getThreshold().getSelectedItem().toString();
+    if (threshold.equalsIgnoreCase("No Threshold"))
+    {
+      thresholdValue.setToolTipText(defaultTtip);
+      slider.setToolTipText(defaultTtip);
+    }
+  }
+
   public void reset()
   {
     if (this.getOldColumnSelection() != null)
@@ -383,6 +412,8 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
               .setThresholdType(AnnotationFilterParameter.ThresholdType.NO_THRESHOLD);
       if (getCurrentAnnotation().graph != AlignmentAnnotation.NO_GRAPH)
       {
+        filterParams
+                .setThresholdValue(getCurrentAnnotation().threshold.value);
 
         if (selectedThresholdItem == AnnotationColourGradient.ABOVE_THRESHOLD)
         {
@@ -397,17 +428,18 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       }
     }
 
+    updateThresholdPanelToolTip();
     if (currentStructureFilterPanel != null)
     {
-      if (currentStructureFilterPanel.getAlphaHelix().isSelected())
+      if (currentStructureFilterPanel.alphaHelix.isSelected())
       {
         filterParams.setFilterAlphaHelix(true);
       }
-      if (currentStructureFilterPanel.getBetaStrand().isSelected())
+      if (currentStructureFilterPanel.betaStrand.isSelected())
       {
         filterParams.setFilterBetaSheet(true);
       }
-      if (currentStructureFilterPanel.getTurn().isSelected())
+      if (currentStructureFilterPanel.turn.isSelected())
       {
         filterParams.setFilterTurn(true);
       }
@@ -415,17 +447,18 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
 
     if (currentSearchPanel != null)
     {
-      if (!currentSearchPanel.getSearchString().isEmpty())
+
+      if (!currentSearchPanel.searchBox.getText().isEmpty())
       {
-        currentSearchPanel.getDescription().setEnabled(true);
-        currentSearchPanel.getDisplayName().setEnabled(true);
-        filterParams.setRegexString(currentSearchPanel.getSearchString());
-        if (currentSearchPanel.isDisplayNameChecked())
+        currentSearchPanel.description.setEnabled(true);
+        currentSearchPanel.displayName.setEnabled(true);
+        filterParams.setRegexString(currentSearchPanel.searchBox.getText());
+        if (currentSearchPanel.displayName.isSelected())
         {
           filterParams
                   .addRegexSearchField(AnnotationFilterParameter.SearchableAnnotationField.DISPLAY_STRING);
         }
-        if (currentSearchPanel.isDescriptionChecked())
+        if (currentSearchPanel.description.isSelected())
         {
           filterParams
                   .addRegexSearchField(AnnotationFilterParameter.SearchableAnnotationField.DESCRIPTION);
@@ -433,13 +466,13 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       }
       else
       {
-        currentSearchPanel.getDescription().setEnabled(false);
-        currentSearchPanel.getDisplayName().setEnabled(false);
+        currentSearchPanel.description.setEnabled(false);
+        currentSearchPanel.displayName.setEnabled(false);
       }
     }
 
-    filterAnnotations(getCurrentAnnotation().annotations, filterParams,
-            av.getColumnSelection());
+    av.getColumnSelection().filterAnnotations(
+            getCurrentAnnotation().annotations, filterParams);
 
     av.showAllHiddenColumns();
     if (getActionOption() == ACTION_OPTION_HIDE)
@@ -465,6 +498,48 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     }
   }
 
+  public FurtherActionPanel getCurrentFutherActionPanel()
+  {
+    return currentFurtherActionPanel;
+  }
+
+  public void setCurrentFutherActionPanel(
+          FurtherActionPanel currentFutherActionPanel)
+  {
+    this.currentFurtherActionPanel = currentFutherActionPanel;
+  }
+
+  public SearchPanel getCurrentSearchPanel()
+  {
+    return currentSearchPanel;
+  }
+
+  public void setCurrentSearchPanel(SearchPanel currentSearchPanel)
+  {
+    this.currentSearchPanel = currentSearchPanel;
+  }
+
+  public int getActionOption()
+  {
+    return actionOption;
+  }
+
+  public void setActionOption(int actionOption)
+  {
+    this.actionOption = actionOption;
+  }
+
+  public StructureFilterPanel getCurrentStructureFilterPanel()
+  {
+    return currentStructureFilterPanel;
+  }
+
+  public void setCurrentStructureFilterPanel(
+          StructureFilterPanel currentStructureFilterPanel)
+  {
+    this.currentStructureFilterPanel = currentStructureFilterPanel;
+  }
+
   public void select_action(ActionEvent actionEvent)
   {
     JRadioButton radioButton = (JRadioButton) actionEvent.getSource();
@@ -512,48 +587,6 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     updateView();
   }
 
-  public FurtherActionPanel getCurrentFutherActionPanel()
-  {
-    return currentFurtherActionPanel;
-  }
-
-  public void setCurrentFutherActionPanel(
-          FurtherActionPanel currentFutherActionPanel)
-  {
-    this.currentFurtherActionPanel = currentFutherActionPanel;
-  }
-
-  public SearchPanel getCurrentSearchPanel()
-  {
-    return currentSearchPanel;
-  }
-
-  public void setCurrentSearchPanel(SearchPanel currentSearchPanel)
-  {
-    this.currentSearchPanel = currentSearchPanel;
-  }
-
-  public int getActionOption()
-  {
-    return actionOption;
-  }
-
-  public void setActionOption(int actionOption)
-  {
-    this.actionOption = actionOption;
-  }
-
-  public StructureFilterPanel getCurrentStructureFilterPanel()
-  {
-    return currentStructureFilterPanel;
-  }
-
-  public void setCurrentStructureFilterPanel(
-          StructureFilterPanel currentStructureFilterPanel)
-  {
-    this.currentStructureFilterPanel = currentStructureFilterPanel;
-  }
-
   public class FurtherActionPanel extends JPanel
   {
     private AnnotationColumnChooser aColChooser;
@@ -567,10 +600,8 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     public FurtherActionPanel(AnnotationColumnChooser aColChooser)
     {
       this.aColChooser = aColChooser;
-      getSelectOption().setBackground(Color.white);
-      getSelectOption().setFont(JvSwingUtils.getLabelFont());
-      getSelectOption().setText("Select");
-      getSelectOption().addActionListener(new ActionListener()
+      JvSwingUtils.jvInitComponent(selectOption, "action.select");
+      selectOption.addActionListener(new ActionListener()
       {
         @Override
         public void actionPerformed(ActionEvent actionEvent)
@@ -579,10 +610,8 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      getHideOption().setBackground(Color.white);
-      getHideOption().setFont(JvSwingUtils.getLabelFont());
-      getHideOption().setText("Hide");
-      getHideOption().addActionListener(new ActionListener()
+      JvSwingUtils.jvInitComponent(hideOption, "action.hide");
+      hideOption.addActionListener(new ActionListener()
       {
         @Override
         public void actionPerformed(ActionEvent actionEvent)
@@ -591,16 +620,15 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      getOptionsGroup().add(getSelectOption());
-      getOptionsGroup().add(getHideOption());
-      getOptionsGroup().setSelected(getSelectOption().getModel(), true);
+      optionsGroup.add(selectOption);
+      optionsGroup.add(hideOption);
+      optionsGroup.setSelected(selectOption.getModel(), true);
 
-      this.setBackground(Color.white);
-      this.setFont(JvSwingUtils.getLabelFont());
+      JvSwingUtils.jvInitComponent(this);
       syncState();
 
-      this.add(getSelectOption());
-      this.add(getHideOption());
+      this.add(selectOption);
+      this.add(hideOption);
     }
 
     public void selectRadioAction(ActionEvent actionEvent)
@@ -615,47 +643,15 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       aColChooser.hide_action(actionEvent);
     }
 
-    public JRadioButton getHideOption()
-    {
-      return hideOption;
-    }
-
-    public void setHideOption(JRadioButton hideOption)
-    {
-      this.hideOption = hideOption;
-    }
-
-    public JRadioButton getSelectOption()
-    {
-      return selectOption;
-    }
-
-    public void setSelectOption(JRadioButton selectOption)
-    {
-      this.selectOption = selectOption;
-    }
-
-    public ButtonGroup getOptionsGroup()
-    {
-      return optionsGroup;
-    }
-
-    public void setOptionsGroup(ButtonGroup optionsGroup)
-    {
-      this.optionsGroup = optionsGroup;
-    }
-
     public void syncState()
     {
       if (aColChooser.getActionOption() == AnnotationColumnChooser.ACTION_OPTION_HIDE)
       {
-        this.getOptionsGroup().setSelected(this.getHideOption().getModel(),
-                true);
+        this.optionsGroup.setSelected(this.hideOption.getModel(), true);
       }
       else
       {
-        this.getOptionsGroup().setSelected(
-                this.getSelectOption().getModel(), true);
+        this.optionsGroup.setSelected(this.selectOption.getModel(), true);
       }
     }
   }
@@ -676,9 +672,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     {
       this.aColChooser = aColChooser;
 
-      alphaHelix.setBackground(Color.white);
-      alphaHelix.setFont(JvSwingUtils.getLabelFont());
-      alphaHelix.setText("Alpha Helix");
+      JvSwingUtils.jvInitComponent(alphaHelix, "label.alpha_helix");
       alphaHelix.addActionListener(new ActionListener()
       {
         @Override
@@ -688,9 +682,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      betaStrand.setBackground(Color.white);
-      betaStrand.setFont(JvSwingUtils.getLabelFont());
-      betaStrand.setText("Beta Strand");
+      JvSwingUtils.jvInitComponent(betaStrand, "label.beta_strand");
       betaStrand.addActionListener(new ActionListener()
       {
         @Override
@@ -700,9 +692,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      turn.setBackground(Color.white);
-      turn.setFont(JvSwingUtils.getLabelFont());
-      turn.setText("Turn");
+      JvSwingUtils.jvInitComponent(turn, "label.turn");
       turn.addActionListener(new ActionListener()
       {
         @Override
@@ -712,9 +702,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      all.setBackground(Color.white);
-      all.setFont(JvSwingUtils.getLabelFont());
-      all.setText("Select all");
+      JvSwingUtils.jvInitComponent(all, "label.select_all");
       all.addActionListener(new ActionListener()
       {
         @Override
@@ -724,9 +712,9 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      this.setBorder(new TitledBorder("Structures Filter"));
-      this.setBackground(Color.white);
-      this.setFont(JvSwingUtils.getLabelFont());
+      this.setBorder(new TitledBorder(MessageManager
+              .getString("label.structures_filter")));
+      JvSwingUtils.jvInitComponent(this);
 
       this.add(all);
       this.add(alphaHelix);
@@ -792,10 +780,10 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
               .getCurrentStructureFilterPanel();
       if (sfp != null)
       {
-        alphaHelix.setSelected(sfp.getAlphaHelix().isSelected());
-        betaStrand.setSelected(sfp.getBetaStrand().isSelected());
-        turn.setSelected(sfp.getTurn().isSelected());
-        if (sfp.getAll().isSelected())
+        alphaHelix.setSelected(sfp.alphaHelix.isSelected());
+        betaStrand.setSelected(sfp.betaStrand.isSelected());
+        turn.setSelected(sfp.turn.isSelected());
+        if (sfp.all.isSelected())
         {
           all.setSelected(true);
           alphaHelix.setSelected(true);
@@ -805,47 +793,6 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       }
 
     }
-
-    public JCheckBox getAlphaHelix()
-    {
-      return alphaHelix;
-    }
-
-    public void setAlphaHelix(JCheckBox alphaHelix)
-    {
-      this.alphaHelix = alphaHelix;
-    }
-
-    public JCheckBox getBetaStrand()
-    {
-      return betaStrand;
-    }
-
-    public void setBetaStrand(JCheckBox betaStrand)
-    {
-      this.betaStrand = betaStrand;
-    }
-
-    public JCheckBox getTurn()
-    {
-      return turn;
-    }
-
-    public void setTurn(JCheckBox turn)
-    {
-      this.turn = turn;
-    }
-
-    public JCheckBox getAll()
-    {
-      return all;
-    }
-
-    public void setAll(JCheckBox all)
-    {
-      this.all = all;
-
-    }
   }
 
   public class SearchPanel extends JPanel
@@ -858,45 +805,41 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
 
     private JTextField searchBox = new JTextField(10);
 
-    private JCheckBox structuresFilter = new JCheckBox();
-
     public SearchPanel(AnnotationColumnChooser aColChooser)
     {
 
       this.aColChooser = aColChooser;
-      this.setBorder(new TitledBorder("Search Filter"));
-      this.setBackground(Color.white);
-      this.setFont(JvSwingUtils.getLabelFont());
-
-      getSearchBox().setBackground(Color.white);
-      getSearchBox().setFont(JvSwingUtils.getLabelFont());
-      getSearchBox().getDocument().addDocumentListener(
-              new DocumentListener()
-              {
-                @Override
-                public void insertUpdate(DocumentEvent e)
-                {
-                  searchStringAction();
-                }
-
-                @Override
-                public void removeUpdate(DocumentEvent e)
-                {
-                  searchStringAction();
-                }
-
-                @Override
-                public void changedUpdate(DocumentEvent e)
-                {
-                  searchStringAction();
-                }
-              });
-
-      getDisplayName().setBackground(Color.white);
-      getDisplayName().setFont(JvSwingUtils.getLabelFont());
-      getDisplayName().setText("Display Name");
-      getDisplayName().setEnabled(false);
-      getDisplayName().addActionListener(new ActionListener()
+      JvSwingUtils.jvInitComponent(this);
+      this.setBorder(new TitledBorder(MessageManager
+              .getString("label.search_filter")));
+
+      JvSwingUtils.jvInitComponent(searchBox);
+      searchBox.setToolTipText(MessageManager
+              .getString("info.enter_search_text_here"));
+      searchBox.getDocument().addDocumentListener(new DocumentListener()
+      {
+        @Override
+        public void insertUpdate(DocumentEvent e)
+        {
+          searchStringAction();
+        }
+
+        @Override
+        public void removeUpdate(DocumentEvent e)
+        {
+          searchStringAction();
+        }
+
+        @Override
+        public void changedUpdate(DocumentEvent e)
+        {
+          searchStringAction();
+        }
+      });
+
+      JvSwingUtils.jvInitComponent(displayName, "label.label");
+      displayName.setEnabled(false);
+      displayName.addActionListener(new ActionListener()
       {
         @Override
         public void actionPerformed(ActionEvent actionEvent)
@@ -905,11 +848,9 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
         }
       });
 
-      getDescription().setBackground(Color.white);
-      getDescription().setFont(JvSwingUtils.getLabelFont());
-      getDescription().setText("Description");
-      getDescription().setEnabled(false);
-      getDescription().addActionListener(new ActionListener()
+      JvSwingUtils.jvInitComponent(description, "label.description");
+      description.setEnabled(false);
+      description.addActionListener(new ActionListener()
       {
         @Override
         public void actionPerformed(ActionEvent actionEvent)
@@ -919,24 +860,9 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       });
 
       syncState();
-      this.add(getSearchBox());
-      this.add(getDisplayName());
-      this.add(getDescription());
-    }
-
-    public boolean isDescriptionChecked()
-    {
-      return getDescription().isSelected();
-    }
-
-    public boolean isDisplayNameChecked()
-    {
-      return getDisplayName().isSelected();
-    }
-
-    public String getSearchString()
-    {
-      return getSearchBox().getText();
+      this.add(searchBox);
+      this.add(displayName);
+      this.add(description);
     }
 
     public void displayNameCheckboxAction()
@@ -955,46 +881,7 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
     {
       aColChooser.setCurrentSearchPanel(this);
       aColChooser.updateView();
-    }
-
-    public JCheckBox getDisplayName()
-    {
-      return displayName;
-    }
-
-    public void setDisplayName(JCheckBox displayName)
-    {
-      this.displayName = displayName;
-    }
-
-    public JCheckBox getDescription()
-    {
-      return description;
-    }
-
-    public void setDescription(JCheckBox description)
-    {
-      this.description = description;
-    }
-
-    public JTextField getSearchBox()
-    {
-      return searchBox;
-    }
-
-    public void setSearchBox(JTextField searchBox)
-    {
-      this.searchBox = searchBox;
-    }
-
-    public JCheckBox getStructuresFilter()
-    {
-      return structuresFilter;
-    }
-
-    public void setStructuresFilter(JCheckBox structuresFilter)
-    {
-      this.structuresFilter = structuresFilter;
+      updateSearchPanelToolTips();
     }
 
     public void syncState()
@@ -1002,14 +889,31 @@ public class AnnotationColumnChooser extends AnnotationRowFilter implements
       SearchPanel sp = aColChooser.getCurrentSearchPanel();
       if (sp != null)
       {
-        description.setEnabled(sp.getDescription().isEnabled());
-        description.setSelected(sp.getDescription().isSelected());
+        description.setEnabled(sp.description.isEnabled());
+        description.setSelected(sp.description.isSelected());
 
-        displayName.setEnabled(sp.getDisplayName().isEnabled());
-        displayName.setSelected(sp.getDisplayName().isSelected());
+        displayName.setEnabled(sp.displayName.isEnabled());
+        displayName.setSelected(sp.displayName.isSelected());
 
-        searchBox.setText(sp.getSearchBox().getText());
+        searchBox.setText(sp.searchBox.getText());
       }
+      updateSearchPanelToolTips();
+    }
+
+    public void updateSearchPanelToolTips()
+    {
+      String defaultTtip = MessageManager
+              .getString("info.enter_search_text_to_enable");
+      String labelTtip = MessageManager.formatMessage(
+              "info.search_in_annotation_label", annotations
+                      .getSelectedItem().toString());
+      String descTtip = MessageManager.formatMessage(
+              "info.search_in_annotation_description", annotations
+                      .getSelectedItem().toString());
+      displayName.setToolTipText(displayName.isEnabled() ? labelTtip
+              : defaultTtip);
+      description.setToolTipText(description.isEnabled() ? descTtip
+              : defaultTtip);
     }
   }