JAL-2804 update search results when enter pressed or query retrieved from history
[jalview.git] / src / jalview / fts / core / GFTSPanel.java
index 30b6417..67f1fdc 100644 (file)
@@ -28,6 +28,7 @@ import jalview.gui.Desktop;
 import jalview.gui.IProgressIndicator;
 import jalview.gui.JvSwingUtils;
 import jalview.gui.SequenceFetcher;
+import jalview.io.cache.JvCacheableInputBox;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -38,6 +39,8 @@ import java.awt.event.ActionListener;
 import java.awt.event.FocusAdapter;
 import java.awt.event.FocusEvent;
 import java.awt.event.FocusListener;
+import java.awt.event.ItemEvent;
+import java.awt.event.ItemListener;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
@@ -53,6 +56,7 @@ import java.util.List;
 
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
+import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
@@ -61,7 +65,6 @@ import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTable;
-import javax.swing.JTextField;
 import javax.swing.Timer;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
@@ -70,6 +73,7 @@ import javax.swing.event.DocumentListener;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.table.DefaultTableModel;
 import javax.swing.table.TableColumn;
+import javax.swing.text.JTextComponent;
 
 /**
  * This class provides the swing GUI layout for FTS Panel and implements most of
@@ -95,7 +99,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected JButton btn_cancel = new JButton();
 
-  protected JTextField txt_search = new JTextField(30);
+  protected JCheckBox btn_autosearch = new JCheckBox();
+
+  protected JvCacheableInputBox<String> txt_search;
 
   protected SequenceFetcher seqFetcher;
 
@@ -109,14 +115,14 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected StringBuilder errorWarning = new StringBuilder();
 
-  protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
-          "/images/warning.gif"));
+  protected ImageIcon warningImage = new ImageIcon(
+          getClass().getResource("/images/warning.gif"));
 
-  protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
-          "/images/loading.gif"));
+  protected ImageIcon loadingImage = new ImageIcon(
+          getClass().getResource("/images/loading.gif"));
 
-  protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
-          .getResource("/images/blank_16x16_placeholder.png"));
+  protected ImageIcon balnkPlaceholderImage = new ImageIcon(
+          getClass().getResource("/images/blank_16x16_placeholder.png"));
 
   protected JLabel lbl_warning = new JLabel(warningImage);
 
@@ -146,8 +152,13 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected HashSet<String> paginatorCart = new HashSet<String>();
 
+  private static final int MIN_WIDTH = 670;
+
+  private static final int MIN_HEIGHT = 300;
+
   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
           "###,###");
+
   private JTable tbl_summary = new JTable()
   {
     private boolean inLayout;
@@ -218,13 +229,15 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
         e.printStackTrace();
       }
       toolTipText = (toolTipText == null ? null
-              : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
-                      true, toolTipText.subSequence(0, 500) + "...")
+              : (toolTipText.length() > 500
+                      ? JvSwingUtils.wrapTooltip(true,
+                              toolTipText.subSequence(0, 500) + "...")
                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 
       return toolTipText;
     }
   };
+
   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 
   public GFTSPanel()
@@ -232,6 +245,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     try
     {
       jbInit();
+      mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
       mainFrame.addFocusListener(new FocusAdapter()
       {
         @Override
@@ -255,6 +269,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
    */
   private void jbInit() throws Exception
   {
+
+    txt_search = new JvCacheableInputBox<String>(getCacheKey());
+    populateCmbSearchTargetOptions();
     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
             : getTempUserPrefs().get("FTSPanel.width");
     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
@@ -317,6 +334,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       }
     });
 
+    btn_autosearch.setText("");
+    btn_autosearch.setToolTipText(
+            MessageManager.getString("option.enable_disable_autosearch"));
     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()
@@ -362,8 +382,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       }
     });
     btn_next_page.setEnabled(false);
-    btn_next_page.setToolTipText(MessageManager
-            .getString("label.next_page_tooltip"));
+    btn_next_page.setToolTipText(
+            MessageManager.getString("label.next_page_tooltip"));
     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_next_page.setText(MessageManager.getString("action.next_page"));
     btn_next_page.addActionListener(new java.awt.event.ActionListener()
@@ -387,8 +407,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     });
 
     btn_prev_page.setEnabled(false);
-    btn_prev_page.setToolTipText(MessageManager
-            .getString("label.prev_page_tooltip"));
+    btn_prev_page.setToolTipText(
+            MessageManager.getString("label.prev_page_tooltip"));
     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
