JAL-1668 added validation for manual entry of pdb structures
[jalview.git] / src / jalview / jbgui / GStructureChooser.java
index cbd6f1a..080fce9 100644 (file)
 
 package jalview.jbgui;
 
+import jalview.datamodel.SequenceI;
 import jalview.gui.AlignmentPanel;
 import jalview.gui.Desktop;
 import jalview.util.MessageManager;
-import jalview.ws.uimodel.PDBRestResponse.PDBResponseSummary;
 
 import java.awt.BorderLayout;
 import java.awt.CardLayout;
@@ -41,12 +41,12 @@ import javax.swing.JComboBox;
 import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
 import javax.swing.JLabel;
-import javax.swing.JList;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
-import javax.swing.ListSelectionModel;
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
 
 @SuppressWarnings("serial")
 /**
@@ -64,26 +64,31 @@ public abstract class GStructureChooser extends JPanel implements
 
   protected JComboBox<FilterOption> cmb_filterOption = new JComboBox<FilterOption>();
 
+
   protected AlignmentPanel ap;
 
   protected JLabel lbl_result = new JLabel(
-          MessageManager.getString("label.select") /* "Select : " */);
+          MessageManager.getString("label.select"));
 
-  protected JButton btn_ok = new JButton();
+  protected JButton btn_view = new JButton();
 
   protected JButton btn_cancel = new JButton();
 
   protected JButton btn_pdbFromFile = new JButton();
 
-  protected JTextField txt_search = new JTextField(18);
+  protected JTextField txt_search = new JTextField(14);
 
   private JPanel pnl_actions = new JPanel();
 
   private JPanel pnl_filter = new JPanel();
 
-  private JPanel pnl_idInput = new JPanel();
+  private JPanel pnl_idInput = new JPanel(new FlowLayout());
+
+  private JPanel pnl_fileChooser = new JPanel(new FlowLayout());
+
+  private JPanel pnl_idInputBL = new JPanel(new BorderLayout());
 
-  private JPanel pnl_fileChooser = new JPanel();
+  private JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
 
   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 
@@ -101,15 +106,30 @@ public abstract class GStructureChooser extends JPanel implements
   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
           "/images/loading.gif"));
 
+  protected ImageIcon goodImage = new ImageIcon(getClass().getResource(
+          "/images/good.png"));
+
+  protected ImageIcon errorImage = new ImageIcon(getClass().getResource(
+          "/images/error.png"));
+
   protected JLabel lbl_loading = new JLabel(loadingImage);
 
+  protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
+
+  protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
+
+  protected AssciateSeqPanel idInputAssSeqPanel = new AssciateSeqPanel();
+
+  protected AssciateSeqPanel fileChooserAssSeqPanel = new AssciateSeqPanel();
+
   protected static final String VIEWS_FILTER = "VIEWS_FILTER";
 
   protected static final String VIEWS_FROM_FILE = "VIEWS_FROM_FILE";
 
   protected static final String VIEWS_ENTER_ID = "VIEWS_ENTER_ID";
 
-  protected JList<PDBResponseSummary> jList_FoundStructures = new JList<PDBResponseSummary>();
+  // protected JList<PDBResponseSummary> jList_FoundStructures = new
+  // JList<PDBResponseSummary>();
 
   protected JTable tbl_summary = new JTable();
 
