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