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.io.cache.JvCacheableInputBox;
32 import jalview.util.MessageManager;
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;
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;
78 * This class provides the swing GUI layout for FTS Panel and implements most of
79 * the contracts defined in GFSPanelI
85 @SuppressWarnings("serial")
86 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
88 protected JInternalFrame mainFrame = new JInternalFrame(
91 protected IProgressIndicator progressIndicator;
93 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
95 protected JButton btn_ok = new JButton();
97 protected JButton btn_back = new JButton();
99 protected JButton btn_cancel = new JButton();
101 protected JvCacheableInputBox<String> txt_search;
103 protected SequenceFetcher seqFetcher;
105 protected Collection<FTSDataColumnI> wantedFields;
107 private String lastSearchTerm = "";
109 protected JButton btn_next_page = new JButton();
111 protected JButton btn_prev_page = new JButton();
113 protected StringBuilder errorWarning = new StringBuilder();
115 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
116 "/images/warning.gif"));
118 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
119 "/images/loading.gif"));
121 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
122 .getResource("/images/blank_16x16_placeholder.png"));
124 protected JLabel lbl_warning = new JLabel(warningImage);
126 protected JLabel lbl_loading = new JLabel(loadingImage);
128 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
130 private JTabbedPane tabbedPane = new JTabbedPane();
132 private JPanel pnl_actions = new JPanel();
134 private JPanel pnl_results = new JPanel(new CardLayout());
136 private JPanel pnl_inputs = new JPanel();
138 private BorderLayout mainLayout = new BorderLayout();
140 protected Object[] previousWantedFields;
142 protected int resultSetCount;
144 protected int totalResultSetCount;
146 protected int offSet;
148 protected int pageLimit;
150 protected HashSet<String> paginatorCart = new HashSet<String>();
152 protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
155 private JTable tbl_summary = new JTable()
157 private boolean inLayout;
160 public boolean getScrollableTracksViewportWidth()
162 return hasExcessWidth();
167 public void doLayout()
169 if (hasExcessWidth())
171 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
176 autoResizeMode = AUTO_RESIZE_OFF;
179 protected boolean hasExcessWidth()
181 return getPreferredSize().width < getParent().getWidth();
185 public void columnMarginChanged(ChangeEvent e)
191 TableColumn resizingColumn = getTableHeader().getResizingColumn();
192 // Need to do this here, before the parent's
193 // layout manager calls getPreferredSize().
194 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
197 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
198 String colHeader = resizingColumn.getHeaderValue().toString();
199 getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
205 public String getToolTipText(MouseEvent evt)
207 String toolTipText = null;
208 java.awt.Point pnt = evt.getPoint();
209 int rowIndex = rowAtPoint(pnt);
210 int colIndex = columnAtPoint(pnt);
214 if (getValueAt(rowIndex, colIndex) == null)
218 toolTipText = getValueAt(rowIndex, colIndex).toString();
220 } catch (Exception e)
224 toolTipText = (toolTipText == null ? null
225 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
226 true, toolTipText.subSequence(0, 500) + "...")
227 : JvSwingUtils.wrapTooltip(true, toolTipText)));
233 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
240 mainFrame.addFocusListener(new FocusAdapter()
243 public void focusGained(FocusEvent e)
245 txt_search.requestFocusInWindow();
248 mainFrame.invalidate();
250 } catch (Exception e)
257 * Initializes the GUI default properties
261 private void jbInit() throws Exception
264 txt_search = new JvCacheableInputBox<String>(getCacheKey());
265 populateCmbSearchTargetOptions();
266 Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
267 : getTempUserPrefs().get("FTSPanel.width");
268 Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
269 : getTempUserPrefs().get("FTSPanel.height");
270 lbl_warning.setVisible(false);
271 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
272 lbl_loading.setVisible(false);
273 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
274 lbl_blank.setVisible(true);
275 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
277 tbl_summary.setAutoCreateRowSorter(true);
278 tbl_summary.getTableHeader().setReorderingAllowed(false);
279 tbl_summary.addMouseListener(new MouseAdapter()
282 public void mouseClicked(MouseEvent e)
288 public void mouseReleased(MouseEvent e)
293 tbl_summary.addKeyListener(new KeyAdapter()
296 public void keyPressed(KeyEvent evt)
299 switch (evt.getKeyCode())
301 case KeyEvent.VK_ESCAPE: // escape key
302 btn_back_ActionPerformed();
304 case KeyEvent.VK_ENTER: // enter key
305 if (btn_ok.isEnabled())
311 case KeyEvent.VK_TAB: // tab key
312 if (evt.isShiftDown())
314 tabbedPane.requestFocus();
318 btn_back.requestFocus();
328 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
329 btn_back.setText(MessageManager.getString("action.back"));
330 btn_back.addActionListener(new java.awt.event.ActionListener()
333 public void actionPerformed(ActionEvent e)
335 btn_back_ActionPerformed();
338 btn_back.addKeyListener(new KeyAdapter()
341 public void keyPressed(KeyEvent evt)
343 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
345 btn_back_ActionPerformed();
350 btn_ok.setEnabled(false);
351 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
352 btn_ok.setText(MessageManager.getString("action.ok"));
353 btn_ok.addActionListener(new java.awt.event.ActionListener()
356 public void actionPerformed(ActionEvent e)
361 btn_ok.addKeyListener(new KeyAdapter()
364 public void keyPressed(KeyEvent evt)
366 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
372 btn_next_page.setEnabled(false);
373 btn_next_page.setToolTipText(MessageManager
374 .getString("label.next_page_tooltip"));
375 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
376 btn_next_page.setText(MessageManager.getString("action.next_page"));
377 btn_next_page.addActionListener(new java.awt.event.ActionListener()
380 public void actionPerformed(ActionEvent e)
385 btn_next_page.addKeyListener(new KeyAdapter()
388 public void keyPressed(KeyEvent evt)
390 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
397 btn_prev_page.setEnabled(false);
398 btn_prev_page.setToolTipText(MessageManager
399 .getString("label.prev_page_tooltip"));
400 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
401 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
402 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
405 public void actionPerformed(ActionEvent e)
410 btn_prev_page.addKeyListener(new KeyAdapter()
413 public void keyPressed(KeyEvent evt)
415 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
422 if (isPaginationEnabled())
424 btn_prev_page.setVisible(true);
425 btn_next_page.setVisible(true);
429 btn_prev_page.setVisible(false);
430 btn_next_page.setVisible(false);
433 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
434 btn_cancel.setText(MessageManager.getString("action.cancel"));
435 btn_cancel.addActionListener(new java.awt.event.ActionListener()
438 public void actionPerformed(ActionEvent e)
440 btn_cancel_ActionPerformed();
443 btn_cancel.addKeyListener(new KeyAdapter()
446 public void keyPressed(KeyEvent evt)
448 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
450 btn_cancel_ActionPerformed();
454 scrl_searchResult.setPreferredSize(new Dimension(width, height));
456 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
457 cmb_searchTarget.addItemListener(new ItemListener()
460 public void itemStateChanged(ItemEvent e)
462 if (e.getStateChange() == ItemEvent.SELECTED)
465 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
468 tooltipText = MessageManager.getString("label.search_all");
470 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
471 .getSelectedItem().toString()))
473 tooltipText = MessageManager
474 .getString("label.separate_multiple_accession_ids");
478 tooltipText = MessageManager.formatMessage(
479 "label.separate_multiple_query_values",
480 new Object[] { getCmbSearchTarget().getSelectedItem()
483 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
491 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
493 txt_search.getEditor().getEditorComponent()
494 .addKeyListener(new KeyAdapter()
497 public void keyPressed(KeyEvent e)
499 if (e.getKeyCode() == KeyEvent.VK_ENTER)
501 if (getTypedText() == null || getTypedText().isEmpty())
505 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
507 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
508 .getSelectedItem().toString()))
510 transferToSequenceFetcher(getTypedText());
515 final DeferredTextInputListener listener = new DeferredTextInputListener(
516 1500, new ActionListener()
519 public void actionPerformed(ActionEvent e)
521 String typed = getTypedText();
522 if (!typed.equalsIgnoreCase(lastSearchTerm))
525 paginatorCart.clear();
526 lastSearchTerm = typed;
530 ((JTextComponent) txt_search.getEditor().getEditorComponent())
531 .getDocument().addDocumentListener(listener);
533 txt_search.addFocusListener(new FocusListener()
536 public void focusGained(FocusEvent e)
542 public void focusLost(FocusEvent e)
548 final String searchTabTitle = MessageManager
549 .getString("label.search_result");
550 final String configureCols = MessageManager
551 .getString("label.configure_displayed_columns");
552 ChangeListener changeListener = new ChangeListener()
555 public void stateChanged(ChangeEvent changeEvent)
557 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
559 int index = sourceTabbedPane.getSelectedIndex();
561 btn_back.setVisible(true);
562 btn_cancel.setVisible(true);
563 btn_ok.setVisible(true);
564 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
566 btn_back.setVisible(false);
567 btn_cancel.setVisible(false);
568 btn_ok.setVisible(false);
569 btn_back.setEnabled(false);
570 btn_cancel.setEnabled(false);
571 btn_ok.setEnabled(false);
572 btn_next_page.setEnabled(false);
573 btn_prev_page.setEnabled(false);
574 txt_search.setEnabled(false);
575 cmb_searchTarget.setEnabled(false);
576 previousWantedFields = getFTSRestClient()
577 .getAllDefaultDisplayedFTSDataColumns().toArray(
580 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
582 btn_back.setEnabled(true);
583 btn_cancel.setEnabled(true);
584 refreshPaginatorState();
585 txt_search.setEnabled(true);
586 cmb_searchTarget.setEnabled(true);
587 if (wantedFieldsUpdated())
590 paginatorCart.clear();
599 tabbedPane.addChangeListener(changeListener);
600 tabbedPane.setPreferredSize(new Dimension(width, height));
601 tabbedPane.add(searchTabTitle, scrl_searchResult);
602 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
603 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
605 pnl_actions.add(btn_back);
606 pnl_actions.add(btn_ok);
607 pnl_actions.add(btn_cancel);
609 pnl_results.add(tabbedPane);
610 pnl_inputs.add(cmb_searchTarget);
611 pnl_inputs.add(txt_search);
612 pnl_inputs.add(lbl_loading);
613 pnl_inputs.add(lbl_warning);
614 pnl_inputs.add(lbl_blank);
615 pnl_inputs.add(btn_prev_page);
616 pnl_inputs.add(btn_next_page);
618 this.setLayout(mainLayout);
619 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
620 this.add(pnl_results, java.awt.BorderLayout.CENTER);
621 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
622 mainFrame.setVisible(true);
623 mainFrame.setContentPane(this);
624 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
626 .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
629 public void internalFrameClosing(InternalFrameEvent e)
634 mainFrame.setVisible(true);
635 mainFrame.setContentPane(this);
636 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
637 Integer x = getTempUserPrefs().get("FTSPanel.x");
638 Integer y = getTempUserPrefs().get("FTSPanel.y");
639 if (x != null && y != null)
641 mainFrame.setLocation(x, y);
643 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
646 protected void closeAction()
648 getTempUserPrefs().put("FTSPanel.width", this.getWidth());
649 getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
650 getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
651 getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
653 txt_search.persistCache();
656 public class DeferredTextInputListener implements DocumentListener
658 private final Timer swingTimer;
660 public DeferredTextInputListener(int timeOut, ActionListener listener,
663 swingTimer = new Timer(timeOut, listener);
664 swingTimer.setRepeats(repeats);
678 public void insertUpdate(DocumentEvent e)
680 swingTimer.restart();
684 public void removeUpdate(DocumentEvent e)
686 swingTimer.restart();
690 public void changedUpdate(DocumentEvent e)
692 swingTimer.restart();
697 public boolean wantedFieldsUpdated()
699 if (previousWantedFields == null)
704 return Arrays.equals(getFTSRestClient()
705 .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
706 previousWantedFields) ? false : true;
710 public void validateSelection()
712 if (tbl_summary.getSelectedRows().length > 0
713 || !paginatorCart.isEmpty())
715 btn_ok.setEnabled(true);
719 btn_ok.setEnabled(false);
723 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
725 return cmb_searchTarget;
728 public JComboBox<String> getTxtSearch()
733 public JInternalFrame getMainFrame()
738 protected void delayAndEnableActionButtons()
748 } catch (InterruptedException e)
752 btn_ok.setEnabled(true);
753 btn_back.setEnabled(true);
754 btn_cancel.setEnabled(true);
759 protected void checkForErrors()
761 lbl_warning.setVisible(false);
762 lbl_blank.setVisible(true);
763 if (errorWarning.length() > 0)
765 lbl_loading.setVisible(false);
766 lbl_blank.setVisible(false);
767 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
768 errorWarning.toString()));
769 lbl_warning.setVisible(true);
773 protected void btn_back_ActionPerformed()
776 new SequenceFetcher(progressIndicator);
779 protected void disableActionButtons()
781 btn_ok.setEnabled(false);
782 btn_back.setEnabled(false);
783 btn_cancel.setEnabled(false);
786 protected void btn_cancel_ActionPerformed()
792 * Populates search target combo-box options
794 public void populateCmbSearchTargetOptions()
796 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
799 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
800 .getSearchableDataColumns();
801 searchableTargets.addAll(foundFTSTargets);
802 } catch (Exception e)
807 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
810 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
812 return o1.getName().compareTo(o2.getName());
816 for (FTSDataColumnI searchTarget : searchableTargets)
818 cmb_searchTarget.addItem(searchTarget);
822 public void transferToSequenceFetcher(String ids)
824 seqFetcher.getTextArea().setText(ids);
825 Thread worker = new Thread(seqFetcher);
830 public String getTypedText()
832 return txt_search.getUserInput();
836 public JTable getResultTable()
843 lbl_loading.setVisible(false);
844 errorWarning.setLength(0);
845 lbl_warning.setVisible(false);
846 lbl_blank.setVisible(true);
847 btn_ok.setEnabled(false);
848 mainFrame.setTitle(getFTSFrameTitle());
850 tbl_summary.setModel(new DefaultTableModel());
851 tbl_summary.setVisible(false);
855 public void setPrevPageButtonEnabled(boolean isEnabled)
857 btn_prev_page.setEnabled(isEnabled);
861 public void setNextPageButtonEnabled(boolean isEnabled)
863 btn_next_page.setEnabled(isEnabled);
867 public void setErrorMessage(String message)
869 errorWarning.append(message);
873 public void updateSearchFrameTitle(String title)
875 mainFrame.setTitle(title);
879 public void setSearchInProgress(Boolean isSearchInProgress)
881 lbl_blank.setVisible(!isSearchInProgress);
882 lbl_loading.setVisible(isSearchInProgress);
883 txt_search.setEditable(!isSearchInProgress);
887 public void prevPageAction()
889 updatePaginatorCart();
890 if (offSet >= pageLimit)
892 offSet = offSet - pageLimit;
897 refreshPaginatorState();
902 public void nextPageAction()
904 updatePaginatorCart();
905 offSet = offSet + pageLimit;
909 public void updatePaginatorCart()
911 int primaryKeyColIndex = 0;
912 JTable resultTable = getResultTable();
913 int totalRows = resultTable.getRowCount();
916 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
917 wantedFields, false);
918 } catch (Exception e)
923 for (int row = 0; row < totalRows; row++)
925 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
926 if (paginatorCart.contains(id))
928 paginatorCart.remove(id);
931 int[] selectedRows = resultTable.getSelectedRows();
932 for (int summaryRow : selectedRows)
934 String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
936 paginatorCart.add(idStr);
940 public void updateSummaryTableSelections()
942 JTable resultTable = getResultTable();
943 if (paginatorCart.isEmpty())
947 int primaryKeyColIndex = 0;
950 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
951 wantedFields, false);
952 } catch (Exception e)
956 int totalRows = resultTable.getRowCount();
957 for (int row = 0; row < totalRows; row++)
959 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
960 if (paginatorCart.contains(id))
962 resultTable.addRowSelectionInterval(row, row);
968 public void refreshPaginatorState()
970 setPrevPageButtonEnabled(false);
971 setNextPageButtonEnabled(false);
972 if (resultSetCount == 0 && pageLimit == 0)
976 if (resultSetCount >= pageLimit)
978 setNextPageButtonEnabled(true);
980 if (offSet >= pageLimit)
982 setPrevPageButtonEnabled(true);
986 public void referesh()
988 mainFrame.setTitle(getFTSFrameTitle());