JAL-1645 source formatting and organise imports
[jalview.git] / src / jalview / jbgui / GStructureChooser.java
index cbd6f1a..c4043c4 100644 (file)
 
 package jalview.jbgui;
 
+import jalview.datamodel.SequenceI;
 import jalview.gui.AlignmentPanel;
 import jalview.gui.Desktop;
+import jalview.gui.JvSwingUtils;
+import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
 import jalview.util.MessageManager;
-import jalview.ws.uimodel.PDBRestResponse.PDBResponseSummary;
+import jalview.ws.dbsources.PDBRestClient;
+import jalview.ws.dbsources.PDBRestClient.PDBDocField;
 
 import java.awt.BorderLayout;
 import java.awt.CardLayout;
@@ -33,6 +37,9 @@ import java.awt.FlowLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.ItemEvent;
 import java.awt.event.ItemListener;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.Arrays;
 
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
@@ -41,12 +48,15 @@ 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.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
-import javax.swing.ListSelectionModel;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
 
 @SuppressWarnings("serial")
 /**
@@ -66,24 +76,32 @@ public abstract class GStructureChooser extends JPanel implements
 
   protected AlignmentPanel ap;
 
+  protected StringBuilder errorWarning = new StringBuilder();
+
   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_main = new JPanel();
+
+  private JPanel pnl_idInput = new JPanel(new FlowLayout());
+
+  private JPanel pnl_fileChooser = new JPanel(new FlowLayout());
 
-  private JPanel pnl_idInput = new JPanel();
+  private JPanel pnl_idInputBL = new JPanel(new BorderLayout());
 
-  private JPanel pnl_fileChooser = new JPanel();
+  private JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
+
+  private JPanel pnl_locPDB = new JPanel(new BorderLayout());
 
   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 
@@ -101,20 +119,72 @@ 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 ImageIcon warningImage = new ImageIcon(getClass().getResource(
+          "/images/warning.gif"));
+
+  protected JLabel lbl_warning = new JLabel(warningImage);
+
   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 static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
+
+  protected JTable tbl_summary = new JTable()
+  {
+    public String getToolTipText(MouseEvent evt)
+    {
+      String toolTipText = null;
+      java.awt.Point pnt = evt.getPoint();
+      int rowIndex = rowAtPoint(pnt);
+      int colIndex = columnAtPoint(pnt);
+
+      try
+      {
+        toolTipText = getValueAt(rowIndex, colIndex).toString();
+      } catch (Exception e)
+      {
+        e.printStackTrace();
+      }
+      toolTipText = (toolTipText == null ? null
+              : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
+                      true, "\"" + toolTipText.subSequence(0, 500)
+                              + "...\"") : JvSwingUtils.wrapTooltip(true,
+                      toolTipText)));
+      return toolTipText;
+    }
+  };
+
+  protected JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
+
+  protected JTable tbl_local_pdb = new JTable();
 
-  protected JTable tbl_summary = new JTable();
+  protected JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
 
-  protected JScrollPane scrl_foundStructures = new JScrollPane(
-          tbl_summary);
+  private JTabbedPane pnl_filter = new JTabbedPane();
+
+  private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
+          PreferenceSource.STRUCTURE_CHOOSER);
+
+  protected PDBDocField[] previousWantedFields;
 
   public GStructureChooser()
   {
@@ -137,9 +207,26 @@ 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()
+    tbl_summary.setAutoCreateRowSorter(true);
+    tbl_summary.getTableHeader().setReorderingAllowed(false);
+    tbl_local_pdb.setAutoCreateRowSorter(true);
+    tbl_local_pdb.getTableHeader().setReorderingAllowed(false);
+    tbl_local_pdb.addMouseListener(new MouseAdapter()
+    {
+      public void mouseClicked(MouseEvent e)
+      {
+        updateCurrentView();
+      }
+
+      public void mouseReleased(MouseEvent e)
+      {
+        updateCurrentView();
+      }
+    });
+
+    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 +245,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,45 +254,115 @@ 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);
 
+    scrl_localPDB.setPreferredSize(new Dimension(500, 300));
+    scrl_localPDB
+            .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
+
     cmb_filterOption.setFont(new java.awt.Font("Verdana", 0, 12));
     chk_invertFilter.setFont(new java.awt.Font("Verdana", 0, 12));
     chk_rememberSettings.setFont(new java.awt.Font("Verdana", 0, 12));
+    chk_rememberSettings.setVisible(false);
+
+    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();
+      }
+
+      @Override
+      public void removeUpdate(DocumentEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
+
+      @Override
+      public void changedUpdate(DocumentEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
+    });
 
     cmb_filterOption.addItemListener(this);
     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(cmb_filterOption);
+    // pnl_filter.add(lbl_result);
+    pnl_main.add(cmb_filterOption);
+    pnl_main.add(lbl_loading);
+    pnl_main.add(chk_invertFilter);
     lbl_loading.setVisible(false);
 
-    pnl_filter.add(lbl_loading);
-
-    pnl_filter.add(chk_invertFilter);
+    pnl_fileChooser.add(btn_pdbFromFile);
+    pnl_fileChooser.add(lbl_fromFileStatus);
+    pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
+    pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 
-    pnl_idInput.setLayout(new FlowLayout());
     pnl_idInput.add(txt_search);
+    pnl_idInput.add(lbl_pdbManualFetchStatus);
+    pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
+    pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
+
+    final String foundStructureSummary = MessageManager
+            .getString("label.found_structures_summary");
+    final String configureCols = MessageManager
+            .getString("label.configure_displayed_columns");
+    ChangeListener changeListener = new ChangeListener()
+    {
+      public void stateChanged(ChangeEvent changeEvent)
+      {
+        JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
+                .getSource();
+        int index = sourceTabbedPane.getSelectedIndex();
+        if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
+        {
+          btn_view.setEnabled(false);
+          btn_cancel.setEnabled(false);
+          previousWantedFields = PDBDocFieldPreferences
+                  .getStructureSummaryFields().toArray(
+                          new PDBRestClient.PDBDocField[0]);
+        }
+        if (sourceTabbedPane.getTitleAt(index)
+                .equals(foundStructureSummary))
+        {
+          btn_cancel.setEnabled(true);
+          if (wantedFieldsUpdated())
+          {
+            tabRefresh();
+          }
+          else
+          {
+            validateSelections();
+          }
+        }
+      }
+    };
+    pnl_filter.addChangeListener(changeListener);
+    pnl_filter.setPreferredSize(new Dimension(500, 300));
+    pnl_filter.add(foundStructureSummary, scrl_foundStructures);
+    pnl_filter.add(configureCols, pdbDocFieldPrefs);
 
-    pnl_fileChooser.setLayout(new FlowLayout());
-    pnl_fileChooser.add(btn_pdbFromFile);
+    pnl_locPDB.add(scrl_localPDB);
+
+    pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
+    pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
+    pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
+    pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
 
-    pnl_switchableViews.add(pnl_fileChooser, VIEWS_FROM_FILE);
-    pnl_switchableViews.add(pnl_idInput, VIEWS_ENTER_ID);
-    pnl_switchableViews.add(scrl_foundStructures, VIEWS_FILTER);
-    
     this.setLayout(mainLayout);
-    this.add(pnl_filter, java.awt.BorderLayout.NORTH);
+    this.add(pnl_main, java.awt.BorderLayout.NORTH);
     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 
@@ -215,7 +372,19 @@ public abstract class GStructureChooser extends JPanel implements
     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
   }
 
-  
+  public boolean wantedFieldsUpdated()
+  {
+    if (previousWantedFields == null)
+    {
+      return true;
+    }
+
+    return Arrays.equals(PDBDocFieldPreferences.getStructureSummaryFields()
+            .toArray(new PDBRestClient.PDBDocField[0]),
+            previousWantedFields) ? false : true;
+
+  }
+
   @Override
   /**
    * Event listener for the 'filter' combo-box and 'invert' check-box
@@ -282,6 +451,108 @@ 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>();
+
+    private JLabel lbl_associateSeq = new JLabel();
+
+    public AssciateSeqPanel()
+    {
+      this.setLayout(new FlowLayout());
+      this.add(cmb_assSeq);
+      this.add(lbl_associateSeq);
+      cmb_assSeq.setToolTipText(MessageManager
+              .getString("info.associate_wit_sequence"));
+      cmb_assSeq.addItemListener(this);
+    }
+
+    public void loadCmbAssSeq()
+    {
+      populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
+    }
+
+    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 +562,20 @@ 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, JLabel lbl_associateSeq);
+
+  public abstract void cmbAssSeqStateChanged();
+
+  public abstract void tabRefresh();
+
+  public abstract void validateSelections();
 }