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.bin.Cache;
  25 import jalview.fts.api.FTSDataColumnI;
  26 import jalview.fts.api.GFTSPanelI;
  27 import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
  28 import jalview.gui.Desktop;
  29 import jalview.gui.IProgressIndicator;
  30 import jalview.gui.JvSwingUtils;
  31 import jalview.gui.SequenceFetcher;
  32 import jalview.io.cache.JvCacheableInputBox;
  33 import jalview.util.MessageManager;
  34 import jalview.util.Platform;
  35
  36 import java.awt.BorderLayout;
  37 import java.awt.CardLayout;
  38 import java.awt.Dimension;
  39 import java.awt.event.ActionEvent;
  40 import java.awt.event.ActionListener;
  41 import java.awt.event.FocusAdapter;
  42 import java.awt.event.FocusEvent;
  43 import java.awt.event.FocusListener;
  44 import java.awt.event.ItemEvent;
  45 import java.awt.event.ItemListener;
  46 import java.awt.event.KeyAdapter;
  47 import java.awt.event.KeyEvent;
  48 import java.awt.event.MouseAdapter;
  49 import java.awt.event.MouseEvent;
  50 import java.text.DecimalFormat;
  51 import java.util.ArrayList;
  52 import java.util.Arrays;
  53 import java.util.Collection;
  54 import java.util.Collections;
  55 import java.util.Comparator;
  56 import java.util.HashSet;
  57 import java.util.List;
  58
  59 import javax.swing.ImageIcon;
  60 import javax.swing.JButton;
  61 import javax.swing.JCheckBox;
  62 import javax.swing.JComboBox;
  63 import javax.swing.JFrame;
  64 import javax.swing.JInternalFrame;
  65 import javax.swing.JLabel;
  66 import javax.swing.JPanel;
  67 import javax.swing.JScrollPane;
  68 import javax.swing.JTabbedPane;
  69 import javax.swing.JTable;
  70 import javax.swing.Timer;
  71 import javax.swing.event.ChangeEvent;
  72 import javax.swing.event.ChangeListener;
  73 import javax.swing.event.DocumentEvent;
  74 import javax.swing.event.DocumentListener;
  75 import javax.swing.event.InternalFrameEvent;
  76 import javax.swing.table.DefaultTableModel;
  77 import javax.swing.table.TableColumn;
  78
  79 /**
  80  * This class provides the swing GUI layout for FTS Panel and implements most of
  81  * the contracts defined in GFSPanelI
  82  *
  83  * @author tcnofoegbu
  84  *
  85  */
  86
  87 @SuppressWarnings("serial")
  88 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
  89 {
  90   protected JInternalFrame mainFrame = new JInternalFrame(
  91           getFTSFrameTitle());
  92
  93   protected JTabbedPane tabs = jalview.jbgui.GDesktop.createTabbedPane();
  94
  95   protected IProgressIndicator progressIndicator;
  96
  97   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<>();
  98
  99   protected JButton btn_ok = new JButton();
 100
 101   protected JButton btn_back = new JButton();
 102
 103   protected JButton btn_cancel = new JButton();
 104
 105   protected JCheckBox btn_autosearch = new JCheckBox();
 106
 107   protected JvCacheableInputBox<String> txt_search;
 108
 109   protected SequenceFetcher seqFetcher;
 110
 111   protected Collection<FTSDataColumnI> wantedFields;
 112
 113   private String lastSearchTerm = "";
 114
 115   protected JButton btn_next_page = new JButton();
 116
 117   protected JButton btn_prev_page = new JButton();
 118
 119   protected StringBuilder errorWarning = new StringBuilder();
 120
 121   protected ImageIcon warningImage = new ImageIcon(
 122           getClass().getResource("/images/warning.gif"));
 123
 124   protected ImageIcon loadingImage = new ImageIcon(
 125           getClass().getResource("/images/loading.gif"));
 126
 127   protected ImageIcon balnkPlaceholderImage = new ImageIcon(
 128           getClass().getResource("/images/blank_16x16_placeholder.png"));
 129
 130   protected JLabel lbl_warning = new JLabel(warningImage);
 131
 132   protected JLabel lbl_loading = new JLabel(loadingImage);
 133
 134   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
 135
 136   JTabbedPane tabbedPane = jalview.jbgui.GDesktop.createTabbedPane();
 137
 138   private JPanel pnl_actions = new JPanel();
 139
 140   private JPanel pnl_results = new JPanel(new CardLayout());
 141
 142   private JPanel pnl_inputs = new JPanel();
 143
 144   private BorderLayout mainLayout = new BorderLayout();
 145
 146   protected Object[] previousWantedFields;
 147
 148   protected int resultSetCount;
 149
 150   protected int totalResultSetCount;
 151
 152   protected int offSet;
 153
 154   protected int pageLimit;
 155
 156   protected HashSet<String> paginatorCart = new HashSet<>();
 157
 158   private static final int MIN_WIDTH = 670;
 159
 160   private static final int MIN_HEIGHT = 300;
 161
 162   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
 163           "###,###");
 164
 165   private JTable tbl_summary = new JTable()
 166   {
 167     private boolean inLayout;
 168
 169     @Override
 170     public boolean getScrollableTracksViewportWidth()
 171     {
 172       return hasExcessWidth();
 173
 174     }
 175
 176     @Override
 177     public void doLayout()
 178     {
 179       if (hasExcessWidth())
 180       {
 181         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
 182       }
 183       inLayout = true;
 184       super.doLayout();
 185       inLayout = false;
 186       autoResizeMode = AUTO_RESIZE_OFF;
 187     }
 188
 189     protected boolean hasExcessWidth()
 190     {
 191       return getPreferredSize().width < getParent().getWidth();
 192     }
 193
 194     @Override
 195     public void columnMarginChanged(ChangeEvent e)
 196     {
 197       if (isEditing())
 198       {
 199         removeEditor();
 200       }
 201       TableColumn resizingColumn = getTableHeader().getResizingColumn();
 202       // Need to do this here, before the parent's
 203       // layout manager calls getPreferredSize().
 204       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
 205               && !inLayout)
 206       {
 207         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
 208         String colHeader = resizingColumn.getHeaderValue().toString();
 209         getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
 210       }
 211       resizeAndRepaint();
 212     }
 213
 214     @Override
 215     public String getToolTipText(MouseEvent evt)
 216     {
 217       String toolTipText = null;
 218       java.awt.Point pnt = evt.getPoint();
 219       int rowIndex = rowAtPoint(pnt);
 220       int colIndex = columnAtPoint(pnt);
 221
 222       try
 223       {
 224         if (getValueAt(rowIndex, colIndex) == null)
 225         {
 226           return null;
 227         }
 228         toolTipText = getValueAt(rowIndex, colIndex).toString();
 229
 230       } catch (Exception e)
 231       {
 232         e.printStackTrace();
 233       }
 234       toolTipText = (toolTipText == null ? null
 235               : (toolTipText.length() > 500
 236                       ? JvSwingUtils.wrapTooltip(true,
 237                               toolTipText.subSequence(0, 500) + "...")
 238                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 239
 240       return toolTipText;
 241     }
 242   };
 243
 244   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 245
 246   public GFTSPanel()
 247   {
 248     this(null);
 249   }
 250
 251   public GFTSPanel(SequenceFetcher fetcher)
 252   {
 253     try
 254     {
 255       if (fetcher == null)
 256       {
 257         tabs = null;
 258       }
 259       jbInit();
 260       if (fetcher != null)
 261       {
 262         tabs.addTab(MessageManager.getString("label.retrieve_ids"),
 263                 fetcher);
 264         fetcher.embedIn(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.getComponent().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(Platform.isJS() ? false :
 365                 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.getComponent().setToolTipText(
 530                   JvSwingUtils.wrapTooltip(true, tooltipText));
 531           searchAction(true);
 532         }
 533       }
 534     });
 535
 536     txt_search.getComponent().setFont(new java.awt.Font("Verdana", 0, 12));
 537
 538     txt_search.addKeyListener(new KeyAdapter()
 539             {
 540               @Override
 541               public void keyPressed(KeyEvent e)
 542               {
 543                 if (e.getKeyCode() == KeyEvent.VK_ENTER)
 544                 {
 545                   if (getTypedText() == null || getTypedText().isEmpty())
 546                   {
 547                     return;
 548                   }
 549                   String primaryKeyName = getFTSRestClient()
 550                           .getPrimaryKeyColumn().getName();
 551                   if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
 552                           .getSelectedItem().toString()))
 553                   {
 554                     // TODO: nicer to show the list in the result set before
 555                     // viewing in Jalview perhaps ?
 556                     transferToSequenceFetcher(getTypedText());
 557                   }
 558                   else
 559                   {
 560                     performSearchAction();
 561                   }
 562                 }
 563               }
 564             });
 565     final DeferredTextInputListener listener = new DeferredTextInputListener(
 566             1500, new ActionListener()
 567             {
 568               @Override
 569               public void actionPerformed(ActionEvent e)
 570               {
 571                 if (btn_autosearch.isSelected()
 572                         || txt_search.wasEnterPressed())
 573                 {
 574                   performSearchAction();
 575                 }
 576               }
 577             }, false);
 578     txt_search.addDocumentListener(listener);
 579
 580     txt_search.addFocusListener(new FocusListener()
 581     {
 582       @Override
 583       public void focusGained(FocusEvent e)
 584       {
 585         listener.start();
 586       }
 587
 588       @Override
 589       public void focusLost(FocusEvent e)
 590       {
 591         // listener.stop();
 592       }
 593     });
 594
 595     txt_search.addActionListener(new ActionListener()
 596     {
 597       @Override
 598       public void actionPerformed(ActionEvent e)
 599       {
 600         performSearchAction();
 601       }
 602     });
 603     final String searchTabTitle = MessageManager
 604             .getString("label.search_result");
 605     final String configureCols = MessageManager
 606             .getString("label.configure_displayed_columns");
 607     ChangeListener changeListener = new ChangeListener()
 608     {
 609       @Override
 610       public void stateChanged(ChangeEvent changeEvent)
 611       {
 612         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 613                 .getSource();
 614         int index = sourceTabbedPane.getSelectedIndex();
 615
 616         btn_back.setVisible(true);
 617         btn_cancel.setVisible(true);
 618         btn_ok.setVisible(true);
 619         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 620         {
 621           btn_back.setVisible(false);
 622           btn_cancel.setVisible(false);
 623           btn_ok.setVisible(false);
 624           btn_back.setEnabled(false);
 625           btn_cancel.setEnabled(false);
 626           btn_ok.setEnabled(false);
 627           btn_next_page.setEnabled(false);
 628           btn_prev_page.setEnabled(false);
 629           txt_search.getComponent().setEnabled(false);
 630           cmb_searchTarget.setEnabled(false);
 631           previousWantedFields = getFTSRestClient()
 632                   .getAllDefaultDisplayedFTSDataColumns()
 633                   .toArray(new Object[0]);
 634         }
 635         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 636         {
 637           btn_back.setEnabled(true);
 638           btn_cancel.setEnabled(true);
 639           refreshPaginatorState();
 640           txt_search.getComponent().setEnabled(true);
 641           cmb_searchTarget.setEnabled(true);
 642           if (wantedFieldsUpdated())
 643           {
 644             searchAction(true);
 645             paginatorCart.clear();
 646           }
 647           else
 648           {
 649             validateSelection();
 650           }
 651         }
 652       }
 653     };
 654     tabbedPane.addChangeListener(changeListener);
 655     tabbedPane.setPreferredSize(new Dimension(width, height));
 656     tabbedPane.add(searchTabTitle, scrl_searchResult);
 657     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
 658             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
 659
 660     pnl_actions.add(btn_back);
 661     pnl_actions.add(btn_ok);
 662     pnl_actions.add(btn_cancel);
 663
 664     pnl_results.add(tabbedPane);
 665     pnl_inputs.add(cmb_searchTarget);
 666     pnl_inputs.add(txt_search.getComponent());
 667     pnl_inputs.add(btn_autosearch);
 668     pnl_inputs.add(lbl_loading);
 669     pnl_inputs.add(lbl_warning);
 670     pnl_inputs.add(lbl_blank);
 671     pnl_inputs.add(btn_prev_page);
 672     pnl_inputs.add(btn_next_page);
 673
 674     this.setLayout(mainLayout);
 675     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 676     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 677     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 678     mainFrame.setVisible(true);
 679     if (tabs != null)
 680     {
 681       tabs.setOpaque(true);
 682       tabs.insertTab(MessageManager.getString("label.free_text_search"),
 683               null, this, "", 0);
 684       mainFrame.setContentPane(tabs);
 685       tabs.setVisible(true);
 686     }
 687     else
 688     {
 689       mainFrame.setContentPane(this);
 690     }
 691     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 692     mainFrame.addInternalFrameListener(
 693             new javax.swing.event.InternalFrameAdapter()
 694             {
 695               @Override
 696               public void internalFrameClosing(InternalFrameEvent e)
 697               {
 698                 closeAction();
 699               }
 700             });
 701     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 702     Integer x = getTempUserPrefs().get("FTSPanel.x");
 703     Integer y = getTempUserPrefs().get("FTSPanel.y");
 704     if (x != null && y != null)
 705     {
 706       mainFrame.setLocation(x, y);
 707     }
 708     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
 709   }
 710
 711   protected void closeAction()
 712   {
 713     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
 714     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
 715     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
 716     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
 717     mainFrame.dispose();
 718     txt_search.persistCache();
 719   }
 720
 721   public class DeferredTextInputListener implements DocumentListener
 722   {
 723     private final Timer swingTimer;
 724
 725     public DeferredTextInputListener(int timeOut, ActionListener listener,
 726             boolean repeats)
 727     {
 728       swingTimer = new Timer(timeOut, listener);
 729       swingTimer.setRepeats(repeats);
 730     }
 731
 732     public void start()
 733     {
 734       swingTimer.start();
 735     }
 736
 737     public void stop()
 738     {
 739       swingTimer.stop();
 740     }
 741
 742     @Override
 743     public void insertUpdate(DocumentEvent e)
 744     {
 745       swingTimer.restart();
 746     }
 747
 748     @Override
 749     public void removeUpdate(DocumentEvent e)
 750     {
 751       swingTimer.restart();
 752     }
 753
 754     @Override
 755     public void changedUpdate(DocumentEvent e)
 756     {
 757       swingTimer.restart();
 758     }
 759
 760   }
 761
 762   void performSearchAction()
 763   {
 764     String typed = getTypedText();
 765     if (typed != null && typed.length() > 0
 766             && !typed.equalsIgnoreCase(lastSearchTerm))
 767     {
 768       searchAction(true);
 769       paginatorCart.clear();
 770       lastSearchTerm = typed;
 771     }
 772   }
 773
 774   public boolean wantedFieldsUpdated()
 775   {
 776     if (previousWantedFields == null)
 777     {
 778       return false;
 779     }
 780
 781     return Arrays.equals(getFTSRestClient()
 782             .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
 783             previousWantedFields) ? false : true;
 784
 785   }
 786
 787   public void validateSelection()
 788   {
 789     if (tbl_summary.getSelectedRows().length > 0
 790             || !paginatorCart.isEmpty())
 791     {
 792       btn_ok.setEnabled(true);
 793     }
 794     else
 795     {
 796       btn_ok.setEnabled(false);
 797     }
 798   }
 799
 800   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
 801   {
 802     return cmb_searchTarget;
 803   }
 804
 805   public JInternalFrame getMainFrame()
 806   {
 807     return mainFrame;
 808   }
 809
 810   protected void delayAndEnableActionButtons()
 811   {
 812     new Thread()
 813     {
 814       @Override
 815       public void run()
 816       {
 817         try
 818         {
 819           Thread.sleep(1500);
 820         } catch (InterruptedException e)
 821         {
 822           e.printStackTrace();
 823         }
 824         btn_ok.setEnabled(true);
 825         btn_back.setEnabled(true);
 826         btn_cancel.setEnabled(true);
 827       }
 828     }.start();
 829   }
 830
 831   protected void checkForErrors()
 832   {
 833     lbl_warning.setVisible(false);
 834     lbl_blank.setVisible(true);
 835     if (errorWarning.length() > 0)
 836     {
 837       lbl_loading.setVisible(false);
 838       lbl_blank.setVisible(false);
 839       lbl_warning.setToolTipText(
 840               JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
 841       lbl_warning.setVisible(true);
 842     }
 843   }
 844
 845   /**
 846    * Action on Back button is to close this panel and open a new Sequence
 847    * Fetcher panel
 848    */
 849   public void btn_back_ActionPerformed()
 850   {
 851     closeAction();
 852     new SequenceFetcher(progressIndicator);
 853   }
 854
 855   protected void disableActionButtons()
 856   {
 857     btn_ok.setEnabled(false);
 858     btn_back.setEnabled(false);
 859     btn_cancel.setEnabled(false);
 860   }
 861
 862   public void btn_cancel_ActionPerformed()
 863   {
 864     closeAction();
 865   }
 866
 867   /**
 868    * Populates search target combo-box options
 869    */
 870   public void populateCmbSearchTargetOptions()
 871   {
 872     List<FTSDataColumnI> searchableTargets = new ArrayList<>();
 873     try
 874     {
 875       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
 876               .getSearchableDataColumns();
 877       searchableTargets.addAll(foundFTSTargets);
 878     } catch (Exception e)
 879     {
 880       e.printStackTrace();
 881     }
 882
 883     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
 884     {
 885       @Override
 886       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
 887       {
 888         return o1.getName().compareTo(o2.getName());
 889       }
 890     });
 891
 892     for (FTSDataColumnI searchTarget : searchableTargets)
 893     {
 894       cmb_searchTarget.addItem(searchTarget);
 895     }
 896   }
 897
 898   public void transferToSequenceFetcher(String ids)
 899   {
 900     seqFetcher.setQuery(ids);
 901     Thread worker = new Thread(seqFetcher);
 902     worker.start();
 903   }
 904
 905   @Override
 906   public String getTypedText()
 907   {
 908     return txt_search.getUserInput();
 909   }
 910
 911   @Override
 912   public JTable getResultTable()
 913   {
 914     return tbl_summary;
 915   }
 916
 917   public void reset()
 918   {
 919     lbl_loading.setVisible(false);
 920     errorWarning.setLength(0);
 921     lbl_warning.setVisible(false);
 922     lbl_blank.setVisible(true);
 923     btn_ok.setEnabled(false);
 924     mainFrame.setTitle(getFTSFrameTitle());
 925     refresh();
 926     tbl_summary.setModel(new DefaultTableModel());
 927     tbl_summary.setVisible(false);
 928   }
 929
 930   @Override
 931   public void setPrevPageButtonEnabled(boolean isEnabled)
 932   {
 933     btn_prev_page.setEnabled(isEnabled);
 934   }
 935
 936   @Override
 937   public void setNextPageButtonEnabled(boolean isEnabled)
 938   {
 939     btn_next_page.setEnabled(isEnabled);
 940   }
 941
 942   @Override
 943   public void setErrorMessage(String message)
 944   {
 945     errorWarning.append(message);
 946   }
 947
 948   @Override
 949   public void updateSearchFrameTitle(String title)
 950   {
 951     mainFrame.setTitle(title);
 952   }
 953
 954   @Override
 955   public void setSearchInProgress(Boolean isSearchInProgress)
 956   {
 957     lbl_blank.setVisible(!isSearchInProgress);
 958     lbl_loading.setVisible(isSearchInProgress);
 959     txt_search.setEditable(!isSearchInProgress);
 960   }
 961
 962   @Override
 963   public void prevPageAction()
 964   {
 965     updatePaginatorCart();
 966     if (offSet >= pageLimit)
 967     {
 968       offSet = offSet - pageLimit;
 969       searchAction(false);
 970     }
 971     else
 972     {
 973       refreshPaginatorState();
 974     }
 975   }
 976
 977   @Override
 978   public void nextPageAction()
 979   {
 980     updatePaginatorCart();
 981     offSet = offSet + pageLimit;
 982     searchAction(false);
 983   }
 984
 985   public void updatePaginatorCart()
 986   {
 987     int primaryKeyColIndex = 0;
 988     JTable resultTable = getResultTable();
 989     int totalRows = resultTable.getRowCount();
 990     try
 991     {
 992       primaryKeyColIndex = getFTSRestClient()
 993               .getPrimaryKeyColumIndex(wantedFields, false);
 994     } catch (Exception e)
 995     {
 996       e.printStackTrace();
 997     }
 998
 999     for (int row = 0; row < totalRows; row++)
1000     {
1001       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1002       if (paginatorCart.contains(id))
1003       {
1004         paginatorCart.remove(id);
1005       }
1006     }
1007     int[] selectedRows = resultTable.getSelectedRows();
1008     for (int summaryRow : selectedRows)
1009     {
1010       String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
1011               .toString();
1012       paginatorCart.add(idStr);
1013     }
1014   }
1015
1016   public void updateSummaryTableSelections()
1017   {
1018     JTable resultTable = getResultTable();
1019     if (paginatorCart.isEmpty())
1020     {
1021       return;
1022     }
1023     int primaryKeyColIndex = 0;
1024     try
1025     {
1026       primaryKeyColIndex = getFTSRestClient()
1027               .getPrimaryKeyColumIndex(wantedFields, false);
1028     } catch (Exception e)
1029     {
1030       e.printStackTrace();
1031     }
1032     int totalRows = resultTable.getRowCount();
1033     for (int row = 0; row < totalRows; row++)
1034     {
1035       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1036       if (paginatorCart.contains(id))
1037       {
1038         resultTable.addRowSelectionInterval(row, row);
1039       }
1040     }
1041     validateSelection();
1042   }
1043
1044   public void refreshPaginatorState()
1045   {
1046     setPrevPageButtonEnabled(false);
1047     setNextPageButtonEnabled(false);
1048     if (resultSetCount == 0 && pageLimit == 0)
1049     {
1050       return;
1051     }
1052     if (resultSetCount >= pageLimit)
1053     {
1054       setNextPageButtonEnabled(true);
1055     }
1056     if (offSet >= pageLimit)
1057     {
1058       setPrevPageButtonEnabled(true);
1059     }
1060   }
1061
1062   public void refresh()
1063   {
1064     mainFrame.setTitle(getFTSFrameTitle());
1065   }
1066
1067   @Override
1068   public abstract void okAction();
1069 }