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.text.DecimalFormat;
45 import java.util.ArrayList;
46 import java.util.Arrays;
47 import java.util.Collection;
48 import java.util.Collections;
49 import java.util.Comparator;
50 import java.util.HashSet;
51 import java.util.List;
53 import javax.swing.ImageIcon;
54 import javax.swing.JButton;
55 import javax.swing.JComboBox;
56 import javax.swing.JFrame;
57 import javax.swing.JInternalFrame;
58 import javax.swing.JLabel;
59 import javax.swing.JPanel;
60 import javax.swing.JScrollPane;
61 import javax.swing.JTabbedPane;
62 import javax.swing.JTable;
63 import javax.swing.JTextField;
64 import javax.swing.Timer;
65 import javax.swing.event.ChangeEvent;
66 import javax.swing.event.ChangeListener;
67 import javax.swing.event.DocumentEvent;
68 import javax.swing.event.DocumentListener;
69 import javax.swing.event.InternalFrameEvent;
70 import javax.swing.table.DefaultTableModel;
71 import javax.swing.table.TableColumn;
74 * This class provides the swing GUI layout for FTS Panel and implements most of
75 * the contracts defined in GFSPanelI
81 @SuppressWarnings("serial")
82 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
84 protected JInternalFrame mainFrame = new JInternalFrame(
87 protected IProgressIndicator progressIdicator;
89 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
91 protected JButton btn_ok = new JButton();
93 protected JButton btn_back = new JButton();
95 protected JButton btn_cancel = new JButton();
97 protected JTextField txt_search = new JTextField(30);
99 protected SequenceFetcher seqFetcher;
101 protected Collection<FTSDataColumnI> wantedFields;
103 private String lastSearchTerm = "";
105 protected JButton btn_next_page = new JButton();
107 protected JButton btn_prev_page = new JButton();
109 protected StringBuilder errorWarning = new StringBuilder();
111 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
112 "/images/warning.gif"));
114 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
115 "/images/loading.gif"));
117 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
118 .getResource("/images/blank_16x16_placeholder.png"));
120 protected JLabel lbl_warning = new JLabel(warningImage);
122 protected JLabel lbl_loading = new JLabel(loadingImage);
124 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
126 private JTabbedPane tabbedPane = new JTabbedPane();
128 private JPanel pnl_actions = new JPanel();
130 private JPanel pnl_results = new JPanel(new CardLayout());
132 private JPanel pnl_inputs = new JPanel();
134 private BorderLayout mainLayout = new BorderLayout();
136 protected Object[] previousWantedFields;
138 protected int resultSetCount;
140 protected int totalResultSetCount;
142 protected int offSet;
144 protected int pageLimit;
146 protected HashSet<String> paginatorCart = new HashSet<String>();
148 protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
150 private JTable tbl_summary = new JTable()
152 private boolean inLayout;
155 public boolean getScrollableTracksViewportWidth()
157 return hasExcessWidth();
162 public void doLayout()
164 if (hasExcessWidth())
166 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
171 autoResizeMode = AUTO_RESIZE_OFF;
174 protected boolean hasExcessWidth()
176 return getPreferredSize().width < getParent().getWidth();
180 public void columnMarginChanged(ChangeEvent e)
186 TableColumn resizingColumn = getTableHeader().getResizingColumn();
187 // Need to do this here, before the parent's
188 // layout manager calls getPreferredSize().
189 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
192 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
193 String colHeader = resizingColumn.getHeaderValue().toString();
194 getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
200 public String getToolTipText(MouseEvent evt)
202 String toolTipText = null;
203 java.awt.Point pnt = evt.getPoint();
204 int rowIndex = rowAtPoint(pnt);
205 int colIndex = columnAtPoint(pnt);
209 if (getValueAt(rowIndex, colIndex) == null)
213 toolTipText = getValueAt(rowIndex, colIndex).toString();
215 } catch (Exception e)
219 toolTipText = (toolTipText == null ? null
220 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
221 true, toolTipText.subSequence(0, 500) + "...")
222 : JvSwingUtils.wrapTooltip(true, toolTipText)));
227 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
234 mainFrame.invalidate();
236 } catch (Exception e)
243 * Initializes the GUI default properties
247 private void jbInit() throws Exception
249 Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
250 : getTempUserPrefs().get("FTSPanel.width");
251 Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
252 : getTempUserPrefs().get("FTSPanel.height");
253 lbl_warning.setVisible(false);
254 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
255 lbl_loading.setVisible(false);
256 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
257 lbl_blank.setVisible(true);
258 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
260 tbl_summary.setAutoCreateRowSorter(true);
261 tbl_summary.getTableHeader().setReorderingAllowed(false);
262 tbl_summary.addMouseListener(new MouseAdapter()
265 public void mouseClicked(MouseEvent e)
271 public void mouseReleased(MouseEvent e)
276 tbl_summary.addKeyListener(new KeyAdapter()
279 public void keyPressed(KeyEvent evt)
282 switch (evt.getKeyCode())
284 case KeyEvent.VK_ESCAPE: // escape key
285 btn_back_ActionPerformed();
287 case KeyEvent.VK_ENTER: // enter key
288 if (btn_ok.isEnabled())
294 case KeyEvent.VK_TAB: // tab key
295 if (evt.isShiftDown())
297 tabbedPane.requestFocus();
301 btn_back.requestFocus();
311 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
312 btn_back.setText(MessageManager.getString("action.back"));
313 btn_back.addActionListener(new java.awt.event.ActionListener()
316 public void actionPerformed(ActionEvent e)
318 btn_back_ActionPerformed();
321 btn_back.addKeyListener(new KeyAdapter()
324 public void keyPressed(KeyEvent evt)
326 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
328 btn_back_ActionPerformed();
333 btn_ok.setEnabled(false);
334 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
335 btn_ok.setText(MessageManager.getString("action.ok"));
336 btn_ok.addActionListener(new java.awt.event.ActionListener()
339 public void actionPerformed(ActionEvent e)
344 btn_ok.addKeyListener(new KeyAdapter()
347 public void keyPressed(KeyEvent evt)
349 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
355 btn_next_page.setEnabled(false);
356 btn_next_page.setToolTipText(MessageManager
357 .getString("label.next_page_tooltip"));
358 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
359 btn_next_page.setText(MessageManager.getString("action.next_page"));
360 btn_next_page.addActionListener(new java.awt.event.ActionListener()
363 public void actionPerformed(ActionEvent e)
368 btn_next_page.addKeyListener(new KeyAdapter()
371 public void keyPressed(KeyEvent evt)
373 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
380 btn_prev_page.setEnabled(false);
381 btn_prev_page.setToolTipText(MessageManager
382 .getString("label.prev_page_tooltip"));
383 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
384 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
385 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
388 public void actionPerformed(ActionEvent e)
393 btn_prev_page.addKeyListener(new KeyAdapter()
396 public void keyPressed(KeyEvent evt)
398 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
405 if (isPaginationEnabled())
407 btn_prev_page.setVisible(true);
408 btn_next_page.setVisible(true);
412 btn_prev_page.setVisible(false);
413 btn_next_page.setVisible(false);
416 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
417 btn_cancel.setText(MessageManager.getString("action.cancel"));
418 btn_cancel.addActionListener(new java.awt.event.ActionListener()
421 public void actionPerformed(ActionEvent e)
423 btn_cancel_ActionPerformed();
426 btn_cancel.addKeyListener(new KeyAdapter()
429 public void keyPressed(KeyEvent evt)
431 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
433 btn_cancel_ActionPerformed();
437 scrl_searchResult.setPreferredSize(new Dimension(width, height));
439 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
440 cmb_searchTarget.addActionListener(new ActionListener()
443 public void actionPerformed(ActionEvent e)
446 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
449 tooltipText = MessageManager.getString("label.search_all");
451 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
452 .getSelectedItem().toString()))
454 tooltipText = MessageManager
455 .getString("label.separate_multiple_accession_ids");
459 tooltipText = MessageManager.formatMessage(
460 "label.separate_multiple_query_values",
461 new Object[] { getCmbSearchTarget().getSelectedItem()
464 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
470 populateCmbSearchTargetOptions();
472 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
474 txt_search.addKeyListener(new KeyAdapter()
477 public void keyPressed(KeyEvent e)
479 if (e.getKeyCode() == KeyEvent.VK_ENTER)
481 if (txt_search.getText() == null
482 || txt_search.getText().isEmpty())
486 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
488 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
489 .getSelectedItem().toString()))
491 transferToSequenceFetcher(txt_search.getText());
497 final DeferredTextInputListener listener = new DeferredTextInputListener(
502 public void actionPerformed(ActionEvent e)
504 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
507 paginatorCart.clear();
508 lastSearchTerm = getTypedText();
512 txt_search.getDocument().addDocumentListener(listener);
513 txt_search.addFocusListener(new FocusListener()
516 public void focusGained(FocusEvent e)
522 public void focusLost(FocusEvent e)
528 final String searchTabTitle = MessageManager
529 .getString("label.search_result");
530 final String configureCols = MessageManager
531 .getString("label.configure_displayed_columns");
532 ChangeListener changeListener = new ChangeListener()
535 public void stateChanged(ChangeEvent changeEvent)
537 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
539 int index = sourceTabbedPane.getSelectedIndex();
541 btn_back.setVisible(true);
542 btn_cancel.setVisible(true);
543 btn_ok.setVisible(true);
544 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
546 btn_back.setVisible(false);
547 btn_cancel.setVisible(false);
548 btn_ok.setVisible(false);
549 btn_back.setEnabled(false);
550 btn_cancel.setEnabled(false);
551 btn_ok.setEnabled(false);
552 btn_next_page.setEnabled(false);
553 btn_prev_page.setEnabled(false);
554 txt_search.setEnabled(false);
555 cmb_searchTarget.setEnabled(false);
556 previousWantedFields = getFTSRestClient()
557 .getAllDefaultDisplayedFTSDataColumns()
558 .toArray(new Object[0]);
560 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
562 btn_back.setEnabled(true);
563 btn_cancel.setEnabled(true);
564 refreshPaginatorState();
565 txt_search.setEnabled(true);
566 cmb_searchTarget.setEnabled(true);
567 if (wantedFieldsUpdated())
570 paginatorCart.clear();
579 tabbedPane.addChangeListener(changeListener);
580 tabbedPane.setPreferredSize(new Dimension(width, height));
581 tabbedPane.add(searchTabTitle, scrl_searchResult);
582 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
583 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
585 pnl_actions.add(btn_back);
586 pnl_actions.add(btn_ok);
587 pnl_actions.add(btn_cancel);
589 pnl_results.add(tabbedPane);
590 pnl_inputs.add(cmb_searchTarget);
591 pnl_inputs.add(txt_search);
592 pnl_inputs.add(lbl_loading);
593 pnl_inputs.add(lbl_warning);
594 pnl_inputs.add(lbl_blank);
595 pnl_inputs.add(btn_prev_page);
596 pnl_inputs.add(btn_next_page);
598 this.setLayout(mainLayout);
599 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
600 this.add(pnl_results, java.awt.BorderLayout.CENTER);
601 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
602 mainFrame.setVisible(true);
603 mainFrame.setContentPane(this);
604 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
606 .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
609 public void internalFrameClosing(InternalFrameEvent e)
614 mainFrame.setVisible(true);
615 mainFrame.setContentPane(this);
616 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
617 Integer x = getTempUserPrefs().get("FTSPanel.x");
618 Integer y = getTempUserPrefs().get("FTSPanel.y");
619 if (x != null && y != null)
621 mainFrame.setLocation(x, y);
623 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
626 protected void closeAction()
628 // System.out.println(">>>>>>>>>> closing internal frame!!!");
629 // System.out.println("width : " + this.getWidth());
630 // System.out.println("heigh : " + this.getHeight());
631 // System.out.println("x : " + mainFrame.getX());
632 // System.out.println("y : " + mainFrame.getY());
633 getTempUserPrefs().put("FTSPanel.width", this.getWidth());
634 getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
635 getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
636 getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
639 public class DeferredTextInputListener implements DocumentListener
641 private final Timer swingTimer;
643 public DeferredTextInputListener(int timeOut, ActionListener listener,
646 swingTimer = new Timer(timeOut, listener);
647 swingTimer.setRepeats(repeats);
661 public void insertUpdate(DocumentEvent e)
663 swingTimer.restart();
667 public void removeUpdate(DocumentEvent e)
669 swingTimer.restart();
673 public void changedUpdate(DocumentEvent e)
675 swingTimer.restart();
680 public boolean wantedFieldsUpdated()
682 if (previousWantedFields == null)
687 return Arrays.equals(getFTSRestClient()
688 .getAllDefaultDisplayedFTSDataColumns()
689 .toArray(new Object[0]), previousWantedFields) ? false
694 public void validateSelection()
696 if (tbl_summary.getSelectedRows().length > 0
697 || !paginatorCart.isEmpty())
699 btn_ok.setEnabled(true);
703 btn_ok.setEnabled(false);
707 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
709 return cmb_searchTarget;
712 public JTextField getTxtSearch()
717 public JInternalFrame getMainFrame()
722 protected void delayAndEnableActionButtons()
732 } catch (InterruptedException e)
736 btn_ok.setEnabled(true);
737 btn_back.setEnabled(true);
738 btn_cancel.setEnabled(true);
743 protected void checkForErrors()
745 lbl_warning.setVisible(false);
746 lbl_blank.setVisible(true);
747 if (errorWarning.length() > 0)
749 lbl_loading.setVisible(false);
750 lbl_blank.setVisible(false);
751 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
752 errorWarning.toString()));
753 lbl_warning.setVisible(true);
757 protected void btn_back_ActionPerformed()
760 new SequenceFetcher(progressIdicator);
763 protected void disableActionButtons()
765 btn_ok.setEnabled(false);
766 btn_back.setEnabled(false);
767 btn_cancel.setEnabled(false);
770 protected void btn_cancel_ActionPerformed()
776 * Populates search target combo-box options
778 public void populateCmbSearchTargetOptions()
780 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
783 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
784 .getSearchableDataColumns();
785 searchableTargets.addAll(foundFTSTargets);
786 } catch (Exception e)
791 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
794 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
796 return o1.getName().compareTo(o2.getName());
800 for (FTSDataColumnI searchTarget : searchableTargets)
802 cmb_searchTarget.addItem(searchTarget);
807 public void transferToSequenceFetcher(String ids)
809 // mainFrame.dispose();
810 seqFetcher.getTextArea().setText(ids);
811 Thread worker = new Thread(seqFetcher);
816 public String getTypedText()
818 return txt_search.getText().trim();
822 public JTable getResultTable()
829 lbl_loading.setVisible(false);
830 errorWarning.setLength(0);
831 lbl_warning.setVisible(false);
832 lbl_blank.setVisible(true);
833 btn_ok.setEnabled(false);
834 mainFrame.setTitle(getFTSFrameTitle());
836 tbl_summary.setModel(new DefaultTableModel());
837 tbl_summary.setVisible(false);
841 public void setPrevPageButtonEnabled(boolean isEnabled)
843 btn_prev_page.setEnabled(isEnabled);
847 public void setNextPageButtonEnabled(boolean isEnabled)
849 btn_next_page.setEnabled(isEnabled);
853 public void setErrorMessage(String message)
855 errorWarning.append(message);
859 public void updateSearchFrameTitle(String title)
861 mainFrame.setTitle(title);
865 public void setSearchInProgress(Boolean isSearchInProgress)
867 lbl_blank.setVisible(!isSearchInProgress);
868 lbl_loading.setVisible(isSearchInProgress);
872 public void prevPageAction()
874 updatePaginatorCart();
875 if (offSet >= pageLimit)
877 offSet = offSet - pageLimit;
882 refreshPaginatorState();
887 public void nextPageAction()
889 updatePaginatorCart();
890 offSet = offSet + pageLimit;
894 public void updatePaginatorCart()
896 int primaryKeyColIndex = 0;
897 JTable resultTable = getResultTable();
898 int totalRows = resultTable.getRowCount();
901 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
902 wantedFields, false);
903 } catch (Exception e)
908 for (int row = 0; row < totalRows; row++)
910 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
911 if (paginatorCart.contains(id))
913 paginatorCart.remove(id);
916 int[] selectedRows = resultTable.getSelectedRows();
917 for (int summaryRow : selectedRows)
919 String idStr = resultTable.getValueAt(summaryRow,
920 primaryKeyColIndex).toString();
921 paginatorCart.add(idStr);
923 // System.out.println("Paginator shopping cart size : "
924 // + paginatorCart.size());
927 public void updateSummaryTableSelections()
929 JTable resultTable = getResultTable();
930 if (paginatorCart.isEmpty())
934 int primaryKeyColIndex = 0;
937 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
938 wantedFields, false);
939 } catch (Exception e)
943 // System.out.println(">>>>>> got here : 1");
944 int totalRows = resultTable.getRowCount();
945 // resultTable.clearSelection();
946 for (int row = 0; row < totalRows; row++)
948 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
949 if (paginatorCart.contains(id))
951 resultTable.addRowSelectionInterval(row, row);
956 public void refreshPaginatorState()
958 // System.out.println("resultSet count : " + resultSetCount);
959 // System.out.println("offSet : " + offSet);
960 // System.out.println("page limit : " + pageLimit);
961 setPrevPageButtonEnabled(false);
962 setNextPageButtonEnabled(false);
963 if (resultSetCount == 0 && pageLimit == 0)
967 if (resultSetCount >= pageLimit)
969 setNextPageButtonEnabled(true);
971 if (offSet >= pageLimit)
973 setPrevPageButtonEnabled(true);
976 public void referesh()
978 mainFrame.setTitle(getFTSFrameTitle());