src/jalview/jbgui/GPDBSearchPanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 package jalview.jbgui;
  23
  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;
  29
  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
  39 import javax.swing.ImageIcon;
  40 import javax.swing.JButton;
  41 import javax.swing.JComboBox;
  42 import javax.swing.JFrame;
  43 import javax.swing.JInternalFrame;
  44 import javax.swing.JLabel;
  45 import javax.swing.JPanel;
  46 import javax.swing.JScrollPane;
  47 import javax.swing.JTabbedPane;
  48 import javax.swing.JTable;
  49 import javax.swing.JTextField;
  50 import javax.swing.event.ChangeEvent;
  51 import javax.swing.event.ChangeListener;
  52 import javax.swing.event.DocumentEvent;
  53 import javax.swing.event.DocumentListener;
  54
  55 /**
  56  * GUI layout for PDB Fetch Panel
  57  *
  58  * @author tcnofoegbu
  59  *
  60  */
  61 @SuppressWarnings("serial")
  62 public abstract class GPDBSearchPanel extends JPanel
  63 {
  64   protected String frameTitle = MessageManager
  65           .getString("label.pdb_sequence_getcher");
  66
  67   protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
  68
  69   protected JComboBox<PDBDocField> cmb_searchTarget = new JComboBox<PDBDocField>();
  70
  71   protected JButton btn_ok = new JButton();
  72
  73   protected JButton btn_back = new JButton();
  74
  75   protected JButton btn_cancel = new JButton();
  76
  77   protected JTextField txt_search = new JTextField(20);
  78
  79   protected JTable tbl_summary = new JTable();
  80
  81   protected StringBuilder errorWarning = new StringBuilder();
  82
  83   protected JScrollPane scrl_searchResult = new JScrollPane(
  84 tbl_summary);
  85
  86   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
  87           "/images/warning.gif"));
  88
  89   protected JLabel lbl_warning = new JLabel(warningImage);
  90
  91   private JTabbedPane tabbedPane = new JTabbedPane();
  92
  93   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
  94           PreferenceSource.SEARCH_SUMMARY);
  95
  96   private JPanel pnl_actions = new JPanel();
  97
  98   private JPanel pnl_results = new JPanel();
  99
 100   private JPanel pnl_inputs = new JPanel();
 101
 102   private BorderLayout mainLayout = new BorderLayout();
 103
 104   public GPDBSearchPanel()
 105   {
 106     try
 107     {
 108       jbInit();
 109       mainFrame.invalidate();
 110       mainFrame.pack();
 111     } catch (Exception e)
 112     {
 113       e.printStackTrace();
 114     }
 115   }
 116
 117   /**
 118    * Initializes the GUI default properties
 119    *
 120    * @throws Exception
 121    */
 122   private void jbInit() throws Exception
 123   {
 124     lbl_warning.setVisible(false);
 125     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 126
 127     tbl_summary.setAutoCreateRowSorter(true);
 128     tbl_summary.addMouseListener(new MouseAdapter()
 129     {
 130       public void mouseClicked(MouseEvent e)
 131       {
 132         validateSelection();
 133       }
 134       public void mouseReleased(MouseEvent e)
 135       {
 136         validateSelection();
 137       }
 138     });
 139
 140     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 141     btn_back.setText(MessageManager.getString("action.back"));
 142     btn_back.addActionListener(new java.awt.event.ActionListener()
 143     {
 144       public void actionPerformed(ActionEvent e)
 145       {
 146         btn_back_ActionPerformed();
 147       }
 148     });
 149
 150     btn_ok.setEnabled(false);
 151     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 152     btn_ok.setText(MessageManager.getString("action.ok"));
 153     btn_ok.addActionListener(new java.awt.event.ActionListener()
 154     {
 155       public void actionPerformed(ActionEvent e)
 156       {
 157         btn_ok_ActionPerformed();
 158       }
 159     });
 160     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 161     btn_cancel.setText(MessageManager.getString("action.cancel"));
 162     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 163     {
 164       public void actionPerformed(ActionEvent e)
 165       {
 166         btn_cancel_ActionPerformed();
 167       }
 168     });
 169
 170
 171     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
 172     scrl_searchResult
 173             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 174
 175     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 176     cmb_searchTarget.addActionListener(new ActionListener()
 177     {
 178       @Override
 179       public void actionPerformed(ActionEvent e)
 180       {
 181         String tooltipText;
 182         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
 183                 .toString()))
 184         {
 185           tooltipText = MessageManager.getString("label.search_all");
 186         }
 187         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 188                 .getSelectedItem().toString()))
 189         {
 190           tooltipText = MessageManager
 191                   .getString("label.separate_multiple_accession_ids");
 192         }
 193         else
 194         {
 195           tooltipText = MessageManager.formatMessage(
 196                   "label.separate_multiple_query_values", new Object[]
 197                   { getCmbSearchTarget().getSelectedItem().toString() });
 198         }
 199         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 200                 tooltipText));
 201         txt_search_ActionPerformed();
 202       }
 203     });
 204
 205     populateCmbSearchTargetOptions();
 206
 207
 208     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 209
 210     txt_search.addKeyListener(new KeyAdapter()
 211     {
 212       @Override
 213       public void keyPressed(KeyEvent e)
 214       {
 215         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 216         {
 217           if (txt_search.getText() == null
 218                   || txt_search.getText().isEmpty())
 219           {
 220             return;
 221           }
 222           if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 223                   .getSelectedItem().toString()))
 224           {
 225             transferToSequenceFetcher(txt_search.getText());
 226           }
 227         }
 228       }
 229     });
 230
 231     txt_search.getDocument().addDocumentListener(new DocumentListener()
 232     {
 233       @Override
 234       public void insertUpdate(DocumentEvent e)
 235       {
 236         txt_search_ActionPerformed();
 237       }
 238
 239       @Override
 240       public void removeUpdate(DocumentEvent e)
 241       {
 242         txt_search_ActionPerformed();
 243       }
 244
 245       @Override
 246       public void changedUpdate(DocumentEvent e)
 247       {
 248         txt_search_ActionPerformed();
 249       }
 250     });
 251
 252     final String searchTabTitle = MessageManager
 253             .getString("label.search_result");
 254     ChangeListener changeListener = new ChangeListener()
 255     {
 256       public void stateChanged(ChangeEvent changeEvent)
 257       {
 258         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 259                 .getSource();
 260         int index = sourceTabbedPane.getSelectedIndex();
 261         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 262         {
 263           txt_search_ActionPerformed();
 264         }
 265       }
 266     };
 267     tabbedPane.addChangeListener(changeListener);
 268     tabbedPane.setPreferredSize(new Dimension(500, 300));
 269     tabbedPane.add(searchTabTitle, scrl_searchResult);
 270     tabbedPane.add(
 271             MessageManager.getString("label.configure_displayed_columns"),
 272             pdbDocFieldPrefs);
 273
 274     pnl_actions.add(btn_back);
 275     pnl_actions.add(btn_ok);
 276     pnl_actions.add(btn_cancel);
 277
 278     pnl_results.add(tabbedPane);
 279     pnl_inputs.add(cmb_searchTarget);
 280     pnl_inputs.add(txt_search);
 281     pnl_inputs.add(lbl_warning);
 282
 283     this.setLayout(mainLayout);
 284     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 285     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 286     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 287     mainFrame.setVisible(true);
 288     mainFrame.setContentPane(this);
 289     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 290     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 291   }
 292
 293   public void validateSelection()
 294   {
 295     if (tbl_summary.getSelectedRows().length > 0)
 296     {
 297       btn_ok.setEnabled(true);
 298     }
 299     else
 300     {
 301       btn_ok.setEnabled(false);
 302     }
 303   }
 304   public JComboBox<PDBDocField> getCmbSearchTarget()
 305   {
 306     return cmb_searchTarget;
 307   }
 308
 309   public JTextField getTxtSearch()
 310   {
 311     return txt_search;
 312   }
 313
 314   public JInternalFrame getMainFrame()
 315   {
 316     return mainFrame;
 317   }
 318
 319   public abstract void transferToSequenceFetcher(String ids);
 320
 321   public abstract void txt_search_ActionPerformed();
 322
 323   public abstract void btn_ok_ActionPerformed();
 324
 325   public abstract void btn_back_ActionPerformed();
 326
 327   public abstract void btn_cancel_ActionPerformed();
 328
 329   public abstract void populateCmbSearchTargetOptions();
 330
 331 }