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