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