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.AppCache;
32 import jalview.io.cache.JvCacheableInputBox;
33 import jalview.util.MessageManager;
35 import java.awt.BorderLayout;
36 import java.awt.CardLayout;
37 import java.awt.Dimension;
38 import java.awt.event.ActionEvent;
39 import java.awt.event.ActionListener;
40 import java.awt.event.FocusAdapter;
41 import java.awt.event.FocusEvent;
42 import java.awt.event.FocusListener;
43 import java.awt.event.ItemEvent;
44 import java.awt.event.ItemListener;
45 import java.awt.event.KeyAdapter;
46 import java.awt.event.KeyEvent;
47 import java.awt.event.MouseAdapter;
48 import java.awt.event.MouseEvent;
49 import java.text.DecimalFormat;
50 import java.util.ArrayList;
51 import java.util.Arrays;
52 import java.util.Collection;
53 import java.util.Collections;
54 import java.util.Comparator;
55 import java.util.HashSet;
56 import java.util.List;
58 import javax.swing.ImageIcon;
59 import javax.swing.JButton;
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;
79 * This class provides the swing GUI layout for FTS Panel and implements most of
80 * the contracts defined in GFSPanelI
86 @SuppressWarnings("serial")
87 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
89 protected JInternalFrame mainFrame = new JInternalFrame(
92 protected IProgressIndicator progressIndicator;
94 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
96 protected JButton btn_ok = new JButton();
98 protected JButton btn_back = new JButton();
100 protected JButton btn_cancel = new JButton();
102 protected JvCacheableInputBox<String> txt_search;
104 protected SequenceFetcher seqFetcher;
106 protected Collection<FTSDataColumnI> wantedFields;
108 private String lastSearchTerm = "";
110 protected JButton btn_next_page = new JButton();
112 protected JButton btn_prev_page = new JButton();
114 protected StringBuilder errorWarning = new StringBuilder();
116 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
117 "/images/warning.gif"));
119 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
120 "/images/loading.gif"));
122 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
123 .getResource("/images/blank_16x16_placeholder.png"));
125 protected JLabel lbl_warning = new JLabel(warningImage);
127 protected JLabel lbl_loading = new JLabel(loadingImage);
129 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
131 private JTabbedPane tabbedPane = new JTabbedPane();
133 private JPanel pnl_actions = new JPanel();
135 private JPanel pnl_results = new JPanel(new CardLayout());
137 private JPanel pnl_inputs = new JPanel();
139 private BorderLayout mainLayout = new BorderLayout();
141 protected Object[] previousWantedFields;
143 protected int resultSetCount;
145 protected int totalResultSetCount;
147 protected int offSet;
149 protected int pageLimit;
151 protected HashSet<String> paginatorCart = new HashSet<String>();
153 protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
156 private JTable tbl_summary = new JTable()
158 private boolean inLayout;
161 public boolean getScrollableTracksViewportWidth()
163 return hasExcessWidth();
168 public void doLayout()
170 if (hasExcessWidth())
172 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
177 autoResizeMode = AUTO_RESIZE_OFF;
180 protected boolean hasExcessWidth()
182 return getPreferredSize().width < getParent().getWidth();
186 public void columnMarginChanged(ChangeEvent e)
192 TableColumn resizingColumn = getTableHeader().getResizingColumn();
193 // Need to do this here, before the parent's
194 // layout manager calls getPreferredSize().
195 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
198 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
199 String colHeader = resizingColumn.getHeaderValue().toString();
200 getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
206 public String getToolTipText(MouseEvent evt)
208 String toolTipText = null;
209 java.awt.Point pnt = evt.getPoint();
210 int rowIndex = rowAtPoint(pnt);
211 int colIndex = columnAtPoint(pnt);
215 if (getValueAt(rowIndex, colIndex) == null)
219 toolTipText = getValueAt(rowIndex, colIndex).toString();
221 } catch (Exception e)
225 toolTipText = (toolTipText == null ? null
226 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
227 true, toolTipText.subSequence(0, 500) + "...")
228 : JvSwingUtils.wrapTooltip(true, toolTipText)));
234 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
241 mainFrame.addFocusListener(new FocusAdapter()
244 public void focusGained(FocusEvent e)
246 txt_search.requestFocusInWindow();
249 mainFrame.invalidate();
251 } catch (Exception e)
258 * Initializes the GUI default properties
262 private void jbInit() throws Exception
265 txt_search = new JvCacheableInputBox<String>(getCacheKey());
266 populateCmbSearchTargetOptions();
267 Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
268 : getTempUserPrefs().get("FTSPanel.width");
269 Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
270 : getTempUserPrefs().get("FTSPanel.height");
271 lbl_warning.setVisible(false);
272 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
273 lbl_loading.setVisible(false);
274 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
275 lbl_blank.setVisible(true);
276 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
278 tbl_summary.setAutoCreateRowSorter(true);
279 tbl_summary.getTableHeader().setReorderingAllowed(false);
280 tbl_summary.addMouseListener(new MouseAdapter()
283 public void mouseClicked(MouseEvent e)
289 public void mouseReleased(MouseEvent e)
294 tbl_summary.addKeyListener(new KeyAdapter()
297 public void keyPressed(KeyEvent evt)
300 switch (evt.getKeyCode())
302 case KeyEvent.VK_ESCAPE: // escape key
303 btn_back_ActionPerformed();
305 case KeyEvent.VK_ENTER: // enter key
306 if (btn_ok.isEnabled())
312 case KeyEvent.VK_TAB: // tab key
313 if (evt.isShiftDown())
315 tabbedPane.requestFocus();
319 btn_back.requestFocus();
329 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
330 btn_back.setText(MessageManager.getString("action.back"));
331 btn_back.addActionListener(new java.awt.event.ActionListener()
334 public void actionPerformed(ActionEvent e)
336 btn_back_ActionPerformed();
339 btn_back.addKeyListener(new KeyAdapter()
342 public void keyPressed(KeyEvent evt)
344 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
346 btn_back_ActionPerformed();
351 btn_ok.setEnabled(false);
352 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
353 btn_ok.setText(MessageManager.getString("action.ok"));
354 btn_ok.addActionListener(new java.awt.event.ActionListener()
357 public void actionPerformed(ActionEvent e)
362 btn_ok.addKeyListener(new KeyAdapter()
365 public void keyPressed(KeyEvent evt)
367 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
373 btn_next_page.setEnabled(false);
374 btn_next_page.setToolTipText(MessageManager
375 .getString("label.next_page_tooltip"));
376 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
377 btn_next_page.setText(MessageManager.getString("action.next_page"));
378 btn_next_page.addActionListener(new java.awt.event.ActionListener()
381 public void actionPerformed(ActionEvent e)
386 btn_next_page.addKeyListener(new KeyAdapter()
389 public void keyPressed(KeyEvent evt)
391 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
398 btn_prev_page.setEnabled(false);
399 btn_prev_page.setToolTipText(MessageManager
400 .getString("label.prev_page_tooltip"));
401 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
402 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
403 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
406 public void actionPerformed(ActionEvent e)
411 btn_prev_page.addKeyListener(new KeyAdapter()
414 public void keyPressed(KeyEvent evt)
416 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
423 if (isPaginationEnabled())
425 btn_prev_page.setVisible(true);
426 btn_next_page.setVisible(true);
430 btn_prev_page.setVisible(false);
431 btn_next_page.setVisible(false);
434 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
435 btn_cancel.setText(MessageManager.getString("action.cancel"));
436 btn_cancel.addActionListener(new java.awt.event.ActionListener()
439 public void actionPerformed(ActionEvent e)
441 btn_cancel_ActionPerformed();
444 btn_cancel.addKeyListener(new KeyAdapter()
447 public void keyPressed(KeyEvent evt)
449 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
451 btn_cancel_ActionPerformed();
455 scrl_searchResult.setPreferredSize(new Dimension(width, height));
457 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
458 cmb_searchTarget.addItemListener(new ItemListener()
461 public void itemStateChanged(ItemEvent e)
463 if (e.getStateChange() == ItemEvent.SELECTED)
466 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
469 tooltipText = MessageManager.getString("label.search_all");
471 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
472 .getSelectedItem().toString()))
474 tooltipText = MessageManager
475 .getString("label.separate_multiple_accession_ids");
479 tooltipText = MessageManager.formatMessage(
480 "label.separate_multiple_query_values",
481 new Object[] { getCmbSearchTarget().getSelectedItem()
484 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
492 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
494 txt_search.getEditor().getEditorComponent()
495 .addKeyListener(new KeyAdapter()
498 public void keyPressed(KeyEvent e)
500 if (e.getKeyCode() == KeyEvent.VK_ENTER)
502 if (getTypedText() == null || getTypedText().isEmpty())
506 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
508 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
509 .getSelectedItem().toString()))
511 transferToSequenceFetcher(getTypedText());
516 final DeferredTextInputListener listener = new DeferredTextInputListener(
517 1500, new ActionListener()
520 public void actionPerformed(ActionEvent e)
522 String typed = getTypedText();
523 if (!typed.equalsIgnoreCase(lastSearchTerm))
526 paginatorCart.clear();
527 lastSearchTerm = typed;
531 ((JTextComponent) txt_search.getEditor().getEditorComponent())
532 .getDocument().addDocumentListener(listener);
534 txt_search.addFocusListener(new FocusListener()
537 public void focusGained(FocusEvent e)
543 public void focusLost(FocusEvent e)
549 final String searchTabTitle = MessageManager
550 .getString("label.search_result");
551 final String configureCols = MessageManager
552 .getString("label.configure_displayed_columns");
553 ChangeListener changeListener = new ChangeListener()
556 public void stateChanged(ChangeEvent changeEvent)
558 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
560 int index = sourceTabbedPane.getSelectedIndex();
562 btn_back.setVisible(true);
563 btn_cancel.setVisible(true);
564 btn_ok.setVisible(true);
565 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
567 btn_back.setVisible(false);
568 btn_cancel.setVisible(false);
569 btn_ok.setVisible(false);
570 btn_back.setEnabled(false);
571 btn_cancel.setEnabled(false);
572 btn_ok.setEnabled(false);
573 btn_next_page.setEnabled(false);
574 btn_prev_page.setEnabled(false);
575 txt_search.setEnabled(false);
576 cmb_searchTarget.setEnabled(false);
577 previousWantedFields = getFTSRestClient()
578 .getAllDefaultDisplayedFTSDataColumns().toArray(
581 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
583 btn_back.setEnabled(true);
584 btn_cancel.setEnabled(true);
585 refreshPaginatorState();
586 txt_search.setEnabled(true);
587 cmb_searchTarget.setEnabled(true);
588 if (wantedFieldsUpdated())
591 paginatorCart.clear();
600 tabbedPane.addChangeListener(changeListener);
601 tabbedPane.setPreferredSize(new Dimension(width, height));
602 tabbedPane.add(searchTabTitle, scrl_searchResult);
603 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
604 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
606 pnl_actions.add(btn_back);
607 pnl_actions.add(btn_ok);
608 pnl_actions.add(btn_cancel);
610 pnl_results.add(tabbedPane);
611 pnl_inputs.add(cmb_searchTarget);
612 pnl_inputs.add(txt_search);
613 pnl_inputs.add(lbl_loading);
614 pnl_inputs.add(lbl_warning);
615 pnl_inputs.add(lbl_blank);
616 pnl_inputs.add(btn_prev_page);
617 pnl_inputs.add(btn_next_page);
619 this.setLayout(mainLayout);
620 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
621 this.add(pnl_results, java.awt.BorderLayout.CENTER);
622 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
623 mainFrame.setVisible(true);
624 mainFrame.setContentPane(this);
625 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
627 .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
630 public void internalFrameClosing(InternalFrameEvent e)
635 mainFrame.setVisible(true);
636 mainFrame.setContentPane(this);
637 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
638 Integer x = getTempUserPrefs().get("FTSPanel.x");
639 Integer y = getTempUserPrefs().get("FTSPanel.y");
640 if (x != null && y != null)
642 mainFrame.setLocation(x, y);
644 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
647 protected void closeAction()
649 getTempUserPrefs().put("FTSPanel.width", this.getWidth());
650 getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
651 getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
652 getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
654 AppCache.getInstance().persistCache(getCacheKey());
657 public class DeferredTextInputListener implements DocumentListener
659 private final Timer swingTimer;
661 public DeferredTextInputListener(int timeOut, ActionListener listener,
664 swingTimer = new Timer(timeOut, listener);
665 swingTimer.setRepeats(repeats);
679 public void insertUpdate(DocumentEvent e)
681 swingTimer.restart();
685 public void removeUpdate(DocumentEvent e)
687 swingTimer.restart();
691 public void changedUpdate(DocumentEvent e)
693 swingTimer.restart();
698 public boolean wantedFieldsUpdated()
700 if (previousWantedFields == null)
705 return Arrays.equals(getFTSRestClient()
706 .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
707 previousWantedFields) ? false : true;
711 public void validateSelection()
713 if (tbl_summary.getSelectedRows().length > 0
714 || !paginatorCart.isEmpty())
716 btn_ok.setEnabled(true);
720 btn_ok.setEnabled(false);
724 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
726 return cmb_searchTarget;
729 public JComboBox<String> getTxtSearch()
734 public JInternalFrame getMainFrame()
739 protected void delayAndEnableActionButtons()
749 } catch (InterruptedException e)
753 btn_ok.setEnabled(true);
754 btn_back.setEnabled(true);
755 btn_cancel.setEnabled(true);
760 protected void checkForErrors()
762 lbl_warning.setVisible(false);
763 lbl_blank.setVisible(true);
764 if (errorWarning.length() > 0)
766 lbl_loading.setVisible(false);
767 lbl_blank.setVisible(false);
768 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
769 errorWarning.toString()));
770 lbl_warning.setVisible(true);
774 protected void btn_back_ActionPerformed()
777 new SequenceFetcher(progressIndicator);
780 protected void disableActionButtons()
782 btn_ok.setEnabled(false);
783 btn_back.setEnabled(false);
784 btn_cancel.setEnabled(false);
787 protected void btn_cancel_ActionPerformed()
793 * Populates search target combo-box options
795 public void populateCmbSearchTargetOptions()
797 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
800 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
801 .getSearchableDataColumns();
802 searchableTargets.addAll(foundFTSTargets);
803 } catch (Exception e)
808 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
811 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
813 return o1.getName().compareTo(o2.getName());
817 for (FTSDataColumnI searchTarget : searchableTargets)
819 cmb_searchTarget.addItem(searchTarget);
823 public void transferToSequenceFetcher(String ids)
825 seqFetcher.getTextArea().setText(ids);
826 Thread worker = new Thread(seqFetcher);
831 public String getTypedText()
833 return txt_search.getUserInput();
837 public JTable getResultTable()
844 lbl_loading.setVisible(false);
845 errorWarning.setLength(0);
846 lbl_warning.setVisible(false);
847 lbl_blank.setVisible(true);
848 btn_ok.setEnabled(false);
849 mainFrame.setTitle(getFTSFrameTitle());
851 tbl_summary.setModel(new DefaultTableModel());
852 tbl_summary.setVisible(false);
856 public void setPrevPageButtonEnabled(boolean isEnabled)
858 btn_prev_page.setEnabled(isEnabled);
862 public void setNextPageButtonEnabled(boolean isEnabled)
864 btn_next_page.setEnabled(isEnabled);
868 public void setErrorMessage(String message)
870 errorWarning.append(message);
874 public void updateSearchFrameTitle(String title)
876 mainFrame.setTitle(title);
880 public void setSearchInProgress(Boolean isSearchInProgress)
882 lbl_blank.setVisible(!isSearchInProgress);
883 lbl_loading.setVisible(isSearchInProgress);
884 txt_search.setEditable(!isSearchInProgress);
888 public void prevPageAction()
890 updatePaginatorCart();
891 if (offSet >= pageLimit)
893 offSet = offSet - pageLimit;
898 refreshPaginatorState();
903 public void nextPageAction()
905 updatePaginatorCart();
906 offSet = offSet + pageLimit;
910 public void updatePaginatorCart()
912 int primaryKeyColIndex = 0;
913 JTable resultTable = getResultTable();
914 int totalRows = resultTable.getRowCount();
917 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
918 wantedFields, false);
919 } catch (Exception e)
924 for (int row = 0; row < totalRows; row++)
926 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
927 if (paginatorCart.contains(id))
929 paginatorCart.remove(id);
932 int[] selectedRows = resultTable.getSelectedRows();
933 for (int summaryRow : selectedRows)
935 String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
937 paginatorCart.add(idStr);
941 public void updateSummaryTableSelections()
943 JTable resultTable = getResultTable();
944 if (paginatorCart.isEmpty())
948 int primaryKeyColIndex = 0;
951 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
952 wantedFields, false);
953 } catch (Exception e)
957 int totalRows = resultTable.getRowCount();
958 for (int row = 0; row < totalRows; row++)
960 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
961 if (paginatorCart.contains(id))
963 resultTable.addRowSelectionInterval(row, row);
969 public void refreshPaginatorState()
971 setPrevPageButtonEnabled(false);
972 setNextPageButtonEnabled(false);
973 if (resultSetCount == 0 && pageLimit == 0)
977 if (resultSetCount >= pageLimit)
979 setNextPageButtonEnabled(true);
981 if (offSet >= pageLimit)
983 setPrevPageButtonEnabled(true);
987 public void referesh()
989 mainFrame.setTitle(getFTSFrameTitle());