JAL-3490 revised layout and search algorithm (more tests to be added)
[jalview.git] / src / jalview / jbgui / GFinder.java
index 76f75e1..57beaee 100755 (executable)
@@ -24,22 +24,19 @@ 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.Cacheable;
+import jalview.io.cache.JvCacheableInputBox;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
-import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.GridLayout;
-import java.awt.Insets;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
 
 import javax.swing.JButton;
 import javax.swing.JCheckBox;
-import javax.swing.JComboBox;
-import javax.swing.JComponent;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.SwingConstants;
@@ -48,42 +45,22 @@ 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();
+  private static final java.awt.Font VERDANA_12 = new Font("Verdana",
+          Font.PLAIN, 12);
 
-  protected JButton findAll = new JButton();
+  private static final String FINDER_CACHE_KEY = "CACHE.FINDER";
 
-  protected JButton findNext = new JButton();
+  protected JButton createFeatures;
 
-  JPanel actionsPanel = new JPanel();
+  protected JvCacheableInputBox<String> searchBox;
 
-  GridLayout gridLayout1 = new GridLayout();
+  protected JCheckBox caseSensitive;
 
-  protected JButton createNewGroup = new JButton();
+  protected JCheckBox searchDescription;
 
-
-  protected JComboBox<String> searchBox = new JComboBox<String>();
-
-  BorderLayout mainBorderLayout = new BorderLayout();
-
-  JPanel jPanel2 = new JPanel();
-
-  JPanel jPanel3 = new JPanel();
-
-  JPanel jPanel4 = new JPanel();
-
-  BorderLayout borderLayout2 = new BorderLayout();
-
-  JPanel jPanel6 = new JPanel();
-
-  protected JCheckBox caseSensitive = new JCheckBox();
-
-  protected JCheckBox searchDescription = new JCheckBox();
-
-  GridLayout optionsGridLayout = new GridLayout();
-
-  private static final String FINDER_CACHE_KEY = "FINDER_CACHE_KEY";
+  protected JCheckBox ignoreHidden;
 
   public GFinder()
   {
@@ -96,136 +73,168 @@ public class GFinder extends JPanel implements Cacheable
     }
   }
 
+  /**
+   * Constructs the widgets and adds them to the layout
+   */
   private void jbInit() throws Exception
   {
-    jLabelFind.setFont(new java.awt.Font("Verdana", 0, 12));
-    jLabelFind.setText(MessageManager.getString("label.find"));
-    this.setLayout(mainBorderLayout);
-    findAll.setFont(new java.awt.Font("Verdana", 0, 12));
-    findAll.setText(MessageManager.getString("action.find_all"));
-    findAll.addActionListener(new java.awt.event.ActionListener()
+    /*
+     * border layout
+     * West: 4 rows
+     *   first row 'Find'
+     *   remaining rows empty
+     * Center: 4 rows
+     *   first row search box
+     *   second row 'match case' checkbox
+     *   third row 'include description' checkbox
+     *   fourth row 'ignore hidden' checkbox
+     * East: four rows
+     *   first row 'find next' button
+     *   second row 'find all' button
+     *   third row 'new feature' button
+     *   fourth row empty
+     */
+    this.setLayout(new BorderLayout());
+    JPanel eastPanel = new JPanel();
+    eastPanel.setLayout(new GridLayout(4, 1));
+    this.add(eastPanel, BorderLayout.EAST);
+    JPanel centrePanel = new JPanel();
+    centrePanel.setLayout(new GridLayout(4, 1));
+    this.add(centrePanel, BorderLayout.CENTER);
+    JPanel westPanel = new JPanel();
+    westPanel.setLayout(new GridLayout(4, 1));
+    this.add(westPanel, BorderLayout.WEST);
+
+    /*
+     * 'Find' prompt goes top left
+     */
+    JLabel findLabel = new JLabel(
+            " " + MessageManager.getString("label.find") + " ");
+    findLabel.setFont(VERDANA_12);
+    westPanel.add(findLabel);
+
+    /*
+     * search box
+     */
+    searchBox = new JvCacheableInputBox<>(FINDER_CACHE_KEY, 25);
+    searchBox.setFont(VERDANA_12);
+    ((JTextComponent) searchBox.getEditor().getEditorComponent())
+            .addCaretListener(new CaretListener()
+            {
+              @Override
+              public void caretUpdate(CaretEvent e)
+              {
+                textfield_caretUpdate();
+              }
+            });
+    searchBox.getEditor().getEditorComponent()
+            .addKeyListener(new KeyAdapter()
+            {
+              @Override
+              public void keyPressed(KeyEvent e)
+              {
+                textfield_keyPressed(e);
+              }
+            });
+    centrePanel.add(searchBox);
+
+    /*
+     * search options checkboxes
+     */
+    caseSensitive = new JCheckBox();
+    caseSensitive.setHorizontalAlignment(SwingConstants.LEFT);
+    caseSensitive.setText(MessageManager.getString("label.match_case"));
+
+    searchDescription = new JCheckBox();
+    searchDescription
+            .setText(MessageManager.getString("label.include_description"));
+
+    ignoreHidden = new JCheckBox();
+    ignoreHidden.setText(MessageManager.getString("label.ignore_hidden"));
+    ignoreHidden.setToolTipText(
+            MessageManager.getString("label.ignore_hidden_tooltip"));
+    
+    centrePanel.add(caseSensitive);
+    centrePanel.add(searchDescription);
+    centrePanel.add(ignoreHidden);
+
+    /*
+     * action buttons
+     */
+    JButton findAll = new JButton(
+            MessageManager.getString("action.find_all"));
+    findAll.setFont(VERDANA_12);
+    findAll.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        findAll_actionPerformed(e);
+        findAll_actionPerformed();
       }
     });
