JAL-3490 revised layout and search algorithm (more tests to be added)
[jalview.git] / src / jalview / jbgui / GFinder.java
index 8292e58..57beaee 100755 (executable)
@@ -1,61 +1,66 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.jbgui;
 
-import java.awt.*;
-import java.awt.event.*;
-import javax.swing.*;
-import javax.swing.event.*;
+import jalview.datamodel.AlignmentI;
+import jalview.io.DataSourceType;
+import jalview.io.FileFormat;
+import jalview.io.FormatAdapter;
+import jalview.io.cache.JvCacheableInputBox;
+import jalview.util.MessageManager;
 
-import jalview.datamodel.*;
-import jalview.io.*;
+import java.awt.BorderLayout;
+import java.awt.Font;
+import java.awt.GridLayout;
+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.JLabel;
+import javax.swing.JPanel;
+import javax.swing.SwingConstants;
+import javax.swing.SwingUtilities;
+import javax.swing.event.CaretEvent;
+import javax.swing.event.CaretListener;
+import javax.swing.text.JTextComponent;
 
 public class GFinder extends JPanel
 {
-  JLabel jLabel1 = new JLabel();
-
-  protected JButton findAll = new JButton();
-
-  protected JButton findNext = new JButton();
-
-  JPanel jPanel1 = new JPanel();
-
-  GridLayout gridLayout1 = new GridLayout();
+  private static final java.awt.Font VERDANA_12 = new Font("Verdana",
+          Font.PLAIN, 12);
 
-  protected JButton createNewGroup = new JButton();
+  private static final String FINDER_CACHE_KEY = "CACHE.FINDER";
 
-  JScrollPane jScrollPane1 = new JScrollPane();
+  protected JButton createFeatures;
 
-  protected JTextArea textfield = new JTextArea();
+  protected JvCacheableInputBox<String> searchBox;
 
-  BorderLayout borderLayout1 = new BorderLayout();
+  protected JCheckBox caseSensitive;
 
-  JPanel jPanel2 = new JPanel();
+  protected JCheckBox searchDescription;
 
-  JPanel jPanel3 = new JPanel();
-
-  JPanel jPanel4 = new JPanel();
-
-  BorderLayout borderLayout2 = new BorderLayout();
-
-  JPanel jPanel6 = new JPanel();
-
-  protected JCheckBox caseSensitive = new JCheckBox();
+  protected JCheckBox ignoreHidden;
 
   public GFinder()
   {
@@ -68,130 +73,186 @@ public class GFinder extends JPanel
     }
   }
 
+  /**
+   * Constructs the widgets and adds them to the layout
+   */
   private void jbInit() throws Exception
   {
-    jLabel1.setFont(new java.awt.Font("Verdana", 0, 12));
-    jLabel1.setText("Find");
-    this.setLayout(borderLayout1);
-    findAll.setFont(new java.awt.Font("Verdana", 0, 12));
-    findAll.setText("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("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();
       }
     });
-    jPanel1.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("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);
-      }
-    });
-    textfield.setFont(new java.awt.Font("Verdana", Font.PLAIN, 12));
-    textfield.setText("");
-    textfield.setLineWrap(true);
-    textfield.addCaretListener(new CaretListener()
-    {
-      public void caretUpdate(CaretEvent e)
-      {
-        textfield_caretUpdate(e);
-      }
-    });
-    textfield.addKeyListener(new java.awt.event.KeyAdapter()
-    {
-      public void keyPressed(KeyEvent e)
-      {
-        textfield_keyPressed(e);
+        createFeatures_actionPerformed();
       }
     });
-
-    borderLayout1.setHgap(5);
-    borderLayout1.setVgap(5);
-    jPanel4.setLayout(borderLayout2);
-    jPanel2.setPreferredSize(new Dimension(10, 1));
-    jPanel3.setPreferredSize(new Dimension(10, 1));
-    caseSensitive.setHorizontalAlignment(SwingConstants.LEFT);
-    caseSensitive.setText("Match Case");
-    jPanel1.add(findNext, null);
-    jPanel1.add(findAll, null);
-    jPanel1.add(createNewGroup, null);
-    this.add(jLabel1, java.awt.BorderLayout.WEST);
-    this.add(jPanel1, 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(jScrollPane1, java.awt.BorderLayout.CENTER);
-    jScrollPane1.getViewport().add(textfield);
-    jPanel4.add(jPanel6, java.awt.BorderLayout.NORTH);
-    jPanel4.add(caseSensitive, java.awt.BorderLayout.SOUTH);
+    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);
-    }
   }
 
-  public void createNewGroup_actionPerformed(ActionEvent e)
+  public void createFeatures_actionPerformed()
   {
   }
 
-  public void textfield_caretUpdate(CaretEvent e)
+  public void textfield_caretUpdate()
   {
-    if (textfield.getText().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 = textfield.getText();
-          Alignment al = null;
+          String str = searchBox.getUserInput();
+          AlignmentI al = null;
           try
           {
-            al = new FormatAdapter().readFile(str, "Paste", "FASTA");
+            al = new FormatAdapter().readFile(str, DataSourceType.PASTE,
+                    FileFormat.Fasta);
           } catch (Exception ex)
           {
           }
           if (al != null && al.getHeight() > 0)
           {
             str = jalview.analysis.AlignSeq.extractGaps(
-                    jalview.util.Comparison.GapChars, al.getSequenceAt(0)
-                            .getSequenceAsString());
-
-            textfield.setText(str);
+                    jalview.util.Comparison.GapChars,
+                    al.getSequenceAt(0).getSequenceAsString());
+            // todo and what? set str as searchBox text?
           }
         }
       });
     }
   }
+
 }