@@ -446,79 +466,84 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     scrl_searchResult.setPreferredSize(new Dimension(width, height));
 
     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
-    cmb_searchTarget.addActionListener(new ActionListener()
+    cmb_searchTarget.addItemListener(new ItemListener()
     {
       @Override
-      public void actionPerformed(ActionEvent e)
+      public void itemStateChanged(ItemEvent e)
       {
-        String tooltipText;
-        if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
-                .toString()))
-        {
-          tooltipText = MessageManager.getString("label.search_all");
-        }
-        else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
-                .getSelectedItem().toString()))
+        if (e.getStateChange() == ItemEvent.SELECTED)
         {
-          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));
-        searchAction(true);
-      }
-    });
-
-    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())
+          String tooltipText;
+          if ("all".equalsIgnoreCase(
+                  getCmbSearchTarget().getSelectedItem().toString()))
           {
-            return;
+            tooltipText = MessageManager.getString("label.search_all");
           }
-          String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
-                  .getName();
-          if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
-                  .getSelectedItem().toString()))
+          else if ("pdb id".equalsIgnoreCase(
+                  getCmbSearchTarget().getSelectedItem().toString()))
+          {
+            tooltipText = MessageManager
+                    .getString("label.separate_multiple_accession_ids");
+          }
+          else
           {
-            transferToSequenceFetcher(txt_search.getText());
+            tooltipText = MessageManager.formatMessage(
+                    "label.separate_multiple_query_values", new Object[]
+                    { getCmbSearchTarget().getSelectedItem().toString() });
           }
+          txt_search.setToolTipText(
+                  JvSwingUtils.wrapTooltip(true, tooltipText));
+          searchAction(true);
         }
       }
     });
 
+    txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
+
+    txt_search.getEditor().getEditorComponent()
+            .addKeyListener(new KeyAdapter()
+            {
+              @Override
+              public void keyPressed(KeyEvent e)
+              {
+                if (e.getKeyCode() == KeyEvent.VK_ENTER)
+                {
+                  if (getTypedText() == null || getTypedText().isEmpty())
+                  {
+                    return;
+                  }
+                  String primaryKeyName = getFTSRestClient()
+                          .getPrimaryKeyColumn().getName();
+                  if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
+                          .getSelectedItem().toString()))
+                  {
+                    // TODO: nicer to show the list in the result set before
+                    // viewing in Jalview perhaps ?
+                    transferToSequenceFetcher(getTypedText());
+                  }
+                  else
+                  {
+                    performSearchAction();
+                  }
+                }
+              }
+            });
     final DeferredTextInputListener listener = new DeferredTextInputListener(
-            1500,
-            new ActionListener()
+            1500, new ActionListener()
             {
               @Override
               public void actionPerformed(ActionEvent e)
               {
-                if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
+                if (btn_autosearch.isSelected()
+                        || txt_search.wasEnterPressed())
                 {
-                  searchAction(true);
-                  paginatorCart.clear();
-                  lastSearchTerm = getTypedText();
+                  performSearchAction();
                 }
               }
             }, false);
-    txt_search.getDocument().addDocumentListener(listener);
+    ((JTextComponent) txt_search.getEditor().getEditorComponent())
+            .getDocument().addDocumentListener(listener);
+
     txt_search.addFocusListener(new FocusListener()
     {
       @Override
@@ -530,10 +555,19 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       @Override
       public void focusLost(FocusEvent e)
       {
-//        listener.stop();
+        // listener.stop();
       }
     });
 
+    txt_search.addActionListener(new ActionListener()
+    {
+
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        performSearchAction();
+      }
+    });
     final String searchTabTitle = MessageManager
             .getString("label.search_result");
     final String configureCols = MessageManager
@@ -598,6 +632,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     pnl_results.add(tabbedPane);
     pnl_inputs.add(cmb_searchTarget);
     pnl_inputs.add(txt_search);
+    pnl_inputs.add(btn_autosearch);
     pnl_inputs.add(lbl_loading);
     pnl_inputs.add(lbl_warning);
     pnl_inputs.add(lbl_blank);
@@ -611,8 +646,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     mainFrame.setVisible(true);
     mainFrame.setContentPane(this);
     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
