JAL-4034 Fix #2 show an icon and a button to press to initiate search
[jalview.git] / src / jalview / jbgui / GFinder.java
index 76b4b42..c5488f0 100755 (executable)
+/*
+ * 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.jbgui;
 
-import javax.swing.*;
-import java.awt.*;
-import java.awt.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 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;
 
 public class GFinder extends JPanel
 {
-  JLabel jLabel1 = new JLabel();
-  protected JTextField textfield = new JTextField();
-  protected JButton findAll = new JButton();
-  protected JButton findNext = new JButton();
-  protected JButton cancel = new JButton();
-  JPanel jPanel1 = new JPanel();
-  GridLayout gridLayout1 = new GridLayout();
+  private static final java.awt.Font VERDANA_12 = new Font("Verdana",
+          Font.PLAIN, 12);
+
+  private static final String FINDER_CACHE_KEY = "CACHE.FINDER";
+
+  /*
+   * if more checkboxes are wanted, increase this value
+   * and add to centrePanel in jbInit()  
+   */
+  private static final int PANEL_ROWS = 4;
+
+  protected JButton createFeatures;
+
+  protected JvCacheableInputBox<String> searchBox;
+
+  protected JCheckBox caseSensitive;
+
+  protected JCheckBox searchDescription;
+
+  protected JCheckBox ignoreHidden;
 
   public GFinder()
   {
     try
     {
       jbInit();
-    }
-    catch(Exception e)
+    } catch (Exception e)
     {
       e.printStackTrace();
     }
   }
+
+  /**
+   * 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");
-    jLabel1.setBounds(new Rectangle(6, 28, 34, 15));
-    this.setLayout(null);
-    textfield.setFont(new java.awt.Font("Verdana", 0, 12));
-    textfield.setText("");
-    textfield.setBounds(new Rectangle(41, 24, 133, 21));
-    textfield.addKeyListener(new java.awt.event.KeyAdapter()
+    /*
+     * 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(PANEL_ROWS, 1));
+    this.add(eastPanel, BorderLayout.EAST);
+    JPanel centrePanel = new JPanel();
+    centrePanel.setLayout(new GridLayout(PANEL_ROWS, 1));
+    this.add(centrePanel, BorderLayout.CENTER);
+    JPanel westPanel = new JPanel();
+    westPanel.setLayout(new GridLayout(PANEL_ROWS, 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.getComponent().setFont(VERDANA_12);
+    searchBox.addCaretListener(new CaretListener()
     {
-      public void keyTyped(KeyEvent e)
+      @Override
+      public void caretUpdate(CaretEvent e)
       {
-        textfield_keyTyped(e);
+        textfield_caretUpdate();
       }
     });
-    textfield.addActionListener(new java.awt.event.ActionListener()
+    searchBox.addKeyListener(new KeyAdapter()
     {
-      public void actionPerformed(ActionEvent e)
+      @Override
+      public void keyPressed(KeyEvent e)
       {
-        textfield_actionPerformed(e);
+        textfield_keyPressed(e);
       }
     });
-    findAll.setFont(new java.awt.Font("Verdana", 0, 12));
-    findAll.setText("Find all");
-    findAll.addActionListener(new java.awt.event.ActionListener()
+    centrePanel.add(searchBox.getComponent());
+
+    /*
+     * 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.setEnabled(false);
-    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();
       }
     });
-    cancel.setFont(new java.awt.Font("Verdana", 0, 12));
-    cancel.setText("Close");
-    cancel.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)
       {
-        cancel_actionPerformed(e);
+        createFeatures_actionPerformed();
       }
     });
-    jPanel1.setBounds(new Rectangle(178, 4, 102, 62));
-    jPanel1.setLayout(gridLayout1);
-    gridLayout1.setHgap(0);
-    gridLayout1.setRows(3);
-    gridLayout1.setVgap(2);
-    this.add(textfield, null);
-    this.add(jPanel1, null);
-    jPanel1.add(findNext, null);
-    jPanel1.add(findAll, null);
-    jPanel1.add(cancel, null);
-    this.add(jLabel1, null);
+    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 cancel_actionPerformed(ActionEvent e)
+  protected void findAll_actionPerformed()
   {
-
   }
 
-  protected void textfield_actionPerformed(ActionEvent e)
+  public void createFeatures_actionPerformed()
   {
-
   }
 
-  void textfield_keyTyped(KeyEvent e)
+  public void textfield_caretUpdate()
   {
-    findNext.setEnabled(true);
+    // 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.getUserInput();
+          AlignmentI al = null;
+          try
+          {
+            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());
+            // todo and what? set str as searchBox text?
+          }
+        }
+      });
+    }
   }
+
 }