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
  77 /**
  78  * This class provides the swing GUI layout for FTS Panel and implements most of
  79  * the contracts defined in GFSPanelI
  80  *
  81  * @author tcnofoegbu
  82  *
  83  */
  84
  85 @SuppressWarnings("serial")
  86 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
  87 {
  88   protected JInternalFrame mainFrame = new JInternalFrame(
  89           getFTSFrameTitle());
  90
  91   protected JTabbedPane tabs = jalview.jbgui.GDesktop.createTabbedPane();
  92
  93   protected IProgressIndicator progressIndicator;
  94
  95   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<>();
  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   JTabbedPane tabbedPane = jalview.jbgui.GDesktop.createTabbedPane();
 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<>();
 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         tabs = null;
 256       }
 257       jbInit();
 258       if (fetcher != null)
 259       {
 260         tabs.addTab(MessageManager.getString("label.retrieve_ids"),
 261                 fetcher);
 262         fetcher.embedIn(this);
 263       }
 264       mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
 265       final JPanel ftsPanel = this;
 266       mainFrame.addFocusListener(new FocusAdapter()
 267       {
 268         @Override
 269         public void focusGained(FocusEvent e)
 270         {
 271           // TODO: make selected tab gain focus in correct widget
 272           if (tabs != null
 273                   && tabs.getSelectedComponent() == ftsPanel)
 274           {
 275             txt_search.getComponent().requestFocusInWindow();
 276           }
 277         }
 278       });
 279       mainFrame.invalidate();
 280       mainFrame.pack();
 281     } catch (Exception e)
 282     {
 283       e.printStackTrace();
 284     }
 285   }
 286
 287   /**
 288    * Initializes the GUI default properties
 289    *
 290    * @throws Exception
 291    */
 292   private void jbInit() throws Exception
 293   {
 294
 295     txt_search = new JvCacheableInputBox<>(getCacheKey());
 296     populateCmbSearchTargetOptions();
 297     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
 298             : getTempUserPrefs().get("FTSPanel.width");
 299     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
 300             : getTempUserPrefs().get("FTSPanel.height");
 301     lbl_warning.setVisible(false);
 302     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 303     lbl_loading.setVisible(false);
 304     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
 305     lbl_blank.setVisible(true);
 306     lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
 307
 308     tbl_summary.setAutoCreateRowSorter(true);
 309     tbl_summary.getTableHeader().setReorderingAllowed(false);
 310     tbl_summary.addMouseListener(new MouseAdapter()
 311     {
 312       @Override
 313       public void mouseClicked(MouseEvent e)
 314       {
 315         validateSelection();
 316       }
 317
 318       @Override
 319       public void mouseReleased(MouseEvent e)
 320       {
 321         validateSelection();
 322       }
 323     });
 324     tbl_summary.addKeyListener(new KeyAdapter()
 325     {
 326       @Override
 327       public void keyPressed(KeyEvent evt)
 328       {
 329         validateSelection();
 330         switch (evt.getKeyCode())
 331         {
 332         case KeyEvent.VK_ESCAPE: // escape key
 333           btn_back_ActionPerformed();
 334           break;
 335         case KeyEvent.VK_ENTER: // enter key
 336           if (btn_ok.isEnabled())
 337           {
 338             okAction();
 339           }
 340           evt.consume();
 341           break;
 342         case KeyEvent.VK_TAB: // tab key
 343           if (evt.isShiftDown())
 344           {
 345             tabbedPane.requestFocus();
 346           }
 347           else
 348           {
 349             btn_back.requestFocus();
 350           }
 351           evt.consume();
 352           break;
 353         default:
 354           return;
 355         }
 356       }
 357     });
 358
 359     btn_autosearch.setText(MessageManager.getString("option.autosearch"));
 360     btn_autosearch.setToolTipText(
 361             MessageManager.getString("option.enable_disable_autosearch"));
 362     btn_autosearch.setSelected(
 363             jalview.bin.Cache.getDefault(getAutosearchPreference(), true));
 364     btn_autosearch.addActionListener(new java.awt.event.ActionListener()
 365     {
 366       @Override
 367       public void actionPerformed(ActionEvent e)
 368       {
 369         jalview.bin.Cache.setProperty(getAutosearchPreference(),
 370                 Boolean.toString(btn_autosearch.isSelected()));
 371       }
 372     });
 373     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 374     btn_back.setText(MessageManager.getString("action.back"));
 375     btn_back.addActionListener(new java.awt.event.ActionListener()
 376     {
 377       @Override
 378       public void actionPerformed(ActionEvent e)
 379       {
 380         btn_back_ActionPerformed();
 381       }
 382     });
 383     btn_back.addKeyListener(new KeyAdapter()
 384     {
 385       @Override
 386       public void keyPressed(KeyEvent evt)
 387       {
 388         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 389         {
 390           btn_back_ActionPerformed();
 391         }
 392       }
 393     });
 394
 395     btn_ok.setEnabled(false);
 396     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 397     btn_ok.setText(MessageManager.getString("action.ok"));
 398     btn_ok.addActionListener(new java.awt.event.ActionListener()
 399     {
 400       @Override
 401       public void actionPerformed(ActionEvent e)
 402       {
 403         okAction();
 404       }
 405     });
 406     btn_ok.addKeyListener(new KeyAdapter()
 407     {
 408       @Override
 409       public void keyPressed(KeyEvent evt)
 410       {
 411         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 412         {
 413           okAction();
 414         }
 415       }
 416     });
 417     btn_next_page.setEnabled(false);
 418     btn_next_page.setToolTipText(
 419             MessageManager.getString("label.next_page_tooltip"));
 420     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
 421     btn_next_page.setText(MessageManager.getString("action.next_page"));
 422     btn_next_page.addActionListener(new java.awt.event.ActionListener()
 423     {
 424       @Override
 425       public void actionPerformed(ActionEvent e)
 426       {
 427         nextPageAction();
 428       }
 429     });
 430     btn_next_page.addKeyListener(new KeyAdapter()
 431     {
 432       @Override
 433       public void keyPressed(KeyEvent evt)
 434       {
 435         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 436         {
 437           nextPageAction();
 438         }
 439       }
 440     });
 441
 442     btn_prev_page.setEnabled(false);
 443     btn_prev_page.setToolTipText(
 444             MessageManager.getString("label.prev_page_tooltip"));
 445     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
 446     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
 447     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
 448     {
 449       @Override
 450       public void actionPerformed(ActionEvent e)
 451       {
 452         prevPageAction();
 453       }
 454     });
 455     btn_prev_page.addKeyListener(new KeyAdapter()
 456     {
 457       @Override
 458       public void keyPressed(KeyEvent evt)
 459       {
 460         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 461         {
 462           prevPageAction();
 463         }
 464       }
 465     });
 466
 467     if (isPaginationEnabled())
 468     {
 469       btn_prev_page.setVisible(true);
 470       btn_next_page.setVisible(true);
 471     }
 472     else
 473     {
 474       btn_prev_page.setVisible(false);
 475       btn_next_page.setVisible(false);
 476     }
 477
 478     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 479     btn_cancel.setText(MessageManager.getString("action.cancel"));
 480     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 481     {
 482       @Override
 483       public void actionPerformed(ActionEvent e)
 484       {
 485         btn_cancel_ActionPerformed();
 486       }
 487     });
 488     btn_cancel.addKeyListener(new KeyAdapter()
 489     {
 490       @Override
 491       public void keyPressed(KeyEvent evt)
 492       {
 493         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 494         {
 495           btn_cancel_ActionPerformed();
 496         }
 497       }
 498     });
 499     scrl_searchResult.setPreferredSize(new Dimension(width, height));
 500
 501     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 502     cmb_searchTarget.addItemListener(new ItemListener()
 503     {
 504       @Override
 505       public void itemStateChanged(ItemEvent e)
 506       {
 507         if (e.getStateChange() == ItemEvent.SELECTED)
 508         {
 509           String tooltipText;
 510           if ("all".equalsIgnoreCase(
 511                   getCmbSearchTarget().getSelectedItem().toString()))
 512           {
 513             tooltipText = MessageManager.getString("label.search_all");
 514           }
 515           else if ("pdb id".equalsIgnoreCase(
 516                   getCmbSearchTarget().getSelectedItem().toString()))
 517           {
 518             tooltipText = MessageManager
 519                     .getString("label.separate_multiple_accession_ids");
 520           }
 521           else
 522           {
 523             tooltipText = MessageManager.formatMessage(
 524                     "label.separate_multiple_query_values", new Object[]
 525                     { getCmbSearchTarget().getSelectedItem().toString() });
 526           }
 527           txt_search.getComponent().setToolTipText(
 528                   JvSwingUtils.wrapTooltip(true, tooltipText));
 529           searchAction(true);
 530         }
 531       }
 532     });
 533
 534     txt_search.getComponent().setFont(new java.awt.Font("Verdana", 0, 12));
 535
 536     txt_search.addKeyListener(new KeyAdapter()
 537             {
 538               @Override
 539               public void keyPressed(KeyEvent e)
 540               {
 541                 if (e.getKeyCode() == KeyEvent.VK_ENTER)
 542                 {
 543                   if (getTypedText() == null || getTypedText().isEmpty())
 544                   {
 545                     return;
 546                   }
 547                   String primaryKeyName = getFTSRestClient()
 548                           .getPrimaryKeyColumn().getName();
 549                   if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
 550                           .getSelectedItem().toString()))
 551                   {
 552                     // TODO: nicer to show the list in the result set before
 553                     // viewing in Jalview perhaps ?
 554                     transferToSequenceFetcher(getTypedText());
 555                   }
 556                   else
 557                   {
 558                     performSearchAction();
 559                   }
 560                 }
 561               }
 562             });
 563     final DeferredTextInputListener listener = new DeferredTextInputListener(
 564             1500, new ActionListener()
 565             {
 566               @Override
 567               public void actionPerformed(ActionEvent e)
 568               {
 569                 if (btn_autosearch.isSelected()
 570                         || txt_search.wasEnterPressed())
 571                 {
 572                   performSearchAction();
 573                 }
 574               }
 575             }, false);
 576     txt_search.addDocumentListener(listener);
 577
 578     txt_search.addFocusListener(new FocusListener()
 579     {
 580       @Override
 581       public void focusGained(FocusEvent e)
 582       {
 583         listener.start();
 584       }
 585
 586       @Override
 587       public void focusLost(FocusEvent e)
 588       {
 589         // listener.stop();
 590       }
 591     });
 592
 593     txt_search.addActionListener(new ActionListener()
 594     {
 595       @Override
 596       public void actionPerformed(ActionEvent e)
 597       {
 598         performSearchAction();
 599       }
 600     });
 601     final String searchTabTitle = MessageManager
 602             .getString("label.search_result");
 603     final String configureCols = MessageManager
 604             .getString("label.configure_displayed_columns");
 605     ChangeListener changeListener = new ChangeListener()
 606     {
 607       @Override
 608       public void stateChanged(ChangeEvent changeEvent)
 609       {
 610         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 611                 .getSource();
 612         int index = sourceTabbedPane.getSelectedIndex();
 613
 614         btn_back.setVisible(true);
 615         btn_cancel.setVisible(true);
 616         btn_ok.setVisible(true);
 617         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 618         {
 619           btn_back.setVisible(false);
 620           btn_cancel.setVisible(false);
 621           btn_ok.setVisible(false);
 622           btn_back.setEnabled(false);
 623           btn_cancel.setEnabled(false);
 624           btn_ok.setEnabled(false);
 625           btn_next_page.setEnabled(false);
 626           btn_prev_page.setEnabled(false);
 627           txt_search.getComponent().setEnabled(false);
 628           cmb_searchTarget.setEnabled(false);
 629           previousWantedFields = getFTSRestClient()
 630                   .getAllDefaultDisplayedFTSDataColumns()
 631                   .toArray(new Object[0]);
 632         }
 633         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 634         {
 635           btn_back.setEnabled(true);
 636           btn_cancel.setEnabled(true);
 637           refreshPaginatorState();
 638           txt_search.getComponent().setEnabled(true);
 639           cmb_searchTarget.setEnabled(true);
 640           if (wantedFieldsUpdated())
 641           {
 642             searchAction(true);
 643             paginatorCart.clear();
 644           }
 645           else
 646           {
 647             validateSelection();
 648           }
 649         }
 650       }
 651     };
 652     tabbedPane.addChangeListener(changeListener);
 653     tabbedPane.setPreferredSize(new Dimension(width, height));
 654     tabbedPane.add(searchTabTitle, scrl_searchResult);
 655     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
 656             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
 657
 658     pnl_actions.add(btn_back);
 659     pnl_actions.add(btn_ok);
 660     pnl_actions.add(btn_cancel);
 661
 662     pnl_results.add(tabbedPane);
 663     pnl_inputs.add(cmb_searchTarget);
 664     pnl_inputs.add(txt_search.getComponent());
 665     pnl_inputs.add(btn_autosearch);
 666     pnl_inputs.add(lbl_loading);
 667     pnl_inputs.add(lbl_warning);
 668     pnl_inputs.add(lbl_blank);
 669     pnl_inputs.add(btn_prev_page);
 670     pnl_inputs.add(btn_next_page);
 671
 672     this.setLayout(mainLayout);
 673     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 674     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 675     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 676     mainFrame.setVisible(true);
 677     if (tabs != null)
 678     {
 679       tabs.setOpaque(true);
 680       tabs.insertTab(MessageManager.getString("label.free_text_search"),
 681               null, this, "", 0);
 682       mainFrame.setContentPane(tabs);
 683       tabs.setVisible(true);
 684     }
 685     else
 686     {
 687       mainFrame.setContentPane(this);
 688     }
 689     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 690     mainFrame.addInternalFrameListener(
 691             new javax.swing.event.InternalFrameAdapter()
 692             {
 693               @Override
 694               public void internalFrameClosing(InternalFrameEvent e)
 695               {
 696                 closeAction();
 697               }
 698             });
 699     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 700     Integer x = getTempUserPrefs().get("FTSPanel.x");
 701     Integer y = getTempUserPrefs().get("FTSPanel.y");
 702     if (x != null && y != null)
 703     {
 704       mainFrame.setLocation(x, y);
 705     }
 706     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
 707   }
 708
 709   protected void closeAction()
 710   {
 711     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
 712     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
 713     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
 714     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
 715     mainFrame.dispose();
 716     txt_search.persistCache();
 717   }
 718
 719   public class DeferredTextInputListener implements DocumentListener
 720   {
 721     private final Timer swingTimer;
 722
 723     public DeferredTextInputListener(int timeOut, ActionListener listener,
 724             boolean repeats)
 725     {
 726       swingTimer = new Timer(timeOut, listener);
 727       swingTimer.setRepeats(repeats);
 728     }
 729
 730     public void start()
 731     {
 732       swingTimer.start();
 733     }
 734
 735     public void stop()
 736     {
 737       swingTimer.stop();
 738     }
 739
 740     @Override
 741     public void insertUpdate(DocumentEvent e)
 742     {
 743       swingTimer.restart();
 744     }
 745
 746     @Override
 747     public void removeUpdate(DocumentEvent e)
 748     {
 749       swingTimer.restart();
 750     }
 751
 752     @Override
 753     public void changedUpdate(DocumentEvent e)
 754     {
 755       swingTimer.restart();
 756     }
 757
 758   }
 759
 760   void performSearchAction()
 761   {
 762     String typed = getTypedText();
 763     if (typed != null && typed.length() > 0
 764             && !typed.equalsIgnoreCase(lastSearchTerm))
 765     {
 766       searchAction(true);
 767       paginatorCart.clear();
 768       lastSearchTerm = typed;
 769     }
 770   }
 771
 772   public boolean wantedFieldsUpdated()
 773   {
 774     if (previousWantedFields == null)
 775     {
 776       return false;
 777     }
 778
 779     return Arrays.equals(getFTSRestClient()
 780             .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
 781             previousWantedFields) ? false : true;
 782
 783   }
 784
 785   public void validateSelection()
 786   {
 787     if (tbl_summary.getSelectedRows().length > 0
 788             || !paginatorCart.isEmpty())
 789     {
 790       btn_ok.setEnabled(true);
 791     }
 792     else
 793     {
 794       btn_ok.setEnabled(false);
 795     }
 796   }
 797
 798   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
 799   {
 800     return cmb_searchTarget;
 801   }
 802
 803   public JInternalFrame getMainFrame()
 804   {
 805     return mainFrame;
 806   }
 807
 808   protected void delayAndEnableActionButtons()
 809   {
 810     new Thread()
 811     {
 812       @Override
 813       public void run()
 814       {
 815         try
 816         {
 817           Thread.sleep(1500);
 818         } catch (InterruptedException e)
 819         {
 820           e.printStackTrace();
 821         }
 822         btn_ok.setEnabled(true);
 823         btn_back.setEnabled(true);
 824         btn_cancel.setEnabled(true);
 825       }
 826     }.start();
 827   }
 828
 829   protected void checkForErrors()
 830   {
 831     lbl_warning.setVisible(false);
 832     lbl_blank.setVisible(true);
 833     if (errorWarning.length() > 0)
 834     {
 835       lbl_loading.setVisible(false);
 836       lbl_blank.setVisible(false);
 837       lbl_warning.setToolTipText(
 838               JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
 839       lbl_warning.setVisible(true);
 840     }
 841   }
 842
 843   /**
 844    * Action on Back button is to close this panel and open a new Sequence
 845    * Fetcher panel
 846    */
 847   public void btn_back_ActionPerformed()
 848   {
 849     closeAction();
 850     new SequenceFetcher(progressIndicator);
 851   }
 852
 853   protected void disableActionButtons()
 854   {
 855     btn_ok.setEnabled(false);
 856     btn_back.setEnabled(false);
 857     btn_cancel.setEnabled(false);
 858   }
 859
 860   public void btn_cancel_ActionPerformed()
 861   {
 862     closeAction();
 863   }
 864
 865   /**
 866    * Populates search target combo-box options
 867    */
 868   public void populateCmbSearchTargetOptions()
 869   {
 870     List<FTSDataColumnI> searchableTargets = new ArrayList<>();
 871     try
 872     {
 873       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
 874               .getSearchableDataColumns();
 875       searchableTargets.addAll(foundFTSTargets);
 876     } catch (Exception e)
 877     {
 878       e.printStackTrace();
 879     }
 880
 881     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
 882     {
 883       @Override
 884       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
 885       {
 886         return o1.getName().compareTo(o2.getName());
 887       }
 888     });
 889
 890     for (FTSDataColumnI searchTarget : searchableTargets)
 891     {
 892       cmb_searchTarget.addItem(searchTarget);
 893     }
 894   }
 895
 896   public void transferToSequenceFetcher(String ids)
 897   {
 898     seqFetcher.setQuery(ids);
 899     Thread worker = new Thread(seqFetcher);
 900     worker.start();
 901   }
 902
 903   @Override
 904   public String getTypedText()
 905   {
 906     return txt_search.getUserInput();
 907   }
 908
 909   @Override
 910   public JTable getResultTable()
 911   {
 912     return tbl_summary;
 913   }
 914
 915   public void reset()
 916   {
 917     lbl_loading.setVisible(false);
 918     errorWarning.setLength(0);
 919     lbl_warning.setVisible(false);
 920     lbl_blank.setVisible(true);
 921     btn_ok.setEnabled(false);
 922     mainFrame.setTitle(getFTSFrameTitle());
 923     refresh();
 924     tbl_summary.setModel(new DefaultTableModel());
 925     tbl_summary.setVisible(false);
 926   }
 927
 928   @Override
 929   public void setPrevPageButtonEnabled(boolean isEnabled)
 930   {
 931     btn_prev_page.setEnabled(isEnabled);
 932   }
 933
 934   @Override
 935   public void setNextPageButtonEnabled(boolean isEnabled)
 936   {
 937     btn_next_page.setEnabled(isEnabled);
 938   }
 939
 940   @Override
 941   public void setErrorMessage(String message)
 942   {
 943     errorWarning.append(message);
 944   }
 945
 946   @Override
 947   public void updateSearchFrameTitle(String title)
 948   {
 949     mainFrame.setTitle(title);
 950   }
 951
 952   @Override
 953   public void setSearchInProgress(Boolean isSearchInProgress)
 954   {
 955     lbl_blank.setVisible(!isSearchInProgress);
 956     lbl_loading.setVisible(isSearchInProgress);
 957     txt_search.setEditable(!isSearchInProgress);
 958   }
 959
 960   @Override
 961   public void prevPageAction()
 962   {
 963     updatePaginatorCart();
 964     if (offSet >= pageLimit)
 965     {
 966       offSet = offSet - pageLimit;
 967       searchAction(false);
 968     }
 969     else
 970     {
 971       refreshPaginatorState();
 972     }
 973   }
 974
 975   @Override
 976   public void nextPageAction()
 977   {
 978     updatePaginatorCart();
 979     offSet = offSet + pageLimit;
 980     searchAction(false);
 981   }
 982
 983   public void updatePaginatorCart()
 984   {
 985     int primaryKeyColIndex = 0;
 986     JTable resultTable = getResultTable();
 987     int totalRows = resultTable.getRowCount();
 988     try
 989     {
 990       primaryKeyColIndex = getFTSRestClient()
 991               .getPrimaryKeyColumIndex(wantedFields, false);
 992     } catch (Exception e)
 993     {
 994       e.printStackTrace();
 995     }
 996
 997     for (int row = 0; row < totalRows; row++)
 998     {
 999       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1000       if (paginatorCart.contains(id))
1001       {
1002         paginatorCart.remove(id);
1003       }
1004     }
1005     int[] selectedRows = resultTable.getSelectedRows();
1006     for (int summaryRow : selectedRows)
1007     {
1008       String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
1009               .toString();
1010       paginatorCart.add(idStr);
1011     }
1012   }
1013
1014   public void updateSummaryTableSelections()
1015   {
1016     JTable resultTable = getResultTable();
1017     if (paginatorCart.isEmpty())
1018     {
1019       return;
1020     }
1021     int primaryKeyColIndex = 0;
1022     try
1023     {
1024       primaryKeyColIndex = getFTSRestClient()
1025               .getPrimaryKeyColumIndex(wantedFields, false);
1026     } catch (Exception e)
1027     {
1028       e.printStackTrace();
1029     }
1030     int totalRows = resultTable.getRowCount();
1031     for (int row = 0; row < totalRows; row++)
1032     {
1033       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1034       if (paginatorCart.contains(id))
1035       {
1036         resultTable.addRowSelectionInterval(row, row);
1037       }
1038     }
1039     validateSelection();
1040   }
1041
1042   public void refreshPaginatorState()
1043   {
1044     setPrevPageButtonEnabled(false);
1045     setNextPageButtonEnabled(false);
1046     if (resultSetCount == 0 && pageLimit == 0)
1047     {
1048       return;
1049     }
1050     if (resultSetCount >= pageLimit)
1051     {
1052       setNextPageButtonEnabled(true);
1053     }
1054     if (offSet >= pageLimit)
1055     {
1056       setPrevPageButtonEnabled(true);
1057     }
1058   }
1059
1060   public void refresh()
1061   {
1062     mainFrame.setTitle(getFTSFrameTitle());
1063   }
1064
1065   @Override
1066   public abstract void okAction();
1067 }