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)
342 btn_next_page.setEnabled(false);
343 btn_next_page.setToolTipText(MessageManager
344 .getString("label.next_page_tooltop"));
345 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
346 btn_next_page.setText(MessageManager.getString("action.next_page"));
347 btn_next_page.addActionListener(new java.awt.event.ActionListener()
350 public void actionPerformed(ActionEvent e)
355 btn_next_page.addKeyListener(new KeyAdapter()
358 public void keyPressed(KeyEvent evt)
360 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
367 btn_prev_page.setEnabled(false);
368 btn_prev_page.setToolTipText(MessageManager
369 .getString("label.prev_page_tooltop"));
370 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
371 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
372 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
375 public void actionPerformed(ActionEvent e)
380 btn_prev_page.addKeyListener(new KeyAdapter()
383 public void keyPressed(KeyEvent evt)
385 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
392 if (isPaginationEnabled())
394 btn_prev_page.setVisible(true);
395 btn_next_page.setVisible(true);
399 btn_prev_page.setVisible(false);
400 btn_next_page.setVisible(false);
403 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
404 btn_cancel.setText(MessageManager.getString("action.cancel"));
405 btn_cancel.addActionListener(new java.awt.event.ActionListener()
408 public void actionPerformed(ActionEvent e)
410 btn_cancel_ActionPerformed();
413 btn_cancel.addKeyListener(new KeyAdapter()
416 public void keyPressed(KeyEvent evt)
418 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
420 btn_cancel_ActionPerformed();
424 scrl_searchResult.setPreferredSize(new Dimension(800, 400));
426 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
427 cmb_searchTarget.addActionListener(new ActionListener()
430 public void actionPerformed(ActionEvent e)
433 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
436 tooltipText = MessageManager.getString("label.search_all");
438 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
439 .getSelectedItem().toString()))
441 tooltipText = MessageManager
442 .getString("label.separate_multiple_accession_ids");
446 tooltipText = MessageManager.formatMessage(
447 "label.separate_multiple_query_values",
448 new Object[] { getCmbSearchTarget().getSelectedItem()
451 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
457 populateCmbSearchTargetOptions();
459 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
461 txt_search.addKeyListener(new KeyAdapter()
464 public void keyPressed(KeyEvent e)
466 if (e.getKeyCode() == KeyEvent.VK_ENTER)
468 if (txt_search.getText() == null
469 || txt_search.getText().isEmpty())
473 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
475 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
476 .getSelectedItem().toString()))
478 transferToSequenceFetcher(txt_search.getText());
484 final DeferredTextInputListener listener = new DeferredTextInputListener(
489 public void actionPerformed(ActionEvent e)
491 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
494 lastSearchTerm = getTypedText();
498 txt_search.getDocument().addDocumentListener(listener);
499 txt_search.addFocusListener(new FocusListener()
502 public void focusGained(FocusEvent e)
508 public void focusLost(FocusEvent e)
514 final String searchTabTitle = MessageManager
515 .getString("label.search_result");
516 final String configureCols = MessageManager
517 .getString("label.configure_displayed_columns");
518 ChangeListener changeListener = new ChangeListener()
521 public void stateChanged(ChangeEvent changeEvent)
523 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
525 int index = sourceTabbedPane.getSelectedIndex();
527 btn_back.setVisible(true);
528 btn_cancel.setVisible(true);
529 btn_ok.setVisible(true);
530 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
532 btn_back.setVisible(false);
533 btn_cancel.setVisible(false);
534 btn_ok.setVisible(false);
535 btn_back.setEnabled(false);
536 btn_cancel.setEnabled(false);
537 btn_ok.setEnabled(false);
538 btn_next_page.setEnabled(false);
539 btn_prev_page.setEnabled(false);
540 txt_search.setEnabled(false);
541 cmb_searchTarget.setEnabled(false);
542 previousWantedFields = getFTSRestClient()
543 .getAllDefaulDisplayedDataColumns()
544 .toArray(new Object[0]);
546 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
548 btn_back.setEnabled(true);
549 btn_cancel.setEnabled(true);
550 refreshPaginatorState();
551 txt_search.setEnabled(true);
552 cmb_searchTarget.setEnabled(true);
553 if (wantedFieldsUpdated())
564 tabbedPane.addChangeListener(changeListener);
565 tabbedPane.setPreferredSize(new Dimension(800, 400));
566 tabbedPane.add(searchTabTitle, scrl_searchResult);
567 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
568 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
570 pnl_actions.add(btn_back);
571 pnl_actions.add(btn_ok);
572 pnl_actions.add(btn_cancel);
574 pnl_results.add(tabbedPane);
575 pnl_inputs.add(cmb_searchTarget);
576 pnl_inputs.add(txt_search);
577 pnl_inputs.add(lbl_loading);
578 pnl_inputs.add(lbl_warning);
579 pnl_inputs.add(lbl_blank);
580 pnl_inputs.add(btn_prev_page);
581 pnl_inputs.add(btn_next_page);
583 this.setLayout(mainLayout);
584 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
585 this.add(pnl_results, java.awt.BorderLayout.CENTER);
586 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
587 mainFrame.setVisible(true);
588 mainFrame.setContentPane(this);
589 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
590 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
593 public class DeferredTextInputListener implements DocumentListener
595 private final Timer swingTimer;
597 public DeferredTextInputListener(int timeOut, ActionListener listener,
600 swingTimer = new Timer(timeOut, listener);
601 swingTimer.setRepeats(repeats);
615 public void insertUpdate(DocumentEvent e)
617 swingTimer.restart();
621 public void removeUpdate(DocumentEvent e)
623 swingTimer.restart();
627 public void changedUpdate(DocumentEvent e)
629 swingTimer.restart();
634 public boolean wantedFieldsUpdated()
636 if (previousWantedFields == null)
641 return Arrays.equals(getFTSRestClient()
642 .getAllDefaulDisplayedDataColumns()
643 .toArray(new Object[0]), previousWantedFields) ? false
648 public void validateSelection()
650 if (tbl_summary.getSelectedRows().length > 0)
652 btn_ok.setEnabled(true);
656 btn_ok.setEnabled(false);
660 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
662 return cmb_searchTarget;
665 public JTextField getTxtSearch()
670 public JInternalFrame getMainFrame()
675 protected void delayAndEnableActionButtons()
685 } catch (InterruptedException e)
689 btn_ok.setEnabled(true);
690 btn_back.setEnabled(true);
691 btn_cancel.setEnabled(true);
696 protected void checkForErrors()
698 lbl_warning.setVisible(false);
699 lbl_blank.setVisible(true);
700 if (errorWarning.length() > 0)
702 lbl_loading.setVisible(false);
703 lbl_blank.setVisible(false);
704 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
705 errorWarning.toString()));
706 lbl_warning.setVisible(true);
710 protected void btn_back_ActionPerformed()
713 new SequenceFetcher(progressIdicator);
716 protected void disableActionButtons()
718 btn_ok.setEnabled(false);
719 btn_back.setEnabled(false);
720 btn_cancel.setEnabled(false);
723 protected void btn_cancel_ActionPerformed()
729 * Populates search target combo-box options
731 public void populateCmbSearchTargetOptions()
733 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
736 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
737 .getSearchableDataColumns();
738 searchableTargets.addAll(foundFTSTargets);
739 } catch (Exception e)
744 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
747 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
749 return o1.getName().compareTo(o2.getName());
753 for (FTSDataColumnI searchTarget : searchableTargets)
755 cmb_searchTarget.addItem(searchTarget);
760 public void transferToSequenceFetcher(String ids)
762 // mainFrame.dispose();
763 seqFetcher.getTextArea().setText(ids);
764 Thread worker = new Thread(seqFetcher);
769 public String getTypedText()
771 return txt_search.getText().trim();
775 public JTable getResultTable()
782 lbl_loading.setVisible(false);
783 errorWarning.setLength(0);
784 lbl_warning.setVisible(false);
785 lbl_blank.setVisible(true);
786 btn_ok.setEnabled(false);
787 mainFrame.setTitle(getFTSFrameTitle());
789 tbl_summary.setModel(new DefaultTableModel());
790 tbl_summary.setVisible(false);
794 public void setPrevPageButtonEnabled(boolean isEnabled)
796 btn_prev_page.setEnabled(isEnabled);
800 public void setNextPageButtonEnabled(boolean isEnabled)
802 btn_next_page.setEnabled(isEnabled);
806 public void setErrorMessage(String message)
808 errorWarning.append(message);
812 public void updateSearchFrameTitle(String title)
814 mainFrame.setTitle(title);
818 public void setSearchInProgress(Boolean isSearchInProgress)
820 lbl_blank.setVisible(!isSearchInProgress);
821 lbl_loading.setVisible(isSearchInProgress);
825 public void prevPageAction()
827 if (offSet >= pageLimit)
829 offSet = offSet - pageLimit;
834 refreshPaginatorState();
839 public void nextPageAction()
841 offSet = offSet + pageLimit;
846 public void refreshPaginatorState()
848 // System.out.println("resultSet count : " + resultSetCount);
849 // System.out.println("offSet : " + offSet);
850 // System.out.println("page limit : " + pageLimit);
851 setPrevPageButtonEnabled(false);
852 setNextPageButtonEnabled(false);
853 if (resultSetCount == 0 && pageLimit == 0)
857 if (resultSetCount >= pageLimit)
859 setNextPageButtonEnabled(true);
861 if (offSet >= pageLimit)
863 setPrevPageButtonEnabled(true);
866 public void referesh()
868 mainFrame.setTitle(getFTSFrameTitle());