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