2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 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.jbgui;
24 import jalview.gui.Desktop;
25 import jalview.gui.JvSwingUtils;
26 import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
27 import jalview.util.MessageManager;
28 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
30 import java.awt.BorderLayout;
31 import java.awt.CardLayout;
32 import java.awt.Dimension;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.KeyAdapter;
36 import java.awt.event.KeyEvent;
37 import java.awt.event.MouseAdapter;
38 import java.awt.event.MouseEvent;
39 import java.util.Arrays;
41 import javax.swing.ImageIcon;
42 import javax.swing.JButton;
43 import javax.swing.JComboBox;
44 import javax.swing.JFrame;
45 import javax.swing.JInternalFrame;
46 import javax.swing.JLabel;
47 import javax.swing.JPanel;
48 import javax.swing.JScrollPane;
49 import javax.swing.JTabbedPane;
50 import javax.swing.JTable;
51 import javax.swing.JTextField;
52 import javax.swing.event.ChangeEvent;
53 import javax.swing.event.ChangeListener;
54 import javax.swing.event.DocumentEvent;
55 import javax.swing.event.DocumentListener;
58 * GUI layout for PDB Fetch Panel
63 @SuppressWarnings("serial")
64 public abstract class GPDBSearchPanel extends JPanel
66 protected String frameTitle = MessageManager
67 .getString("label.pdb_sequence_getcher");
69 protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
71 protected JComboBox<PDBDocField> cmb_searchTarget = new JComboBox<PDBDocField>();
73 protected JButton btn_ok = new JButton();
75 protected JButton btn_back = new JButton();
77 protected JButton btn_cancel = new JButton();
79 protected JTextField txt_search = new JTextField(20);
81 protected JTable tbl_summary = new JTable()
84 public String getToolTipText(MouseEvent evt)
86 String toolTipText = null;
87 java.awt.Point pnt = evt.getPoint();
88 int rowIndex = rowAtPoint(pnt);
89 int colIndex = columnAtPoint(pnt);
93 if (getValueAt(rowIndex, colIndex) == null)
97 toolTipText = getValueAt(rowIndex, colIndex).toString();
103 toolTipText = (toolTipText == null ? null
104 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
105 true, toolTipText.subSequence(0, 500) + "...")
106 : JvSwingUtils.wrapTooltip(true, toolTipText)));
112 protected StringBuilder errorWarning = new StringBuilder();
114 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
116 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
117 "/images/warning.gif"));
119 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
120 "/images/loading.gif"));
122 protected JLabel lbl_warning = new JLabel(warningImage);
124 protected JLabel lbl_loading = new JLabel(loadingImage);
126 private JTabbedPane tabbedPane = new JTabbedPane();
128 private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
129 PreferenceSource.SEARCH_SUMMARY);
131 private JPanel pnl_actions = new JPanel();
133 private JPanel pnl_results = new JPanel(new CardLayout());
135 private JPanel pnl_inputs = new JPanel();
137 private BorderLayout mainLayout = new BorderLayout();
139 protected PDBDocField[] previousWantedFields;
141 public GPDBSearchPanel()
146 mainFrame.invalidate();
148 } catch (Exception e)
155 * Initializes the GUI default properties
159 private void jbInit() throws Exception
161 lbl_warning.setVisible(false);
162 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
163 lbl_loading.setVisible(false);
164 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
166 tbl_summary.setAutoResizeMode(JTable.AUTO_RESIZE_ALL_COLUMNS);
167 tbl_summary.setAutoCreateRowSorter(true);
168 tbl_summary.getTableHeader().setReorderingAllowed(false);
169 tbl_summary.addMouseListener(new MouseAdapter()
172 public void mouseClicked(MouseEvent e)
178 public void mouseReleased(MouseEvent e)
183 tbl_summary.addKeyListener(new KeyAdapter()
186 public void keyPressed(KeyEvent evt)
189 switch (evt.getKeyCode())
191 case KeyEvent.VK_ESCAPE: // escape key
192 btn_back_ActionPerformed();
194 case KeyEvent.VK_ENTER: // enter key
195 if (btn_ok.isEnabled())
197 btn_ok_ActionPerformed();
201 case KeyEvent.VK_TAB: // tab key
202 if (evt.isShiftDown())
204 tabbedPane.requestFocus();
208 btn_back.requestFocus();
218 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
219 btn_back.setText(MessageManager.getString("action.back"));
220 btn_back.addActionListener(new java.awt.event.ActionListener()
223 public void actionPerformed(ActionEvent e)
225 btn_back_ActionPerformed();
228 btn_back.addKeyListener(new KeyAdapter()
231 public void keyPressed(KeyEvent evt)
233 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
235 btn_back_ActionPerformed();
240 btn_ok.setEnabled(false);
241 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
242 btn_ok.setText(MessageManager.getString("action.ok"));
243 btn_ok.addActionListener(new java.awt.event.ActionListener()
246 public void actionPerformed(ActionEvent e)
248 btn_ok_ActionPerformed();
251 btn_ok.addKeyListener(new KeyAdapter()
254 public void keyPressed(KeyEvent evt)
256 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
258 btn_ok_ActionPerformed();
263 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
264 btn_cancel.setText(MessageManager.getString("action.cancel"));
265 btn_cancel.addActionListener(new java.awt.event.ActionListener()
268 public void actionPerformed(ActionEvent e)
270 btn_cancel_ActionPerformed();
273 btn_cancel.addKeyListener(new KeyAdapter()
276 public void keyPressed(KeyEvent evt)
278 if (evt.getKeyCode() == KeyEvent.VK_ENTER)
280 btn_cancel_ActionPerformed();
285 scrl_searchResult.setPreferredSize(new Dimension(500, 300));
287 .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
289 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
290 cmb_searchTarget.addActionListener(new ActionListener()
293 public void actionPerformed(ActionEvent e)
296 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
299 tooltipText = MessageManager.getString("label.search_all");
301 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
302 .getSelectedItem().toString()))
304 tooltipText = MessageManager
305 .getString("label.separate_multiple_accession_ids");
309 tooltipText = MessageManager.formatMessage(
310 "label.separate_multiple_query_values",
311 new Object[] { getCmbSearchTarget().getSelectedItem()
314 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
316 txt_search_ActionPerformed();
320 populateCmbSearchTargetOptions();
322 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
324 txt_search.addKeyListener(new KeyAdapter()
327 public void keyPressed(KeyEvent e)
329 if (e.getKeyCode() == KeyEvent.VK_ENTER)
331 if (txt_search.getText() == null
332 || txt_search.getText().isEmpty())
336 if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
337 .getSelectedItem().toString()))
339 transferToSequenceFetcher(txt_search.getText());
345 txt_search.getDocument().addDocumentListener(new DocumentListener()
348 public void insertUpdate(DocumentEvent e)
350 txt_search_ActionPerformed();
354 public void removeUpdate(DocumentEvent e)
356 txt_search_ActionPerformed();
360 public void changedUpdate(DocumentEvent e)
362 txt_search_ActionPerformed();
366 final String searchTabTitle = MessageManager
367 .getString("label.search_result");
368 final String configureCols = MessageManager
369 .getString("label.configure_displayed_columns");
370 ChangeListener changeListener = new ChangeListener()
373 public void stateChanged(ChangeEvent changeEvent)
375 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
377 int index = sourceTabbedPane.getSelectedIndex();
379 btn_back.setVisible(true);
380 btn_cancel.setVisible(true);
381 btn_ok.setVisible(true);
382 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
384 btn_back.setVisible(false);
385 btn_cancel.setVisible(false);
386 btn_ok.setVisible(false);
387 btn_back.setEnabled(false);
388 btn_cancel.setEnabled(false);
389 btn_ok.setEnabled(false);
390 previousWantedFields = PDBDocFieldPreferences
391 .getSearchSummaryFields().toArray(new PDBDocField[0]);
393 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
395 btn_back.setEnabled(true);
396 btn_cancel.setEnabled(true);
397 if (wantedFieldsUpdated())
399 txt_search_ActionPerformed();
408 tabbedPane.addChangeListener(changeListener);
409 tabbedPane.setPreferredSize(new Dimension(500, 300));
410 tabbedPane.add(searchTabTitle, scrl_searchResult);
411 tabbedPane.add(configureCols, pdbDocFieldPrefs);
413 pnl_actions.add(btn_back);
414 pnl_actions.add(btn_ok);
415 pnl_actions.add(btn_cancel);
417 pnl_results.add(tabbedPane);
418 pnl_inputs.add(cmb_searchTarget);
419 pnl_inputs.add(txt_search);
420 pnl_inputs.add(lbl_loading);
421 pnl_inputs.add(lbl_warning);
423 this.setLayout(mainLayout);
424 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
425 this.add(pnl_results, java.awt.BorderLayout.CENTER);
426 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
427 mainFrame.setVisible(true);
428 mainFrame.setContentPane(this);
429 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
430 Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
433 public boolean wantedFieldsUpdated()
435 if (previousWantedFields == null)
440 return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
441 .toArray(new PDBDocField[0]), previousWantedFields) ? false
446 public void validateSelection()
448 if (tbl_summary.getSelectedRows().length > 0)
450 btn_ok.setEnabled(true);
454 btn_ok.setEnabled(false);
458 public JComboBox<PDBDocField> getCmbSearchTarget()
460 return cmb_searchTarget;
463 public JTextField getTxtSearch()
468 public JInternalFrame getMainFrame()
473 public abstract void transferToSequenceFetcher(String ids);
475 public abstract void txt_search_ActionPerformed();
477 public abstract void btn_ok_ActionPerformed();
479 public abstract void btn_back_ActionPerformed();
481 public abstract void btn_cancel_ActionPerformed();
483 public abstract void populateCmbSearchTargetOptions();