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