JAL-3144 spelling, Javadoc, abstract method for JalviewJS
[jalview.git] / src / jalview / fts / core / GFTSPanel.java
index 1c20d1d..4771601 100644 (file)
@@ -28,9 +28,7 @@ import jalview.gui.Desktop;
 import jalview.gui.IProgressIndicator;
 import jalview.gui.JvSwingUtils;
 import jalview.gui.SequenceFetcher;
-import jalview.io.cache.AppCache;
-import jalview.io.cache.CacheBoxI;
-import jalview.io.cache.Cacheable;
+import jalview.io.cache.JvCacheableInputBox;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -58,6 +56,7 @@ import java.util.List;
 
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
+import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
@@ -74,7 +73,6 @@ import javax.swing.event.DocumentListener;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.table.DefaultTableModel;
 import javax.swing.table.TableColumn;
-import javax.swing.text.JTextComponent;
 
 /**
  * This class provides the swing GUI layout for FTS Panel and implements most of
@@ -85,14 +83,16 @@ import javax.swing.text.JTextComponent;
  */
 
 @SuppressWarnings("serial")
-public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
+public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 {
   protected JInternalFrame mainFrame = new JInternalFrame(
           getFTSFrameTitle());
 
+  protected JTabbedPane tabs = jalview.jbgui.GDesktop.createTabbedPane();
   protected IProgressIndicator progressIndicator;
 
-  protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
+  protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<>();
 
   protected JButton btn_ok = new JButton();
 
@@ -100,7 +100,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   protected JButton btn_cancel = new JButton();
 
-  protected JComboBox<String> txt_search;
+  protected JCheckBox btn_autosearch = new JCheckBox();
+
+  protected JvCacheableInputBox<String> txt_search;
 
   protected SequenceFetcher seqFetcher;
 
@@ -114,14 +116,14 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   protected StringBuilder errorWarning = new StringBuilder();
 
-  protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
-          "/images/warning.gif"));
+  protected ImageIcon warningImage = new ImageIcon(
+          getClass().getResource("/images/warning.gif"));
 
-  protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
-          "/images/loading.gif"));
+  protected ImageIcon loadingImage = new ImageIcon(
+          getClass().getResource("/images/loading.gif"));
 
-  protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
-          .getResource("/images/blank_16x16_placeholder.png"));
+  protected ImageIcon balnkPlaceholderImage = new ImageIcon(
+          getClass().getResource("/images/blank_16x16_placeholder.png"));
 
   protected JLabel lbl_warning = new JLabel(warningImage);
 
@@ -129,7 +131,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
 
-  private JTabbedPane tabbedPane = new JTabbedPane();
+  JTabbedPane tabbedPane = jalview.jbgui.GDesktop.createTabbedPane();
 
   private JPanel pnl_actions = new JPanel();
 
@@ -149,7 +151,11 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   protected int pageLimit;
 
-  protected HashSet<String> paginatorCart = new HashSet<String>();
+  protected HashSet<String> paginatorCart = new HashSet<>();
+
+  private static final int MIN_WIDTH = 670;
+
+  private static final int MIN_HEIGHT = 300;
 
   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
           "###,###");
