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(
116 getClass().getResource("/images/warning.gif"));
118 protected ImageIcon loadingImage = new ImageIcon(
119 getClass().getResource("/images/loading.gif"));
121 protected ImageIcon balnkPlaceholderImage = new ImageIcon(
122 getClass().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
230 ? JvSwingUtils.wrapTooltip(true,
231 toolTipText.subSequence(0, 500) + "...")
232 : JvSwingUtils.wrapTooltip(true, toolTipText)));
238 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
245 mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
246 mainFrame.addFocusListener(new FocusAdapter()
249 public void focusGained(FocusEvent e)
251 txt_search.requestFocusInWindow();
254 mainFrame.invalidate();
256 } catch (Exception e)
263 * Initializes the GUI default properties
267 private void jbInit() throws Exception
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));
283 tbl_summary.setAutoCreateRowSorter(true);
284 tbl_summary.getTableHeader().setReorderingAllowed(false);
285 tbl_summary.addMouseListener(new MouseAdapter()
288 public void mouseClicked(MouseEvent e)
294 public void mouseReleased(MouseEvent e)
299 tbl_summary.addKeyListener(new KeyAdapter()
302 public void keyPressed(KeyEvent evt)
305 switch (evt.getKeyCode())
307 case KeyEvent.VK_ESCAPE: // escape key
308 btn_back_ActionPerformed();
310 case KeyEvent.VK_ENTER: // enter key
311 if (btn_ok.isEnabled())
317 case KeyEvent.VK_TAB: // tab key
318 if (evt.isShiftDown())
320 tabbedPane.requestFocus();
324 btn_back.requestFocus();
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()
339 public void actionPerformed(ActionEvent e)
341 btn_back_ActionPerformed();
344 btn_back.addKeyListener(new KeyAdapter()
347 public void keyPressed(KeyEvent evt)
349 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
351 btn_back_ActionPerformed();
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()
362 public void actionPerformed(ActionEvent e)
367 btn_ok.addKeyListener(new KeyAdapter()
370 public void keyPressed(KeyEvent evt)
372 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
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()
386 public void actionPerformed(ActionEvent e)
391 btn_next_page.addKeyListener(new KeyAdapter()
394 public void keyPressed(KeyEvent evt)
396 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
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()
411 public void actionPerformed(ActionEvent e)
416 btn_prev_page.addKeyListener(new KeyAdapter()
419 public void keyPressed(KeyEvent evt)
421 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
428 if (isPaginationEnabled())
430 btn_prev_page.setVisible(true);
431 btn_next_page.setVisible(true);
435 btn_prev_page.setVisible(false);
436 btn_next_page.setVisible(false);
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()
444 public void actionPerformed(ActionEvent e)
446 btn_cancel_ActionPerformed();
449 btn_cancel.addKeyListener(new KeyAdapter()
452 public void keyPressed(KeyEvent evt)
454 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
456 btn_cancel_ActionPerformed();
460 scrl_searchResult.setPreferredSize(new Dimension(width, height));
462 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
463 cmb_searchTarget.addItemListener(new ItemListener()
466 public void itemStateChanged(ItemEvent e)
468 if (e.getStateChange() == ItemEvent.SELECTED)
471 if ("all".equalsIgnoreCase(
472 getCmbSearchTarget().getSelectedItem().toString()))
474 tooltipText = MessageManager.getString("label.search_all");
476 else if ("pdb id".equalsIgnoreCase(
477 getCmbSearchTarget().getSelectedItem().toString()))
479 tooltipText = MessageManager
480 .getString("label.separate_multiple_accession_ids");
484 tooltipText = MessageManager.formatMessage(
485 "label.separate_multiple_query_values", new Object[]
486 { getCmbSearchTarget().getSelectedItem().toString() });
488 txt_search.setToolTipText(
489 JvSwingUtils.wrapTooltip(true, tooltipText));
495 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
497 txt_search.getEditor().getEditorComponent()
498 .addKeyListener(new KeyAdapter()
501 public void keyPressed(KeyEvent e)
503 if (e.getKeyCode() == KeyEvent.VK_ENTER)
505 if (getTypedText() == null || getTypedText().isEmpty())
509 String primaryKeyName = getFTSRestClient()
510 .getPrimaryKeyColumn().getName();
511 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
512 .getSelectedItem().toString()))
514 transferToSequenceFetcher(getTypedText());
519 final DeferredTextInputListener listener = new DeferredTextInputListener(
520 1500, new ActionListener()
523 public void actionPerformed(ActionEvent e)
525 String typed = getTypedText();
526 if (!typed.equalsIgnoreCase(lastSearchTerm))
529 paginatorCart.clear();
530 lastSearchTerm = typed;
534 ((JTextComponent) txt_search.getEditor().getEditorComponent())
535 .getDocument().addDocumentListener(listener);
537 txt_search.addFocusListener(new FocusListener()
540 public void focusGained(FocusEvent e)
546 public void focusLost(FocusEvent e)
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()
559 public void stateChanged(ChangeEvent changeEvent)
561 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
563 int index = sourceTabbedPane.getSelectedIndex();
565 btn_back.setVisible(true);
566 btn_cancel.setVisible(true);
567 btn_ok.setVisible(true);
568 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
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]);
584 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
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())
594 paginatorCart.clear();
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()));
609 pnl_actions.add(btn_back);
610 pnl_actions.add(btn_ok);
611 pnl_actions.add(btn_cancel);
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);
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()
633 public void internalFrameClosing(InternalFrameEvent e)
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)
645 mainFrame.setLocation(x, y);
647 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
650 protected void closeAction()
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());
657 txt_search.persistCache();
660 public class DeferredTextInputListener implements DocumentListener
662 private final Timer swingTimer;
664 public DeferredTextInputListener(int timeOut, ActionListener listener,
667 swingTimer = new Timer(timeOut, listener);
668 swingTimer.setRepeats(repeats);
682 public void insertUpdate(DocumentEvent e)
684 swingTimer.restart();
688 public void removeUpdate(DocumentEvent e)
690 swingTimer.restart();
694 public void changedUpdate(DocumentEvent e)
696 swingTimer.restart();
701 public boolean wantedFieldsUpdated()
703 if (previousWantedFields == null)
708 return Arrays.equals(getFTSRestClient()
709 .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
710 previousWantedFields) ? false : true;
714 public void validateSelection()
716 if (tbl_summary.getSelectedRows().length > 0
717 || !paginatorCart.isEmpty())
719 btn_ok.setEnabled(true);
723 btn_ok.setEnabled(false);
727 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
729 return cmb_searchTarget;
732 public JComboBox<String> getTxtSearch()
737 public JInternalFrame getMainFrame()
742 protected void delayAndEnableActionButtons()
752 } catch (InterruptedException e)
756 btn_ok.setEnabled(true);
757 btn_back.setEnabled(true);
758 btn_cancel.setEnabled(true);
763 protected void checkForErrors()
765 lbl_warning.setVisible(false);
766 lbl_blank.setVisible(true);
767 if (errorWarning.length() > 0)
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);
777 protected void btn_back_ActionPerformed()
780 new SequenceFetcher(progressIndicator);
783 protected void disableActionButtons()
785 btn_ok.setEnabled(false);
786 btn_back.setEnabled(false);
787 btn_cancel.setEnabled(false);
790 protected void btn_cancel_ActionPerformed()
796 * Populates search target combo-box options
798 public void populateCmbSearchTargetOptions()
800 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
803 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
804 .getSearchableDataColumns();
805 searchableTargets.addAll(foundFTSTargets);
806 } catch (Exception e)
811 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
814 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
816 return o1.getName().compareTo(o2.getName());
820 for (FTSDataColumnI searchTarget : searchableTargets)
822 cmb_searchTarget.addItem(searchTarget);
826 public void transferToSequenceFetcher(String ids)
828 seqFetcher.getTextArea().setText(ids);
829 Thread worker = new Thread(seqFetcher);
834 public String getTypedText()
836 return txt_search.getUserInput();
840 public JTable getResultTable()
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());
854 tbl_summary.setModel(new DefaultTableModel());
855 tbl_summary.setVisible(false);
859 public void setPrevPageButtonEnabled(boolean isEnabled)
861 btn_prev_page.setEnabled(isEnabled);
865 public void setNextPageButtonEnabled(boolean isEnabled)
867 btn_next_page.setEnabled(isEnabled);
871 public void setErrorMessage(String message)
873 errorWarning.append(message);
877 public void updateSearchFrameTitle(String title)
879 mainFrame.setTitle(title);
883 public void setSearchInProgress(Boolean isSearchInProgress)
885 lbl_blank.setVisible(!isSearchInProgress);
886 lbl_loading.setVisible(isSearchInProgress);
887 txt_search.setEditable(!isSearchInProgress);
891 public void prevPageAction()
893 updatePaginatorCart();
894 if (offSet >= pageLimit)
896 offSet = offSet - pageLimit;
901 refreshPaginatorState();
906 public void nextPageAction()
908 updatePaginatorCart();
909 offSet = offSet + pageLimit;
913 public void updatePaginatorCart()
915 int primaryKeyColIndex = 0;
916 JTable resultTable = getResultTable();
917 int totalRows = resultTable.getRowCount();
920 primaryKeyColIndex = getFTSRestClient()
921 .getPrimaryKeyColumIndex(wantedFields, false);
922 } catch (Exception e)
927 for (int row = 0; row < totalRows; row++)
929 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
930 if (paginatorCart.contains(id))
932 paginatorCart.remove(id);
935 int[] selectedRows = resultTable.getSelectedRows();
936 for (int summaryRow : selectedRows)
938 String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
940 paginatorCart.add(idStr);
944 public void updateSummaryTableSelections()
946 JTable resultTable = getResultTable();
947 if (paginatorCart.isEmpty())
951 int primaryKeyColIndex = 0;
954 primaryKeyColIndex = getFTSRestClient()
955 .getPrimaryKeyColumIndex(wantedFields, false);
956 } catch (Exception e)
960 int totalRows = resultTable.getRowCount();
961 for (int row = 0; row < totalRows; row++)
963 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
964 if (paginatorCart.contains(id))
966 resultTable.addRowSelectionInterval(row, row);
972 public void refreshPaginatorState()
974 setPrevPageButtonEnabled(false);
975 setNextPageButtonEnabled(false);
976 if (resultSetCount == 0 && pageLimit == 0)
980 if (resultSetCount >= pageLimit)
982 setNextPageButtonEnabled(true);
984 if (offSet >= pageLimit)
986 setPrevPageButtonEnabled(true);
990 public void referesh()
992 mainFrame.setTitle(getFTSFrameTitle());