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 private JTable tbl_summary = new JTable()
104 private boolean inLayout;
107 public boolean getScrollableTracksViewportWidth()
109 return hasExcessWidth();
114 public void doLayout()
116 if (hasExcessWidth())
118 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
123 autoResizeMode = AUTO_RESIZE_OFF;
126 protected boolean hasExcessWidth()
128 return getPreferredSize().width < getParent().getWidth();
132 public void columnMarginChanged(ChangeEvent e)
138 TableColumn resizingColumn = getTableHeader().getResizingColumn();
139 // Need to do this here, before the parent's
140 // layout manager calls getPreferredSize().
141 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
144 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
150 public String getToolTipText(MouseEvent evt)
152 String toolTipText = null;
153 java.awt.Point pnt = evt.getPoint();
154 int rowIndex = rowAtPoint(pnt);
155 int colIndex = columnAtPoint(pnt);
159 if (getValueAt(rowIndex, colIndex) == null)
163 toolTipText = getValueAt(rowIndex, colIndex).toString();
165 } catch (Exception e)
169 toolTipText = (toolTipText == null ? null
170 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
171 true, toolTipText.subSequence(0, 500) + "...")
172 : JvSwingUtils.wrapTooltip(true, toolTipText)));
178 protected StringBuilder errorWarning = new StringBuilder();
180 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
182 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
183 "/images/warning.gif"));
185 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
186 "/images/loading.gif"));
188 protected JLabel lbl_warning = new JLabel(warningImage);
190 protected JLabel lbl_loading = new JLabel(loadingImage);
192 private JTabbedPane tabbedPane = new JTabbedPane();
194 private JPanel pnl_actions = new JPanel();
196 private JPanel pnl_results = new JPanel(new CardLayout());
198 private JPanel pnl_inputs = new JPanel();
200 private BorderLayout mainLayout = new BorderLayout();
202 protected Object[] previousWantedFields;
209 mainFrame.invalidate();
211 } catch (Exception e)
218 * Initializes the GUI default properties
222 private void jbInit() throws Exception
224 lbl_warning.setVisible(false);
225 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
226 lbl_loading.setVisible(false);
227 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
229 tbl_summary.setAutoCreateRowSorter(true);
230 tbl_summary.getTableHeader().setReorderingAllowed(false);
231 tbl_summary.addMouseListener(new MouseAdapter()
234 public void mouseClicked(MouseEvent e)
240 public void mouseReleased(MouseEvent e)
245 tbl_summary.addKeyListener(new KeyAdapter()
248 public void keyPressed(KeyEvent evt)
251 switch (evt.getKeyCode())
253 case KeyEvent.VK_ESCAPE: // escape key
254 btn_back_ActionPerformed();
256 case KeyEvent.VK_ENTER: // enter key
257 if (btn_ok.isEnabled())
263 case KeyEvent.VK_TAB: // tab key
264 if (evt.isShiftDown())
266 tabbedPane.requestFocus();
270 btn_back.requestFocus();
280 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
281 btn_back.setText(MessageManager.getString("action.back"));
282 btn_back.addActionListener(new java.awt.event.ActionListener()
285 public void actionPerformed(ActionEvent e)
287 btn_back_ActionPerformed();
290 btn_back.addKeyListener(new KeyAdapter()
293 public void keyPressed(KeyEvent evt)
295 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
297 btn_back_ActionPerformed();
302 btn_ok.setEnabled(false);
303 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
304 btn_ok.setText(MessageManager.getString("action.ok"));
305 btn_ok.addActionListener(new java.awt.event.ActionListener()
308 public void actionPerformed(ActionEvent e)
313 btn_ok.addKeyListener(new KeyAdapter()
316 public void keyPressed(KeyEvent evt)
318 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
325 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
326 btn_cancel.setText(MessageManager.getString("action.cancel"));
327 btn_cancel.addActionListener(new java.awt.event.ActionListener()
330 public void actionPerformed(ActionEvent e)
332 btn_cancel_ActionPerformed();
335 btn_cancel.addKeyListener(new KeyAdapter()
338 public void keyPressed(KeyEvent evt)
340 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
342 btn_cancel_ActionPerformed();
346 scrl_searchResult.setPreferredSize(new Dimension(800, 400));
348 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
349 cmb_searchTarget.addActionListener(new ActionListener()
352 public void actionPerformed(ActionEvent e)
355 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
358 tooltipText = MessageManager.getString("label.search_all");
360 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
361 .getSelectedItem().toString()))
363 tooltipText = MessageManager
364 .getString("label.separate_multiple_accession_ids");
368 tooltipText = MessageManager.formatMessage(
369 "label.separate_multiple_query_values",
370 new Object[] { getCmbSearchTarget().getSelectedItem()
373 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
379 populateCmbSearchTargetOptions();
381 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
383 txt_search.addKeyListener(new KeyAdapter()
386 public void keyPressed(KeyEvent e)
388 if (e.getKeyCode() == KeyEvent.VK_ENTER)
390 if (txt_search.getText() == null
391 || txt_search.getText().isEmpty())
395 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
397 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
398 .getSelectedItem().toString()))
400 transferToSequenceFetcher(txt_search.getText());
406 final DeferredTextInputListener listener = new DeferredTextInputListener(
411 public void actionPerformed(ActionEvent e)
413 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
416 lastSearchTerm = getTypedText();
420 txt_search.getDocument().addDocumentListener(listener);
421 txt_search.addFocusListener(new FocusListener()
424 public void focusGained(FocusEvent e)
430 public void focusLost(FocusEvent e)
436 final String searchTabTitle = MessageManager
437 .getString("label.search_result");
438 final String configureCols = MessageManager
439 .getString("label.configure_displayed_columns");
440 ChangeListener changeListener = new ChangeListener()
443 public void stateChanged(ChangeEvent changeEvent)
445 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
447 int index = sourceTabbedPane.getSelectedIndex();
449 btn_back.setVisible(true);
450 btn_cancel.setVisible(true);
451 btn_ok.setVisible(true);
452 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
454 btn_back.setVisible(false);
455 btn_cancel.setVisible(false);
456 btn_ok.setVisible(false);
457 btn_back.setEnabled(false);
458 btn_cancel.setEnabled(false);
459 btn_ok.setEnabled(false);
460 previousWantedFields = getFTSRestClient()
461 .getAllDefaulDisplayedDataColumns()
462 .toArray(new Object[0]);
464 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
466 btn_back.setEnabled(true);
467 btn_cancel.setEnabled(true);
468 if (wantedFieldsUpdated())
479 tabbedPane.addChangeListener(changeListener);
480 tabbedPane.setPreferredSize(new Dimension(800, 400));
481 tabbedPane.add(searchTabTitle, scrl_searchResult);
482 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
483 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
485 pnl_actions.add(btn_back);
486 pnl_actions.add(btn_ok);
487 pnl_actions.add(btn_cancel);
489 pnl_results.add(tabbedPane);
490 pnl_inputs.add(cmb_searchTarget);
491 pnl_inputs.add(txt_search);
492 pnl_inputs.add(lbl_loading);
493 pnl_inputs.add(lbl_warning);
495 this.setLayout(mainLayout);
496 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
497 this.add(pnl_results, java.awt.BorderLayout.CENTER);
498 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
499 mainFrame.setVisible(true);
500 mainFrame.setContentPane(this);
501 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
502 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
505 public class DeferredTextInputListener implements DocumentListener
507 private final Timer swingTimer;
509 public DeferredTextInputListener(int timeOut, ActionListener listener,
512 swingTimer = new Timer(timeOut, listener);
513 swingTimer.setRepeats(repeats);
527 public void insertUpdate(DocumentEvent e)
529 swingTimer.restart();
533 public void removeUpdate(DocumentEvent e)
535 swingTimer.restart();
539 public void changedUpdate(DocumentEvent e)
541 swingTimer.restart();
546 public boolean wantedFieldsUpdated()
548 if (previousWantedFields == null)
553 return Arrays.equals(getFTSRestClient()
554 .getAllDefaulDisplayedDataColumns()
555 .toArray(new Object[0]), previousWantedFields) ? false
560 public void validateSelection()
562 if (tbl_summary.getSelectedRows().length > 0)
564 btn_ok.setEnabled(true);
568 btn_ok.setEnabled(false);
572 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
574 return cmb_searchTarget;
577 public JTextField getTxtSearch()
582 public JInternalFrame getMainFrame()
587 protected void delayAndEnableActionButtons()
597 } catch (InterruptedException e)
601 btn_ok.setEnabled(true);
602 btn_back.setEnabled(true);
603 btn_cancel.setEnabled(true);
608 protected void checkForErrors()
610 lbl_warning.setVisible(false);
611 if (errorWarning.length() > 0)
613 lbl_loading.setVisible(false);
614 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
615 errorWarning.toString()));
616 lbl_warning.setVisible(true);
620 protected void btn_back_ActionPerformed()
623 new SequenceFetcher(progressIdicator);
626 protected void disableActionButtons()
628 btn_ok.setEnabled(false);
629 btn_back.setEnabled(false);
630 btn_cancel.setEnabled(false);
633 protected void btn_cancel_ActionPerformed()
639 * Populates search target combo-box options
641 public void populateCmbSearchTargetOptions()
643 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
646 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
647 .getSearchableDataColumns();
648 searchableTargets.addAll(foundFTSTargets);
649 } catch (Exception e)
654 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
657 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
659 return o1.getName().compareTo(o2.getName());
663 for (FTSDataColumnI searchTarget : searchableTargets)
665 cmb_searchTarget.addItem(searchTarget);
670 public void transferToSequenceFetcher(String ids)
672 // mainFrame.dispose();
673 seqFetcher.getTextArea().setText(ids);
674 Thread worker = new Thread(seqFetcher);
679 public String getTypedText()
681 return txt_search.getText().trim();
685 public JTable getResultTable()
692 lbl_loading.setVisible(false);
693 errorWarning.setLength(0);
694 lbl_warning.setVisible(false);
695 btn_ok.setEnabled(false);
696 mainFrame.setTitle(getFTSFrameTitle());
698 tbl_summary.setModel(new DefaultTableModel());
699 tbl_summary.setVisible(false);
703 public void setErrorMessage(String message)
705 errorWarning.append(message);
709 public void updateSearchFrameTitle(String title)
711 mainFrame.setTitle(title);
715 public void setSearchInProgress(Boolean isSearchInProgress)
717 lbl_loading.setVisible(isSearchInProgress);
719 public void referesh()
721 mainFrame.setTitle(getFTSFrameTitle());