@@ -224,8 +230,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
         e.printStackTrace();
       }
       toolTipText = (toolTipText == null ? null
-              : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
-                      true, toolTipText.subSequence(0, 500) + "...")
+              : (toolTipText.length() > 500
+                      ? JvSwingUtils.wrapTooltip(true,
+                              toolTipText.subSequence(0, 500) + "...")
                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 
       return toolTipText;
@@ -236,15 +243,37 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   public GFTSPanel()
   {
+    this(null);
+  }
+
+  public GFTSPanel(SequenceFetcher fetcher)
+  {
     try
     {
+      if (fetcher == null)
+      {
+        tabs = null;
+      }
       jbInit();
+      if (fetcher != null)
+      {
+        tabs.addTab(MessageManager.getString("label.retrieve_ids"),
+                fetcher);
+        fetcher.embedIn(this);
+      }
+      mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
+      final JPanel ftsPanel = this;
       mainFrame.addFocusListener(new FocusAdapter()
       {
         @Override
         public void focusGained(FocusEvent e)
         {
-          txt_search.requestFocusInWindow();
+          // TODO: make selected tab gain focus in correct widget
+          if (tabs != null
+                  && tabs.getSelectedComponent() == ftsPanel)
+          {
+            txt_search.getComponent().requestFocusInWindow();
+          }
         }
       });
       mainFrame.invalidate();
@@ -263,10 +292,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
   private void jbInit() throws Exception
   {
 
-    txt_search = new JComboBox<String>();
-    txt_search.setEditable(true);
-    txt_search
-            .setPrototypeDisplayValue("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+    txt_search = new JvCacheableInputBox<>(getCacheKey());
     populateCmbSearchTargetOptions();
     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
             : getTempUserPrefs().get("FTSPanel.width");
@@ -330,6 +356,20 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
       }
     });
 
+    btn_autosearch.setText(MessageManager.getString("option.autosearch"));
+    btn_autosearch.setToolTipText(
+            MessageManager.getString("option.enable_disable_autosearch"));
+    btn_autosearch.setSelected(
+            jalview.bin.Cache.getDefault(getAutosearchPreference(), true));
+    btn_autosearch.addActionListener(new java.awt.event.ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        jalview.bin.Cache.setProperty(getAutosearchPreference(),
+                Boolean.toString(btn_autosearch.isSelected()));
+      }
+    });
     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_back.setText(MessageManager.getString("action.back"));
     btn_back.addActionListener(new java.awt.event.ActionListener()
@@ -375,8 +415,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
       }
     });
     btn_next_page.setEnabled(false);
-    btn_next_page.setToolTipText(MessageManager
-            .getString("label.next_page_tooltip"));
+    btn_next_page.setToolTipText(
+            MessageManager.getString("label.next_page_tooltip"));
     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_next_page.setText(MessageManager.getString("action.next_page"));
     btn_next_page.addActionListener(new java.awt.event.ActionListener()
@@ -400,8 +440,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     });
 
     btn_prev_page.setEnabled(false);
-    btn_prev_page.setToolTipText(MessageManager
-            .getString("label.prev_page_tooltip"));
+    btn_prev_page.setToolTipText(
+            MessageManager.getString("label.prev_page_tooltip"));
     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
@@ -467,13 +507,13 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
         if (e.getStateChange() == ItemEvent.SELECTED)
         {
           String tooltipText;
-          if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
-                  .toString()))
+          if ("all".equalsIgnoreCase(
+                  getCmbSearchTarget().getSelectedItem().toString()))
           {
             tooltipText = MessageManager.getString("label.search_all");
           }
-          else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
-                  .getSelectedItem().toString()))
+          else if ("pdb id".equalsIgnoreCase(
+                  getCmbSearchTarget().getSelectedItem().toString()))
           {
             tooltipText = MessageManager
                     .getString("label.separate_multiple_accession_ids");
@@ -481,60 +521,59 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
           else
           {
             tooltipText = MessageManager.formatMessage(
-                    "label.separate_multiple_query_values",
-                    new Object[] { getCmbSearchTarget().getSelectedItem()
-                            .toString() });
+                    "label.separate_multiple_query_values", new Object[]
+                    { getCmbSearchTarget().getSelectedItem().toString() });
           }
-          txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
-                  tooltipText));
+          txt_search.getComponent().setToolTipText(
+                  JvSwingUtils.wrapTooltip(true, tooltipText));
           searchAction(true);
         }
       }
     });
-
 
-    txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
-
-    txt_search.getEditor().getEditorComponent()
-            .addKeyListener(new KeyAdapter()
-    {
-      @Override
-      public void keyPressed(KeyEvent e)
-      {
-        if (e.getKeyCode() == KeyEvent.VK_ENTER)
-        {
-          if (getTypedText() == null || getTypedText().isEmpty())
-          {
-            return;
-          }
-          String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
-                  .getName();
-          if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
-                  .getSelectedItem().toString()))
-          {
-            transferToSequenceFetcher(getTypedText());
-          }
-        }
-      }
-    });
+    txt_search.getComponent().setFont(new java.awt.Font("Verdana", 0, 12));
 
