JAL-1925 update source version in license
[jalview.git] / src / jalview / appletgui / Finder.java
old mode 100755 (executable)
new mode 100644 (file)
index 9e974e9..a371edd
@@ -1,50 +1,68 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program 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 2
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
+ * Copyright (C) 2015 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.
- *
- * This program 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.
- *
+ *  
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
-
 package jalview.appletgui;
 
-import java.util.*;
-
-import java.awt.*;
-import java.awt.event.*;
+import jalview.datamodel.SearchResults;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceI;
+import jalview.util.MessageManager;
+import jalview.viewmodel.AlignmentViewport;
 
-import jalview.datamodel.*;
+import java.awt.Button;
+import java.awt.Checkbox;
+import java.awt.Font;
+import java.awt.Frame;
+import java.awt.GridLayout;
+import java.awt.Label;
+import java.awt.Panel;
+import java.awt.Rectangle;
+import java.awt.TextField;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.util.Vector;
 
-public class Finder
-    extends Panel implements ActionListener
+public class Finder extends Panel implements ActionListener
 {
-  AlignViewport av;
+  AlignmentViewport av;
+
   AlignmentPanel ap;
+
   Frame frame;
 
   SearchResults searchResults;
 
   int seqIndex = 0;
-  int resIndex = 0;
+
+  int resIndex = -1;
+
   public Finder(final AlignmentPanel ap)
   {
     try
     {
       jbInit();
 
-    }
-    catch (Exception e)
+    } catch (Exception e)
     {
       e.printStackTrace();
     }
@@ -53,7 +71,8 @@ public class Finder
     this.ap = ap;
     frame = new Frame();
     frame.add(this);
-    jalview.bin.JalviewLite.addFrame(frame, "Find", 340, 120);
+    jalview.bin.JalviewLite.addFrame(frame,
+            MessageManager.getString("action.find"), 340, 120);
     frame.repaint();
     frame.addWindowListener(new WindowAdapter()
     {
@@ -79,7 +98,7 @@ public class Finder
 
     else if (evt.getSource() == findAll)
     {
-      resIndex = 0;
+      resIndex = -1;
       seqIndex = 0;
       doSearch(true);
     }
@@ -92,39 +111,39 @@ public class Finder
   public void createNewGroup_actionPerformed()
   {
     SequenceI[] seqs = new SequenceI[searchResults.getSize()];
-    SequenceFeature[] features = new SequenceFeature[searchResults.getSize()];
+    SequenceFeature[] features = new SequenceFeature[searchResults
+            .getSize()];
 
     for (int i = 0; i < searchResults.getSize(); i++)
     {
       seqs[i] = searchResults.getResultSequence(i);
 
       features[i] = new SequenceFeature(textfield.getText().trim(),
-                                        "Search Results", null,
-                                        searchResults.getResultStart(i),
-                                        searchResults.getResultEnd(i),
-                                        "Search Results");
+              "Search Results", null, searchResults.getResultStart(i),
+              searchResults.getResultEnd(i), "Search Results");
     }
 
-    if (ap.seqPanel.seqCanvas.getFeatureRenderer()
-        .amendFeatures(seqs, features, true, ap))
+    if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
+            features, true, ap))
     {
       ap.alignFrame.sequenceFeatures.setState(true);
-      av.showSequenceFeatures(true);
+      av.setShowSequenceFeatures(true);
       ap.highlightSearchResults(null);
     }
   }
 
   void doSearch(boolean findAll)
   {
-    if (jalview.bin.JalviewLite.currentAlignFrame != null)
+    if (ap.av.applet.currentAlignFrame != null)
     {
-      ap = jalview.bin.JalviewLite.currentAlignFrame.alignPanel;
+      ap = ap.av.applet.currentAlignFrame.alignPanel;
       av = ap.av;
     }
     createNewGroup.setEnabled(false);
-    jalview.analysis.Finder finder = new jalview.analysis.Finder(av.
-        getAlignment(), av.getSelectionGroup(), seqIndex, resIndex);
+    jalview.analysis.Finder finder = new jalview.analysis.Finder(
+            av.getAlignment(), av.getSelectionGroup(), seqIndex, resIndex);
     finder.setCaseSensitive(caseSensitive.getState());
+    finder.setIncludeDescription(searchDescription.getState());
     finder.setFindAll(findAll);
 
     String searchString = textfield.getText();
@@ -134,56 +153,97 @@ public class Finder
     resIndex = finder.getResIndex();
     searchResults = finder.getSearchResults();
     Vector idMatch = finder.getIdMatch();
-
-    if (searchResults.getSize() == 0 && idMatch.size() > 0)
+    boolean haveResults = false;
+    // set or reset the GUI
+    if ((idMatch.size() > 0))
     {
+      haveResults = true;
       ap.idPanel.highlightSearchResults(idMatch);
     }
+    else
+    {
+      ap.idPanel.highlightSearchResults(null);
+    }
 
     if (searchResults.getSize() > 0)
     {
+      haveResults = true;
       createNewGroup.setEnabled(true);
 
     }
     else
     {
       searchResults = null;
-      resIndex = 0;
-      seqIndex = 0;
     }
 
-    // if allResults is null, this effectively switches displaySearch flag in seqCanvas
+    // if allResults is null, this effectively switches displaySearch flag in
+    // seqCanvas
     ap.highlightSearchResults(searchResults);
-
-    if (findAll)
+    // TODO: add enablers for 'SelectSequences' or 'SelectColumns' or
+    // 'SelectRegion' selection
+    if (!haveResults)
     {
-      String message = (searchResults == null ? 0 : searchResults.getSize()) +
-          " matches found.";
-      ap.alignFrame.statusBar.setText("Search results: " + searchString + " : " +
-                                      message);
+      ap.alignFrame.statusBar.setText(MessageManager
+              .getString("label.finished_searching"));
+      resIndex = -1;
+      seqIndex = 0;
     }
+    else
+    {
+      if (findAll)
+      {
+        String message = (idMatch.size() > 0) ? "" + idMatch.size()
+                + " IDs" : "";
+        if (idMatch.size() > 0 && searchResults != null
+                && searchResults.getSize() > 0)
+        {
+          message += " and ";
+        }
+        if (searchResults != null)
+        {
+          message += searchResults.getSize() + " subsequence matches.";
+        }
+        ap.alignFrame.statusBar.setText(MessageManager.formatMessage(
+                "label.search_results", new String[] { searchString,
+                    message }));
 
+      }
+      else
+      {
+        // TODO: indicate sequence and matching position in status bar
+        ap.alignFrame.statusBar.setText(MessageManager.formatMessage(
+                "label.found_match_for", new String[] { searchString }));
+      }
+    }
   }
 
   Label jLabel1 = new Label();
