JAL-1648 improvement on finder searchbox keyboard control - Enter to update search...

[jalview.git] / src / jalview / jbgui / GFinder.java

diff --git a/src/jalview/jbgui/GFinder.java b/src/jalview/jbgui/GFinder.java
index e5d760c..c335b33 100755 (executable)
--- a/src/jalview/jbgui/GFinder.java
+++ b/src/jalview/jbgui/GFinder.java
@@ -24,9 +24,7 @@ import jalview.datamodel.AlignmentI;
 import jalview.io.DataSourceType;
 import jalview.io.FileFormat;
 import jalview.io.FormatAdapter;
-import jalview.io.cache.AppCache;
-import jalview.io.cache.CacheBoxI;
-import jalview.io.cache.Cacheable;
+import jalview.io.cache.JvCacheableInputBox;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -39,7 +37,6 @@ import java.awt.event.KeyEvent;
 
 import javax.swing.JButton;
 import javax.swing.JCheckBox;
-import javax.swing.JComboBox;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.SwingConstants;
@@ -48,7 +45,7 @@ import javax.swing.event.CaretEvent;
 import javax.swing.event.CaretListener;
 import javax.swing.text.JTextComponent;
 
-public class GFinder extends JPanel implements Cacheable
+public class GFinder extends JPanel
 {
   JLabel jLabelFind = new JLabel();
 
@@ -60,9 +57,9 @@ public class GFinder extends JPanel implements Cacheable
 
   GridLayout gridLayout1 = new GridLayout();
 
-  protected JButton createNewGroup = new JButton();
+  protected JButton createFeatures = new JButton();
 
-  protected JComboBox<String> searchBox = new JComboBox<String>();
+  protected JvCacheableInputBox<String> searchBox = new JvCacheableInputBox<String>(getCacheKey());
 
   BorderLayout mainBorderLayout = new BorderLayout();
 
@@ -82,7 +79,7 @@ public class GFinder extends JPanel implements Cacheable
 
   GridLayout optionsGridLayout = new GridLayout();
 
-  private static final String FINDER_CACHE_KEY = "FINDER_CACHE_KEY";
+  private static final String FINDER_CACHE_KEY = "CACHE.FINDER";
 
   public GFinder()
   {
@@ -124,22 +121,19 @@ public class GFinder extends JPanel implements Cacheable
     gridLayout1.setHgap(0);
     gridLayout1.setRows(3);
     gridLayout1.setVgap(2);
-    createNewGroup.setEnabled(false);
-    createNewGroup.setFont(new java.awt.Font("Verdana", 0, 12));
-    createNewGroup.setMargin(new Insets(0, 0, 0, 0));
-    createNewGroup.setText(MessageManager.getString("label.new_feature"));
-    createNewGroup.addActionListener(new java.awt.event.ActionListener()
+    createFeatures.setEnabled(false);
+    createFeatures.setFont(new java.awt.Font("Verdana", 0, 12));
+    createFeatures.setMargin(new Insets(0, 0, 0, 0));
+    createFeatures.setText(MessageManager.getString("label.new_feature"));
+    createFeatures.addActionListener(new java.awt.event.ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        createNewGroup_actionPerformed(e);
+        createFeatures_actionPerformed();
       }
     });
     searchBox.setFont(new java.awt.Font("Verdana", Font.PLAIN, 12));
-    searchBox.setEditable(true);
-    searchBox
-.setPrototypeDisplayValue("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
     ((JTextComponent) searchBox.getEditor().getEditorComponent())
             .addCaretListener(new CaretListener()
     {
@@ -151,14 +145,13 @@ public class GFinder extends JPanel implements Cacheable
     });
     searchBox.getEditor().getEditorComponent()
             .addKeyListener(new java.awt.event.KeyAdapter()
-    {
-      @Override
-      public void keyPressed(KeyEvent e)
-      {
-        textfield_keyPressed(e);
-      }
-    });
-
+            {
+              @Override
+              public void keyPressed(KeyEvent e)
+              {
+                textfield_keyPressed(e);
+              }
+            });
     mainBorderLayout.setHgap(5);
     mainBorderLayout.setVgap(5);
     jPanel4.setLayout(borderLayout2);
@@ -172,7 +165,7 @@ public class GFinder extends JPanel implements Cacheable
 
     actionsPanel.add(findNext, null);
     actionsPanel.add(findAll, null);
-    actionsPanel.add(createNewGroup, null);
+    actionsPanel.add(createFeatures, null);
     this.add(jLabelFind, java.awt.BorderLayout.WEST);
     this.add(actionsPanel, java.awt.BorderLayout.EAST);
     this.add(jPanel2, java.awt.BorderLayout.SOUTH);
@@ -190,41 +183,43 @@ public class GFinder extends JPanel implements Cacheable
     optionsPanel.add(searchDescription, null);
 
     jPanel4.add(optionsPanel, java.awt.BorderLayout.WEST);
-    fireCache();
   }
 
