JAL-2045 JAL-2047 improvement for sorting PDB quality measure numerically, and improv...
[jalview.git] / src / jalview / jbgui / GPDBSearchPanel.java
index b350a0f..d640df8 100644 (file)
 package jalview.jbgui;
 
 import jalview.gui.Desktop;
+import jalview.gui.JvSwingUtils;
+import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
 import jalview.util.MessageManager;
 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
 
 import java.awt.BorderLayout;
+import java.awt.CardLayout;
 import java.awt.Dimension;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.awt.event.KeyAdapter;
+import java.awt.event.KeyEvent;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.Arrays;
 
+import javax.swing.ImageIcon;
 import javax.swing.JButton;
 import javax.swing.JComboBox;
 import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
+import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
+import javax.swing.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 
@@ -60,30 +73,71 @@ public abstract class GPDBSearchPanel extends JPanel
   protected JButton btn_ok = new JButton();
 
   protected JButton btn_back = new JButton();
-  
+
   protected JButton btn_cancel = new JButton();
-  
+
   protected JTextField txt_search = new JTextField(20);
-  
-  // protected JList<PDBResponseSummary> lst_searchResult = new
-  // JList<PDBResponseSummary>();
 
-  // protected JScrollPane scrl_searchResult = new JScrollPane(
-  // lst_searchResult);
+  protected JTable tbl_summary = new JTable()
+  {
+    @Override
+    public String getToolTipText(MouseEvent evt)
+    {
+      String toolTipText = null;
+      java.awt.Point pnt = evt.getPoint();
+      int rowIndex = rowAtPoint(pnt);
+      int colIndex = columnAtPoint(pnt);
+
+      try
+      {
+        if (getValueAt(rowIndex, colIndex) == null)
+        {
+          return null;
+        }
+        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 StringBuilder errorWarning = new StringBuilder();
+
+  protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
+
+  protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
+          "/images/warning.gif"));
+
+  protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
+          "/images/loading.gif"));
+
+  protected JLabel lbl_warning = new JLabel(warningImage);
+
+  protected JLabel lbl_loading = new JLabel(loadingImage);
 
-  protected JTable tbl_summary = new JTable();
+  private JTabbedPane tabbedPane = new JTabbedPane();
 
-  protected JScrollPane scrl_searchResult = new JScrollPane(
-tbl_summary);
+  private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
+          PreferenceSource.SEARCH_SUMMARY);
 
   private JPanel pnl_actions = new JPanel();
 
-  private JPanel pnl_results = new JPanel();
+  private JPanel pnl_results = new JPanel(new CardLayout());
 
   private JPanel pnl_inputs = new JPanel();
 
   private BorderLayout mainLayout = new BorderLayout();
 
+  protected PDBDocField[] previousWantedFields;
+
   public GPDBSearchPanel()
   {
     try
@@ -104,46 +158,133 @@ tbl_summary);
    */
   private void jbInit() throws Exception
   {
+    lbl_warning.setVisible(false);
+    lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
+    lbl_loading.setVisible(false);
+    lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
+
+    tbl_summary.setAutoResizeMode(JTable.AUTO_RESIZE_ALL_COLUMNS);
+    tbl_summary.setAutoCreateRowSorter(true);
+    tbl_summary.getTableHeader().setReorderingAllowed(false);
+    tbl_summary.addMouseListener(new MouseAdapter()
+    {
+      @Override
+      public void mouseClicked(MouseEvent e)
+      {
+        validateSelection();
+      }
+
+      @Override
+      public void mouseReleased(MouseEvent e)
+      {
+        validateSelection();
+      }
+    });
+    tbl_summary.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        validateSelection();
+        switch (evt.getKeyCode())
+        {
+        case KeyEvent.VK_ESCAPE: // escape key
+          btn_back_ActionPerformed();
+          break;
+        case KeyEvent.VK_ENTER: // enter key
+          if (btn_ok.isEnabled())
+          {
+            btn_ok_ActionPerformed();
+          }
+          evt.consume();
+          break;
+        case KeyEvent.VK_TAB: // tab key
+          if (evt.isShiftDown())
+          {
+            tabbedPane.requestFocus();
+          }
+          else
+          {
+            btn_back.requestFocus();
+          }
+          evt.consume();
+          break;
+        default:
+          return;
+        }
+      }
+    });
+
     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_back.setText(MessageManager.getString("action.back"));
     btn_back.addActionListener(new java.awt.event.ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent e)
       {
         btn_back_ActionPerformed();
       }
     });
+    btn_back.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          btn_back_ActionPerformed();
+        }
+      }
+    });
+
+    btn_ok.setEnabled(false);
     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_ok.setText(MessageManager.getString("action.ok"));
     btn_ok.addActionListener(new java.awt.event.ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent e)
       {
         btn_ok_ActionPerformed();
       }
     });
+    btn_ok.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          btn_ok_ActionPerformed();
+        }
+      }
+    });
+
     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_cancel.setText(MessageManager.getString("action.cancel"));
     btn_cancel.addActionListener(new java.awt.event.ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent e)
       {
         btn_cancel_ActionPerformed();
       }
     });