+
   protected TextField textfield = new TextField();
+
   protected Button findAll = new Button();
+
   protected Button findNext = new Button();
-  Panel jPanel1 = new Panel();
+
+  Panel actionsPanel = new Panel();
+
   GridLayout gridLayout1 = new GridLayout();
+
   protected Button createNewGroup = new Button();
+
   Checkbox caseSensitive = new Checkbox();
 
-  private void jbInit()
-      throws Exception
+  Checkbox searchDescription = new Checkbox();
+
+  private void jbInit() throws Exception
   {
     jLabel1.setFont(new java.awt.Font("Verdana", 0, 12));
-    jLabel1.setText("Find");
+    jLabel1.setText(MessageManager.getString("action.find"));
     jLabel1.setBounds(new Rectangle(3, 30, 34, 15));
     this.setLayout(null);
     textfield.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
     textfield.setText("");
-    textfield.setBounds(new Rectangle(40, 27, 133, 21));
+    textfield.setBounds(new Rectangle(40, 17, 133, 21));
     textfield.addKeyListener(new java.awt.event.KeyAdapter()
     {
       public void keyTyped(KeyEvent e)
@@ -193,30 +253,35 @@ public class Finder
     });
     textfield.addActionListener(this);
     findAll.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
-    findAll.setLabel("Find all");
+    findAll.setLabel(MessageManager.getString("action.find_all"));
     findAll.addActionListener(this);
     findNext.setEnabled(false);
     findNext.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
-    findNext.setLabel("Find Next");
+    findNext.setLabel(MessageManager.getString("action.find_next"));
     findNext.addActionListener(this);
-    jPanel1.setBounds(new Rectangle(180, 5, 141, 64));
-    jPanel1.setLayout(gridLayout1);
+    actionsPanel.setBounds(new Rectangle(195, 5, 141, 64));
+    actionsPanel.setLayout(gridLayout1);
     gridLayout1.setHgap(0);
     gridLayout1.setRows(3);
     gridLayout1.setVgap(2);
     createNewGroup.setEnabled(false);
     createNewGroup.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
-    createNewGroup.setLabel("New Feature");
+    createNewGroup.setLabel(MessageManager.getString("label.new_feature"));
     createNewGroup.addActionListener(this);
-    caseSensitive.setLabel("Match Case");
-    caseSensitive.setBounds(new Rectangle(40, 49, 126, 23));
-    jPanel1.add(findNext, null);
-    jPanel1.add(findAll, null);
-    jPanel1.add(createNewGroup, null);
+    caseSensitive.setLabel(MessageManager.getString("label.match_case"));
+    caseSensitive.setBounds(new Rectangle(30, 39, 126, 23));
+
+    searchDescription.setLabel(MessageManager
+            .getString("label.include_description"));
+    searchDescription.setBounds(new Rectangle(30, 59, 170, 23));
+    actionsPanel.add(findNext, null);
+    actionsPanel.add(findAll, null);
+    actionsPanel.add(createNewGroup, null);
     this.add(caseSensitive);
     this.add(textfield, null);
     this.add(jLabel1, null);
-    this.add(jPanel1, null);
+    this.add(actionsPanel, null);
+    this.add(searchDescription);
   }
 
   void textfield_keyTyped(KeyEvent e)