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.FocusAdapter;
39 import java.awt.event.FocusEvent;
40 import java.awt.event.FocusListener;
41 import java.awt.event.KeyAdapter;
42 import java.awt.event.KeyEvent;
43 import java.awt.event.MouseAdapter;
44 import java.awt.event.MouseEvent;
45 import java.text.DecimalFormat;
46 import java.util.ArrayList;
47 import java.util.Arrays;
48 import java.util.Collection;
49 import java.util.Collections;
50 import java.util.Comparator;
51 import java.util.HashSet;
52 import java.util.List;
54 import javax.swing.ImageIcon;
55 import javax.swing.JButton;
56 import javax.swing.JComboBox;
57 import javax.swing.JFrame;
58 import javax.swing.JInternalFrame;
59 import javax.swing.JLabel;
60 import javax.swing.JPanel;
61 import javax.swing.JScrollPane;
62 import javax.swing.JTabbedPane;
63 import javax.swing.JTable;
64 import javax.swing.JTextField;
65 import javax.swing.Timer;
66 import javax.swing.event.ChangeEvent;
67 import javax.swing.event.ChangeListener;
68 import javax.swing.event.DocumentEvent;
69 import javax.swing.event.DocumentListener;
70 import javax.swing.event.InternalFrameEvent;
71 import javax.swing.table.DefaultTableModel;
72 import javax.swing.table.TableColumn;
75 * This class provides the swing GUI layout for FTS Panel and implements most of
76 * the contracts defined in GFSPanelI
82 @SuppressWarnings("serial")
83 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
85 protected JInternalFrame mainFrame = new JInternalFrame(
88 protected IProgressIndicator progressIndicator;
90 protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
92 protected JButton btn_ok = new JButton();
94 protected JButton btn_back = new JButton();
96 protected JButton btn_cancel = new JButton();
98 protected JTextField txt_search = new JTextField(30);
100 protected SequenceFetcher seqFetcher;
102 protected Collection<FTSDataColumnI> wantedFields;
104 private String lastSearchTerm = "";
106 protected JButton btn_next_page = new JButton();
108 protected JButton btn_prev_page = new JButton();
110 protected StringBuilder errorWarning = new StringBuilder();
112 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
113 "/images/warning.gif"));
115 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
116 "/images/loading.gif"));
118 protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
119 .getResource("/images/blank_16x16_placeholder.png"));
121 protected JLabel lbl_warning = new JLabel(warningImage);
123 protected JLabel lbl_loading = new JLabel(loadingImage);
125 protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
127 private JTabbedPane tabbedPane = new JTabbedPane();
129 private JPanel pnl_actions = new JPanel();
131 private JPanel pnl_results = new JPanel(new CardLayout());
133 private JPanel pnl_inputs = new JPanel();
135 private BorderLayout mainLayout = new BorderLayout();
137 protected Object[] previousWantedFields;
139 protected int resultSetCount;
141 protected int totalResultSetCount;
143 protected int offSet;
145 protected int pageLimit;
147 protected HashSet<String> paginatorCart = new HashSet<String>();
149 protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
151 private JTable tbl_summary = new JTable()
153 private boolean inLayout;
156 public boolean getScrollableTracksViewportWidth()
158 return hasExcessWidth();
163 public void doLayout()
165 if (hasExcessWidth())
167 autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
172 autoResizeMode = AUTO_RESIZE_OFF;
175 protected boolean hasExcessWidth()
177 return getPreferredSize().width < getParent().getWidth();
181 public void columnMarginChanged(ChangeEvent e)
187 TableColumn resizingColumn = getTableHeader().getResizingColumn();
188 // Need to do this here, before the parent's
189 // layout manager calls getPreferredSize().
190 if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
193 resizingColumn.setPreferredWidth(resizingColumn.getWidth());
194 String colHeader = resizingColumn.getHeaderValue().toString();
195 getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
201 public String getToolTipText(MouseEvent evt)
203 String toolTipText = null;
204 java.awt.Point pnt = evt.getPoint();
205 int rowIndex = rowAtPoint(pnt);
206 int colIndex = columnAtPoint(pnt);
210 if (getValueAt(rowIndex, colIndex) == null)
214 toolTipText = getValueAt(rowIndex, colIndex).toString();
216 } catch (Exception e)
220 toolTipText = (toolTipText == null ? null
221 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
222 true, toolTipText.subSequence(0, 500) + "...")
223 : JvSwingUtils.wrapTooltip(true, toolTipText)));
228 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
235 mainFrame.addFocusListener(new FocusAdapter()
238 public void focusGained(FocusEvent e)
240 txt_search.requestFocusInWindow();
243 mainFrame.invalidate();
245 } catch (Exception e)
252 * Initializes the GUI default properties
256 private void jbInit() throws Exception
258 Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
259 : getTempUserPrefs().get("FTSPanel.width");
260 Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
261 : getTempUserPrefs().get("FTSPanel.height");
262 lbl_warning.setVisible(false);
263 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
264 lbl_loading.setVisible(false);
265 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
266 lbl_blank.setVisible(true);
267 lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
269 tbl_summary.setAutoCreateRowSorter(true);
270 tbl_summary.getTableHeader().setReorderingAllowed(false);
271 tbl_summary.addMouseListener(new MouseAdapter()
274 public void mouseClicked(MouseEvent e)
280 public void mouseReleased(MouseEvent e)
285 tbl_summary.addKeyListener(new KeyAdapter()
288 public void keyPressed(KeyEvent evt)
291 switch (evt.getKeyCode())
293 case KeyEvent.VK_ESCAPE: // escape key
294 btn_back_ActionPerformed();
296 case KeyEvent.VK_ENTER: // enter key
297 if (btn_ok.isEnabled())
303 case KeyEvent.VK_TAB: // tab key
304 if (evt.isShiftDown())
306 tabbedPane.requestFocus();
310 btn_back.requestFocus();
320 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
321 btn_back.setText(MessageManager.getString("action.back"));
322 btn_back.addActionListener(new java.awt.event.ActionListener()
325 public void actionPerformed(ActionEvent e)
327 btn_back_ActionPerformed();
330 btn_back.addKeyListener(new KeyAdapter()
333 public void keyPressed(KeyEvent evt)
335 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
337 btn_back_ActionPerformed();
342 btn_ok.setEnabled(false);
343 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
344 btn_ok.setText(MessageManager.getString("action.ok"));
345 btn_ok.addActionListener(new java.awt.event.ActionListener()
348 public void actionPerformed(ActionEvent e)
353 btn_ok.addKeyListener(new KeyAdapter()
356 public void keyPressed(KeyEvent evt)
358 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
364 btn_next_page.setEnabled(false);
365 btn_next_page.setToolTipText(MessageManager
366 .getString("label.next_page_tooltip"));
367 btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
368 btn_next_page.setText(MessageManager.getString("action.next_page"));
369 btn_next_page.addActionListener(new java.awt.event.ActionListener()
372 public void actionPerformed(ActionEvent e)
377 btn_next_page.addKeyListener(new KeyAdapter()
380 public void keyPressed(KeyEvent evt)
382 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
389 btn_prev_page.setEnabled(false);
390 btn_prev_page.setToolTipText(MessageManager
391 .getString("label.prev_page_tooltip"));
392 btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
393 btn_prev_page.setText(MessageManager.getString("action.prev_page"));
394 btn_prev_page.addActionListener(new java.awt.event.ActionListener()
397 public void actionPerformed(ActionEvent e)
402 btn_prev_page.addKeyListener(new KeyAdapter()
405 public void keyPressed(KeyEvent evt)
407 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
414 if (isPaginationEnabled())
416 btn_prev_page.setVisible(true);
417 btn_next_page.setVisible(true);
421 btn_prev_page.setVisible(false);
422 btn_next_page.setVisible(false);
425 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
426 btn_cancel.setText(MessageManager.getString("action.cancel"));
427 btn_cancel.addActionListener(new java.awt.event.ActionListener()
430 public void actionPerformed(ActionEvent e)
432 btn_cancel_ActionPerformed();
435 btn_cancel.addKeyListener(new KeyAdapter()
438 public void keyPressed(KeyEvent evt)
440 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
442 btn_cancel_ActionPerformed();
446 scrl_searchResult.setPreferredSize(new Dimension(width, height));
448 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
449 cmb_searchTarget.addActionListener(new ActionListener()
452 public void actionPerformed(ActionEvent e)
455 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
458 tooltipText = MessageManager.getString("label.search_all");
460 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
461 .getSelectedItem().toString()))
463 tooltipText = MessageManager
464 .getString("label.separate_multiple_accession_ids");
468 tooltipText = MessageManager.formatMessage(
469 "label.separate_multiple_query_values",
470 new Object[] { getCmbSearchTarget().getSelectedItem()
473 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
479 populateCmbSearchTargetOptions();
481 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
483 txt_search.addKeyListener(new KeyAdapter()
486 public void keyPressed(KeyEvent e)
488 if (e.getKeyCode() == KeyEvent.VK_ENTER)
490 if (txt_search.getText() == null
491 || txt_search.getText().isEmpty())
495 String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
497 if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
498 .getSelectedItem().toString()))
500 transferToSequenceFetcher(txt_search.getText());
506 final DeferredTextInputListener listener = new DeferredTextInputListener(
511 public void actionPerformed(ActionEvent e)
513 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
516 paginatorCart.clear();
517 lastSearchTerm = getTypedText();
521 txt_search.getDocument().addDocumentListener(listener);
522 txt_search.addFocusListener(new FocusListener()
525 public void focusGained(FocusEvent e)
531 public void focusLost(FocusEvent e)
537 final String searchTabTitle = MessageManager
538 .getString("label.search_result");
539 final String configureCols = MessageManager
540 .getString("label.configure_displayed_columns");
541 ChangeListener changeListener = new ChangeListener()
544 public void stateChanged(ChangeEvent changeEvent)
546 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
548 int index = sourceTabbedPane.getSelectedIndex();
550 btn_back.setVisible(true);
551 btn_cancel.setVisible(true);
552 btn_ok.setVisible(true);
553 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
555 btn_back.setVisible(false);
556 btn_cancel.setVisible(false);
557 btn_ok.setVisible(false);
558 btn_back.setEnabled(false);
559 btn_cancel.setEnabled(false);
560 btn_ok.setEnabled(false);
561 btn_next_page.setEnabled(false);
562 btn_prev_page.setEnabled(false);
563 txt_search.setEnabled(false);
564 cmb_searchTarget.setEnabled(false);
565 previousWantedFields = getFTSRestClient()
566 .getAllDefaultDisplayedFTSDataColumns()
567 .toArray(new Object[0]);
569 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
571 btn_back.setEnabled(true);
572 btn_cancel.setEnabled(true);
573 refreshPaginatorState();
574 txt_search.setEnabled(true);
575 cmb_searchTarget.setEnabled(true);
576 if (wantedFieldsUpdated())
579 paginatorCart.clear();
588 tabbedPane.addChangeListener(changeListener);
589 tabbedPane.setPreferredSize(new Dimension(width, height));
590 tabbedPane.add(searchTabTitle, scrl_searchResult);
591 tabbedPane.add(configureCols, new FTSDataColumnPreferences(
592 PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
594 pnl_actions.add(btn_back);
595 pnl_actions.add(btn_ok);
596 pnl_actions.add(btn_cancel);
598 pnl_results.add(tabbedPane);
599 pnl_inputs.add(cmb_searchTarget);
600 pnl_inputs.add(txt_search);
601 pnl_inputs.add(lbl_loading);
602 pnl_inputs.add(lbl_warning);
603 pnl_inputs.add(lbl_blank);
604 pnl_inputs.add(btn_prev_page);
605 pnl_inputs.add(btn_next_page);
607 this.setLayout(mainLayout);
608 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
609 this.add(pnl_results, java.awt.BorderLayout.CENTER);
610 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
611 mainFrame.setVisible(true);
612 mainFrame.setContentPane(this);
613 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
615 .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
618 public void internalFrameClosing(InternalFrameEvent e)
623 mainFrame.setVisible(true);
624 mainFrame.setContentPane(this);
625 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
626 Integer x = getTempUserPrefs().get("FTSPanel.x");
627 Integer y = getTempUserPrefs().get("FTSPanel.y");
628 if (x != null && y != null)
630 mainFrame.setLocation(x, y);
632 Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
635 protected void closeAction()
637 // System.out.println(">>>>>>>>>> closing internal frame!!!");
638 // System.out.println("width : " + this.getWidth());
639 // System.out.println("heigh : " + this.getHeight());
640 // System.out.println("x : " + mainFrame.getX());
641 // System.out.println("y : " + mainFrame.getY());
642 getTempUserPrefs().put("FTSPanel.width", this.getWidth());
643 getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
644 getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
645 getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
648 public class DeferredTextInputListener implements DocumentListener
650 private final Timer swingTimer;
652 public DeferredTextInputListener(int timeOut, ActionListener listener,
655 swingTimer = new Timer(timeOut, listener);
656 swingTimer.setRepeats(repeats);
670 public void insertUpdate(DocumentEvent e)
672 swingTimer.restart();
676 public void removeUpdate(DocumentEvent e)
678 swingTimer.restart();
682 public void changedUpdate(DocumentEvent e)
684 swingTimer.restart();
689 public boolean wantedFieldsUpdated()
691 if (previousWantedFields == null)
696 return Arrays.equals(getFTSRestClient()
697 .getAllDefaultDisplayedFTSDataColumns()
698 .toArray(new Object[0]), previousWantedFields) ? false
703 public void validateSelection()
705 if (tbl_summary.getSelectedRows().length > 0
706 || !paginatorCart.isEmpty())
708 btn_ok.setEnabled(true);
712 btn_ok.setEnabled(false);
716 public JComboBox<FTSDataColumnI> getCmbSearchTarget()
718 return cmb_searchTarget;
721 public JTextField getTxtSearch()
726 public JInternalFrame getMainFrame()
731 protected void delayAndEnableActionButtons()
741 } catch (InterruptedException e)
745 btn_ok.setEnabled(true);
746 btn_back.setEnabled(true);
747 btn_cancel.setEnabled(true);
752 protected void checkForErrors()
754 lbl_warning.setVisible(false);
755 lbl_blank.setVisible(true);
756 if (errorWarning.length() > 0)
758 lbl_loading.setVisible(false);
759 lbl_blank.setVisible(false);
760 lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
761 errorWarning.toString()));
762 lbl_warning.setVisible(true);
766 protected void btn_back_ActionPerformed()
769 new SequenceFetcher(progressIndicator);
772 protected void disableActionButtons()
774 btn_ok.setEnabled(false);
775 btn_back.setEnabled(false);
776 btn_cancel.setEnabled(false);
779 protected void btn_cancel_ActionPerformed()
785 * Populates search target combo-box options
787 public void populateCmbSearchTargetOptions()
789 List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
792 Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
793 .getSearchableDataColumns();
794 searchableTargets.addAll(foundFTSTargets);
795 } catch (Exception e)
800 Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
803 public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
805 return o1.getName().compareTo(o2.getName());
809 for (FTSDataColumnI searchTarget : searchableTargets)
811 cmb_searchTarget.addItem(searchTarget);
816 public void transferToSequenceFetcher(String ids)
818 // mainFrame.dispose();
819 seqFetcher.getTextArea().setText(ids);
820 Thread worker = new Thread(seqFetcher);
825 public String getTypedText()
827 return txt_search.getText().trim();
831 public JTable getResultTable()
838 lbl_loading.setVisible(false);
839 errorWarning.setLength(0);
840 lbl_warning.setVisible(false);
841 lbl_blank.setVisible(true);
842 btn_ok.setEnabled(false);
843 mainFrame.setTitle(getFTSFrameTitle());
845 tbl_summary.setModel(new DefaultTableModel());
846 tbl_summary.setVisible(false);
850 public void setPrevPageButtonEnabled(boolean isEnabled)
852 btn_prev_page.setEnabled(isEnabled);
856 public void setNextPageButtonEnabled(boolean isEnabled)
858 btn_next_page.setEnabled(isEnabled);
862 public void setErrorMessage(String message)
864 errorWarning.append(message);
868 public void updateSearchFrameTitle(String title)
870 mainFrame.setTitle(title);
874 public void setSearchInProgress(Boolean isSearchInProgress)
876 lbl_blank.setVisible(!isSearchInProgress);
877 lbl_loading.setVisible(isSearchInProgress);
881 public void prevPageAction()
883 updatePaginatorCart();
884 if (offSet >= pageLimit)
886 offSet = offSet - pageLimit;
891 refreshPaginatorState();
896 public void nextPageAction()
898 updatePaginatorCart();
899 offSet = offSet + pageLimit;
903 public void updatePaginatorCart()
905 int primaryKeyColIndex = 0;
906 JTable resultTable = getResultTable();
907 int totalRows = resultTable.getRowCount();
910 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
911 wantedFields, false);
912 } catch (Exception e)
917 for (int row = 0; row < totalRows; row++)
919 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
920 if (paginatorCart.contains(id))
922 paginatorCart.remove(id);
925 int[] selectedRows = resultTable.getSelectedRows();
926 for (int summaryRow : selectedRows)
928 String idStr = resultTable.getValueAt(summaryRow,
929 primaryKeyColIndex).toString();
930 paginatorCart.add(idStr);
932 // System.out.println("Paginator shopping cart size : "
933 // + paginatorCart.size());
936 public void updateSummaryTableSelections()
938 JTable resultTable = getResultTable();
939 if (paginatorCart.isEmpty())
943 int primaryKeyColIndex = 0;
946 primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
947 wantedFields, false);
948 } catch (Exception e)
952 // System.out.println(">>>>>> got here : 1");
953 int totalRows = resultTable.getRowCount();
954 // resultTable.clearSelection();
955 for (int row = 0; row < totalRows; row++)
957 String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
958 if (paginatorCart.contains(id))
960 resultTable.addRowSelectionInterval(row, row);
965 public void refreshPaginatorState()
967 // System.out.println("resultSet count : " + resultSetCount);
968 // System.out.println("offSet : " + offSet);
969 // System.out.println("page limit : " + pageLimit);
970 setPrevPageButtonEnabled(false);
971 setNextPageButtonEnabled(false);
972 if (resultSetCount == 0 && pageLimit == 0)
976 if (resultSetCount >= pageLimit)
978 setNextPageButtonEnabled(true);
980 if (offSet >= pageLimit)
982 setPrevPageButtonEnabled(true);
985 public void referesh()
987 mainFrame.setTitle(getFTSFrameTitle());