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             tabbedPane.requestFocus();
 195           }
 196           else
 197           {
 198             btn_back.requestFocus();
 199           }
 200           evt.consume();
 201           break;
 202         default:
 203           return;
 204         }
 205       }
 206     });
 207
 208     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 209     btn_back.setText(MessageManager.getString("action.back"));
 210     btn_back.addActionListener(new java.awt.event.ActionListener()
 211     {
 212       public void actionPerformed(ActionEvent e)
 213       {
 214         btn_back_ActionPerformed();
 215       }
 216     });
 217     btn_back.addKeyListener(new KeyAdapter()
 218     {
 219       @Override
 220       public void keyPressed(KeyEvent evt)
 221       {
 222         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 223         {
 224           btn_back_ActionPerformed();
 225         }
 226       }
 227     });
 228
 229     btn_ok.setEnabled(false);
 230     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 231     btn_ok.setText(MessageManager.getString("action.ok"));
 232     btn_ok.addActionListener(new java.awt.event.ActionListener()
 233     {
 234       public void actionPerformed(ActionEvent e)
 235       {
 236         btn_ok_ActionPerformed();
 237       }
 238     });
 239     btn_ok.addKeyListener(new KeyAdapter()
 240     {
 241       @Override
 242       public void keyPressed(KeyEvent evt)
 243       {
 244         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 245         {
 246           btn_ok_ActionPerformed();
 247         }
 248       }
 249     });
 250
 251     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 252     btn_cancel.setText(MessageManager.getString("action.cancel"));
 253     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 254     {
 255       public void actionPerformed(ActionEvent e)
 256       {
 257         btn_cancel_ActionPerformed();
 258       }
 259     });
 260     btn_cancel.addKeyListener(new KeyAdapter()
 261     {
 262       @Override
 263       public void keyPressed(KeyEvent evt)
 264       {
 265         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 266         {
 267           btn_cancel_ActionPerformed();
 268         }
 269       }
 270     });
 271
 272     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
 273     scrl_searchResult
 274             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 275
 276     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 277     cmb_searchTarget.addActionListener(new ActionListener()
 278     {
 279       @Override
 280       public void actionPerformed(ActionEvent e)
 281       {
 282         String tooltipText;
 283         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
 284                 .toString()))
 285         {
 286           tooltipText = MessageManager.getString("label.search_all");
 287         }
 288         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 289                 .getSelectedItem().toString()))
 290         {
 291           tooltipText = MessageManager
 292                   .getString("label.separate_multiple_accession_ids");
 293         }
 294         else
 295         {
 296           tooltipText = MessageManager.formatMessage(
 297                   "label.separate_multiple_query_values",
 298                   new Object[] { getCmbSearchTarget().getSelectedItem()
 299                           .toString() });
 300         }
 301         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 302                 tooltipText));
 303         txt_search_ActionPerformed();
 304       }
 305     });
 306
 307     populateCmbSearchTargetOptions();
 308
 309     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 310
 311     txt_search.addKeyListener(new KeyAdapter()
 312     {
 313       @Override
 314       public void keyPressed(KeyEvent e)
 315       {
 316         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 317         {
 318           if (txt_search.getText() == null
 319                   || txt_search.getText().isEmpty())
 320           {
 321             return;
 322           }
 323           if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 324                   .getSelectedItem().toString()))
 325           {
 326             transferToSequenceFetcher(txt_search.getText());
 327           }
 328         }
 329       }
 330     });
 331
 332     txt_search.getDocument().addDocumentListener(new DocumentListener()
 333     {
 334       @Override
 335       public void insertUpdate(DocumentEvent e)
 336       {
 337         txt_search_ActionPerformed();
 338       }
 339
 340       @Override
 341       public void removeUpdate(DocumentEvent e)
 342       {
 343         txt_search_ActionPerformed();
 344       }
 345
 346       @Override
 347       public void changedUpdate(DocumentEvent e)
 348       {
 349         txt_search_ActionPerformed();
 350       }
 351     });
 352
 353     final String searchTabTitle = MessageManager
 354             .getString("label.search_result");
 355     final String configureCols = MessageManager
 356             .getString("label.configure_displayed_columns");
 357     ChangeListener changeListener = new ChangeListener()
 358     {
 359       public void stateChanged(ChangeEvent changeEvent)
 360       {
 361         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 362                 .getSource();
 363         int index = sourceTabbedPane.getSelectedIndex();
 364         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 365         {
 366           btn_back.setEnabled(false);
 367           btn_cancel.setEnabled(false);
 368           btn_ok.setEnabled(false);
 369           previousWantedFields = PDBDocFieldPreferences
 370                   .getSearchSummaryFields().toArray(new PDBDocField[0]);
 371         }
 372         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 373         {
 374           btn_back.setEnabled(true);
 375           btn_cancel.setEnabled(true);
 376           if (wantedFieldsUpdated())
 377           {
 378             txt_search_ActionPerformed();
 379           }
 380           else
 381           {
 382             validateSelection();
 383           }
 384         }
 385       }
 386     };
 387     tabbedPane.addChangeListener(changeListener);
 388     tabbedPane.setPreferredSize(new Dimension(500, 300));
 389     tabbedPane.add(searchTabTitle, scrl_searchResult);
 390     tabbedPane.add(configureCols, pdbDocFieldPrefs);
 391
 392     pnl_actions.add(btn_back);
 393     pnl_actions.add(btn_ok);
 394     pnl_actions.add(btn_cancel);
 395
 396     pnl_results.add(tabbedPane);
 397     pnl_inputs.add(cmb_searchTarget);
 398     pnl_inputs.add(txt_search);
 399     pnl_inputs.add(lbl_loading);
 400     pnl_inputs.add(lbl_warning);
 401
 402     this.setLayout(mainLayout);
 403     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 404     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 405     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 406     mainFrame.setVisible(true);
 407     mainFrame.setContentPane(this);
 408     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 409     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 410   }
 411
 412   public boolean wantedFieldsUpdated()
 413   {
 414     if (previousWantedFields == null)
 415     {
 416       return true;
 417     }
 418
 419     return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
 420             .toArray(new PDBDocField[0]), previousWantedFields) ? false
 421             : true;
 422
 423   }
 424
 425   public void validateSelection()
 426   {
 427     if (tbl_summary.getSelectedRows().length > 0)
 428     {
 429       btn_ok.setEnabled(true);
 430     }
 431     else
 432     {
 433       btn_ok.setEnabled(false);
 434     }
 435   }
 436
 437   public JComboBox<PDBDocField> getCmbSearchTarget()
 438   {
 439     return cmb_searchTarget;
 440   }
 441
 442   public JTextField getTxtSearch()
 443   {
 444     return txt_search;
 445   }
 446
 447   public JInternalFrame getMainFrame()
 448   {
 449     return mainFrame;
 450   }
 451
 452   public abstract void transferToSequenceFetcher(String ids);
 453
 454   public abstract void txt_search_ActionPerformed();
 455
 456   public abstract void btn_ok_ActionPerformed();
 457
 458   public abstract void btn_back_ActionPerformed();
 459
 460   public abstract void btn_cancel_ActionPerformed();
 461
 462   public abstract void populateCmbSearchTargetOptions();
 463
 464 }