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