+    txt_search.addKeyListener(new KeyAdapter()
+            {
+              @Override
+              public void keyPressed(KeyEvent e)
+              {
+                if (e.getKeyCode() == KeyEvent.VK_ENTER)
+                {
+                  if (getTypedText() == null || getTypedText().isEmpty())
+                  {
+                    return;
+                  }
+                  String primaryKeyName = getFTSRestClient()
+                          .getPrimaryKeyColumn().getName();
+                  if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
+                          .getSelectedItem().toString()))
+                  {
+                    // TODO: nicer to show the list in the result set before
+                    // viewing in Jalview perhaps ?
+                    transferToSequenceFetcher(getTypedText());
+                  }
+                  else
+                  {
+                    performSearchAction();
+                  }
+                }
+              }
+            });
     final DeferredTextInputListener listener = new DeferredTextInputListener(
             1500, new ActionListener()
             {
               @Override
               public void actionPerformed(ActionEvent e)
               {
-                if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
+                if (btn_autosearch.isSelected()
+                        || txt_search.wasEnterPressed())
                 {
-                  searchAction(true);
-                  paginatorCart.clear();
-                  lastSearchTerm = getTypedText();
+                  performSearchAction();
                 }
               }
             }, false);
-    ((JTextComponent) txt_search.getEditor().getEditorComponent())
-            .getDocument().addDocumentListener(listener);
+    txt_search.addDocumentListener(listener);
 
     txt_search.addFocusListener(new FocusListener()
     {
@@ -551,6 +590,14 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
       }
     });
 
+    txt_search.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        performSearchAction();
+      }
+    });
     final String searchTabTitle = MessageManager
             .getString("label.search_result");
     final String configureCols = MessageManager
@@ -577,18 +624,18 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
           btn_ok.setEnabled(false);
           btn_next_page.setEnabled(false);
           btn_prev_page.setEnabled(false);
-          txt_search.setEnabled(false);
+          txt_search.getComponent().setEnabled(false);
           cmb_searchTarget.setEnabled(false);
           previousWantedFields = getFTSRestClient()
-                  .getAllDefaultDisplayedFTSDataColumns().toArray(
-                          new Object[0]);
+                  .getAllDefaultDisplayedFTSDataColumns()
+                  .toArray(new Object[0]);
         }
         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
         {
           btn_back.setEnabled(true);
           btn_cancel.setEnabled(true);
           refreshPaginatorState();
-          txt_search.setEnabled(true);
+          txt_search.getComponent().setEnabled(true);
           cmb_searchTarget.setEnabled(true);
           if (wantedFieldsUpdated())
           {
@@ -614,7 +661,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
     pnl_results.add(tabbedPane);
     pnl_inputs.add(cmb_searchTarget);
-    pnl_inputs.add(txt_search);
+    pnl_inputs.add(txt_search.getComponent());
+    pnl_inputs.add(btn_autosearch);
     pnl_inputs.add(lbl_loading);
     pnl_inputs.add(lbl_warning);
     pnl_inputs.add(lbl_blank);
@@ -626,10 +674,21 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     this.add(pnl_results, java.awt.BorderLayout.CENTER);
     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
     mainFrame.setVisible(true);
-    mainFrame.setContentPane(this);
+    if (tabs != null)
+    {
+      tabs.setOpaque(true);
+      tabs.insertTab(MessageManager.getString("label.free_text_search"),
+              null, this, "", 0);
+      mainFrame.setContentPane(tabs);
+      tabs.setVisible(true);
+    }
+    else
+    {
+      mainFrame.setContentPane(this);
+    }
     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
-    mainFrame
-            .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
+    mainFrame.addInternalFrameListener(
+            new javax.swing.event.InternalFrameAdapter()
             {
               @Override
               public void internalFrameClosing(InternalFrameEvent e)
@@ -637,8 +696,6 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
                 closeAction();
               }
             });
-    mainFrame.setVisible(true);
-    mainFrame.setContentPane(this);
     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
     Integer x = getTempUserPrefs().get("FTSPanel.x");
     Integer y = getTempUserPrefs().get("FTSPanel.y");
@@ -656,7 +713,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
     mainFrame.dispose();
-    AppCache.getInstance().persistCache(this);
+    txt_search.persistCache();
   }
 
   public class DeferredTextInputListener implements DocumentListener
@@ -700,6 +757,18 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   }
 
+  void performSearchAction()
+  {
+    String typed = getTypedText();
+    if (typed != null && typed.length() > 0
+            && !typed.equalsIgnoreCase(lastSearchTerm))
+    {
+      searchAction(true);
+      paginatorCart.clear();
+      lastSearchTerm = typed;
+    }
+  }
+
   public boolean wantedFieldsUpdated()
   {
     if (previousWantedFields == null)
@@ -731,11 +800,6 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     return cmb_searchTarget;
   }
 
