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