-    pnl_actions.add(btn_back);
-    pnl_actions.add(btn_ok);
-    pnl_actions.add(btn_cancel);
-
-    // lst_searchResult
-    // .setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
-    // lst_searchResult.setLayoutOrientation(JList.VERTICAL);
-    // lst_searchResult.setVisibleRowCount(-1);
+    btn_cancel.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          btn_cancel_ActionPerformed();
+        }
+      }
+    });
 
     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
     scrl_searchResult
             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
-    pnl_results.add(scrl_searchResult);
 
     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
     cmb_searchTarget.addActionListener(new ActionListener()
@@ -151,6 +292,27 @@ tbl_summary);
       @Override
       public void actionPerformed(ActionEvent e)
       {
+        String tooltipText;
+        if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
+                .toString()))
+        {
+          tooltipText = MessageManager.getString("label.search_all");
+        }
+        else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
+                .getSelectedItem().toString()))
+        {
+          tooltipText = MessageManager
+                  .getString("label.separate_multiple_accession_ids");
+        }
+        else
+        {
+          tooltipText = MessageManager.formatMessage(
+                  "label.separate_multiple_query_values",
+                  new Object[] { getCmbSearchTarget().getSelectedItem()
+                          .toString() });
+        }
+        txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
+                tooltipText));
         txt_search_ActionPerformed();
       }
     });
@@ -158,6 +320,28 @@ tbl_summary);
     populateCmbSearchTargetOptions();
 
     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
+
+    txt_search.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent e)
+      {
+        if (e.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          if (txt_search.getText() == null
+                  || txt_search.getText().isEmpty())
+          {
+            return;
+          }
+          if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
+                  .getSelectedItem().toString()))
+          {
+            transferToSequenceFetcher(txt_search.getText());
+          }
+        }
+      }
+    });
+
     txt_search.getDocument().addDocumentListener(new DocumentListener()
     {
       @Override
@@ -179,8 +363,62 @@ tbl_summary);
       }
     });
 
+    final String searchTabTitle = MessageManager
+            .getString("label.search_result");
+    final String configureCols = MessageManager
+            .getString("label.configure_displayed_columns");
+    ChangeListener changeListener = new ChangeListener()
+    {
+      @Override
+      public void stateChanged(ChangeEvent changeEvent)
+      {
+        JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
+                .getSource();
+        int index = sourceTabbedPane.getSelectedIndex();
+
+        btn_back.setVisible(true);
+        btn_cancel.setVisible(true);
+        btn_ok.setVisible(true);
+        if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
+        {
+          btn_back.setVisible(false);
+          btn_cancel.setVisible(false);
+          btn_ok.setVisible(false);
+          btn_back.setEnabled(false);
+          btn_cancel.setEnabled(false);
+          btn_ok.setEnabled(false);
+          previousWantedFields = PDBDocFieldPreferences
+                  .getSearchSummaryFields().toArray(new PDBDocField[0]);
+        }
+        if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
+        {
+          btn_back.setEnabled(true);
+          btn_cancel.setEnabled(true);
+          if (wantedFieldsUpdated())
+          {
+            txt_search_ActionPerformed();
+          }
+          else
+          {
+            validateSelection();
+          }
+        }
+      }
+    };
+    tabbedPane.addChangeListener(changeListener);
+    tabbedPane.setPreferredSize(new Dimension(500, 300));
+    tabbedPane.add(searchTabTitle, scrl_searchResult);
+    tabbedPane.add(configureCols, pdbDocFieldPrefs);
+
+    pnl_actions.add(btn_back);
+    pnl_actions.add(btn_ok);
+    pnl_actions.add(btn_cancel);
+
+    pnl_results.add(tabbedPane);
     pnl_inputs.add(cmb_searchTarget);
     pnl_inputs.add(txt_search);
+    pnl_inputs.add(lbl_loading);
+    pnl_inputs.add(lbl_warning);
 
     this.setLayout(mainLayout);
     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
@@ -192,6 +430,31 @@ tbl_summary);
     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
   }
 
+  public boolean wantedFieldsUpdated()
+  {
+    if (previousWantedFields == null)
+    {
+      return true;
+    }
+
+    return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
+            .toArray(new PDBDocField[0]), previousWantedFields) ? false
+            : true;
+
+  }
+
+  public void validateSelection()
+  {
+    if (tbl_summary.getSelectedRows().length > 0)
+    {
+      btn_ok.setEnabled(true);
+    }
+    else
+    {
+      btn_ok.setEnabled(false);
+    }
+  }
+
   public JComboBox<PDBDocField> getCmbSearchTarget()
   {
     return cmb_searchTarget;
@@ -207,6 +470,8 @@ tbl_summary);
     return mainFrame;
   }
 
+  public abstract void transferToSequenceFetcher(String ids);
+
   public abstract void txt_search_ActionPerformed();
 
   public abstract void btn_ok_ActionPerformed();