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