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, toolTipText)));
 100
 101       return toolTipText;
 102     }
 103   };
 104
 105   protected StringBuilder errorWarning = new StringBuilder();
 106
 107   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 108
 109   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
 110           "/images/warning.gif"));
 111
 112   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
 113           "/images/loading.gif"));
 114
 115   protected JLabel lbl_warning = new JLabel(warningImage);
 116
 117   protected JLabel lbl_loading = new JLabel(loadingImage);
 118
 119   private JTabbedPane tabbedPane = new JTabbedPane();
 120
 121   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
 122           PreferenceSource.SEARCH_SUMMARY);
 123
 124   private JPanel pnl_actions = new JPanel();
 125
 126   private JPanel pnl_results = new JPanel();
 127
 128   private JPanel pnl_inputs = new JPanel();
 129
 130   private BorderLayout mainLayout = new BorderLayout();
 131
 132   protected PDBDocField[] previousWantedFields;
 133
 134   public GPDBSearchPanel()
 135   {
 136     try
 137     {
 138       jbInit();
 139       mainFrame.invalidate();
 140       mainFrame.pack();
 141     } catch (Exception e)
 142     {
 143       e.printStackTrace();
 144     }
 145   }
 146
 147   /**
 148    * Initializes the GUI default properties
 149    *
 150    * @throws Exception
 151    */
 152   private void jbInit() throws Exception
 153   {
 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));
 158
 159     tbl_summary.setAutoCreateRowSorter(true);
 160     tbl_summary.getTableHeader().setReorderingAllowed(false);
 161     tbl_summary.addMouseListener(new MouseAdapter()
 162     {
 163       public void mouseClicked(MouseEvent e)
 164       {
 165         validateSelection();
 166       }
 167
 168       public void mouseReleased(MouseEvent e)
 169       {
 170         validateSelection();
 171       }
 172     });
 173     tbl_summary.addKeyListener(new KeyAdapter()
 174     {
 175       @Override
 176       public void keyPressed(KeyEvent evt)
 177       {
 178         validateSelection();
 179         switch (evt.getKeyCode())
 180         {
 181         case KeyEvent.VK_ESCAPE: // escape key
 182           btn_back_ActionPerformed();
 183           break;
 184         case KeyEvent.VK_ENTER: // enter key
 185           if (btn_ok.isEnabled())
 186           {
 187             btn_ok_ActionPerformed();
 188           }
 189           evt.consume();
 190           break;
 191         case KeyEvent.VK_TAB: // tab key
 192           if (evt.isShiftDown())
 193           {
 194             txt_search.requestFocus();
 195           }
 196           else
 197           {
 198             btn_back.requestFocus();
 199           }
 200           break;
 201         default:
 202           return;
 203         }
 204       }
 205     });
 206
 207     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 208     btn_back.setText(MessageManager.getString("action.back"));
 209     btn_back.addActionListener(new java.awt.event.ActionListener()
 210     {
 211       public void actionPerformed(ActionEvent e)
 212       {
 213         btn_back_ActionPerformed();
 214       }
 215     });
 216     btn_back.addKeyListener(new KeyAdapter()
 217     {
 218       @Override
 219       public void keyPressed(KeyEvent evt)
 220       {
 221         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 222         {
 223           btn_back_ActionPerformed();
 224         }
 225       }
 226     });
 227
 228     btn_ok.setEnabled(false);
 229     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 230     btn_ok.setText(MessageManager.getString("action.ok"));
 231     btn_ok.addActionListener(new java.awt.event.ActionListener()
 232     {
 233       public void actionPerformed(ActionEvent e)
 234       {
 235         btn_ok_ActionPerformed();
 236       }
 237     });
 238     btn_ok.addKeyListener(new KeyAdapter()
 239     {
 240       @Override
 241       public void keyPressed(KeyEvent evt)
 242       {
 243         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 244         {
 245           btn_ok_ActionPerformed();
 246         }
 247       }
 248     });
 249
 250     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 251     btn_cancel.setText(MessageManager.getString("action.cancel"));
 252     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 253     {
 254       public void actionPerformed(ActionEvent e)
 255       {
 256         btn_cancel_ActionPerformed();
 257       }
 258     });
 259     btn_cancel.addKeyListener(new KeyAdapter()
 260     {
 261       @Override
 262       public void keyPressed(KeyEvent evt)
 263       {
 264         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 265         {
 266           btn_cancel_ActionPerformed();
 267         }
 268       }
 269     });
 270
 271     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
 272     scrl_searchResult
 273             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 274
 275     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 276     cmb_searchTarget.addActionListener(new ActionListener()
 277     {
 278       @Override
 279       public void actionPerformed(ActionEvent e)
 280       {
 281         String tooltipText;
 282         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
 283                 .toString()))
 284         {
 285           tooltipText = MessageManager.getString("label.search_all");
 286         }
 287         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 288                 .getSelectedItem().toString()))
 289         {
 290           tooltipText = MessageManager
 291                   .getString("label.separate_multiple_accession_ids");
 292         }
 293         else
 294         {
 295           tooltipText = MessageManager.formatMessage(
 296                   "label.separate_multiple_query_values",
 297                   new Object[] { getCmbSearchTarget().getSelectedItem()
 298                           .toString() });
 299         }
 300         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 301                 tooltipText));
 302         txt_search_ActionPerformed();
 303       }
 304     });
 305
 306     populateCmbSearchTargetOptions();
 307
 308     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 309
 310     txt_search.addKeyListener(new KeyAdapter()
 311     {
 312       @Override
 313       public void keyPressed(KeyEvent e)
 314       {
 315         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 316         {
 317           if (txt_search.getText() == null
 318                   || txt_search.getText().isEmpty())
 319           {
 320             return;
 321           }
 322           if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 323                   .getSelectedItem().toString()))
 324           {
 325             transferToSequenceFetcher(txt_search.getText());
 326           }
 327         }
 328       }
 329     });
 330
 331     txt_search.getDocument().addDocumentListener(new DocumentListener()
 332     {
 333       @Override
 334       public void insertUpdate(DocumentEvent e)
 335       {
 336         txt_search_ActionPerformed();
 337       }
 338
 339       @Override
 340       public void removeUpdate(DocumentEvent e)
 341       {
 342         txt_search_ActionPerformed();
 343       }
 344
 345       @Override
 346       public void changedUpdate(DocumentEvent e)
 347       {
 348         txt_search_ActionPerformed();
 349       }
 350     });
 351
 352     final String searchTabTitle = MessageManager
 353             .getString("label.search_result");
 354     final String configureCols = MessageManager
 355             .getString("label.configure_displayed_columns");
 356     ChangeListener changeListener = new ChangeListener()
 357     {
 358       public void stateChanged(ChangeEvent changeEvent)
 359       {
 360         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 361                 .getSource();
 362         int index = sourceTabbedPane.getSelectedIndex();
 363         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 364         {
 365           btn_back.setEnabled(false);
 366           btn_cancel.setEnabled(false);
 367           btn_ok.setEnabled(false);
 368           previousWantedFields = PDBDocFieldPreferences
 369                   .getSearchSummaryFields().toArray(new PDBDocField[0]);
 370         }
 371         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 372         {
 373           btn_back.setEnabled(true);
 374           btn_cancel.setEnabled(true);
 375           if (wantedFieldsUpdated())
 376           {
 377             txt_search_ActionPerformed();
 378           }
 379           else
 380           {
 381             validateSelection();
 382           }
 383         }
 384       }
 385     };
 386     tabbedPane.addChangeListener(changeListener);
 387     tabbedPane.setPreferredSize(new Dimension(500, 300));
 388     tabbedPane.add(searchTabTitle, scrl_searchResult);
 389     tabbedPane.add(configureCols, pdbDocFieldPrefs);
 390
 391     pnl_actions.add(btn_back);
 392     pnl_actions.add(btn_ok);
 393     pnl_actions.add(btn_cancel);
 394
 395     pnl_results.add(tabbedPane);
 396     pnl_inputs.add(cmb_searchTarget);
 397     pnl_inputs.add(txt_search);
 398     pnl_inputs.add(lbl_loading);
 399     pnl_inputs.add(lbl_warning);
 400
 401     this.setLayout(mainLayout);
 402     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 403     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 404     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 405     mainFrame.setVisible(true);
 406     mainFrame.setContentPane(this);
 407     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 408     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 409   }
 410
 411   public boolean wantedFieldsUpdated()
 412   {
 413     if (previousWantedFields == null)
 414     {
 415       return true;
 416     }
 417
 418     return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
 419             .toArray(new PDBDocField[0]), previousWantedFields) ? false
 420             : true;
 421
 422   }
 423
 424   public void validateSelection()
 425   {
 426     if (tbl_summary.getSelectedRows().length > 0)
 427     {
 428       btn_ok.setEnabled(true);
 429     }
 430     else
 431     {
 432       btn_ok.setEnabled(false);
 433     }
 434   }
 435
 436   public JComboBox<PDBDocField> getCmbSearchTarget()
 437   {
 438     return cmb_searchTarget;
 439   }
 440
 441   public JTextField getTxtSearch()
 442   {
 443     return txt_search;
 444   }
 445
 446   public JInternalFrame getMainFrame()
 447   {
 448     return mainFrame;
 449   }
 450
 451   public abstract void transferToSequenceFetcher(String ids);
 452
 453   public abstract void txt_search_ActionPerformed();
 454
 455   public abstract void btn_ok_ActionPerformed();
 456
 457   public abstract void btn_back_ActionPerformed();
 458
 459   public abstract void btn_cancel_ActionPerformed();
 460
 461   public abstract void populateCmbSearchTargetOptions();
 462
 463 }