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.Dimension;
32 import java.awt.event.ActionEvent;
33 import java.awt.event.ActionListener;
34 import java.awt.event.KeyAdapter;
35 import java.awt.event.KeyEvent;
36 import java.awt.event.MouseAdapter;
37 import java.awt.event.MouseEvent;
38 import java.util.Arrays;
40 import javax.swing.ImageIcon;
41 import javax.swing.JButton;
42 import javax.swing.JComboBox;
43 import javax.swing.JFrame;
44 import javax.swing.JInternalFrame;
45 import javax.swing.JLabel;
46 import javax.swing.JPanel;
47 import javax.swing.JScrollPane;
48 import javax.swing.JTabbedPane;
49 import javax.swing.JTable;
50 import javax.swing.JTextField;
51 import javax.swing.event.ChangeEvent;
52 import javax.swing.event.ChangeListener;
53 import javax.swing.event.DocumentEvent;
54 import javax.swing.event.DocumentListener;
57 * GUI layout for PDB Fetch Panel
62 @SuppressWarnings("serial")
63 public abstract class GPDBSearchPanel extends JPanel
65 protected String frameTitle = MessageManager
66 .getString("label.pdb_sequence_getcher");
68 protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
70 protected JComboBox<PDBDocField> cmb_searchTarget = new JComboBox<PDBDocField>();
72 protected JButton btn_ok = new JButton();
74 protected JButton btn_back = new JButton();
76 protected JButton btn_cancel = new JButton();
78 protected JTextField txt_search = new JTextField(20);
80 protected JTable tbl_summary = new JTable()
82 public String getToolTipText(MouseEvent evt)
84 String toolTipText = null;
85 java.awt.Point pnt = evt.getPoint();
86 int rowIndex = rowAtPoint(pnt);
87 int colIndex = columnAtPoint(pnt);
91 toolTipText = getValueAt(rowIndex, colIndex).toString();
96 toolTipText = (toolTipText == null ? null
97 : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
98 true, toolTipText.subSequence(0, 500) + "...")
99 : JvSwingUtils.wrapTooltip(true, toolTipText)));
105 protected StringBuilder errorWarning = new StringBuilder();
107 protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
109 protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
110 "/images/warning.gif"));
112 protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
113 "/images/loading.gif"));
115 protected JLabel lbl_warning = new JLabel(warningImage);
117 protected JLabel lbl_loading = new JLabel(loadingImage);
119 private JTabbedPane tabbedPane = new JTabbedPane();
121 private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
122 PreferenceSource.SEARCH_SUMMARY);
124 private JPanel pnl_actions = new JPanel();
126 private JPanel pnl_results = new JPanel();
128 private JPanel pnl_inputs = new JPanel();
130 private BorderLayout mainLayout = new BorderLayout();
132 protected PDBDocField[] previousWantedFields;
134 public GPDBSearchPanel()
139 mainFrame.invalidate();
141 } catch (Exception e)
148 * Initializes the GUI default properties
152 private void jbInit() throws Exception
154 lbl_warning.setVisible(false);
155 lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
156 lbl_loading.setVisible(false);
157 lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
159 tbl_summary.setAutoCreateRowSorter(true);
160 tbl_summary.getTableHeader().setReorderingAllowed(false);
161 tbl_summary.addMouseListener(new MouseAdapter()
163 public void mouseClicked(MouseEvent e)
168 public void mouseReleased(MouseEvent e)
174 btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
175 btn_back.setText(MessageManager.getString("action.back"));
176 btn_back.addActionListener(new java.awt.event.ActionListener()
178 public void actionPerformed(ActionEvent e)
180 btn_back_ActionPerformed();
184 btn_ok.setEnabled(false);
185 btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
186 btn_ok.setText(MessageManager.getString("action.ok"));
187 btn_ok.addActionListener(new java.awt.event.ActionListener()
189 public void actionPerformed(ActionEvent e)
191 btn_ok_ActionPerformed();
194 btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
195 btn_cancel.setText(MessageManager.getString("action.cancel"));
196 btn_cancel.addActionListener(new java.awt.event.ActionListener()
198 public void actionPerformed(ActionEvent e)
200 btn_cancel_ActionPerformed();
204 scrl_searchResult.setPreferredSize(new Dimension(500, 300));
206 .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
208 cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
209 cmb_searchTarget.addActionListener(new ActionListener()
212 public void actionPerformed(ActionEvent e)
215 if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
218 tooltipText = MessageManager.getString("label.search_all");
220 else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
221 .getSelectedItem().toString()))
223 tooltipText = MessageManager
224 .getString("label.separate_multiple_accession_ids");
228 tooltipText = MessageManager.formatMessage(
229 "label.separate_multiple_query_values",
230 new Object[] { getCmbSearchTarget().getSelectedItem()
233 txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
235 txt_search_ActionPerformed();
239 populateCmbSearchTargetOptions();
241 txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
243 txt_search.addKeyListener(new KeyAdapter()
246 public void keyPressed(KeyEvent e)
248 if (e.getKeyCode() == KeyEvent.VK_ENTER)
250 if (txt_search.getText() == null
251 || txt_search.getText().isEmpty())
255 if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
256 .getSelectedItem().toString()))
258 transferToSequenceFetcher(txt_search.getText());
264 txt_search.getDocument().addDocumentListener(new DocumentListener()
267 public void insertUpdate(DocumentEvent e)
269 txt_search_ActionPerformed();
273 public void removeUpdate(DocumentEvent e)
275 txt_search_ActionPerformed();
279 public void changedUpdate(DocumentEvent e)
281 txt_search_ActionPerformed();
285 final String searchTabTitle = MessageManager
286 .getString("label.search_result");
287 final String configureCols = MessageManager
288 .getString("label.configure_displayed_columns");
289 ChangeListener changeListener = new ChangeListener()
291 public void stateChanged(ChangeEvent changeEvent)
293 JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
295 int index = sourceTabbedPane.getSelectedIndex();
296 if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
298 btn_back.setEnabled(false);
299 btn_cancel.setEnabled(false);
300 btn_ok.setEnabled(false);
301 previousWantedFields = PDBDocFieldPreferences
302 .getSearchSummaryFields().toArray(new PDBDocField[0]);
304 if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
306 btn_back.setEnabled(true);
307 btn_cancel.setEnabled(true);
308 if (wantedFieldsUpdated())
310 txt_search_ActionPerformed();
319 tabbedPane.addChangeListener(changeListener);
320 tabbedPane.setPreferredSize(new Dimension(500, 300));
321 tabbedPane.add(searchTabTitle, scrl_searchResult);
322 tabbedPane.add(configureCols, pdbDocFieldPrefs);
324 pnl_actions.add(btn_back);
325 pnl_actions.add(btn_ok);
326 pnl_actions.add(btn_cancel);
328 pnl_results.add(tabbedPane);
329 pnl_inputs.add(cmb_searchTarget);
330 pnl_inputs.add(txt_search);
331 pnl_inputs.add(lbl_loading);
332 pnl_inputs.add(lbl_warning);
334 this.setLayout(mainLayout);
335 this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
336 this.add(pnl_results, java.awt.BorderLayout.CENTER);
337 this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
338 mainFrame.setVisible(true);
339 mainFrame.setContentPane(this);
340 mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
341 Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
344 public boolean wantedFieldsUpdated()
346 if (previousWantedFields == null)
351 return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
352 .toArray(new PDBDocField[0]), previousWantedFields) ? false
357 public void validateSelection()
359 if (tbl_summary.getSelectedRows().length > 0)
361 btn_ok.setEnabled(true);
365 btn_ok.setEnabled(false);
369 public JComboBox<PDBDocField> getCmbSearchTarget()
371 return cmb_searchTarget;
374 public JTextField getTxtSearch()
379 public JInternalFrame getMainFrame()
384 public abstract void transferToSequenceFetcher(String ids);
386 public abstract void txt_search_ActionPerformed();
388 public abstract void btn_ok_ActionPerformed();
390 public abstract void btn_back_ActionPerformed();
392 public abstract void btn_cancel_ActionPerformed();
394 public abstract void populateCmbSearchTargetOptions();