@@ -137,9 +157,9 @@ public abstract class GStructureChooser extends JPanel implements
    */
   private void jbInit() throws Exception
   {
-    btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
-    btn_ok.setText(MessageManager.getString("action.view"));
-    btn_ok.addActionListener(new java.awt.event.ActionListener()
+    btn_view.setFont(new java.awt.Font("Verdana", 0, 12));
+    btn_view.setText(MessageManager.getString("action.view"));
+    btn_view.addActionListener(new java.awt.event.ActionListener()
     {
       public void actionPerformed(ActionEvent e)
       {
@@ -158,7 +178,7 @@ public abstract class GStructureChooser extends JPanel implements
 
     btn_pdbFromFile.setFont(new java.awt.Font("Verdana", 0, 12));
     String btn_title = MessageManager.getString("label.select_pdb_file");
-    btn_pdbFromFile.setText("             " + btn_title + "            ");
+    btn_pdbFromFile.setText(btn_title + "              ");
     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
     {
       public void actionPerformed(ActionEvent e)
@@ -167,10 +187,6 @@ public abstract class GStructureChooser extends JPanel implements
       }
     });
 
-    jList_FoundStructures
-            .setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
-    jList_FoundStructures.setLayoutOrientation(JList.VERTICAL);
-    jList_FoundStructures.setVisibleRowCount(-1);
     scrl_foundStructures.setPreferredSize(new Dimension(500, 300));
     scrl_foundStructures
             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
@@ -183,25 +199,53 @@ public abstract class GStructureChooser extends JPanel implements
     chk_invertFilter.addItemListener(this);
 
     pnl_actions.add(chk_rememberSettings);
-    pnl_actions.add(btn_ok);
+    pnl_actions.add(btn_view);
     pnl_actions.add(btn_cancel);
 
-    pnl_filter.add(lbl_result);
+    // pnl_filter.add(lbl_result);
     pnl_filter.add(cmb_filterOption);
+    pnl_filter.add(lbl_loading);
+    pnl_filter.add(chk_invertFilter);
     lbl_loading.setVisible(false);
 
-    pnl_filter.add(lbl_loading);
+    txt_search.setToolTipText(MessageManager
+            .getString("label.enter_pdb_id"));
+    cmb_filterOption.setToolTipText(MessageManager
+            .getString("info.select_filter_option"));
+    txt_search.getDocument().addDocumentListener(new DocumentListener()
+    {
+      @Override
+      public void insertUpdate(DocumentEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
 
-    pnl_filter.add(chk_invertFilter);
+      @Override
+      public void removeUpdate(DocumentEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
 
-    pnl_idInput.setLayout(new FlowLayout());
+      @Override
+      public void changedUpdate(DocumentEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
+    });
     pnl_idInput.add(txt_search);
+    pnl_idInput.add(lbl_pdbManualFetchStatus);
 
-    pnl_fileChooser.setLayout(new FlowLayout());
     pnl_fileChooser.add(btn_pdbFromFile);
+    pnl_fileChooser.add(lbl_fromFileStatus);
+
+    pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
+    pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
+
+    pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
+    pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 
-    pnl_switchableViews.add(pnl_fileChooser, VIEWS_FROM_FILE);
-    pnl_switchableViews.add(pnl_idInput, VIEWS_ENTER_ID);
+    pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
+    pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
     pnl_switchableViews.add(scrl_foundStructures, VIEWS_FILTER);
     
     this.setLayout(mainLayout);
@@ -282,6 +326,103 @@ public abstract class GStructureChooser extends JPanel implements
     }
   }
 
+  /**
+   * This inner class provides the provides the data model for associate
+   * sequence combo-box - cmb_assSeq
+   * 
+   * @author tcnofoegbu
+   *
+   */
+  public class AssociateSeqOptions
+  {
+    private SequenceI sequence;
+    private String name;
+
+    public AssociateSeqOptions(SequenceI seq)
+    {
+      this.sequence = seq;
+      this.name = (seq.getName().length() >= 23) ? seq.getName().substring(
+              0, 23) : seq.getName();
+    }
+
+    public AssociateSeqOptions(String name, SequenceI seq)
+    {
+      this.name = name;
+      this.sequence = seq;
+    }
+
+    public String toString()
+    {
+      return name;
+    }
+
+    public String getName()
+    {
+      return name;
+    }
+
+    public void setName(String name)
+    {
+      this.name = name;
+    }
+
+    public SequenceI getSequence()
+    {
+      return sequence;
+    }
+
+    public void setSequence(SequenceI sequence)
+    {
+      this.sequence = sequence;
+    }
+
+  }
+
+  /**
+   * This inner class holds the Layout and configuration of the panel which
+   * handles association of manually fetched structures to a unique sequence
+   * when more than one sequence selection is made
+   * 
+   * @author tcnofoegbu
+   *
+   */
+  public class AssciateSeqPanel extends JPanel implements ItemListener
+  {
+    private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<AssociateSeqOptions>();
+    public AssciateSeqPanel()
+    {
+      this.setLayout(new FlowLayout());
+      this.add(cmb_assSeq);
+      cmb_assSeq.setToolTipText(MessageManager
+              .getString("info.associate_wit_sequence"));
+      cmb_assSeq.addItemListener(this);
+    }
+
+    public void loadCmbAssSeq()
+    {
+      populateCmbAssociateSeqOptions(cmb_assSeq);
+    }
+
+    public JComboBox<AssociateSeqOptions> getCmb_assSeq()
+    {
+      return cmb_assSeq;
+    }
+
+    public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
+    {
+      this.cmb_assSeq = cmb_assSeq;
+    }
+
+    @Override
+    public void itemStateChanged(ItemEvent e)
+    {
+      if (e.getStateChange() == ItemEvent.SELECTED)
+      {
+        cmbAssSeqStateChanged();
+      }
+    }
+  }
+
   public JComboBox<FilterOption> getCmbFilterOption()
   {
     return cmb_filterOption;
@@ -291,9 +432,16 @@ public abstract class GStructureChooser extends JPanel implements
 
   protected abstract void updateCurrentView();
 
-  protected abstract void ok_ActionPerformed();
-
   protected abstract void populateFilterComboBox();
 
+  protected abstract void ok_ActionPerformed();
+
   protected abstract void pdbFromFile_actionPerformed();
+
+  protected abstract void txt_search_ActionPerformed();
+
+  public abstract void populateCmbAssociateSeqOptions(
+          JComboBox<AssociateSeqOptions> cmb_assSeq);
+
+  public abstract void cmbAssSeqStateChanged();
 }