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.List;
51 import javax.swing.ImageIcon;
52 import javax.swing.JButton;
53 import javax.swing.JComboBox;
54 import javax.swing.JFrame;
55 import javax.swing.JInternalFrame;
56 import javax.swing.JLabel;
57 import javax.swing.JPanel;
58 import javax.swing.JScrollPane;
59 import javax.swing.JTabbedPane;
60 import javax.swing.JTable;
61 import javax.swing.JTextField;
62 import javax.swing.Timer;
63 import javax.swing.event.ChangeEvent;
64 import javax.swing.event.ChangeListener;
65 import javax.swing.event.DocumentEvent;
66 import javax.swing.event.DocumentListener;
67 import javax.swing.table.DefaultTableModel;
68 import javax.swing.table.TableColumn;
71 * This class provides the swing GUI layout for FTS Panel and implements most of
72 * the contracts defined in GFSPanelI
78 @SuppressWarnings("serial")
79 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
81 protected JInternalFrame mainFrame = new JInternalFrame(
84 protected IProgressIndicator progressIdicator;
86 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
88 protected JButton btn_ok = new JButton();
90 protected JButton btn_back = new JButton();
92 protected JButton btn_cancel = new JButton();
94 protected JTextField txt_search = new JTextField(30);
96 protected SequenceFetcher seqFetcher;
98 protected Collection<FTSDataColumnI> wantedFields;
100 private String lastSearchTerm = "";
102 protected JButton btn_next_page = new JButton();
104 protected JButton btn_prev_page = new JButton();
106 protected StringBuilder errorWarning = new StringBuilder();
108 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
109 "/images/warning.gif"));
111 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
112 "/images/loading.gif"));
114 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
115 .getResource("/images/blank_16x16_placeholder.png"));
117 protected JLabel lbl_warning = new JLabel(warningImage);
119 protected JLabel lbl_loading = new JLabel(loadingImage);
121 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
123 private JTabbedPane tabbedPane = new JTabbedPane();
125 private JPanel pnl_actions = new JPanel();
127 private JPanel pnl_results = new JPanel(new CardLayout());
129 private JPanel pnl_inputs = new JPanel();
131 private BorderLayout mainLayout = new BorderLayout();
133 protected Object[] previousWantedFields;
135 protected int resultSetCount;
137 protected int totalResultSetCount;
139 protected int offSet;
141 protected int pageLimit;
143 private JTable tbl_summary = new JTable()
145 private boolean inLayout;
148 public boolean getScrollableTracksViewportWidth()
150 return hasExcessWidth();
155 public void doLayout()
157 if (hasExcessWidth())
159 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
164 autoResizeMode = AUTO_RESIZE_OFF;
167 protected boolean hasExcessWidth()
169 return getPreferredSize().width < getParent().getWidth();
173 public void columnMarginChanged(ChangeEvent e)
179 TableColumn resizingColumn = getTableHeader().getResizingColumn();
180 // Need to do this here, before the parent's
181 // layout manager calls getPreferredSize().
182 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
185 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
191 public String getToolTipText(MouseEvent evt)
193 String toolTipText = null;
194 java.awt.Point pnt = evt.getPoint();
195 int rowIndex = rowAtPoint(pnt);
196 int colIndex = columnAtPoint(pnt);
200 if (getValueAt(rowIndex, colIndex) == null)
204 toolTipText = getValueAt(rowIndex, colIndex).toString();
206 } catch (Exception e)
210 toolTipText = (toolTipText == null ? null
211 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
212 true, toolTipText.subSequence(0, 500) + "...")
213 : JvSwingUtils.wrapTooltip(true, toolTipText)));
218 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
225 mainFrame.invalidate();
227 } catch (Exception e)
234 * Initializes the GUI default properties
238 private void jbInit() throws Exception
240 lbl_warning.setVisible(false);
241 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
242 lbl_loading.setVisible(false);
243 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
244 lbl_blank.setVisible(true);
245 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
247 tbl_summary.setAutoCreateRowSorter(true);
248 tbl_summary.getTableHeader().setReorderingAllowed(false);
249 tbl_summary.addMouseListener(new MouseAdapter()
252 public void mouseClicked(MouseEvent e)
258 public void mouseReleased(MouseEvent e)
263 tbl_summary.addKeyListener(new KeyAdapter()
266 public void keyPressed(KeyEvent evt)
269 switch (evt.getKeyCode())
271 case KeyEvent.VK_ESCAPE: // escape key
272 btn_back_ActionPerformed();
274 case KeyEvent.VK_ENTER: // enter key
275 if (btn_ok.isEnabled())
281 case KeyEvent.VK_TAB: // tab key
282 if (evt.isShiftDown())
284 tabbedPane.requestFocus();
288 btn_back.requestFocus();
298 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
299 btn_back.setText(MessageManager.getString("action.back"));
300 btn_back.addActionListener(new java.awt.event.ActionListener()
303 public void actionPerformed(ActionEvent e)
305 btn_back_ActionPerformed();
308 btn_back.addKeyListener(new KeyAdapter()
311 public void keyPressed(KeyEvent evt)
313 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
315 btn_back_ActionPerformed();
320 btn_ok.setEnabled(false);
321 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
322 btn_ok.setText(MessageManager.getString("action.ok"));
323 btn_ok.addActionListener(new java.awt.event.ActionListener()
326 public void actionPerformed(ActionEvent e)
331 btn_ok.addKeyListener(new KeyAdapter()
334 public void keyPressed(KeyEvent evt)
336 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
343 btn_next_page.setEnabled(false);
344 btn_next_page.setToolTipText(MessageManager
345 .getString("label.next_page_tooltop"));
346 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
347 btn_next_page.setText(MessageManager.getString("action.next_page"));
348 btn_next_page.addActionListener(new java.awt.event.ActionListener()
351 public void actionPerformed(ActionEvent e)
356 btn_next_page.addKeyListener(new KeyAdapter()
359 public void keyPressed(KeyEvent evt)
361 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
368 btn_prev_page.setEnabled(false);
369 btn_prev_page.setToolTipText(MessageManager
370 .getString("label.prev_page_tooltop"));
371 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
372 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
373 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
376 public void actionPerformed(ActionEvent e)
381 btn_prev_page.addKeyListener(new KeyAdapter()
384 public void keyPressed(KeyEvent evt)
386 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
393 if (isPaginationEnabled())
395 btn_prev_page.setVisible(true);
396 btn_next_page.setVisible(true);
400 btn_prev_page.setVisible(false);
401 btn_next_page.setVisible(false);
404 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
405 btn_cancel.setText(MessageManager.getString("action.cancel"));
406 btn_cancel.addActionListener(new java.awt.event.ActionListener()
409 public void actionPerformed(ActionEvent e)
411 btn_cancel_ActionPerformed();
414 btn_cancel.addKeyListener(new KeyAdapter()
417 public void keyPressed(KeyEvent evt)
419 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
421 btn_cancel_ActionPerformed();
425 scrl_searchResult.setPreferredSize(new Dimension(800, 400));
427 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
428 cmb_searchTarget.addActionListener(new ActionListener()
431 public void actionPerformed(ActionEvent e)
434 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
437 tooltipText = MessageManager.getString("label.search_all");
439 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
440 .getSelectedItem().toString()))
442 tooltipText = MessageManager
443 .getString("label.separate_multiple_accession_ids");
447 tooltipText = MessageManager.formatMessage(
448 "label.separate_multiple_query_values",
449 new Object[] { getCmbSearchTarget().getSelectedItem()
452 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
458 populateCmbSearchTargetOptions();
460 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
462 txt_search.addKeyListener(new KeyAdapter()
465 public void keyPressed(KeyEvent e)
467 if (e.getKeyCode() == KeyEvent.VK_ENTER)
469 if (txt_search.getText() == null
470 || txt_search.getText().isEmpty())
474 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
476 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
477 .getSelectedItem().toString()))
479 transferToSequenceFetcher(txt_search.getText());
485 final DeferredTextInputListener listener = new DeferredTextInputListener(
490 public void actionPerformed(ActionEvent e)
492 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
495 lastSearchTerm = getTypedText();
499 txt_search.getDocument().addDocumentListener(listener);
500 txt_search.addFocusListener(new FocusListener()
503 public void focusGained(FocusEvent e)
509 public void focusLost(FocusEvent e)
515 final String searchTabTitle = MessageManager
516 .getString("label.search_result");
517 final String configureCols = MessageManager
518 .getString("label.configure_displayed_columns");
519 ChangeListener changeListener = new ChangeListener()
522 public void stateChanged(ChangeEvent changeEvent)
524 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
526 int index = sourceTabbedPane.getSelectedIndex();
528 btn_back.setVisible(true);
529 btn_cancel.setVisible(true);
530 btn_ok.setVisible(true);
531 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
533 btn_back.setVisible(false);
534 btn_cancel.setVisible(false);
535 btn_ok.setVisible(false);
536 btn_back.setEnabled(false);
537 btn_cancel.setEnabled(false);
538 btn_ok.setEnabled(false);
539 btn_next_page.setEnabled(false);
540 btn_prev_page.setEnabled(false);
541 txt_search.setEnabled(false);
542 cmb_searchTarget.setEnabled(false);
543 previousWantedFields = getFTSRestClient()
544 .getAllDefaulDisplayedDataColumns()
545 .toArray(new Object[0]);
547 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
549 btn_back.setEnabled(true);
550 btn_cancel.setEnabled(true);
551 refreshPaginatorState();
552 txt_search.setEnabled(true);
553 cmb_searchTarget.setEnabled(true);
554 if (wantedFieldsUpdated())
565 tabbedPane.addChangeListener(changeListener);
566 tabbedPane.setPreferredSize(new Dimension(800, 400));
567 tabbedPane.add(searchTabTitle, scrl_searchResult);
568 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
569 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
571 pnl_actions.add(btn_back);
572 pnl_actions.add(btn_ok);
573 pnl_actions.add(btn_cancel);
575 pnl_results.add(tabbedPane);
576 pnl_inputs.add(cmb_searchTarget);
577 pnl_inputs.add(txt_search);
578 pnl_inputs.add(lbl_loading);
579 pnl_inputs.add(lbl_warning);
580 pnl_inputs.add(lbl_blank);
581 pnl_inputs.add(btn_prev_page);
582 pnl_inputs.add(btn_next_page);
584 this.setLayout(mainLayout);
585 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
586 this.add(pnl_results, java.awt.BorderLayout.CENTER);
587 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
588 mainFrame.setVisible(true);
589 mainFrame.setContentPane(this);
590 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
591 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
594 public class DeferredTextInputListener implements DocumentListener
596 private final Timer swingTimer;
598 public DeferredTextInputListener(int timeOut, ActionListener listener,
601 swingTimer = new Timer(timeOut, listener);
602 swingTimer.setRepeats(repeats);
616 public void insertUpdate(DocumentEvent e)
618 swingTimer.restart();
622 public void removeUpdate(DocumentEvent e)
624 swingTimer.restart();
628 public void changedUpdate(DocumentEvent e)
630 swingTimer.restart();
635 public boolean wantedFieldsUpdated()
637 if (previousWantedFields == null)
642 return Arrays.equals(getFTSRestClient()
643 .getAllDefaulDisplayedDataColumns()
644 .toArray(new Object[0]), previousWantedFields) ? false
649 public void validateSelection()
651 if (tbl_summary.getSelectedRows().length > 0)
653 btn_ok.setEnabled(true);
657 btn_ok.setEnabled(false);
661 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
663 return cmb_searchTarget;
666 public JTextField getTxtSearch()
671 public JInternalFrame getMainFrame()
676 protected void delayAndEnableActionButtons()
686 } catch (InterruptedException e)
690 btn_ok.setEnabled(true);
691 btn_back.setEnabled(true);
692 btn_cancel.setEnabled(true);
697 protected void checkForErrors()
699 lbl_warning.setVisible(false);
700 lbl_blank.setVisible(true);
701 if (errorWarning.length() > 0)
703 lbl_loading.setVisible(false);
704 lbl_blank.setVisible(false);
705 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
706 errorWarning.toString()));
707 lbl_warning.setVisible(true);
711 protected void btn_back_ActionPerformed()
714 new SequenceFetcher(progressIdicator);
717 protected void disableActionButtons()
719 btn_ok.setEnabled(false);
720 btn_back.setEnabled(false);
721 btn_cancel.setEnabled(false);
724 protected void btn_cancel_ActionPerformed()
730 * Populates search target combo-box options
732 public void populateCmbSearchTargetOptions()
734 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
737 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
738 .getSearchableDataColumns();
739 searchableTargets.addAll(foundFTSTargets);
740 } catch (Exception e)
745 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
748 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
750 return o1.getName().compareTo(o2.getName());
754 for (FTSDataColumnI searchTarget : searchableTargets)
756 cmb_searchTarget.addItem(searchTarget);
761 public void transferToSequenceFetcher(String ids)
763 // mainFrame.dispose();
764 seqFetcher.getTextArea().setText(ids);
765 Thread worker = new Thread(seqFetcher);
770 public String getTypedText()
772 return txt_search.getText().trim();
776 public JTable getResultTable()
783 lbl_loading.setVisible(false);
784 errorWarning.setLength(0);
785 lbl_warning.setVisible(false);
786 lbl_blank.setVisible(true);
787 btn_ok.setEnabled(false);
788 mainFrame.setTitle(getFTSFrameTitle());
790 tbl_summary.setModel(new DefaultTableModel());
791 tbl_summary.setVisible(false);
795 public void setPrevPageButtonEnabled(boolean isEnabled)
797 btn_prev_page.setEnabled(isEnabled);
801 public void setNextPageButtonEnabled(boolean isEnabled)
803 btn_next_page.setEnabled(isEnabled);
807 public void setErrorMessage(String message)
809 errorWarning.append(message);
813 public void updateSearchFrameTitle(String title)
815 mainFrame.setTitle(title);
819 public void setSearchInProgress(Boolean isSearchInProgress)
821 lbl_blank.setVisible(!isSearchInProgress);
822 lbl_loading.setVisible(isSearchInProgress);
826 public void prevPageAction()
828 if (offSet >= pageLimit)
830 offSet = offSet - pageLimit;
835 refreshPaginatorState();
840 public void nextPageAction()
842 offSet = offSet + pageLimit;
847 public void refreshPaginatorState()
849 // System.out.println("resultSet count : " + resultSetCount);
850 // System.out.println("offSet : " + offSet);
851 // System.out.println("page limit : " + pageLimit);
852 setPrevPageButtonEnabled(false);
853 setNextPageButtonEnabled(false);
854 if (resultSetCount >= pageLimit)
856 setNextPageButtonEnabled(true);
858 if (offSet >= pageLimit)
860 setPrevPageButtonEnabled(true);
863 public void referesh()
865 mainFrame.setTitle(getFTSFrameTitle());