-  protected void findNext_actionPerformed(ActionEvent e)
+  protected void textfield_keyPressed(KeyEvent e)
   {
+    if (e.getKeyCode() == KeyEvent.VK_ENTER)
+    {
+      if (!searchBox.isPopupVisible())
+      {
+        e.consume();
+        findNext_actionPerformed(null);
+      }
+    }
   }
 
-  protected void findAll_actionPerformed(ActionEvent e)
+  protected void findNext_actionPerformed(ActionEvent e)
   {
   }
 
-  protected void textfield_keyPressed(KeyEvent e)
+  protected void findAll_actionPerformed(ActionEvent e)
   {
-    if (e.getKeyCode() == KeyEvent.VK_ENTER)
-    {
-      e.consume();
-      findNext_actionPerformed(null);
-      fireCache();
-    }
   }
 
-  public void createNewGroup_actionPerformed(ActionEvent e)
+
+  public void createFeatures_actionPerformed()
   {
   }
 
   public void textfield_caretUpdate(CaretEvent e)
   {
-    if (searchBox.getEditor().getItem().toString().indexOf(">") > -1)
+    if (searchBox.getUserInput().indexOf(">") > -1)
     {
       SwingUtilities.invokeLater(new Runnable()
       {
         @Override
         public void run()
         {
-          String str = searchBox.getEditor().getItem().toString();
+          String str = searchBox.getUserInput();
           AlignmentI al = null;
           try
           {
@@ -239,7 +234,6 @@ public class GFinder extends JPanel implements Cacheable
                     jalview.util.Comparison.GapChars, al.getSequenceAt(0)
                             .getSequenceAsString());
 
-            searchBox.setSelectedItem(str);
           }
         }
       });
@@ -247,72 +241,20 @@ public class GFinder extends JPanel implements Cacheable
   }
 
 
-  protected void fireCache()
-  {
-    AppCache.getInstance().updateCache(this);
-  }
-
-  @Override
-  public void init()
-  {
-    // TODO Auto-generated method stub
-  }
-
-  @Override
-  public CacheBoxI<String> getCacheComboBox()
-  {
-    return new CacheBoxI<String>()
-    {
-
-      @Override
-      public void setSelectedItem(Object anObject)
-      {
-        searchBox.setSelectedItem(anObject);
-      }
-
-      @Override
-      public void requestFocus()
-      {
-        searchBox.requestFocusInWindow();
-      }
 
-      @Override
-      public void looseFocus()
-      {
-        jPanel6.requestFocusInWindow();
-      }
 
-      @Override
-      public void addItem(String item)
-      {
-        searchBox.addItem(item);
-      }
 
-      @Override
-      public void removeAllItems()
-      {
-        searchBox.removeAllItems();
-      }
-
-      @Override
-      public int getItemCount()
-      {
-        return searchBox.getItemCount();
-      }
-
-      @Override
-      public String getUserInput()
-      {
-        return searchBox.getEditor().getItem() == null ? "" : searchBox
-                .getEditor().getItem().toString().trim();
-      }
-    };
-  }
-
-  @Override
+  /**
+   * Returns unique key used for storing Finder cache items in the cache data
+   * structure
+   * 
+   * @return
+   */
   public String getCacheKey()
   {
     return FINDER_CACHE_KEY;
   }
 
+
+
 }