src/jalview/fts/core/GFTSPanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21
  22 package jalview.fts.core;
  23
  24 import jalview.fts.api.FTSDataColumnI;
  25 import jalview.fts.api.GFTSPanelI;
  26 import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
  27 import jalview.gui.Desktop;
  28 import jalview.gui.IProgressIndicator;
  29 import jalview.gui.JvSwingUtils;
  30 import jalview.gui.SequenceFetcher;
  31 import jalview.io.cache.JvCacheableInputBox;
  32 import jalview.util.MessageManager;
  33
  34 import java.awt.BorderLayout;
  35 import java.awt.CardLayout;
  36 import java.awt.Dimension;
  37 import java.awt.event.ActionEvent;
  38 import java.awt.event.ActionListener;
  39 import java.awt.event.FocusAdapter;
  40 import java.awt.event.FocusEvent;
  41 import java.awt.event.FocusListener;
  42 import java.awt.event.ItemEvent;
  43 import java.awt.event.ItemListener;
  44 import java.awt.event.KeyAdapter;
  45 import java.awt.event.KeyEvent;
  46 import java.awt.event.MouseAdapter;
  47 import java.awt.event.MouseEvent;
  48 import java.text.DecimalFormat;
  49 import java.util.ArrayList;
  50 import java.util.Arrays;
  51 import java.util.Collection;
  52 import java.util.Collections;
  53 import java.util.Comparator;
  54 import java.util.HashSet;
  55 import java.util.List;
  56
  57 import javax.swing.ImageIcon;
  58 import javax.swing.JButton;
  59 import javax.swing.JCheckBox;
  60 import javax.swing.JComboBox;
  61 import javax.swing.JFrame;
  62 import javax.swing.JInternalFrame;
  63 import javax.swing.JLabel;
  64 import javax.swing.JPanel;
  65 import javax.swing.JScrollPane;
  66 import javax.swing.JTabbedPane;
  67 import javax.swing.JTable;
  68 import javax.swing.Timer;
  69 import javax.swing.event.ChangeEvent;
  70 import javax.swing.event.ChangeListener;
  71 import javax.swing.event.DocumentEvent;
  72 import javax.swing.event.DocumentListener;
  73 import javax.swing.event.InternalFrameEvent;
  74 import javax.swing.table.DefaultTableModel;
  75 import javax.swing.table.TableColumn;
  76 import javax.swing.text.JTextComponent;
  77
  78 /**
  79  * This class provides the swing GUI layout for FTS Panel and implements most of
  80  * the contracts defined in GFSPanelI
  81  *
  82  * @author tcnofoegbu
  83  *
  84  */
  85
  86 @SuppressWarnings("serial")
  87 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
  88 {
  89   protected JInternalFrame mainFrame = new JInternalFrame(
  90           getFTSFrameTitle());
  91
  92   protected JTabbedPane tabs = jalview.jbgui.GDesktop.createTabbedPane();
  93
  94   protected IProgressIndicator progressIndicator;
  95
  96   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<>();
  97
  98   protected JButton btn_ok = new JButton();
  99
 100   protected JButton btn_back = new JButton();
 101
 102   protected JButton btn_cancel = new JButton();
 103
 104   protected JCheckBox btn_autosearch = new JCheckBox();
 105
 106   protected JvCacheableInputBox<String> txt_search;
 107
 108   protected SequenceFetcher seqFetcher;
 109
 110   protected Collection<FTSDataColumnI> wantedFields;
 111
 112   private String lastSearchTerm = "";
 113
 114   protected JButton btn_next_page = new JButton();
 115
 116   protected JButton btn_prev_page = new JButton();
 117
 118   protected StringBuilder errorWarning = new StringBuilder();
 119
 120   protected ImageIcon warningImage = new ImageIcon(
 121           getClass().getResource("/images/warning.gif"));
 122
 123   protected ImageIcon loadingImage = new ImageIcon(
 124           getClass().getResource("/images/loading.gif"));
 125
 126   protected ImageIcon balnkPlaceholderImage = new ImageIcon(
 127           getClass().getResource("/images/blank_16x16_placeholder.png"));
 128
 129   protected JLabel lbl_warning = new JLabel(warningImage);
 130
 131   protected JLabel lbl_loading = new JLabel(loadingImage);
 132
 133   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
 134
 135   private JTabbedPane tabbedPane = jalview.jbgui.GDesktop.createTabbedPane();
 136
 137   private JPanel pnl_actions = new JPanel();
 138
 139   private JPanel pnl_results = new JPanel(new CardLayout());
 140
 141   private JPanel pnl_inputs = new JPanel();
 142
 143   private BorderLayout mainLayout = new BorderLayout();
 144
 145   protected Object[] previousWantedFields;
 146
 147   protected int resultSetCount;
 148
 149   protected int totalResultSetCount;
 150
 151   protected int offSet;
 152
 153   protected int pageLimit;
 154
 155   protected HashSet<String> paginatorCart = new HashSet<>();
 156
 157   private static final int MIN_WIDTH = 670;
 158
 159   private static final int MIN_HEIGHT = 300;
 160
 161   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
 162           "###,###");
 163
 164   private JTable tbl_summary = new JTable()
 165   {
 166     private boolean inLayout;
 167
 168     @Override
 169     public boolean getScrollableTracksViewportWidth()
 170     {
 171       return hasExcessWidth();
 172
 173     }
 174
 175     @Override
 176     public void doLayout()
 177     {
 178       if (hasExcessWidth())
 179       {
 180         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
 181       }
 182       inLayout = true;
 183       super.doLayout();
 184       inLayout = false;
 185       autoResizeMode = AUTO_RESIZE_OFF;
 186     }
 187
 188     protected boolean hasExcessWidth()
 189     {
 190       return getPreferredSize().width < getParent().getWidth();
 191     }
 192
 193     @Override
 194     public void columnMarginChanged(ChangeEvent e)
 195     {
 196       if (isEditing())
 197       {
 198         removeEditor();
 199       }
 200       TableColumn resizingColumn = getTableHeader().getResizingColumn();
 201       // Need to do this here, before the parent's
 202       // layout manager calls getPreferredSize().
 203       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
 204               && !inLayout)
 205       {
 206         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
 207         String colHeader = resizingColumn.getHeaderValue().toString();
 208         getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
 209       }
 210       resizeAndRepaint();
 211     }
 212
 213     @Override
 214     public String getToolTipText(MouseEvent evt)
 215     {
 216       String toolTipText = null;
 217       java.awt.Point pnt = evt.getPoint();
 218       int rowIndex = rowAtPoint(pnt);
 219       int colIndex = columnAtPoint(pnt);
 220
 221       try
 222       {
 223         if (getValueAt(rowIndex, colIndex) == null)
 224         {
 225           return null;
 226         }
 227         toolTipText = getValueAt(rowIndex, colIndex).toString();
 228
 229       } catch (Exception e)
 230       {
 231         e.printStackTrace();
 232       }
 233       toolTipText = (toolTipText == null ? null
 234               : (toolTipText.length() > 500
 235                       ? JvSwingUtils.wrapTooltip(true,
 236                               toolTipText.subSequence(0, 500) + "...")
 237                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 238
 239       return toolTipText;
 240     }
 241   };
 242
 243   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 244
 245   public GFTSPanel()
 246   {
 247     this(null);
 248   }
 249
 250   public GFTSPanel(SequenceFetcher fetcher)
 251   {
 252     try
 253     {
 254       if (fetcher == null)
 255       {
 256         tabs = null;
 257       }
 258       jbInit();
 259       if (fetcher != null)
 260       {
 261         tabs.addTab(MessageManager.getString("label.retrieve_ids"),
 262                 fetcher);
 263         fetcher.setDatabaseChooserVisible(false);
 264         fetcher.embedWithFTSPanel(this);
 265       }
 266       mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
 267       final JPanel ftsPanel = this;
 268       mainFrame.addFocusListener(new FocusAdapter()
 269       {
 270         @Override
 271         public void focusGained(FocusEvent e)
 272         {
 273           // TODO: make selected tab gain focus in correct widget
 274           if (tabs != null
 275                   && tabs.getSelectedComponent() == ftsPanel)
 276           {
 277             txt_search.requestFocusInWindow();
 278           }
 279         }
 280       });
 281       mainFrame.invalidate();
 282       mainFrame.pack();
 283     } catch (Exception e)
 284     {
 285       e.printStackTrace();
 286     }
 287   }
 288
 289   /**
 290    * Initializes the GUI default properties
 291    *
 292    * @throws Exception
 293    */
 294   private void jbInit() throws Exception
 295   {
 296
 297     txt_search = new JvCacheableInputBox<>(getCacheKey());
 298     populateCmbSearchTargetOptions();
 299     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
 300             : getTempUserPrefs().get("FTSPanel.width");
 301     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
 302             : getTempUserPrefs().get("FTSPanel.height");
 303     lbl_warning.setVisible(false);
 304     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 305     lbl_loading.setVisible(false);
 306     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
 307     lbl_blank.setVisible(true);
 308     lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
 309
 310     tbl_summary.setAutoCreateRowSorter(true);
 311     tbl_summary.getTableHeader().setReorderingAllowed(false);
 312     tbl_summary.addMouseListener(new MouseAdapter()
 313     {
 314       @Override
 315       public void mouseClicked(MouseEvent e)
 316       {
 317         validateSelection();
 318       }
 319
 320       @Override
 321       public void mouseReleased(MouseEvent e)
 322       {
 323         validateSelection();
 324       }
 325     });
 326     tbl_summary.addKeyListener(new KeyAdapter()
 327     {
 328       @Override
 329       public void keyPressed(KeyEvent evt)
 330       {
 331         validateSelection();
 332         switch (evt.getKeyCode())
 333         {
 334         case KeyEvent.VK_ESCAPE: // escape key
 335           btn_back_ActionPerformed();
 336           break;
 337         case KeyEvent.VK_ENTER: // enter key
 338           if (btn_ok.isEnabled())
 339           {
 340             okAction();
 341           }
 342           evt.consume();
 343           break;
 344         case KeyEvent.VK_TAB: // tab key
 345           if (evt.isShiftDown())
 346           {
 347             tabbedPane.requestFocus();
 348           }
 349           else
 350           {
 351             btn_back.requestFocus();
 352           }
 353           evt.consume();
 354           break;
 355         default:
 356           return;
 357         }
 358       }
 359     });
 360
 361     btn_autosearch.setText(MessageManager.getString("option.autosearch"));
 362     btn_autosearch.setToolTipText(
 363             MessageManager.getString("option.enable_disable_autosearch"));
 364     btn_autosearch.setSelected(
 365             jalview.bin.Cache.getDefault(getAutosearchPreference(), true));
 366     btn_autosearch.addActionListener(new java.awt.event.ActionListener()
 367     {
 368       @Override
 369       public void actionPerformed(ActionEvent e)
 370       {
 371         jalview.bin.Cache.setProperty(getAutosearchPreference(),
 372                 Boolean.toString(btn_autosearch.isSelected()));
 373       }
 374     });
 375     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 376     btn_back.setText(MessageManager.getString("action.back"));
 377     btn_back.addActionListener(new java.awt.event.ActionListener()
 378     {
 379       @Override
 380       public void actionPerformed(ActionEvent e)
 381       {
 382         btn_back_ActionPerformed();
 383       }
 384     });
 385     btn_back.addKeyListener(new KeyAdapter()
 386     {
 387       @Override
 388       public void keyPressed(KeyEvent evt)
 389       {
 390         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 391         {
 392           btn_back_ActionPerformed();
 393         }
 394       }
 395     });
 396
 397     btn_ok.setEnabled(false);
 398     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 399     btn_ok.setText(MessageManager.getString("action.ok"));
 400     btn_ok.addActionListener(new java.awt.event.ActionListener()
 401     {
 402       @Override
 403       public void actionPerformed(ActionEvent e)
 404       {
 405         okAction();
 406       }
 407     });
 408     btn_ok.addKeyListener(new KeyAdapter()
 409     {
 410       @Override
 411       public void keyPressed(KeyEvent evt)
 412       {
 413         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 414         {
 415           okAction();
 416         }
 417       }
 418     });
 419     btn_next_page.setEnabled(false);
 420     btn_next_page.setToolTipText(
 421             MessageManager.getString("label.next_page_tooltip"));
 422     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
 423     btn_next_page.setText(MessageManager.getString("action.next_page"));
 424     btn_next_page.addActionListener(new java.awt.event.ActionListener()
 425     {
 426       @Override
 427       public void actionPerformed(ActionEvent e)
 428       {
 429         nextPageAction();
 430       }
 431     });
 432     btn_next_page.addKeyListener(new KeyAdapter()
 433     {
 434       @Override
 435       public void keyPressed(KeyEvent evt)
 436       {
 437         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 438         {
 439           nextPageAction();
 440         }
 441       }
 442     });
 443
 444     btn_prev_page.setEnabled(false);
 445     btn_prev_page.setToolTipText(
 446             MessageManager.getString("label.prev_page_tooltip"));
 447     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
 448     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
 449     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
 450     {
 451       @Override
 452       public void actionPerformed(ActionEvent e)
 453       {
 454         prevPageAction();
 455       }
 456     });
 457     btn_prev_page.addKeyListener(new KeyAdapter()
 458     {
 459       @Override
 460       public void keyPressed(KeyEvent evt)
 461       {
 462         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 463         {
 464           prevPageAction();
 465         }
 466       }
 467     });
 468
 469     if (isPaginationEnabled())
 470     {
 471       btn_prev_page.setVisible(true);
 472       btn_next_page.setVisible(true);
 473     }
 474     else
 475     {
 476       btn_prev_page.setVisible(false);
 477       btn_next_page.setVisible(false);
 478     }
 479
 480     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 481     btn_cancel.setText(MessageManager.getString("action.cancel"));
 482     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 483     {
 484       @Override
 485       public void actionPerformed(ActionEvent e)
 486       {
 487         btn_cancel_ActionPerformed();
 488       }
 489     });
 490     btn_cancel.addKeyListener(new KeyAdapter()
 491     {
 492       @Override
 493       public void keyPressed(KeyEvent evt)
 494       {
 495         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 496         {
 497           btn_cancel_ActionPerformed();
 498         }
 499       }
 500     });
 501     scrl_searchResult.setPreferredSize(new Dimension(width, height));
 502
 503     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 504     cmb_searchTarget.addItemListener(new ItemListener()
 505     {
 506       @Override
 507       public void itemStateChanged(ItemEvent e)
 508       {
 509         if (e.getStateChange() == ItemEvent.SELECTED)
 510         {
 511           String tooltipText;
 512           if ("all".equalsIgnoreCase(
 513                   getCmbSearchTarget().getSelectedItem().toString()))
 514           {
 515             tooltipText = MessageManager.getString("label.search_all");
 516           }
 517           else if ("pdb id".equalsIgnoreCase(
 518                   getCmbSearchTarget().getSelectedItem().toString()))
 519           {
 520             tooltipText = MessageManager
 521                     .getString("label.separate_multiple_accession_ids");
 522           }
 523           else
 524           {
 525             tooltipText = MessageManager.formatMessage(
 526                     "label.separate_multiple_query_values", new Object[]
 527                     { getCmbSearchTarget().getSelectedItem().toString() });
 528           }
 529           txt_search.setToolTipText(
 530                   JvSwingUtils.wrapTooltip(true, tooltipText));
 531           searchAction(true);
 532         }
 533       }
 534     });
 535
 536     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 537
 538     txt_search.getEditor().getEditorComponent()
 539             .addKeyListener(new KeyAdapter()
 540             {
 541               @Override
 542               public void keyPressed(KeyEvent e)
 543               {
 544                 if (e.getKeyCode() == KeyEvent.VK_ENTER)
 545                 {
 546                   if (getTypedText() == null || getTypedText().isEmpty())
 547                   {
 548                     return;
 549                   }
 550                   String primaryKeyName = getFTSRestClient()
 551                           .getPrimaryKeyColumn().getName();
 552                   if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
 553                           .getSelectedItem().toString()))
 554                   {
 555                     // TODO: nicer to show the list in the result set before
 556                     // viewing in Jalview perhaps ?
 557                     transferToSequenceFetcher(getTypedText());
 558                   }
 559                   else
 560                   {
 561                     performSearchAction();
 562                   }
 563                 }
 564               }
 565             });
 566     final DeferredTextInputListener listener = new DeferredTextInputListener(
 567             1500, new ActionListener()
 568             {
 569               @Override
 570               public void actionPerformed(ActionEvent e)
 571               {
 572                 if (btn_autosearch.isSelected()
 573                         || txt_search.wasEnterPressed())
 574                 {
 575                   performSearchAction();
 576                 }
 577               }
 578             }, false);
 579     ((JTextComponent) txt_search.getEditor().getEditorComponent())
 580             .getDocument().addDocumentListener(listener);
 581
 582     txt_search.addFocusListener(new FocusListener()
 583     {
 584       @Override
 585       public void focusGained(FocusEvent e)
 586       {
 587         listener.start();
 588       }
 589
 590       @Override
 591       public void focusLost(FocusEvent e)
 592       {
 593         // listener.stop();
 594       }
 595     });
 596
 597     txt_search.addActionListener(new ActionListener()
 598     {
 599
 600       @Override
 601       public void actionPerformed(ActionEvent e)
 602       {
 603         performSearchAction();
 604       }
 605     });
 606     final String searchTabTitle = MessageManager
 607             .getString("label.search_result");
 608     final String configureCols = MessageManager
 609             .getString("label.configure_displayed_columns");
 610     ChangeListener changeListener = new ChangeListener()
 611     {
 612       @Override
 613       public void stateChanged(ChangeEvent changeEvent)
 614       {
 615         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 616                 .getSource();
 617         int index = sourceTabbedPane.getSelectedIndex();
 618
 619         btn_back.setVisible(true);
 620         btn_cancel.setVisible(true);
 621         btn_ok.setVisible(true);
 622         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 623         {
 624           btn_back.setVisible(false);
 625           btn_cancel.setVisible(false);
 626           btn_ok.setVisible(false);
 627           btn_back.setEnabled(false);
 628           btn_cancel.setEnabled(false);
 629           btn_ok.setEnabled(false);
 630           btn_next_page.setEnabled(false);
 631           btn_prev_page.setEnabled(false);
 632           txt_search.setEnabled(false);
 633           cmb_searchTarget.setEnabled(false);
 634           previousWantedFields = getFTSRestClient()
 635                   .getAllDefaultDisplayedFTSDataColumns()
 636                   .toArray(new Object[0]);
 637         }
 638         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 639         {
 640           btn_back.setEnabled(true);
 641           btn_cancel.setEnabled(true);
 642           refreshPaginatorState();
 643           txt_search.setEnabled(true);
 644           cmb_searchTarget.setEnabled(true);
 645           if (wantedFieldsUpdated())
 646           {
 647             searchAction(true);
 648             paginatorCart.clear();
 649           }
 650           else
 651           {
 652             validateSelection();
 653           }
 654         }
 655       }
 656     };
 657     tabbedPane.addChangeListener(changeListener);
 658     tabbedPane.setPreferredSize(new Dimension(width, height));
 659     tabbedPane.add(searchTabTitle, scrl_searchResult);
 660     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
 661             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
 662
 663     pnl_actions.add(btn_back);
 664     pnl_actions.add(btn_ok);
 665     pnl_actions.add(btn_cancel);
 666
 667     pnl_results.add(tabbedPane);
 668     pnl_inputs.add(cmb_searchTarget);
 669     pnl_inputs.add(txt_search);
 670     pnl_inputs.add(btn_autosearch);
 671     pnl_inputs.add(lbl_loading);
 672     pnl_inputs.add(lbl_warning);
 673     pnl_inputs.add(lbl_blank);
 674     pnl_inputs.add(btn_prev_page);
 675     pnl_inputs.add(btn_next_page);
 676
 677     this.setLayout(mainLayout);
 678     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 679     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 680     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 681     mainFrame.setVisible(true);
 682     if (tabs != null)
 683     {
 684       tabs.setOpaque(true);
 685       tabs.insertTab(MessageManager.getString("label.free_text_search"),
 686               null, this, "", 0);
 687       mainFrame.setContentPane(tabs);
 688       tabs.setVisible(true);
 689     }
 690     else
 691     {
 692       mainFrame.setContentPane(this);
 693     }
 694     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 695     mainFrame.addInternalFrameListener(
 696             new javax.swing.event.InternalFrameAdapter()
 697             {
 698               @Override
 699               public void internalFrameClosing(InternalFrameEvent e)
 700               {
 701                 closeAction();
 702               }
 703             });
 704     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 705     Integer x = getTempUserPrefs().get("FTSPanel.x");
 706     Integer y = getTempUserPrefs().get("FTSPanel.y");
 707     if (x != null && y != null)
 708     {
 709       mainFrame.setLocation(x, y);
 710     }
 711     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
 712   }
 713
 714   protected void closeAction()
 715   {
 716     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
 717     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
 718     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
 719     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
 720     mainFrame.dispose();
 721     txt_search.persistCache();
 722   }
 723
 724   public class DeferredTextInputListener implements DocumentListener
 725   {
 726     private final Timer swingTimer;
 727
 728     public DeferredTextInputListener(int timeOut, ActionListener listener,
 729             boolean repeats)
 730     {
 731       swingTimer = new Timer(timeOut, listener);
 732       swingTimer.setRepeats(repeats);
 733     }
 734
 735     public void start()
 736     {
 737       swingTimer.start();
 738     }
 739
 740     public void stop()
 741     {
 742       swingTimer.stop();
 743     }
 744
 745     @Override
 746     public void insertUpdate(DocumentEvent e)
 747     {
 748       swingTimer.restart();
 749     }
 750
 751     @Override
 752     public void removeUpdate(DocumentEvent e)
 753     {
 754       swingTimer.restart();
 755     }
 756
 757     @Override
 758     public void changedUpdate(DocumentEvent e)
 759     {
 760       swingTimer.restart();
 761     }
 762
 763   }
 764
 765   void performSearchAction()
 766   {
 767     String typed = getTypedText();
 768     if (typed != null && typed.length() > 0
 769             && !typed.equalsIgnoreCase(lastSearchTerm))
 770     {
 771       searchAction(true);
 772       paginatorCart.clear();
 773       lastSearchTerm = typed;
 774     }
 775   }
 776
 777   public boolean wantedFieldsUpdated()
 778   {
 779     if (previousWantedFields == null)
 780     {
 781       return false;
 782     }
 783
 784     return Arrays.equals(getFTSRestClient()
 785             .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
 786             previousWantedFields) ? false : true;
 787
 788   }
 789
 790   public void validateSelection()
 791   {
 792     if (tbl_summary.getSelectedRows().length > 0
 793             || !paginatorCart.isEmpty())
 794     {
 795       btn_ok.setEnabled(true);
 796     }
 797     else
 798     {
 799       btn_ok.setEnabled(false);
 800     }
 801   }
 802
 803   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
 804   {
 805     return cmb_searchTarget;
 806   }
 807
 808   public JComboBox<String> getTxtSearch()
 809   {
 810     return txt_search;
 811   }
 812
 813   public JInternalFrame getMainFrame()
 814   {
 815     return mainFrame;
 816   }
 817
 818   protected void delayAndEnableActionButtons()
 819   {
 820     new Thread()
 821     {
 822       @Override
 823       public void run()
 824       {
 825         try
 826         {
 827           Thread.sleep(1500);
 828         } catch (InterruptedException e)
 829         {
 830           e.printStackTrace();
 831         }
 832         btn_ok.setEnabled(true);
 833         btn_back.setEnabled(true);
 834         btn_cancel.setEnabled(true);
 835       }
 836     }.start();
 837   }
 838
 839   protected void checkForErrors()
 840   {
 841     lbl_warning.setVisible(false);
 842     lbl_blank.setVisible(true);
 843     if (errorWarning.length() > 0)
 844     {
 845       lbl_loading.setVisible(false);
 846       lbl_blank.setVisible(false);
 847       lbl_warning.setToolTipText(
 848               JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
 849       lbl_warning.setVisible(true);
 850     }
 851   }
 852
 853   public void btn_back_ActionPerformed()
 854   {
 855     closeAction();
 856     new SequenceFetcher(progressIndicator);
 857   }
 858
 859   protected void disableActionButtons()
 860   {
 861     btn_ok.setEnabled(false);
 862     btn_back.setEnabled(false);
 863     btn_cancel.setEnabled(false);
 864   }
 865
 866   public void btn_cancel_ActionPerformed()
 867   {
 868     closeAction();
 869   }
 870
 871   /**
 872    * Populates search target combo-box options
 873    */
 874   public void populateCmbSearchTargetOptions()
 875   {
 876     List<FTSDataColumnI> searchableTargets = new ArrayList<>();
 877     try
 878     {
 879       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
 880               .getSearchableDataColumns();
 881       searchableTargets.addAll(foundFTSTargets);
 882     } catch (Exception e)
 883     {
 884       e.printStackTrace();
 885     }
 886
 887     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
 888     {
 889       @Override
 890       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
 891       {
 892         return o1.getName().compareTo(o2.getName());
 893       }
 894     });
 895
 896     for (FTSDataColumnI searchTarget : searchableTargets)
 897     {
 898       cmb_searchTarget.addItem(searchTarget);
 899     }
 900   }
 901
 902   public void transferToSequenceFetcher(String ids)
 903   {
 904     seqFetcher.getTextArea().setText(ids);
 905     Thread worker = new Thread(seqFetcher);
 906     worker.start();
 907   }
 908
 909   @Override
 910   public String getTypedText()
 911   {
 912     return txt_search.getUserInput();
 913   }
 914
 915   @Override
 916   public JTable getResultTable()
 917   {
 918     return tbl_summary;
 919   }
 920
 921   public void reset()
 922   {
 923     lbl_loading.setVisible(false);
 924     errorWarning.setLength(0);
 925     lbl_warning.setVisible(false);
 926     lbl_blank.setVisible(true);
 927     btn_ok.setEnabled(false);
 928     mainFrame.setTitle(getFTSFrameTitle());
 929     referesh();
 930     tbl_summary.setModel(new DefaultTableModel());
 931     tbl_summary.setVisible(false);
 932   }
 933
 934   @Override
 935   public void setPrevPageButtonEnabled(boolean isEnabled)
 936   {
 937     btn_prev_page.setEnabled(isEnabled);
 938   }
 939
 940   @Override
 941   public void setNextPageButtonEnabled(boolean isEnabled)
 942   {
 943     btn_next_page.setEnabled(isEnabled);
 944   }
 945
 946   @Override
 947   public void setErrorMessage(String message)
 948   {
 949     errorWarning.append(message);
 950   }
 951
 952   @Override
 953   public void updateSearchFrameTitle(String title)
 954   {
 955     mainFrame.setTitle(title);
 956   }
 957
 958   @Override
 959   public void setSearchInProgress(Boolean isSearchInProgress)
 960   {
 961     lbl_blank.setVisible(!isSearchInProgress);
 962     lbl_loading.setVisible(isSearchInProgress);
 963     txt_search.setEditable(!isSearchInProgress);
 964   }
 965
 966   @Override
 967   public void prevPageAction()
 968   {
 969     updatePaginatorCart();
 970     if (offSet >= pageLimit)
 971     {
 972       offSet = offSet - pageLimit;
 973       searchAction(false);
 974     }
 975     else
 976     {
 977       refreshPaginatorState();
 978     }
 979   }
 980
 981   @Override
 982   public void nextPageAction()
 983   {
 984     updatePaginatorCart();
 985     offSet = offSet + pageLimit;
 986     searchAction(false);
 987   }
 988
 989   public void updatePaginatorCart()
 990   {
 991     int primaryKeyColIndex = 0;
 992     JTable resultTable = getResultTable();
 993     int totalRows = resultTable.getRowCount();
 994     try
 995     {
 996       primaryKeyColIndex = getFTSRestClient()
 997               .getPrimaryKeyColumIndex(wantedFields, false);
 998     } catch (Exception e)
 999     {
1000       e.printStackTrace();
1001     }
1002
1003     for (int row = 0; row < totalRows; row++)
1004     {
1005       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1006       if (paginatorCart.contains(id))
1007       {
1008         paginatorCart.remove(id);
1009       }
1010     }
1011     int[] selectedRows = resultTable.getSelectedRows();
1012     for (int summaryRow : selectedRows)
1013     {
1014       String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
1015               .toString();
1016       paginatorCart.add(idStr);
1017     }
1018   }
1019
1020   public void updateSummaryTableSelections()
1021   {
1022     JTable resultTable = getResultTable();
1023     if (paginatorCart.isEmpty())
1024     {
1025       return;
1026     }
1027     int primaryKeyColIndex = 0;
1028     try
1029     {
1030       primaryKeyColIndex = getFTSRestClient()
1031               .getPrimaryKeyColumIndex(wantedFields, false);
1032     } catch (Exception e)
1033     {
1034       e.printStackTrace();
1035     }
1036     int totalRows = resultTable.getRowCount();
1037     for (int row = 0; row < totalRows; row++)
1038     {
1039       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1040       if (paginatorCart.contains(id))
1041       {
1042         resultTable.addRowSelectionInterval(row, row);
1043       }
1044     }
1045     validateSelection();
1046   }
1047
1048   public void refreshPaginatorState()
1049   {
1050     setPrevPageButtonEnabled(false);
1051     setNextPageButtonEnabled(false);
1052     if (resultSetCount == 0 && pageLimit == 0)
1053     {
1054       return;
1055     }
1056     if (resultSetCount >= pageLimit)
1057     {
1058       setNextPageButtonEnabled(true);
1059     }
1060     if (offSet >= pageLimit)
1061     {
1062       setPrevPageButtonEnabled(true);
1063     }
1064   }
1065
1066   public void referesh()
1067   {
1068     mainFrame.setTitle(getFTSFrameTitle());
1069   }
1070
1071 }