-  public JComboBox<String> getTxtSearch()
-  {
-    return txt_search;
-  }
-
   public JInternalFrame getMainFrame()
   {
     return mainFrame;
@@ -770,13 +834,17 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     {
       lbl_loading.setVisible(false);
       lbl_blank.setVisible(false);
-      lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
-              errorWarning.toString()));
+      lbl_warning.setToolTipText(
+              JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
       lbl_warning.setVisible(true);
     }
   }
 
-  protected void btn_back_ActionPerformed()
+  /**
+   * Action on Back button is to close this panel and open a new Sequence
+   * Fetcher panel
+   */
+  public void btn_back_ActionPerformed()
   {
     closeAction();
     new SequenceFetcher(progressIndicator);
@@ -789,7 +857,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     btn_cancel.setEnabled(false);
   }
 
-  protected void btn_cancel_ActionPerformed()
+  public void btn_cancel_ActionPerformed()
   {
     closeAction();
   }
@@ -799,7 +867,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
    */
   public void populateCmbSearchTargetOptions()
   {
-    List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
+    List<FTSDataColumnI> searchableTargets = new ArrayList<>();
     try
     {
       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
@@ -827,7 +895,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 
   public void transferToSequenceFetcher(String ids)
   {
-    seqFetcher.getTextArea().setText(ids);
+    seqFetcher.setQuery(ids);
     Thread worker = new Thread(seqFetcher);
     worker.start();
   }
@@ -835,8 +903,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
   @Override
   public String getTypedText()
   {
-    return txt_search.getEditor().getItem() == null ? "" : txt_search
-            .getEditor().getItem().toString().trim();
+    return txt_search.getUserInput();
   }
 
   @Override
@@ -853,7 +920,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     lbl_blank.setVisible(true);
     btn_ok.setEnabled(false);
     mainFrame.setTitle(getFTSFrameTitle());
-    referesh();
+    refresh();
     tbl_summary.setModel(new DefaultTableModel());
     tbl_summary.setVisible(false);
   }
@@ -887,6 +954,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
   {
     lbl_blank.setVisible(!isSearchInProgress);
     lbl_loading.setVisible(isSearchInProgress);
+    txt_search.setEditable(!isSearchInProgress);
   }
 
   @Override
@@ -919,8 +987,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     int totalRows = resultTable.getRowCount();
     try
     {
-      primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
-              wantedFields, false);
+      primaryKeyColIndex = getFTSRestClient()
+              .getPrimaryKeyColumIndex(wantedFields, false);
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -953,8 +1021,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     int primaryKeyColIndex = 0;
     try
     {
-      primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
-              wantedFields, false);
+      primaryKeyColIndex = getFTSRestClient()
+              .getPrimaryKeyColumIndex(wantedFields, false);
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -989,82 +1057,11 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
     }
   }
 
-  public void referesh()
+  public void refresh()
   {
     mainFrame.setTitle(getFTSFrameTitle());
   }
 
   @Override
-  public void initCache()
-  {
-    AppCache.getInstance().initCache(this);
-  }
-
-  @Override
-  public void updateCache()
-  {
-    AppCache.getInstance().updateCache(this);
-  }
-
-
-
-  @Override
-  public String getCacheKey()
-  {
-    return getCacheKey();
-  }
-
-  @Override
-  public CacheBoxI<String> getCacheComboBox()
-  {
-    return new CacheBoxI<String>()
-    {
-
-      @Override
-      public void setSelectedItem(Object anObject)
-      {
-        txt_search.setSelectedItem(anObject);
-      }
-
-      @Override
-      public void requestFocus()
-      {
-        txt_search.requestFocusInWindow();
-      }
-
-      @Override
-      public void looseFocus()
-      {
-        mainFrame.requestFocusInWindow();
-      }
-
-      @Override
-      public void addItem(String item)
-      {
-        txt_search.addItem(item);
-      }
-
-      @Override
-      public void removeAllItems()
-      {
-        txt_search.removeAllItems();
-      }
-
-      @Override
-      public int getItemCount()
-      {
-        return txt_search.getItemCount();
-      }
-
-      @Override
-      public String getUserInput()
-      {
-        return txt_search.getEditor().getItem() == null ? "" : txt_search
-                .getEditor().getItem().toString().trim();
-      }
-    };
-  }
-
-
-
+  public abstract void okAction();
 }