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 private static final int MIN_WIDTH = 670;
154 private static final int MIN_HEIGHT = 300;
156 protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
159 private JTable tbl_summary = new JTable()
161 private boolean inLayout;
164 public boolean getScrollableTracksViewportWidth()
166 return hasExcessWidth();
171 public void doLayout()
173 if (hasExcessWidth())
175 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
180 autoResizeMode = AUTO_RESIZE_OFF;
183 protected boolean hasExcessWidth()
185 return getPreferredSize().width < getParent().getWidth();
189 public void columnMarginChanged(ChangeEvent e)
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
201 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
202 String colHeader = resizingColumn.getHeaderValue().toString();
203 getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
209 public String getToolTipText(MouseEvent evt)
211 String toolTipText = null;
212 java.awt.Point pnt = evt.getPoint();
213 int rowIndex = rowAtPoint(pnt);
214 int colIndex = columnAtPoint(pnt);
218 if (getValueAt(rowIndex, colIndex) == null)
222 toolTipText = getValueAt(rowIndex, colIndex).toString();
224 } catch (Exception e)
228 toolTipText = (toolTipText == null ? null
229 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
230 true, toolTipText.subSequence(0, 500) + "...")
231 : JvSwingUtils.wrapTooltip(true, toolTipText)));
237 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
244 mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
245 mainFrame.addFocusListener(new FocusAdapter()
248 public void focusGained(FocusEvent e)
250 txt_search.requestFocusInWindow();
253 mainFrame.invalidate();
255 } catch (Exception e)
262 * Initializes the GUI default properties
266 private void jbInit() throws Exception
269 txt_search = new JvCacheableInputBox<String>(getCacheKey());
270 populateCmbSearchTargetOptions();
271 Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
272 : getTempUserPrefs().get("FTSPanel.width");
273 Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
274 : getTempUserPrefs().get("FTSPanel.height");
275 lbl_warning.setVisible(false);
276 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
277 lbl_loading.setVisible(false);
278 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
279 lbl_blank.setVisible(true);
280 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
282 tbl_summary.setAutoCreateRowSorter(true);
283 tbl_summary.getTableHeader().setReorderingAllowed(false);
284 tbl_summary.addMouseListener(new MouseAdapter()
287 public void mouseClicked(MouseEvent e)
293 public void mouseReleased(MouseEvent e)
298 tbl_summary.addKeyListener(new KeyAdapter()
301 public void keyPressed(KeyEvent evt)
304 switch (evt.getKeyCode())
306 case KeyEvent.VK_ESCAPE: // escape key
307 btn_back_ActionPerformed();
309 case KeyEvent.VK_ENTER: // enter key
310 if (btn_ok.isEnabled())
316 case KeyEvent.VK_TAB: // tab key
317 if (evt.isShiftDown())
319 tabbedPane.requestFocus();
323 btn_back.requestFocus();
333 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
334 btn_back.setText(MessageManager.getString("action.back"));
335 btn_back.addActionListener(new java.awt.event.ActionListener()
338 public void actionPerformed(ActionEvent e)
340 btn_back_ActionPerformed();
343 btn_back.addKeyListener(new KeyAdapter()
346 public void keyPressed(KeyEvent evt)
348 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
350 btn_back_ActionPerformed();
355 btn_ok.setEnabled(false);
356 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
357 btn_ok.setText(MessageManager.getString("action.ok"));
358 btn_ok.addActionListener(new java.awt.event.ActionListener()
361 public void actionPerformed(ActionEvent e)
366 btn_ok.addKeyListener(new KeyAdapter()
369 public void keyPressed(KeyEvent evt)
371 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
377 btn_next_page.setEnabled(false);
378 btn_next_page.setToolTipText(MessageManager
379 .getString("label.next_page_tooltip"));
380 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
381 btn_next_page.setText(MessageManager.getString("action.next_page"));
382 btn_next_page.addActionListener(new java.awt.event.ActionListener()
385 public void actionPerformed(ActionEvent e)
390 btn_next_page.addKeyListener(new KeyAdapter()
393 public void keyPressed(KeyEvent evt)
395 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
402 btn_prev_page.setEnabled(false);
403 btn_prev_page.setToolTipText(MessageManager
404 .getString("label.prev_page_tooltip"));
405 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
406 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
407 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
410 public void actionPerformed(ActionEvent e)
415 btn_prev_page.addKeyListener(new KeyAdapter()
418 public void keyPressed(KeyEvent evt)
420 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
427 if (isPaginationEnabled())
429 btn_prev_page.setVisible(true);
430 btn_next_page.setVisible(true);
434 btn_prev_page.setVisible(false);
435 btn_next_page.setVisible(false);
438 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
439 btn_cancel.setText(MessageManager.getString("action.cancel"));
440 btn_cancel.addActionListener(new java.awt.event.ActionListener()
443 public void actionPerformed(ActionEvent e)
445 btn_cancel_ActionPerformed();
448 btn_cancel.addKeyListener(new KeyAdapter()
451 public void keyPressed(KeyEvent evt)
453 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
455 btn_cancel_ActionPerformed();
459 scrl_searchResult.setPreferredSize(new Dimension(width, height));
461 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
462 cmb_searchTarget.addItemListener(new ItemListener()
465 public void itemStateChanged(ItemEvent e)
467 if (e.getStateChange() == ItemEvent.SELECTED)
470 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
473 tooltipText = MessageManager.getString("label.search_all");
475 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
476 .getSelectedItem().toString()))
478 tooltipText = MessageManager
479 .getString("label.separate_multiple_accession_ids");
483 tooltipText = MessageManager.formatMessage(
484 "label.separate_multiple_query_values",
485 new Object[] { getCmbSearchTarget().getSelectedItem()
488 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
496 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
498 txt_search.getEditor().getEditorComponent()
499 .addKeyListener(new KeyAdapter()
502 public void keyPressed(KeyEvent e)
504 if (e.getKeyCode() == KeyEvent.VK_ENTER)
506 if (getTypedText() == null || getTypedText().isEmpty())
510 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
512 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
513 .getSelectedItem().toString()))
515 transferToSequenceFetcher(getTypedText());
520 final DeferredTextInputListener listener = new DeferredTextInputListener(
521 1500, new ActionListener()
524 public void actionPerformed(ActionEvent e)
526 String typed = getTypedText();
527 if (!typed.equalsIgnoreCase(lastSearchTerm))
530 paginatorCart.clear();
531 lastSearchTerm = typed;
535 ((JTextComponent) txt_search.getEditor().getEditorComponent())
536 .getDocument().addDocumentListener(listener);
538 txt_search.addFocusListener(new FocusListener()
541 public void focusGained(FocusEvent e)
547 public void focusLost(FocusEvent e)
553 final String searchTabTitle = MessageManager
554 .getString("label.search_result");
555 final String configureCols = MessageManager
556 .getString("label.configure_displayed_columns");
557 ChangeListener changeListener = new ChangeListener()
560 public void stateChanged(ChangeEvent changeEvent)
562 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
564 int index = sourceTabbedPane.getSelectedIndex();
566 btn_back.setVisible(true);
567 btn_cancel.setVisible(true);
568 btn_ok.setVisible(true);
569 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
571 btn_back.setVisible(false);
572 btn_cancel.setVisible(false);
573 btn_ok.setVisible(false);
574 btn_back.setEnabled(false);
575 btn_cancel.setEnabled(false);
576 btn_ok.setEnabled(false);
577 btn_next_page.setEnabled(false);
578 btn_prev_page.setEnabled(false);
579 txt_search.setEnabled(false);
580 cmb_searchTarget.setEnabled(false);
581 previousWantedFields = getFTSRestClient()
582 .getAllDefaultDisplayedFTSDataColumns().toArray(
585 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
587 btn_back.setEnabled(true);
588 btn_cancel.setEnabled(true);
589 refreshPaginatorState();
590 txt_search.setEnabled(true);
591 cmb_searchTarget.setEnabled(true);
592 if (wantedFieldsUpdated())
595 paginatorCart.clear();
604 tabbedPane.addChangeListener(changeListener);
605 tabbedPane.setPreferredSize(new Dimension(width, height));
606 tabbedPane.add(searchTabTitle, scrl_searchResult);
607 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
608 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
610 pnl_actions.add(btn_back);
611 pnl_actions.add(btn_ok);
612 pnl_actions.add(btn_cancel);
614 pnl_results.add(tabbedPane);
615 pnl_inputs.add(cmb_searchTarget);
616 pnl_inputs.add(txt_search);
617 pnl_inputs.add(lbl_loading);
618 pnl_inputs.add(lbl_warning);
619 pnl_inputs.add(lbl_blank);
620 pnl_inputs.add(btn_prev_page);
621 pnl_inputs.add(btn_next_page);
623 this.setLayout(mainLayout);
624 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
625 this.add(pnl_results, java.awt.BorderLayout.CENTER);
626 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
627 mainFrame.setVisible(true);
628 mainFrame.setContentPane(this);
629 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
631 .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
634 public void internalFrameClosing(InternalFrameEvent e)
639 mainFrame.setVisible(true);
640 mainFrame.setContentPane(this);
641 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
642 Integer x = getTempUserPrefs().get("FTSPanel.x");
643 Integer y = getTempUserPrefs().get("FTSPanel.y");
644 if (x != null && y != null)
646 mainFrame.setLocation(x, y);
648 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
651 protected void closeAction()
653 getTempUserPrefs().put("FTSPanel.width", this.getWidth());
654 getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
655 getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
656 getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
658 txt_search.persistCache();
661 public class DeferredTextInputListener implements DocumentListener
663 private final Timer swingTimer;
665 public DeferredTextInputListener(int timeOut, ActionListener listener,
668 swingTimer = new Timer(timeOut, listener);
669 swingTimer.setRepeats(repeats);
683 public void insertUpdate(DocumentEvent e)
685 swingTimer.restart();
689 public void removeUpdate(DocumentEvent e)
691 swingTimer.restart();
695 public void changedUpdate(DocumentEvent e)
697 swingTimer.restart();
702 public boolean wantedFieldsUpdated()
704 if (previousWantedFields == null)
709 return Arrays.equals(getFTSRestClient()
710 .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
711 previousWantedFields) ? false : true;
715 public void validateSelection()
717 if (tbl_summary.getSelectedRows().length > 0
718 || !paginatorCart.isEmpty())
720 btn_ok.setEnabled(true);
724 btn_ok.setEnabled(false);
728 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
730 return cmb_searchTarget;
733 public JComboBox<String> getTxtSearch()
738 public JInternalFrame getMainFrame()
743 protected void delayAndEnableActionButtons()
753 } catch (InterruptedException e)
757 btn_ok.setEnabled(true);
758 btn_back.setEnabled(true);
759 btn_cancel.setEnabled(true);
764 protected void checkForErrors()
766 lbl_warning.setVisible(false);
767 lbl_blank.setVisible(true);
768 if (errorWarning.length() > 0)
770 lbl_loading.setVisible(false);
771 lbl_blank.setVisible(false);
772 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
773 errorWarning.toString()));
774 lbl_warning.setVisible(true);
778 protected void btn_back_ActionPerformed()
781 new SequenceFetcher(progressIndicator);
784 protected void disableActionButtons()
786 btn_ok.setEnabled(false);
787 btn_back.setEnabled(false);
788 btn_cancel.setEnabled(false);
791 protected void btn_cancel_ActionPerformed()
797 * Populates search target combo-box options
799 public void populateCmbSearchTargetOptions()
801 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
804 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
805 .getSearchableDataColumns();
806 searchableTargets.addAll(foundFTSTargets);
807 } catch (Exception e)
812 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
815 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
817 return o1.getName().compareTo(o2.getName());
821 for (FTSDataColumnI searchTarget : searchableTargets)
823 cmb_searchTarget.addItem(searchTarget);
827 public void transferToSequenceFetcher(String ids)
829 seqFetcher.getTextArea().setText(ids);
830 Thread worker = new Thread(seqFetcher);
835 public String getTypedText()
837 return txt_search.getUserInput();
841 public JTable getResultTable()
848 lbl_loading.setVisible(false);
849 errorWarning.setLength(0);
850 lbl_warning.setVisible(false);
851 lbl_blank.setVisible(true);
852 btn_ok.setEnabled(false);
853 mainFrame.setTitle(getFTSFrameTitle());
855 tbl_summary.setModel(new DefaultTableModel());
856 tbl_summary.setVisible(false);
860 public void setPrevPageButtonEnabled(boolean isEnabled)
862 btn_prev_page.setEnabled(isEnabled);
866 public void setNextPageButtonEnabled(boolean isEnabled)
868 btn_next_page.setEnabled(isEnabled);
872 public void setErrorMessage(String message)
874 errorWarning.append(message);
878 public void updateSearchFrameTitle(String title)
880 mainFrame.setTitle(title);
884 public void setSearchInProgress(Boolean isSearchInProgress)
886 lbl_blank.setVisible(!isSearchInProgress);
887 lbl_loading.setVisible(isSearchInProgress);
888 txt_search.setEditable(!isSearchInProgress);
892 public void prevPageAction()
894 updatePaginatorCart();
895 if (offSet >= pageLimit)
897 offSet = offSet - pageLimit;
902 refreshPaginatorState();
907 public void nextPageAction()
909 updatePaginatorCart();
910 offSet = offSet + pageLimit;
914 public void updatePaginatorCart()
916 int primaryKeyColIndex = 0;
917 JTable resultTable = getResultTable();
918 int totalRows = resultTable.getRowCount();
921 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
922 wantedFields, false);
923 } catch (Exception e)
928 for (int row = 0; row < totalRows; row++)
930 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
931 if (paginatorCart.contains(id))
933 paginatorCart.remove(id);
936 int[] selectedRows = resultTable.getSelectedRows();
937 for (int summaryRow : selectedRows)
939 String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
941 paginatorCart.add(idStr);
945 public void updateSummaryTableSelections()
947 JTable resultTable = getResultTable();
948 if (paginatorCart.isEmpty())
952 int primaryKeyColIndex = 0;
955 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
956 wantedFields, false);
957 } catch (Exception e)
961 int totalRows = resultTable.getRowCount();
962 for (int row = 0; row < totalRows; row++)
964 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
965 if (paginatorCart.contains(id))
967 resultTable.addRowSelectionInterval(row, row);
973 public void refreshPaginatorState()
975 setPrevPageButtonEnabled(false);
976 setNextPageButtonEnabled(false);
977 if (resultSetCount == 0 && pageLimit == 0)
981 if (resultSetCount >= pageLimit)
983 setNextPageButtonEnabled(true);
985 if (offSet >= pageLimit)
987 setPrevPageButtonEnabled(true);
991 public void referesh()
993 mainFrame.setTitle(getFTSFrameTitle());