-    findNext.setFont(new java.awt.Font("Verdana", 0, 12));
-    findNext.setText(MessageManager.getString("action.find_next"));
-    findNext.addActionListener(new java.awt.event.ActionListener()
+    JButton findNext = new JButton(
+            MessageManager.getString("action.find_next"));
+    findNext.setFont(VERDANA_12);
+    findNext.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        findNext_actionPerformed(e);
+        findNext_actionPerformed();
       }
     });
-    actionsPanel.setLayout(gridLayout1);
-    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 = new JButton();
+    createFeatures.setEnabled(false);
+    createFeatures.setFont(VERDANA_12);
+    createFeatures.setText(MessageManager.getString("label.new_feature"));
+    createFeatures.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        createNewGroup_actionPerformed(e);
-      }
-    });
-    searchBox.setFont(new java.awt.Font("Verdana", Font.PLAIN, 12));
-    searchBox.setEditable(true);
-    searchBox
-.setPrototypeDisplayValue("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
-    ((JTextComponent) searchBox.getEditor().getEditorComponent())
-            .addCaretListener(new CaretListener()
-    {
-      @Override
-      public void caretUpdate(CaretEvent e)
-      {
-        textfield_caretUpdate(e);
+        createFeatures_actionPerformed();
       }
     });
-    searchBox.getEditor().getEditorComponent()
-            .addKeyListener(new java.awt.event.KeyAdapter()
-    {
-      @Override
-      public void keyPressed(KeyEvent e)
-      {
-        textfield_keyPressed(e);
-      }
-    });
-
-    mainBorderLayout.setHgap(5);
-    mainBorderLayout.setVgap(5);
-    jPanel4.setLayout(borderLayout2);
-    jPanel2.setPreferredSize(new Dimension(10, 1));
-    jPanel3.setPreferredSize(new Dimension(10, 1));
-    caseSensitive.setHorizontalAlignment(SwingConstants.LEFT);
-    caseSensitive.setText(MessageManager.getString("label.match_case"));
-
-    searchDescription.setText(MessageManager
-            .getString("label.include_description"));
-
-    actionsPanel.add(findNext, null);
-    actionsPanel.add(findAll, null);
-    actionsPanel.add(createNewGroup, null);
-    this.add(jLabelFind, java.awt.BorderLayout.WEST);
-    this.add(actionsPanel, java.awt.BorderLayout.EAST);
-    this.add(jPanel2, java.awt.BorderLayout.SOUTH);
-    this.add(jPanel3, java.awt.BorderLayout.NORTH);
-    this.add(jPanel4, java.awt.BorderLayout.CENTER);
-    jPanel4.add(searchBox, java.awt.BorderLayout.NORTH);
-
-    JPanel optionsPanel = new JPanel();
-
-    optionsGridLayout.setHgap(0);
-    optionsGridLayout.setRows(2);
-    optionsGridLayout.setVgap(2);
-    optionsPanel.setLayout(optionsGridLayout);
-    optionsPanel.add(caseSensitive, null);
-    optionsPanel.add(searchDescription, null);
-
-    jPanel4.add(optionsPanel, java.awt.BorderLayout.WEST);
-    fireCache();
+    eastPanel.add(findNext);
+    eastPanel.add(findAll);
+    eastPanel.add(createFeatures);
   }
 
-  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();
+      }
+    }
   }
 
-  protected void findAll_actionPerformed(ActionEvent e)
+  protected void findNext_actionPerformed()
   {
   }
 
-  protected void textfield_keyPressed(KeyEvent e)
+  protected void findAll_actionPerformed()
   {
-    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)
+  public void textfield_caretUpdate()
   {
-    if (searchBox.getEditor().getItem().toString().indexOf(">") > -1)
+    // disabled as appears to be running a non-functional
+    if (false && 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
           {
@@ -237,43 +246,13 @@ public class GFinder extends JPanel implements Cacheable
           if (al != null && al.getHeight() > 0)
           {
             str = jalview.analysis.AlignSeq.extractGaps(
-                    jalview.util.Comparison.GapChars, al.getSequenceAt(0)
-                            .getSequenceAsString());
-
-            searchBox.setSelectedItem(str);
+                    jalview.util.Comparison.GapChars,
+                    al.getSequenceAt(0).getSequenceAsString());
+            // todo and what? set str as searchBox text?
           }
         }
       });
     }
   }
 
-
-  protected void fireCache()
-  {
-    AppCache.getInstance().updateCache(this);
-  }
-
-  @Override
-  public void init()
-  {
-    // TODO Auto-generated method stub
-  }
-
-  @Override
-  public JComboBox<String> getCacheComboBox()
-  {
-    return searchBox;
-  }
-
-  @Override
-  public String getCacheKey()
-  {
-    return FINDER_CACHE_KEY;
-  }
-
-  @Override
-  public JComponent getNextFocusableElement()
-  {
-    return this;
-  }
 }