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