JAL-1517 source formatting
[jalview.git] / src / jalview / gui / Finder.java
index c2c02d1..bc5f823 100755 (executable)
@@ -1,31 +1,33 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
  * 
- * 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
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * 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 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 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.gui;
 
 import java.util.*;
-
-import java.awt.*;
 import java.awt.event.*;
+
 import javax.swing.*;
 
 import jalview.datamodel.*;
 import jalview.jbgui.*;
+import jalview.util.MessageManager;
 
 /**
  * DOCUMENT ME!
@@ -43,7 +45,7 @@ public class Finder extends GFinder
 
   int seqIndex = 0;
 
-  int resIndex = 0;
+  int resIndex = -1;
 
   SearchResults searchResults;
 
@@ -51,14 +53,23 @@ public class Finder extends GFinder
    * Creates a new Finder object.
    * 
    * @param av
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param ap
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param f
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public Finder()
   {
+    this(null, null);
+    focusfixed = false;
+  }
+
+  public Finder(AlignViewport viewport, AlignmentPanel alignPanel)
+  {
+    av = viewport;
+    ap = alignPanel;
+    focusfixed = true;
     frame = new JInternalFrame();
     frame.setContentPane(this);
     frame.setLayer(JLayeredPane.PALETTE_LAYER);
@@ -71,7 +82,7 @@ public class Finder extends GFinder
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void findNext_actionPerformed(ActionEvent e)
   {
@@ -85,27 +96,53 @@ public class Finder extends GFinder
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void findAll_actionPerformed(ActionEvent e)
   {
     if (getFocusedViewport())
     {
-      resIndex = 0;
+      resIndex = -1;
       seqIndex = 0;
       doSearch(true);
     }
   }
 
+  /**
+   * do we only search a given alignment view ?
+   */
+  private boolean focusfixed;
+
+  /**
+   * if !focusfixed and not in a desktop environment, checks that av and ap are
+   * valid. Otherwise, gets the topmost alignment window and sets av and ap
+   * accordingly
+   * 
+   * @return false if no alignment window was found
+   */
   boolean getFocusedViewport()
   {
-    JInternalFrame frame = Desktop.desktop.getAllFrames()[1];
-
-    if (frame != null && frame instanceof AlignFrame)
+    if (focusfixed || Desktop.desktop == null)
+    {
+      if (ap != null && av != null)
+      {
+        return true;
+      }
+      // we aren't in a desktop environment, so give up now.
+      return false;
+    }
+    // now checks further down the window stack to fix bug
+    // https://mantis.lifesci.dundee.ac.uk/view.php?id=36008
+    JInternalFrame[] frames = Desktop.desktop.getAllFrames();
+    for (int f = 0; f < frames.length; f++)
     {
-      av = ((AlignFrame) frame).viewport;
-      ap = ((AlignFrame) frame).alignPanel;
-      return true;
+      JInternalFrame frame = frames[f];
+      if (frame != null && frame instanceof AlignFrame)
+      {
+        av = ((AlignFrame) frame).viewport;
+        ap = ((AlignFrame) frame).alignPanel;
+        return true;
+      }
     }
     return false;
   }
@@ -114,7 +151,7 @@ public class Finder extends GFinder
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void createNewGroup_actionPerformed(ActionEvent e)
   {
@@ -141,10 +178,10 @@ public class Finder extends GFinder
   }
 
   /**
-   * DOCUMENT ME!
+   * incrementally search the alignment
    * 
    * @param findAll
-   *                DOCUMENT ME!
+   *          true means find all results and raise a dialog box
    */
   void doSearch(boolean findAll)
   {
@@ -161,7 +198,7 @@ public class Finder extends GFinder
     // TODO: add switches to control what is searched - sequences, IDS,
     // descriptions, features
     jalview.analysis.Finder finder = new jalview.analysis.Finder(
-            av.alignment, av.getSelectionGroup(), seqIndex, resIndex);
+            av.getAlignment(), av.getSelectionGroup(), seqIndex, resIndex);
     finder.setCaseSensitive(caseSensitive.isSelected());
     finder.setFindAll(findAll);
 
@@ -171,18 +208,23 @@ public class Finder extends GFinder
     resIndex = finder.getResIndex();
 
     searchResults = finder.getSearchResults(); // find(regex,
-                                                // caseSensitive.isSelected(), )
+    // caseSensitive.isSelected(), )
     Vector idMatch = finder.getIdMatch();
+    boolean haveResults = false;
     // set or reset the GUI
-    if ((searchResults.getSize() == 0) && (idMatch.size() > 0))
+    if ((idMatch.size() > 0))
     {
+      haveResults = true;
       ap.idPanel.highlightSearchResults(idMatch);
     }
-
-    int resultSize = searchResults.getSize();
+    else
+    {
+      ap.idPanel.highlightSearchResults(null);
+    }
 
     if (searchResults.getSize() > 0)
     {
+      haveResults = true;
       createNewGroup.setEnabled(true);
     }
     else
@@ -195,19 +237,35 @@ public class Finder extends GFinder
     ap.highlightSearchResults(searchResults);
     // TODO: add enablers for 'SelectSequences' or 'SelectColumns' or
     // 'SelectRegion' selection
-    if (!findAll && resultSize == 0)
+    if (!haveResults)
     {
-      JOptionPane.showInternalMessageDialog(this, "Finished searching",
-              null, JOptionPane.INFORMATION_MESSAGE);
-      resIndex = 0;
+      JOptionPane.showInternalMessageDialog(this,
+              MessageManager.getString("label.finished_searching"), null,
+              JOptionPane.INFORMATION_MESSAGE);
+      resIndex = -1;
       seqIndex = 0;
     }
-
-    if (findAll)
+    else
     {
-      String message = resultSize + " matches found.";
-      JOptionPane.showInternalMessageDialog(this, message, null,
-              JOptionPane.INFORMATION_MESSAGE);
+      if (findAll)
+      {
+        // then we report the matches that were found
+        String message = (idMatch.size() > 0) ? "" + idMatch.size()
+                + " IDs" : "";
+        if (searchResults != null)
+        {
+          if (idMatch.size() > 0 && searchResults.getSize() > 0)
+          {
+            message += " and ";
+          }
+          message += searchResults.getSize()
+                  + " subsequence matches found.";
+        }
+        JOptionPane.showInternalMessageDialog(this, message, null,
+                JOptionPane.INFORMATION_MESSAGE);
+        resIndex = -1;
+        seqIndex = 0;
+      }
     }
 
   }