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(35);
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 private JTable tbl_summary = new JTable()
108 private boolean inLayout;
111 public boolean getScrollableTracksViewportWidth()
113 return hasExcessWidth();
118 public void doLayout()
120 if (hasExcessWidth())
122 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
127 autoResizeMode = AUTO_RESIZE_OFF;
130 protected boolean hasExcessWidth()
132 return getPreferredSize().width < getParent().getWidth();
136 public void columnMarginChanged(ChangeEvent e)
142 TableColumn resizingColumn = getTableHeader().getResizingColumn();
143 // Need to do this here, before the parent's
144 // layout manager calls getPreferredSize().
145 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
148 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
154 public String getToolTipText(MouseEvent evt)
156 String toolTipText = null;
157 java.awt.Point pnt = evt.getPoint();
158 int rowIndex = rowAtPoint(pnt);
159 int colIndex = columnAtPoint(pnt);
163 if (getValueAt(rowIndex, colIndex) == null)
167 toolTipText = getValueAt(rowIndex, colIndex).toString();
169 } catch (Exception e)
173 toolTipText = (toolTipText == null ? null
174 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
175 true, toolTipText.subSequence(0, 500) + "...")
176 : JvSwingUtils.wrapTooltip(true, toolTipText)));
182 protected StringBuilder errorWarning = new StringBuilder();
184 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
186 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
187 "/images/warning.gif"));
189 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
190 "/images/loading.gif"));
192 protected JLabel lbl_warning = new JLabel(warningImage);
194 protected JLabel lbl_loading = new JLabel(loadingImage);
196 private JTabbedPane tabbedPane = new JTabbedPane();
198 private JPanel pnl_actions = new JPanel();
200 private JPanel pnl_results = new JPanel(new CardLayout());
202 private JPanel pnl_inputs = new JPanel();
204 private BorderLayout mainLayout = new BorderLayout();
206 protected Object[] previousWantedFields;
213 mainFrame.invalidate();
215 } catch (Exception e)
222 * Initializes the GUI default properties
226 private void jbInit() throws Exception
228 lbl_warning.setVisible(false);
229 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
230 lbl_loading.setVisible(false);
231 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
233 tbl_summary.setAutoCreateRowSorter(true);
234 tbl_summary.getTableHeader().setReorderingAllowed(false);
235 tbl_summary.addMouseListener(new MouseAdapter()
238 public void mouseClicked(MouseEvent e)
244 public void mouseReleased(MouseEvent e)
249 tbl_summary.addKeyListener(new KeyAdapter()
252 public void keyPressed(KeyEvent evt)
255 switch (evt.getKeyCode())
257 case KeyEvent.VK_ESCAPE: // escape key
258 btn_back_ActionPerformed();
260 case KeyEvent.VK_ENTER: // enter key
261 if (btn_ok.isEnabled())
267 case KeyEvent.VK_TAB: // tab key
268 if (evt.isShiftDown())
270 tabbedPane.requestFocus();
274 btn_back.requestFocus();
284 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
285 btn_back.setText(MessageManager.getString("action.back"));
286 btn_back.addActionListener(new java.awt.event.ActionListener()
289 public void actionPerformed(ActionEvent e)
291 btn_back_ActionPerformed();
294 btn_back.addKeyListener(new KeyAdapter()
297 public void keyPressed(KeyEvent evt)
299 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
301 btn_back_ActionPerformed();
306 btn_ok.setEnabled(false);
307 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
308 btn_ok.setText(MessageManager.getString("action.ok"));
309 btn_ok.addActionListener(new java.awt.event.ActionListener()
312 public void actionPerformed(ActionEvent e)
317 btn_ok.addKeyListener(new KeyAdapter()
320 public void keyPressed(KeyEvent evt)
322 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
329 btn_next_page.setEnabled(false);
330 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
331 btn_next_page.setText(MessageManager.getString("action.next_page"));
332 btn_next_page.addActionListener(new java.awt.event.ActionListener()
335 public void actionPerformed(ActionEvent e)
340 btn_next_page.addKeyListener(new KeyAdapter()
343 public void keyPressed(KeyEvent evt)
345 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
352 btn_prev_page.setEnabled(false);
353 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
354 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
355 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
358 public void actionPerformed(ActionEvent e)
363 btn_prev_page.addKeyListener(new KeyAdapter()
366 public void keyPressed(KeyEvent evt)
368 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
375 if (isPaginationEnabled())
377 btn_prev_page.setVisible(true);
378 btn_next_page.setVisible(true);
382 btn_prev_page.setVisible(false);
383 btn_next_page.setVisible(false);
386 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
387 btn_cancel.setText(MessageManager.getString("action.cancel"));
388 btn_cancel.addActionListener(new java.awt.event.ActionListener()
391 public void actionPerformed(ActionEvent e)
393 btn_cancel_ActionPerformed();
396 btn_cancel.addKeyListener(new KeyAdapter()
399 public void keyPressed(KeyEvent evt)
401 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
403 btn_cancel_ActionPerformed();
407 scrl_searchResult.setPreferredSize(new Dimension(800, 400));
409 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
410 cmb_searchTarget.addActionListener(new ActionListener()
413 public void actionPerformed(ActionEvent e)
416 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
419 tooltipText = MessageManager.getString("label.search_all");
421 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
422 .getSelectedItem().toString()))
424 tooltipText = MessageManager
425 .getString("label.separate_multiple_accession_ids");
429 tooltipText = MessageManager.formatMessage(
430 "label.separate_multiple_query_values",
431 new Object[] { getCmbSearchTarget().getSelectedItem()
434 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
440 populateCmbSearchTargetOptions();
442 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
444 txt_search.addKeyListener(new KeyAdapter()
447 public void keyPressed(KeyEvent e)
449 if (e.getKeyCode() == KeyEvent.VK_ENTER)
451 if (txt_search.getText() == null
452 || txt_search.getText().isEmpty())
456 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
458 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
459 .getSelectedItem().toString()))
461 transferToSequenceFetcher(txt_search.getText());
467 final DeferredTextInputListener listener = new DeferredTextInputListener(
472 public void actionPerformed(ActionEvent e)
474 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
477 lastSearchTerm = getTypedText();
481 txt_search.getDocument().addDocumentListener(listener);
482 txt_search.addFocusListener(new FocusListener()
485 public void focusGained(FocusEvent e)
491 public void focusLost(FocusEvent e)
497 final String searchTabTitle = MessageManager
498 .getString("label.search_result");
499 final String configureCols = MessageManager
500 .getString("label.configure_displayed_columns");
501 ChangeListener changeListener = new ChangeListener()
504 public void stateChanged(ChangeEvent changeEvent)
506 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
508 int index = sourceTabbedPane.getSelectedIndex();
510 btn_back.setVisible(true);
511 btn_cancel.setVisible(true);
512 btn_ok.setVisible(true);
513 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
515 btn_back.setVisible(false);
516 btn_cancel.setVisible(false);
517 btn_ok.setVisible(false);
518 btn_back.setEnabled(false);
519 btn_cancel.setEnabled(false);
520 btn_ok.setEnabled(false);
521 previousWantedFields = getFTSRestClient()
522 .getAllDefaulDisplayedDataColumns()
523 .toArray(new Object[0]);
525 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
527 btn_back.setEnabled(true);
528 btn_cancel.setEnabled(true);
529 if (wantedFieldsUpdated())
540 tabbedPane.addChangeListener(changeListener);
541 tabbedPane.setPreferredSize(new Dimension(800, 400));
542 tabbedPane.add(searchTabTitle, scrl_searchResult);
543 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
544 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
546 pnl_actions.add(btn_back);
547 pnl_actions.add(btn_ok);
548 pnl_actions.add(btn_cancel);
550 pnl_results.add(tabbedPane);
551 pnl_inputs.add(cmb_searchTarget);
552 pnl_inputs.add(txt_search);
553 pnl_inputs.add(lbl_loading);
554 pnl_inputs.add(lbl_warning);
555 pnl_inputs.add(btn_prev_page);
556 pnl_inputs.add(btn_next_page);
558 this.setLayout(mainLayout);
559 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
560 this.add(pnl_results, java.awt.BorderLayout.CENTER);
561 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
562 mainFrame.setVisible(true);
563 mainFrame.setContentPane(this);
564 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
565 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
568 public class DeferredTextInputListener implements DocumentListener
570 private final Timer swingTimer;
572 public DeferredTextInputListener(int timeOut, ActionListener listener,
575 swingTimer = new Timer(timeOut, listener);
576 swingTimer.setRepeats(repeats);
590 public void insertUpdate(DocumentEvent e)
592 swingTimer.restart();
596 public void removeUpdate(DocumentEvent e)
598 swingTimer.restart();
602 public void changedUpdate(DocumentEvent e)
604 swingTimer.restart();
609 public boolean wantedFieldsUpdated()
611 if (previousWantedFields == null)
616 return Arrays.equals(getFTSRestClient()
617 .getAllDefaulDisplayedDataColumns()
618 .toArray(new Object[0]), previousWantedFields) ? false
623 public void validateSelection()
625 if (tbl_summary.getSelectedRows().length > 0)
627 btn_ok.setEnabled(true);
631 btn_ok.setEnabled(false);
635 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
637 return cmb_searchTarget;
640 public JTextField getTxtSearch()
645 public JInternalFrame getMainFrame()
650 protected void delayAndEnableActionButtons()
660 } catch (InterruptedException e)
664 btn_ok.setEnabled(true);
665 btn_back.setEnabled(true);
666 btn_cancel.setEnabled(true);
671 protected void checkForErrors()
673 lbl_warning.setVisible(false);
674 if (errorWarning.length() > 0)
676 lbl_loading.setVisible(false);
677 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
678 errorWarning.toString()));
679 lbl_warning.setVisible(true);
683 protected void btn_back_ActionPerformed()
686 new SequenceFetcher(progressIdicator);
689 protected void disableActionButtons()
691 btn_ok.setEnabled(false);
692 btn_back.setEnabled(false);
693 btn_cancel.setEnabled(false);
696 protected void btn_cancel_ActionPerformed()
702 * Populates search target combo-box options
704 public void populateCmbSearchTargetOptions()
706 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
709 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
710 .getSearchableDataColumns();
711 searchableTargets.addAll(foundFTSTargets);
712 } catch (Exception e)
717 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
720 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
722 return o1.getName().compareTo(o2.getName());
726 for (FTSDataColumnI searchTarget : searchableTargets)
728 cmb_searchTarget.addItem(searchTarget);
733 public void transferToSequenceFetcher(String ids)
735 // mainFrame.dispose();
736 seqFetcher.getTextArea().setText(ids);
737 Thread worker = new Thread(seqFetcher);
742 public String getTypedText()
744 return txt_search.getText().trim();
748 public JTable getResultTable()
755 lbl_loading.setVisible(false);
756 errorWarning.setLength(0);
757 lbl_warning.setVisible(false);
758 btn_ok.setEnabled(false);
759 mainFrame.setTitle(getFTSFrameTitle());
761 tbl_summary.setModel(new DefaultTableModel());
762 tbl_summary.setVisible(false);
766 public void setPrevPageButtonEnabled(boolean isEnabled)
768 btn_prev_page.setEnabled(isEnabled);
772 public void setNextPageButtonEnabled(boolean isEnabled)
774 btn_next_page.setEnabled(isEnabled);
778 public void setErrorMessage(String message)
780 errorWarning.append(message);
784 public void updateSearchFrameTitle(String title)
786 mainFrame.setTitle(title);
790 public void setSearchInProgress(Boolean isSearchInProgress)
792 lbl_loading.setVisible(isSearchInProgress);
794 public void referesh()
796 mainFrame.setTitle(getFTSFrameTitle());