2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
22 package jalview.fts.core;
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.util.MessageManager;
33 import java.awt.BorderLayout;
34 import java.awt.CardLayout;
35 import java.awt.Dimension;
36 import java.awt.event.ActionEvent;
37 import java.awt.event.ActionListener;
38 import java.awt.event.FocusEvent;
39 import java.awt.event.FocusListener;
40 import java.awt.event.KeyAdapter;
41 import java.awt.event.KeyEvent;
42 import java.awt.event.MouseAdapter;
43 import java.awt.event.MouseEvent;
44 import java.util.ArrayList;
45 import java.util.Arrays;
46 import java.util.Collection;
47 import java.util.Collections;
48 import java.util.Comparator;
49 import java.util.HashSet;
50 import java.util.List;
52 import javax.swing.ImageIcon;
53 import javax.swing.JButton;
54 import javax.swing.JComboBox;
55 import javax.swing.JFrame;
56 import javax.swing.JInternalFrame;
57 import javax.swing.JLabel;
58 import javax.swing.JPanel;
59 import javax.swing.JScrollPane;
60 import javax.swing.JTabbedPane;
61 import javax.swing.JTable;
62 import javax.swing.JTextField;
63 import javax.swing.Timer;
64 import javax.swing.event.ChangeEvent;
65 import javax.swing.event.ChangeListener;
66 import javax.swing.event.DocumentEvent;
67 import javax.swing.event.DocumentListener;
68 import javax.swing.table.DefaultTableModel;
69 import javax.swing.table.TableColumn;
72 * This class provides the swing GUI layout for FTS Panel and implements most of
73 * the contracts defined in GFSPanelI
79 @SuppressWarnings("serial")
80 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
82 protected JInternalFrame mainFrame = new JInternalFrame(
85 protected IProgressIndicator progressIdicator;
87 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
89 protected JButton btn_ok = new JButton();
91 protected JButton btn_back = new JButton();
93 protected JButton btn_cancel = new JButton();
95 protected JTextField txt_search = new JTextField(30);
97 protected SequenceFetcher seqFetcher;
99 protected Collection<FTSDataColumnI> wantedFields;
101 private String lastSearchTerm = "";
103 protected JButton btn_next_page = new JButton();
105 protected JButton btn_prev_page = new JButton();
107 protected StringBuilder errorWarning = new StringBuilder();
109 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
110 "/images/warning.gif"));
112 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
113 "/images/loading.gif"));
115 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
116 .getResource("/images/blank_16x16_placeholder.png"));
118 protected JLabel lbl_warning = new JLabel(warningImage);
120 protected JLabel lbl_loading = new JLabel(loadingImage);
122 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
124 private JTabbedPane tabbedPane = new JTabbedPane();
126 private JPanel pnl_actions = new JPanel();
128 private JPanel pnl_results = new JPanel(new CardLayout());
130 private JPanel pnl_inputs = new JPanel();
132 private BorderLayout mainLayout = new BorderLayout();
134 protected Object[] previousWantedFields;
136 protected int resultSetCount;
138 protected int totalResultSetCount;
140 protected int offSet;
142 protected int pageLimit;
144 protected HashSet<String> paginatorCart = new HashSet<String>();
146 private JTable tbl_summary = new JTable()
148 private boolean inLayout;
151 public boolean getScrollableTracksViewportWidth()
153 return hasExcessWidth();
158 public void doLayout()
160 if (hasExcessWidth())
162 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
167 autoResizeMode = AUTO_RESIZE_OFF;
170 protected boolean hasExcessWidth()
172 return getPreferredSize().width < getParent().getWidth();
176 public void columnMarginChanged(ChangeEvent e)
182 TableColumn resizingColumn = getTableHeader().getResizingColumn();
183 // Need to do this here, before the parent's
184 // layout manager calls getPreferredSize().
185 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
188 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
194 public String getToolTipText(MouseEvent evt)
196 String toolTipText = null;
197 java.awt.Point pnt = evt.getPoint();
198 int rowIndex = rowAtPoint(pnt);
199 int colIndex = columnAtPoint(pnt);
203 if (getValueAt(rowIndex, colIndex) == null)
207 toolTipText = getValueAt(rowIndex, colIndex).toString();
209 } catch (Exception e)
213 toolTipText = (toolTipText == null ? null
214 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
215 true, toolTipText.subSequence(0, 500) + "...")
216 : JvSwingUtils.wrapTooltip(true, toolTipText)));
221 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
228 mainFrame.invalidate();
230 } catch (Exception e)
237 * Initializes the GUI default properties
241 private void jbInit() throws Exception
243 lbl_warning.setVisible(false);
244 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
245 lbl_loading.setVisible(false);
246 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
247 lbl_blank.setVisible(true);
248 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
250 tbl_summary.setAutoCreateRowSorter(true);
251 tbl_summary.getTableHeader().setReorderingAllowed(false);
252 tbl_summary.addMouseListener(new MouseAdapter()
255 public void mouseClicked(MouseEvent e)
261 public void mouseReleased(MouseEvent e)
266 tbl_summary.addKeyListener(new KeyAdapter()
269 public void keyPressed(KeyEvent evt)
272 switch (evt.getKeyCode())
274 case KeyEvent.VK_ESCAPE: // escape key
275 btn_back_ActionPerformed();
277 case KeyEvent.VK_ENTER: // enter key
278 if (btn_ok.isEnabled())
284 case KeyEvent.VK_TAB: // tab key
285 if (evt.isShiftDown())
287 tabbedPane.requestFocus();
291 btn_back.requestFocus();
301 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
302 btn_back.setText(MessageManager.getString("action.back"));
303 btn_back.addActionListener(new java.awt.event.ActionListener()
306 public void actionPerformed(ActionEvent e)
308 btn_back_ActionPerformed();
311 btn_back.addKeyListener(new KeyAdapter()
314 public void keyPressed(KeyEvent evt)
316 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
318 btn_back_ActionPerformed();
323 btn_ok.setEnabled(false);
324 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
325 btn_ok.setText(MessageManager.getString("action.ok"));
326 btn_ok.addActionListener(new java.awt.event.ActionListener()
329 public void actionPerformed(ActionEvent e)
334 btn_ok.addKeyListener(new KeyAdapter()
337 public void keyPressed(KeyEvent evt)
339 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
345 btn_next_page.setEnabled(false);
346 btn_next_page.setToolTipText(MessageManager
347 .getString("label.next_page_tooltop"));
348 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
349 btn_next_page.setText(MessageManager.getString("action.next_page"));
350 btn_next_page.addActionListener(new java.awt.event.ActionListener()
353 public void actionPerformed(ActionEvent e)
358 btn_next_page.addKeyListener(new KeyAdapter()
361 public void keyPressed(KeyEvent evt)
363 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
370 btn_prev_page.setEnabled(false);
371 btn_prev_page.setToolTipText(MessageManager
372 .getString("label.prev_page_tooltop"));
373 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
374 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
375 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
378 public void actionPerformed(ActionEvent e)
383 btn_prev_page.addKeyListener(new KeyAdapter()
386 public void keyPressed(KeyEvent evt)
388 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
395 if (isPaginationEnabled())
397 btn_prev_page.setVisible(true);
398 btn_next_page.setVisible(true);
402 btn_prev_page.setVisible(false);
403 btn_next_page.setVisible(false);
406 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
407 btn_cancel.setText(MessageManager.getString("action.cancel"));
408 btn_cancel.addActionListener(new java.awt.event.ActionListener()
411 public void actionPerformed(ActionEvent e)
413 btn_cancel_ActionPerformed();
416 btn_cancel.addKeyListener(new KeyAdapter()
419 public void keyPressed(KeyEvent evt)
421 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
423 btn_cancel_ActionPerformed();
427 scrl_searchResult.setPreferredSize(new Dimension(800, 400));
429 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
430 cmb_searchTarget.addActionListener(new ActionListener()
433 public void actionPerformed(ActionEvent e)
436 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
439 tooltipText = MessageManager.getString("label.search_all");
441 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
442 .getSelectedItem().toString()))
444 tooltipText = MessageManager
445 .getString("label.separate_multiple_accession_ids");
449 tooltipText = MessageManager.formatMessage(
450 "label.separate_multiple_query_values",
451 new Object[] { getCmbSearchTarget().getSelectedItem()
454 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
460 populateCmbSearchTargetOptions();
462 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
464 txt_search.addKeyListener(new KeyAdapter()
467 public void keyPressed(KeyEvent e)
469 if (e.getKeyCode() == KeyEvent.VK_ENTER)
471 if (txt_search.getText() == null
472 || txt_search.getText().isEmpty())
476 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
478 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
479 .getSelectedItem().toString()))
481 transferToSequenceFetcher(txt_search.getText());
487 final DeferredTextInputListener listener = new DeferredTextInputListener(
492 public void actionPerformed(ActionEvent e)
494 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
497 paginatorCart.clear();
498 lastSearchTerm = getTypedText();
502 txt_search.getDocument().addDocumentListener(listener);
503 txt_search.addFocusListener(new FocusListener()
506 public void focusGained(FocusEvent e)
512 public void focusLost(FocusEvent e)
518 final String searchTabTitle = MessageManager
519 .getString("label.search_result");
520 final String configureCols = MessageManager
521 .getString("label.configure_displayed_columns");
522 ChangeListener changeListener = new ChangeListener()
525 public void stateChanged(ChangeEvent changeEvent)
527 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
529 int index = sourceTabbedPane.getSelectedIndex();
531 btn_back.setVisible(true);
532 btn_cancel.setVisible(true);
533 btn_ok.setVisible(true);
534 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
536 btn_back.setVisible(false);
537 btn_cancel.setVisible(false);
538 btn_ok.setVisible(false);
539 btn_back.setEnabled(false);
540 btn_cancel.setEnabled(false);
541 btn_ok.setEnabled(false);
542 btn_next_page.setEnabled(false);
543 btn_prev_page.setEnabled(false);
544 txt_search.setEnabled(false);
545 cmb_searchTarget.setEnabled(false);
546 previousWantedFields = getFTSRestClient()
547 .getAllDefaulDisplayedDataColumns()
548 .toArray(new Object[0]);
550 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
552 btn_back.setEnabled(true);
553 btn_cancel.setEnabled(true);
554 refreshPaginatorState();
555 txt_search.setEnabled(true);
556 cmb_searchTarget.setEnabled(true);
557 if (wantedFieldsUpdated())
560 paginatorCart.clear();
569 tabbedPane.addChangeListener(changeListener);
570 tabbedPane.setPreferredSize(new Dimension(800, 400));
571 tabbedPane.add(searchTabTitle, scrl_searchResult);
572 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
573 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
575 pnl_actions.add(btn_back);
576 pnl_actions.add(btn_ok);
577 pnl_actions.add(btn_cancel);
579 pnl_results.add(tabbedPane);
580 pnl_inputs.add(cmb_searchTarget);
581 pnl_inputs.add(txt_search);
582 pnl_inputs.add(lbl_loading);
583 pnl_inputs.add(lbl_warning);
584 pnl_inputs.add(lbl_blank);
585 pnl_inputs.add(btn_prev_page);
586 pnl_inputs.add(btn_next_page);
588 this.setLayout(mainLayout);
589 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
590 this.add(pnl_results, java.awt.BorderLayout.CENTER);
591 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
592 mainFrame.setVisible(true);
593 mainFrame.setContentPane(this);
594 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
595 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
598 public class DeferredTextInputListener implements DocumentListener
600 private final Timer swingTimer;
602 public DeferredTextInputListener(int timeOut, ActionListener listener,
605 swingTimer = new Timer(timeOut, listener);
606 swingTimer.setRepeats(repeats);
620 public void insertUpdate(DocumentEvent e)
622 swingTimer.restart();
626 public void removeUpdate(DocumentEvent e)
628 swingTimer.restart();
632 public void changedUpdate(DocumentEvent e)
634 swingTimer.restart();
639 public boolean wantedFieldsUpdated()
641 if (previousWantedFields == null)
646 return Arrays.equals(getFTSRestClient()
647 .getAllDefaulDisplayedDataColumns()
648 .toArray(new Object[0]), previousWantedFields) ? false
653 public void validateSelection()
655 if (tbl_summary.getSelectedRows().length > 0
656 || !paginatorCart.isEmpty())
658 btn_ok.setEnabled(true);
662 btn_ok.setEnabled(false);
666 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
668 return cmb_searchTarget;
671 public JTextField getTxtSearch()
676 public JInternalFrame getMainFrame()
681 protected void delayAndEnableActionButtons()
691 } catch (InterruptedException e)
695 btn_ok.setEnabled(true);
696 btn_back.setEnabled(true);
697 btn_cancel.setEnabled(true);
702 protected void checkForErrors()
704 lbl_warning.setVisible(false);
705 lbl_blank.setVisible(true);
706 if (errorWarning.length() > 0)
708 lbl_loading.setVisible(false);
709 lbl_blank.setVisible(false);
710 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
711 errorWarning.toString()));
712 lbl_warning.setVisible(true);
716 protected void btn_back_ActionPerformed()
719 new SequenceFetcher(progressIdicator);
722 protected void disableActionButtons()
724 btn_ok.setEnabled(false);
725 btn_back.setEnabled(false);
726 btn_cancel.setEnabled(false);
729 protected void btn_cancel_ActionPerformed()
735 * Populates search target combo-box options
737 public void populateCmbSearchTargetOptions()
739 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
742 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
743 .getSearchableDataColumns();
744 searchableTargets.addAll(foundFTSTargets);
745 } catch (Exception e)
750 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
753 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
755 return o1.getName().compareTo(o2.getName());
759 for (FTSDataColumnI searchTarget : searchableTargets)
761 cmb_searchTarget.addItem(searchTarget);
766 public void transferToSequenceFetcher(String ids)
768 // mainFrame.dispose();
769 seqFetcher.getTextArea().setText(ids);
770 Thread worker = new Thread(seqFetcher);
775 public String getTypedText()
777 return txt_search.getText().trim();
781 public JTable getResultTable()
788 lbl_loading.setVisible(false);
789 errorWarning.setLength(0);
790 lbl_warning.setVisible(false);
791 lbl_blank.setVisible(true);
792 btn_ok.setEnabled(false);
793 mainFrame.setTitle(getFTSFrameTitle());
795 tbl_summary.setModel(new DefaultTableModel());
796 tbl_summary.setVisible(false);
800 public void setPrevPageButtonEnabled(boolean isEnabled)
802 btn_prev_page.setEnabled(isEnabled);
806 public void setNextPageButtonEnabled(boolean isEnabled)
808 btn_next_page.setEnabled(isEnabled);
812 public void setErrorMessage(String message)
814 errorWarning.append(message);
818 public void updateSearchFrameTitle(String title)
820 mainFrame.setTitle(title);
824 public void setSearchInProgress(Boolean isSearchInProgress)
826 lbl_blank.setVisible(!isSearchInProgress);
827 lbl_loading.setVisible(isSearchInProgress);
831 public void prevPageAction()
833 updatePaginatorCart();
834 if (offSet >= pageLimit)
836 offSet = offSet - pageLimit;
841 refreshPaginatorState();
846 public void nextPageAction()
848 updatePaginatorCart();
849 offSet = offSet + pageLimit;
853 public void updatePaginatorCart()
855 int primaryKeyColIndex = 0;
856 JTable resultTable = getResultTable();
857 int totalRows = resultTable.getRowCount();
860 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
861 wantedFields, false);
862 } catch (Exception e)
867 for (int row = 0; row < totalRows; row++)
869 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
870 if (paginatorCart.contains(id))
872 paginatorCart.remove(id);
875 int[] selectedRows = resultTable.getSelectedRows();
876 for (int summaryRow : selectedRows)
878 String idStr = resultTable.getValueAt(summaryRow,
879 primaryKeyColIndex).toString();
880 paginatorCart.add(idStr);
882 // System.out.println("Paginator shopping cart size : "
883 // + paginatorCart.size());
886 public void updateSummaryTableSelections()
888 JTable resultTable = getResultTable();
889 if (paginatorCart.isEmpty())
893 int primaryKeyColIndex = 0;
896 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
897 wantedFields, false);
898 } catch (Exception e)
902 // System.out.println(">>>>>> got here : 1");
903 int totalRows = resultTable.getRowCount();
904 // resultTable.clearSelection();
905 for (int row = 0; row < totalRows; row++)
907 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
908 if (paginatorCart.contains(id))
910 resultTable.addRowSelectionInterval(row, row);
915 public void refreshPaginatorState()
917 // System.out.println("resultSet count : " + resultSetCount);
918 // System.out.println("offSet : " + offSet);
919 // System.out.println("page limit : " + pageLimit);
920 setPrevPageButtonEnabled(false);
921 setNextPageButtonEnabled(false);
922 if (resultSetCount == 0 && pageLimit == 0)
926 if (resultSetCount >= pageLimit)
928 setNextPageButtonEnabled(true);
930 if (offSet >= pageLimit)
932 setPrevPageButtonEnabled(true);
935 public void referesh()
937 mainFrame.setTitle(getFTSFrameTitle());