-    mainFrame
-            .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
+    mainFrame.addInternalFrameListener(
+            new javax.swing.event.InternalFrameAdapter()
             {
               @Override
               public void internalFrameClosing(InternalFrameEvent e)
@@ -634,17 +669,14 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected void closeAction()
   {
-    // System.out.println(">>>>>>>>>> closing internal frame!!!");
-    // System.out.println("width : " + this.getWidth());
-    // System.out.println("heigh : " + this.getHeight());
-    // System.out.println("x : " + mainFrame.getX());
-    // System.out.println("y : " + mainFrame.getY());
     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
     mainFrame.dispose();
+    txt_search.persistCache();
   }
+
   public class DeferredTextInputListener implements DocumentListener
   {
     private final Timer swingTimer;
@@ -686,17 +718,28 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   }
 
+  void performSearchAction()
+  {
+    String typed = getTypedText();
+    if (typed != null && typed.length() > 0
+            && !typed.equalsIgnoreCase(lastSearchTerm))
+    {
+      searchAction(true);
+      paginatorCart.clear();
+      lastSearchTerm = typed;
+    }
+  }
+
   public boolean wantedFieldsUpdated()
   {
     if (previousWantedFields == null)
     {
-      return true;
+      return false;
     }
 
     return Arrays.equals(getFTSRestClient()
-            .getAllDefaultDisplayedFTSDataColumns()
-            .toArray(new Object[0]), previousWantedFields) ? false
-            : true;
+            .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
+            previousWantedFields) ? false : true;
 
   }
 
@@ -718,7 +761,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     return cmb_searchTarget;
   }
 
-  public JTextField getTxtSearch()
+  public JComboBox<String> getTxtSearch()
   {
     return txt_search;
   }
@@ -757,8 +800,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     {
       lbl_loading.setVisible(false);
       lbl_blank.setVisible(false);
-      lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
-              errorWarning.toString()));
+      lbl_warning.setToolTipText(
+              JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
       lbl_warning.setVisible(true);
     }
   }
@@ -812,10 +855,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     }
   }
 
-
   public void transferToSequenceFetcher(String ids)
   {
-    // mainFrame.dispose();
     seqFetcher.getTextArea().setText(ids);
     Thread worker = new Thread(seqFetcher);
     worker.start();
@@ -824,7 +865,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
   @Override
   public String getTypedText()
   {
-    return txt_search.getText().trim();
+    return txt_search.getUserInput();
   }
 
   @Override
@@ -875,6 +916,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
   {
     lbl_blank.setVisible(!isSearchInProgress);
     lbl_loading.setVisible(isSearchInProgress);
+    txt_search.setEditable(!isSearchInProgress);
   }
 
   @Override
@@ -907,8 +949,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     int totalRows = resultTable.getRowCount();
     try
     {
-      primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
-              wantedFields, false);
+      primaryKeyColIndex = getFTSRestClient()
+              .getPrimaryKeyColumIndex(wantedFields, false);
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -925,12 +967,10 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     int[] selectedRows = resultTable.getSelectedRows();
     for (int summaryRow : selectedRows)
     {
-      String idStr = resultTable.getValueAt(summaryRow,
-              primaryKeyColIndex).toString();
+      String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
+              .toString();
       paginatorCart.add(idStr);
     }
-    // System.out.println("Paginator shopping cart size : "
-    // + paginatorCart.size());
   }
 
   public void updateSummaryTableSelections()
@@ -943,15 +983,13 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     int primaryKeyColIndex = 0;
     try
     {
-      primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
-              wantedFields, false);
+      primaryKeyColIndex = getFTSRestClient()
+              .getPrimaryKeyColumIndex(wantedFields, false);
     } catch (Exception e)
     {
       e.printStackTrace();
     }
-    // System.out.println(">>>>>> got here : 1");
     int totalRows = resultTable.getRowCount();
-    // resultTable.clearSelection();
     for (int row = 0; row < totalRows; row++)
     {
       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
@@ -962,11 +1000,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     }
     validateSelection();
   }
+
   public void refreshPaginatorState()
   {
-    // System.out.println("resultSet count : " + resultSetCount);
-    // System.out.println("offSet : " + offSet);
-    // System.out.println("page limit : " + pageLimit);
     setPrevPageButtonEnabled(false);
     setNextPageButtonEnabled(false);
     if (resultSetCount == 0 && pageLimit == 0)
@@ -982,6 +1018,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       setPrevPageButtonEnabled(true);
     }
   }
+
   public void referesh()
   {
     mainFrame.setTitle(getFTSFrameTitle());